{ "openapi": "3.0.1", "info": { "title": "Marketplace API", "version": "5.0.5328-gc80af7eb" }, "paths": { "/public/v1/system/tasks": { "get": { "tags": [ "Tasks" ], "summary": "Get a list of tasks", "description": "Get a list of tasks.\nSupports filtering, sorting, and pagination via query string parameters. Access: Operations, Vendor, Client, Service.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskListResponse" }, "example": { "$meta": { "pagination": { "offset": 0, "limit": 2, "total": 115 }, "omitted": [ "audit", "access" ] }, "data": [ { "id": "TSK-5498-1544-6054-5440", "name": "Transferring the buyer to a different account", "revision": 1, "status": "Completed", "code": "accounts.buyers.transfer", "queue": "marketplace/platform/internal/buyers/commands", "object": { "id": "BUY-4230-6788" }, "description": "Transferring buyer 'BUY-4230-6788' to account 'ACC-4952-6625'", "progress": 100, "owner": { "id": "SVC-0001", "name": "platform" }, "result": "/public/v1/accounts/buyers/BUY-4230-6788" } ] } } } } } }, "post": { "tags": [ "Tasks" ], "summary": "Create a task", "description": "Create a task.\nOnly services can create tasks. Extesnions service will create a task for the extensions.", "requestBody": { "description": "The task to create.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Task" } ], "description": "The Task represents the state of an asynchronous, usually long running operation." }, "example": { "name": "Transferring the buyer to a different account", "code": "platform.accounts.buyers.transfer", "queue": "marketplace/platform/internal/buyers/commands", "object": { "id": "BUY-1190-0394" }, "description": "Transferring buyer 'BUY-1190-0394' to account 'ACC-5563-4382'", "parameters": { "BuyerId": "BUY-1190-0394", "TargetAccountId": "ACC-5563-4382" }, "access": [ { "id": "ACC-0000-0001" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" }, "example": { "id": "TSK-0001-2474-4798-1266", "name": "Transferring the buyer to a different account", "revision": 1, "status": "Queued", "code": "accounts.buyers.transfer", "queue": "marketplace/platform/internal/buyers/commands", "object": { "id": "BUY-1190-0394" }, "description": "Transferring buyer 'BUY-1190-0394' to account 'ACC-5563-4382'", "parameters": { "BuyerId": "BUY-1190-0394", "TargetAccountId": "ACC-5563-4382" }, "access": [ { "id": "ACC-0000-0001", "name": "SoftwareONE Operations" } ], "owner": { "id": "SVC-0001", "name": "platform" }, "audit": { "created": { "at": "2026-02-02T12:00:00+00:00", "by": { "id": "SVC-0001", "name": "Platform" } }, "updated": { "at": "2026-02-02T12:00:00+00:00", "by": { "id": "SVC-0001", "name": "Platform" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/system/tasks/{id}": { "get": { "tags": [ "Tasks" ], "summary": "Retrieve a task by ID", "description": "Retrieve a task by ID.\nUse the select query parameter to specify which fields to include. Access: OPS, SVC, VENDOR, CLIENT.", "parameters": [ { "name": "id", "in": "path", "description": "The task ID.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional select statement to filter fields.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" }, "example": { "id": "TSK-0001-2474-4798-1266", "name": "Transferring the buyer to a different account", "revision": 1, "status": "Completed", "code": "accounts.buyers.transfer", "queue": "marketplace/platform/internal/buyers/commands", "object": { "id": "BUY-1190-0394" }, "description": "Transferring buyer 'BUY-1190-0394' to account 'ACC-5563-4382'", "parameters": { "BuyerId": "BUY-1190-0394", "TargetAccountId": "ACC-5563-4382" }, "progress": 100, "owner": { "id": "SVC-0001", "name": "platform" }, "result": "/public/v1/accounts/buyers/BUY-1190-0394", "access": [ { "id": "ACC-0000-0001", "name": "SoftwareONE Operations" } ], "audit": { "created": { "at": "2026-02-02T12:00:00+00:00", "by": { "id": "SVC-0001", "name": "Platform" } }, "updated": { "at": "2026-02-02T12:00:00+00:00", "by": { "id": "SVC-0001", "name": "Platform" } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Tasks" ], "summary": "Update a task", "description": "Update a task.\nOnly the owner service or extension can update a task.\nUse this endpoint to update progress, ETA, and parameters.", "parameters": [ { "name": "id", "in": "path", "description": "The task ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated task details.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Task" } ], "description": "The Task represents the state of an asynchronous, usually long running operation." }, "example": { "progress": 45.5, "eta": "2026-02-02T14:30:00+00:00", "parameters": { "Step": "transfer" } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Task" } ], "description": "The Task represents the state of an asynchronous, usually long running operation." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Task" } ], "description": "The Task represents the state of an asynchronous, usually long running operation." } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" }, "example": { "id": "TSK-0001-2474-4798-1266", "name": "Transferring the buyer to a different account", "revision": 5, "status": "Processing", "code": "accounts.buyers.transfer", "queue": "marketplace/platform/internal/buyers/commands", "object": { "id": "BUY-1190-0394" }, "description": "Transferring buyer 'BUY-1190-0394' to account 'ACC-5563-4382'", "progress": 45.5, "eta": "2026-02-02T14:30:00+00:00", "parameters": { "BuyerId": "BUY-1190-0394", "TargetAccountId": "ACC-5563-4382", "Step": "transfer" }, "owner": { "id": "SVC-0001", "name": "platform" }, "audit": { "created": { "at": "2026-02-02T12:00:00+00:00", "by": { "id": "SVC-0001", "name": "Platform" } }, "updated": { "at": "2026-02-02T13:00:00+00:00", "by": { "id": "SVC-0001", "name": "Platform" } } } } } } } } } }, "/public/v1/system/tasks/{id}/result": { "get": { "tags": [ "Tasks" ], "summary": "Get a task result", "description": "Get a task result.\nReturns a JSON result or redirects to a resource if the result is a file. Access: OPS, SVC, VENDOR, CLIENT.", "parameters": [ { "name": "id", "in": "path", "description": "The task ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {}, "example": { "id": "BUY-1190-0394", "name": "AdAstralflex Argentina", "revision": 9, "status": "Active" } } } }, "302": { "description": "Found" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/system/tasks/{id}/logs": { "get": { "tags": [ "Tasks" ], "summary": "Get task logs", "description": "Get task logs.\nDefaults to ordering by timestamp descending when no order query is provided. Access: OPS, SVC.", "parameters": [ { "name": "id", "in": "path", "description": "The task ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskLogListResponse" }, "example": { "$meta": { "pagination": { "offset": 0, "limit": 10, "total": 5 }, "omitted": [ "audit" ] }, "data": [ { "id": "TLR-5992-0640-3485-0535", "revision": 1, "task": { "id": "TSK-5276-2474-4798-1266", "name": "Transferring the buyer to a different account", "revision": 1, "status": "Completed", "code": "accounts.buyers.transfer" }, "severity": "Info", "message": "Applying changes to database and external systems.", "timestamp": "2025-09-04T09:03:20.103+00:00", "progress": 90 } ] } } } } } } }, "/public/v1/system/tasks/{id}/execute": { "post": { "tags": [ "Tasks" ], "summary": "Transition a task to Processing", "description": "Transition a task to Processing.\nAllowed only for the owner service or extension. Valid when status is Queued or Rescheduled.", "parameters": [ { "name": "id", "in": "path", "description": "The task ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" } } } } } } }, "/public/v1/system/tasks/{id}/reschedule": { "post": { "tags": [ "Tasks" ], "summary": "Transition a task to Rescheduled", "description": "Transition a task to Rescheduled.\nAllowed only for the owner service or extension. Valid when status is Processing.", "parameters": [ { "name": "id", "in": "path", "description": "The task ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" } } } } } } }, "/public/v1/system/tasks/{id}/queue": { "post": { "tags": [ "Tasks" ], "summary": "Transition a task to Queued", "description": "Transition a task to Queued.\nAllowed only for the owner service or extension. Valid when status is Processing or Rescheduled.", "parameters": [ { "name": "id", "in": "path", "description": "The task ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" } } } } } } }, "/public/v1/system/tasks/{id}/complete": { "post": { "tags": [ "Tasks" ], "summary": "Transition a task to Completed", "description": "Transition a task to Completed.\nAllowed only for the owner service or extension. Valid when status is Processing.", "parameters": [ { "name": "id", "in": "path", "description": "The task ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" } } } } } } }, "/public/v1/system/tasks/{id}/fail": { "post": { "tags": [ "Tasks" ], "summary": "Transition a task to Failed", "description": "Transition a task to Failed.\nAllowed only for the owner service or extension. Valid when status is Processing, Queued, or Rescheduled.", "parameters": [ { "name": "id", "in": "path", "description": "The task ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" } } } } } } }, "/public/v1/audit/event-types": { "get": { "tags": [ "AuditEventTypes" ], "summary": "Gets a list of audit event types.", "description": "Supports filtering, sorting, and pagination via query string parameters.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditEventTypeListResponse" } } } } } } }, "/public/v1/audit/event-types/{id}": { "get": { "tags": [ "AuditEventTypes" ], "summary": "Retrieves an audit event type by ID.", "description": "Returns the audit event type with the specified ID. Use the select query parameter to specify which fields to include.", "parameters": [ { "name": "id", "in": "path", "description": "The audit event type ID.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional select statement to filter fields.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditEventType" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "AuditEventTypes" ], "summary": "Updates an event type.", "description": "Updates event type properties. Only provided fields will be modified.", "parameters": [ { "name": "id", "in": "path", "description": "The event type ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The update request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditEventType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuditEventType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AuditEventType" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditEventType" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/audit/records": { "post": { "tags": [ "AuditRecords" ], "summary": "Creates a new audit record.", "description": "Creates a custom audit record for tracking changes to an object. Intended for use by automations or extensions.", "requestBody": { "description": "Details of the audit record to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditRecord" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuditRecord" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AuditRecord" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditRecord" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "AuditRecords" ], "summary": "Gets a list of audit records.", "description": "Supports RQL filtering, sorting, and pagination via query string parameters.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditRecordListResponse" } } } } } } }, "/public/v1/audit/records/{id}": { "get": { "tags": [ "AuditRecords" ], "summary": "Retrieves an audit record by ID.", "description": "Returns the audit record with the specified ID. Use the select query parameter to specify which fields to include.", "parameters": [ { "name": "id", "in": "path", "description": "The audit record ID.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional RQL select statement to filter fields.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditRecord" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/analytics": { "get": { "tags": [ "Analytics" ], "summary": "Retrieves aggregated billing analytics data.", "description": "Supports date range grouping, filtering by various dimensions, and returns aggregated billing metrics.\nUse query parameters to specify grouping period, filters, and aggregation type.\n \nSupports multiple response formats based on the Accept header:\n- application/json: Returns JSON response (default)\n- application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: Returns Excel file", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsResultListResponse" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/AnalyticsResultListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/billing/credit-memos/{creditMemoId}/attachments/{id}": { "get": { "tags": [ "CreditMemoAttachments" ], "summary": "Retrieves a specific credit memo attachment by its ID.", "description": "Depending on the Accept header, this endpoint can either download the attachment or return only its metadata.\nUse Accept: application/json to retrieve metadata only, or Accept: application/octet-stream to download the file.\nFor external attachments (e.g., ERP-generated PDF), the file content is returned directly.\nFor internal attachments, a 301 redirect to the download URL is returned.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the credit memo attachment to retrieve.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional select statement to specify which fields to include in the response.", "schema": { "type": "string" } }, { "name": "creditMemoId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditMemoAttachment" } } } }, "301": { "description": "Moved Permanently" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "CreditMemoAttachments" ], "summary": "Updates an existing credit memo attachment.", "description": "Updates the properties (name, description) of an existing credit memo attachment.\nOnly the fields provided in the request body will be updated.\nThe file content cannot be changed; to replace the file, delete and recreate the attachment.", "parameters": [ { "name": "creditMemoId", "in": "path", "description": "The ID of the credit memo to which the attachment belongs.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The ID of the attachment to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated attachment details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditMemoAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreditMemoAttachment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreditMemoAttachment" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditMemoAttachment" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "CreditMemoAttachments" ], "summary": "Deletes an individual credit memo attachment.", "description": "Permanently removes the attachment and its associated file from the credit memo (e.g., CRD-3295-7900-0234).\nThis operation cannot be undone. Returns 204 No Content on success.", "parameters": [ { "name": "creditMemoId", "in": "path", "description": "The ID of the credit memo to which the attachment belongs.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The ID of the attachment to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/credit-memos/{creditMemoId}/attachments": { "get": { "tags": [ "CreditMemoAttachments" ], "summary": "Retrieves a list of credit memo attachments.", "description": "Returns all attachments associated with the credit memo specified in the route parameter (e.g., CRD-3295-7900-0234).\nSupports OData query parameters for filtering, sorting, and pagination.", "parameters": [ { "name": "creditMemoId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditMemoAttachmentListResponse" } } } } } }, "post": { "tags": [ "CreditMemoAttachments" ], "summary": "Creates a new credit memo attachment.", "description": "Uploads a file and associates it with the specified credit memo (e.g., CRD-3295-7900-0234).\nThe request must be sent as multipart/form-data containing the file and optional properties (name, description).", "parameters": [ { "name": "creditMemoId", "in": "path", "description": "The ID of the credit memo to which the attachment belongs.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "attachment": { "type": "object", "properties": { "Name": { "type": "string", "description": "The name of the attachment." }, "Description": { "type": "string", "description": "The description of the attachment." } }, "description": "Json representation of the attachment" }, "file": { "type": "string", "description": "The file of the attachment.", "format": "binary" } } }, "encoding": { "attachment": { "contentType": "application/json" }, "file": { "contentType": "application/octet-stream" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditMemoAttachment" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/credit-memos": { "post": { "tags": [ "CreditMemos" ], "summary": "Creates new credit memos.", "description": "Bulk async operation. Requires MPT-Upsert and MPT-Async headers.\nReturns 202 Accepted with MPT-Task-Id header for tracking the async operation.", "parameters": [ { "name": "creditMemo", "in": "query", "description": "The credit memo to create.", "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditMemo" } ], "description": "Represents a credit memo in the billing system." } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditMemo" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "CreditMemos" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditMemoListResponse" } } } } } } }, "/public/v1/billing/credit-memos/{id}": { "get": { "tags": [ "CreditMemos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditMemo" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/custom-ledgers/{customLedgerId}/attachments/{id}": { "get": { "tags": [ "CustomLedgerAttachments" ], "summary": "Retrieves a specific custom ledger attachment by its ID.", "description": "Depending on the Accept header, returns metadata (application/json) or redirects to file download (301).", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the custom ledger attachment to retrieve.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional select statement to specify which fields to include in the response.", "schema": { "type": "string" } }, { "name": "customLedgerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomLedgerAttachment" } } } }, "301": { "description": "Moved Permanently" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "CustomLedgerAttachments" ], "summary": "Updates an existing custom ledger attachment.", "description": "Updates the properties (name, description) of an existing custom ledger attachment. File content cannot be changed.", "parameters": [ { "name": "customLedgerId", "in": "path", "description": "The ID of the custom ledger to which the attachment belongs.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The ID of the attachment to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated attachment details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomLedgerAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomLedgerAttachment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomLedgerAttachment" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomLedgerAttachment" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "CustomLedgerAttachments" ], "summary": "Deletes a custom ledger attachment.", "description": "Permanently removes the attachment and its file. This operation cannot be undone.", "parameters": [ { "name": "customLedgerId", "in": "path", "description": "The ID of the custom ledger to which the attachment belongs.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The ID of the attachment to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/custom-ledgers/{customLedgerId}/attachments": { "get": { "tags": [ "CustomLedgerAttachments" ], "summary": "Retrieves a list of custom ledger attachments.", "description": "Returns all attachments associated with the custom ledger. Supports filtering, sorting, and pagination.", "parameters": [ { "name": "customLedgerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomLedgerAttachmentListResponse" } } } } } }, "post": { "tags": [ "CustomLedgerAttachments" ], "summary": "Creates a new custom ledger attachment.", "description": "Uploads a file as multipart/form-data with optional properties (name, description).", "parameters": [ { "name": "customLedgerId", "in": "path", "description": "The ID of the custom ledger to which the attachment belongs.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "attachment": { "type": "object", "properties": { "Name": { "type": "string", "description": "The name of the attachment." }, "Description": { "type": "string", "description": "The description of the attachment." } }, "description": "Json representation of the attachment" }, "file": { "type": "string", "description": "The file of the attachment.", "format": "binary" } } }, "encoding": { "attachment": { "contentType": "application/json" }, "file": { "contentType": "application/octet-stream" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomLedgerAttachment" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/custom-ledgers/{customLedgerId}/charges/{id}": { "get": { "tags": [ "CustomLedgerCharges" ], "summary": "Retrieves a specific charge by its ID.", "description": "Returns a single charge record from the custom ledger.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the custom charge.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "The select statement to filter the fields.", "schema": { "type": "string" } }, { "name": "customLedgerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Charge" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/custom-ledgers/{customLedgerId}/charges": { "get": { "tags": [ "CustomLedgerCharges" ], "summary": "Retrieves a list of charges for a specific custom ledger.", "description": "Returns all charges in the custom ledger. Supports JSONL export for operations (Accept: application/jsonl).\nSupports filtering, sorting, and pagination via query parameters.", "parameters": [ { "name": "customLedgerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChargeListResponse" } } } } } } }, "/public/v1/billing/custom-ledgers": { "post": { "tags": [ "CustomLedgers" ], "summary": "Creates a new custom ledger.", "description": "Creates a custom ledger in Draft status. After creation, upload charge data using the /upload endpoint.", "requestBody": { "description": "The custom ledger details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomLedger" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomLedger" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomLedger" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomLedger" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "CustomLedgers" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomLedgerListResponse" } } } } } } }, "/public/v1/billing/custom-ledgers/{id}": { "put": { "tags": [ "CustomLedgers" ], "summary": "Updates an existing custom ledger.", "description": "Updates custom ledger properties. Only provided fields will be modified.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the custom ledger to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The custom ledger details to update.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomLedger" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomLedger" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomLedger" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomLedger" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "CustomLedgers" ], "summary": "Deletes a custom ledger by ID.", "description": "Permanently removes the custom ledger and all associated charges. This operation cannot be undone.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the custom ledger to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "CustomLedgers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomLedger" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/custom-ledgers/{id}/upload": { "post": { "tags": [ "CustomLedgers" ], "summary": "Uploads a file for a specific custom ledger.", "description": "Accepts XLSX files containing charge data. File is validated and charges are extracted for processing.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the custom ledger.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "description": "The file to upload.", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomLedger" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "415": { "description": "Unsupported Media Type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/custom-ledgers/{id}/accept": { "post": { "tags": [ "CustomLedgers" ], "summary": "Accepts a custom ledger.", "description": "Transitions custom ledger to Accepted status, finalizing charges and generating statements.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the custom ledger to accept.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The custom ledger data to be updated before action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomLedger" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomLedger" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomLedger" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomLedger" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/custom-ledgers/{id}/queue": { "post": { "tags": [ "CustomLedgers" ], "summary": "Queues a custom ledger for ERP integration.", "description": "Transitions custom ledger to Queued status, initiating ERP integration processing.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the custom ledger to queue.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The custom ledger data to be updated before action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomLedger" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomLedger" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomLedger" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomLedger" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/invoices/{invoiceId}/attachments/{id}": { "get": { "tags": [ "InvoiceAttachments" ], "summary": "Retrieves a specific invoice attachment by its ID.", "description": "Depending on the Accept header, returns metadata (application/json) or downloads the file.\nFor external attachments (ERP PDFs), returns file content directly; for internal attachments, returns 301 redirect.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the invoice attachment to retrieve.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional select statement to specify which fields to include in the response.", "schema": { "type": "string" } }, { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceAttachment" } } } }, "301": { "description": "Moved Permanently" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "InvoiceAttachments" ], "summary": "Updates an existing invoice attachment.", "description": "Updates the properties (name, description) of an existing invoice attachment. File content cannot be changed.", "parameters": [ { "name": "invoiceId", "in": "path", "description": "The ID of the invoice to which the attachment belongs.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The ID of the attachment to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated attachment details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InvoiceAttachment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/InvoiceAttachment" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceAttachment" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "InvoiceAttachments" ], "summary": "Deletes an invoice attachment.", "description": "Permanently removes the attachment and its file. This operation cannot be undone.", "parameters": [ { "name": "invoiceId", "in": "path", "description": "The ID of the invoice to which the attachment belongs.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The ID of the attachment to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/invoices/{invoiceId}/attachments": { "get": { "tags": [ "InvoiceAttachments" ], "summary": "Retrieves a list of invoice attachments.", "description": "Returns all attachments associated with the invoice. Supports filtering, sorting, and pagination.", "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceAttachmentListResponse" } } } } } }, "post": { "tags": [ "InvoiceAttachments" ], "summary": "Creates a new invoice attachment.", "description": "Uploads a file as multipart/form-data with optional properties (name, description).", "parameters": [ { "name": "invoiceId", "in": "path", "description": "The ID of the invoice to which the attachment belongs.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "attachment": { "type": "object", "properties": { "Name": { "type": "string", "description": "The name of the attachment." }, "Description": { "type": "string", "description": "The description of the attachment." } }, "description": "Json representation of the attachment" }, "file": { "type": "string", "description": "The file of the attachment.", "format": "binary" } } }, "encoding": { "attachment": { "contentType": "application/json" }, "file": { "contentType": "application/octet-stream" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceAttachment" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/invoices": { "post": { "tags": [ "Invoices" ], "summary": "Creates new invoices.", "description": "Bulk async operation. Requires MPT-Upsert and MPT-Async headers.\nReturns 202 Accepted with MPT-Task-Id header for tracking the async operation.", "parameters": [ { "name": "invoice", "in": "query", "description": "The invoice to create (not used due to custom body parsing).", "schema": { "allOf": [ { "$ref": "#/components/schemas/Invoice" } ], "description": "Represents an invoice entity in the billing system." } } ], "responses": { "202": { "description": "Accepted" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Invoices" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceListResponse" } } } } } } }, "/public/v1/billing/invoices/{id}": { "get": { "tags": [ "Invoices" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/journals/{journalId}/attachments/{id}": { "get": { "tags": [ "JournalAttachments" ], "summary": "Retrieves a specific journal attachment by its ID.", "description": "Depending on the Accept header, returns metadata (application/json) or redirects to file download (301).", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the journal attachment to retrieve.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional select statement to specify which fields to include in the response.", "schema": { "type": "string" } }, { "name": "journalId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalAttachment" } } } }, "301": { "description": "Moved Permanently" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "JournalAttachments" ], "summary": "Updates an existing journal attachment.", "description": "Updates the properties (name, description) of an existing journal attachment. File content cannot be changed.", "parameters": [ { "name": "journalId", "in": "path", "description": "The ID of the journal to which the attachment belongs.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The ID of the attachment to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated attachment details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JournalAttachment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/JournalAttachment" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalAttachment" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "JournalAttachments" ], "summary": "Deletes a journal attachment.", "description": "Permanently removes the attachment and its file. This operation cannot be undone.", "parameters": [ { "name": "journalId", "in": "path", "description": "The ID of the journal to which the attachment belongs.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The ID of the attachment to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/journals/{journalId}/attachments": { "get": { "tags": [ "JournalAttachments" ], "summary": "Retrieves a list of journal attachments.", "description": "Returns all attachments associated with the journal. Supports filtering, sorting, and pagination.", "parameters": [ { "name": "journalId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalAttachmentListResponse" } } } } } }, "post": { "tags": [ "JournalAttachments" ], "summary": "Creates a new journal attachment.", "description": "Uploads a file as multipart/form-data with optional properties (name, description).", "parameters": [ { "name": "journalId", "in": "path", "description": "The ID of the journal to which the attachment belongs.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "attachment": { "type": "object", "properties": { "Name": { "type": "string", "description": "The name of the attachment." }, "Description": { "type": "string", "description": "The description of the attachment." } }, "description": "Json representation of the attachment" }, "file": { "type": "string", "description": "The file of the attachment.", "format": "binary" } } }, "encoding": { "attachment": { "contentType": "application/json" }, "file": { "contentType": "application/octet-stream" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalAttachment" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/journals/{journalId}/charges/{id}": { "get": { "tags": [ "JournalCharges" ], "summary": "Retrieves a specific charge by its ID.", "description": "Returns a single charge record from the journal with all pricing and reconciliation details.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the charge.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "The select statement to filter the fields.", "schema": { "type": "string" } }, { "name": "journalId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Charge" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/journals/{journalId}/charges": { "get": { "tags": [ "JournalCharges" ], "summary": "Retrieves a list of charges for a specific journal.", "description": "Returns all charges associated with the journal. Supports JSONL export for operations (Accept: application/jsonl).\nSupports filtering, sorting, and pagination via query parameters.", "parameters": [ { "name": "journalId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChargeListResponse" } } } } } } }, "/public/v1/billing/journals/{journalId}/charges/{id}/match": { "post": { "tags": [ "JournalCharges" ], "summary": "Matches a charge to a subscription.", "description": "Associates the charge with a specific subscription or agreement, completing the reconciliation process.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the charge.", "required": true, "schema": { "type": "string" } }, { "name": "journalId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The charge data to be updated before match action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalCharge" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JournalCharge" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/JournalCharge" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Charge" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/journals/{journalId}/charges/{id}/ignore": { "post": { "tags": [ "JournalCharges" ], "summary": "Ignores a charge.", "description": "Marks the charge as ignored, excluding it from client billing calculations.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the charge.", "required": true, "schema": { "type": "string" } }, { "name": "journalId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The charge data to be updated before ignore action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalCharge" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JournalCharge" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/JournalCharge" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Charge" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/journals/{journalId}/charges/{id}/reset": { "post": { "tags": [ "JournalCharges" ], "summary": "Resets a charge.", "description": "Undoes all reconciliation actions (match, ignore), returning the charge to unreconciled state.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the charge.", "required": true, "schema": { "type": "string" } }, { "name": "journalId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The charge data to be updated before reset action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalCharge" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JournalCharge" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/JournalCharge" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Charge" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/journals": { "post": { "tags": [ "Journals" ], "summary": "Creates a new journal.", "description": "Creates a new journal in Draft status. After creation, upload charge data using the /upload endpoint.", "requestBody": { "description": "The journal to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Journal" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Journal" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Journal" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Journal" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Journals" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalListResponse" } } } } } } }, "/public/v1/billing/journals/{id}": { "put": { "tags": [ "Journals" ], "summary": "Updates an existing journal.", "description": "Updates journal properties. Only provided fields will be modified.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the journal to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated journal data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Journal" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Journal" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Journal" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Journal" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Journals" ], "summary": "Deletes the specified journal.", "description": "Permanently removes the journal and all associated charges and attachments. This operation cannot be undone.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the journal to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Journals" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Journal" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/journals/{id}/upload": { "post": { "tags": [ "Journals" ], "summary": "Uploads a journal file.", "description": "Accepts XLSX or JSONL files containing charge records. Supports chunked uploads via MPT-File-Manager header.\nFile is validated and charges are extracted for processing. Maximum file size is 10GB.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the journal.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "description": "Journal file that contains the charges data.", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Journal" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "415": { "description": "Unsupported Media Type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/journals/{id}/regenerate": { "post": { "tags": [ "Journals" ], "summary": "Regenerates a journal.", "description": "Re-processes the journal charges, recalculating derived values and re-validating data.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the journal to regenerate.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The journal data to be updated before action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Journal" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Journal" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Journal" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Journal" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/journals/{id}/submit": { "post": { "tags": [ "Journals" ], "summary": "Submits a journal for processing.", "description": "Transitions journal to Submitted status, triggering validation and making it available for operations review.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the journal to submit.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The journal data to be updated before action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Journal" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Journal" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Journal" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Journal" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/journals/{id}/enquiry": { "post": { "tags": [ "Journals" ], "summary": "Enquires the journal.", "description": "Transitions journal to Enquiry status, indicating that clarification is needed from the vendor.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the journal.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The journal data to be updated before action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Journal" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Journal" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Journal" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Journal" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/journals/{id}/accept": { "post": { "tags": [ "Journals" ], "summary": "Accepts a journal.", "description": "Transitions journal to Accepted status, finalizing the charges and creating ledger entries for billing.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the journal to accept.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The journal data to be updated before action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Journal" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Journal" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Journal" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Journal" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/journals/{id}/reset": { "post": { "tags": [ "Journals" ], "summary": "Resets a journal.", "description": "Returns journal to Draft status, clearing processing state and allowing re-upload or modification.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the journal to reset.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The journal data to be updated before reset.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Journal" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Journal" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Journal" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Journal" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/journals/{id}/recalculate": { "post": { "tags": [ "Journals" ], "summary": "Recalculates a journal.", "description": "Recalculates pricing, margins, and totals for all charges in the journal without changing status.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the journal to recalculate.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The journal data to be updated before recalculate.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Journal" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Journal" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Journal" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Journal" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/journals/{journalId}/sellers": { "get": { "tags": [ "JournalSellers" ], "summary": "Retrieves a list of sellers for a specific journal.", "description": "Returns all sellers that have charges in the specified journal. Supports filtering, sorting, and pagination.", "parameters": [ { "name": "journalId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalSellerListResponse" } } } } } } }, "/public/v1/billing/ledgers/{ledgerId}/attachments/{id}": { "get": { "tags": [ "LedgerAttachments" ], "summary": "Retrieves a specific ledger attachment by its ID.", "description": "Depending on the Accept header, returns metadata (application/json) or redirects to file download (301).", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the ledger attachment to retrieve.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional select statement to specify which fields to include in the response.", "schema": { "type": "string" } }, { "name": "ledgerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LedgerAttachment" } } } }, "301": { "description": "Moved Permanently" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "LedgerAttachments" ], "summary": "Updates an existing ledger attachment.", "description": "Updates the properties (name, description) of an existing ledger attachment. File content cannot be changed.", "parameters": [ { "name": "ledgerId", "in": "path", "description": "The ID of the ledger to which the attachment belongs.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The ID of the attachment to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated attachment details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LedgerAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LedgerAttachment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LedgerAttachment" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LedgerAttachment" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "LedgerAttachments" ], "summary": "Deletes a ledger attachment.", "description": "Permanently removes the attachment and its file. This operation cannot be undone.", "parameters": [ { "name": "ledgerId", "in": "path", "description": "The ID of the ledger to which the attachment belongs.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The ID of the attachment to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/ledgers/{ledgerId}/attachments": { "get": { "tags": [ "LedgerAttachments" ], "summary": "Retrieves a list of ledger attachments.", "description": "Returns all attachments associated with the ledger. Supports filtering, sorting, and pagination.", "parameters": [ { "name": "ledgerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LedgerAttachmentListResponse" } } } } } }, "post": { "tags": [ "LedgerAttachments" ], "summary": "Creates a new ledger attachment.", "description": "Uploads a file as multipart/form-data with optional properties (name, description).", "parameters": [ { "name": "ledgerId", "in": "path", "description": "The ID of the ledger to which the attachment belongs.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "attachment": { "type": "object", "properties": { "Name": { "type": "string", "description": "The name of the attachment." }, "Description": { "type": "string", "description": "The description of the attachment." } }, "description": "Json representation of the attachment" }, "file": { "type": "string", "description": "The file of the attachment.", "format": "binary" } } }, "encoding": { "attachment": { "contentType": "application/json" }, "file": { "contentType": "application/octet-stream" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LedgerAttachment" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/ledgers/{ledgerId}/charges/{id}": { "get": { "tags": [ "LedgerCharges" ], "summary": "Retrieves a specific charge by its ID.", "description": "Returns a single charge record associated with the ledger.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the charge.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "The select statement to filter the fields.", "schema": { "type": "string" } }, { "name": "ledgerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Charge" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/ledgers/{ledgerId}/charges": { "get": { "tags": [ "LedgerCharges" ], "summary": "Retrieves a list of charges for a specific ledger.", "description": "Returns all charges aggregated in the ledger. Supports JSONL export for operations (Accept: application/jsonl).\nSupports filtering, sorting, and pagination via query parameters.", "parameters": [ { "name": "ledgerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChargeListResponse" } } } } } } }, "/public/v1/billing/ledgers/{id}": { "put": { "tags": [ "Ledgers" ], "summary": "Updates a ledger.", "description": "Updates ledger properties. Only provided fields will be modified.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the ledger to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The ledger data to be updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ledger" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Ledger" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Ledger" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ledger" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Ledgers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ledger" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/ledgers/{id}/recalculate": { "post": { "tags": [ "Ledgers" ], "summary": "Recalculates a ledger.", "description": "Recalculates pricing, margins, and totals for all charges in the ledger without changing status.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the ledger to recalculate.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The ledger data to be updated before action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ledger" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Ledger" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Ledger" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ledger" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/ledgers/{id}/accept": { "post": { "tags": [ "Ledgers" ], "summary": "Accepts a ledger.", "description": "Transitions ledger to Accepted status, finalizing charges and generating statements for clients.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the ledger to accept.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The ledger data to be updated before action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ledger" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Ledger" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Ledger" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ledger" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/ledgers/{id}/queue": { "post": { "tags": [ "Ledgers" ], "summary": "Queues a ledger for ERP integration.", "description": "Transitions ledger to Queued status, initiating ERP integration processing.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the ledger to queue.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The ledger data to be updated before action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ledger" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Ledger" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Ledger" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ledger" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/ledgers": { "get": { "tags": [ "Ledgers" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LedgerListResponse" } } } } } } }, "/public/v1/billing/manual-overrides": { "post": { "tags": [ "ManualOverrides" ], "summary": "Creates a new manual override.", "description": "Creates a pricing rule override that will be applied during billing calculations.", "requestBody": { "description": "The manual override details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Override" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Override" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Override" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Override" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "ManualOverrides" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OverrideListResponse" } } } } } } }, "/public/v1/billing/manual-overrides/{id}": { "put": { "tags": [ "ManualOverrides" ], "summary": "Updates an existing manual override.", "description": "Updates the pricing rule override. Only provided fields will be modified.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the manual override to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated manual override details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Override" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Override" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Override" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Override" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "ManualOverrides" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Override" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/statements/{statementId}/attachments/{id}": { "get": { "tags": [ "StatementAttachments" ], "summary": "Retrieves a specific statement attachment by its ID.", "description": "Depending on the Accept header, returns metadata (application/json) or redirects to file download (301).", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the statement attachment to retrieve.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional select statement to specify which fields to include in the response.", "schema": { "type": "string" } }, { "name": "statementId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatementAttachment" } } } }, "301": { "description": "Moved Permanently" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "StatementAttachments" ], "summary": "Updates an existing statement attachment.", "description": "Updates the properties (name, description) of an existing statement attachment. File content cannot be changed.", "parameters": [ { "name": "statementId", "in": "path", "description": "The ID of the statement to which the attachment belongs.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The ID of the attachment to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated attachment details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatementAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StatementAttachment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/StatementAttachment" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatementAttachment" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "StatementAttachments" ], "summary": "Deletes a statement attachment.", "description": "Permanently removes the attachment and its file. This operation cannot be undone.", "parameters": [ { "name": "statementId", "in": "path", "description": "The ID of the statement to which the attachment belongs.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The ID of the attachment to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/statements/{statementId}/attachments": { "get": { "tags": [ "StatementAttachments" ], "summary": "Retrieves a list of statement attachments.", "description": "Returns all attachments associated with the statement. Supports filtering, sorting, and pagination.", "parameters": [ { "name": "statementId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatementAttachmentListResponse" } } } } } }, "post": { "tags": [ "StatementAttachments" ], "summary": "Creates a new statement attachment.", "description": "Uploads a file as multipart/form-data with optional properties (name, description).", "parameters": [ { "name": "statementId", "in": "path", "description": "The ID of the statement to which the attachment belongs.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "attachment": { "type": "object", "properties": { "Name": { "type": "string", "description": "The name of the attachment." }, "Description": { "type": "string", "description": "The description of the attachment." } }, "description": "Json representation of the attachment" }, "file": { "type": "string", "description": "The file of the attachment.", "format": "binary" } } }, "encoding": { "attachment": { "contentType": "application/json" }, "file": { "contentType": "application/octet-stream" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatementAttachment" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/statements/{statementId}/charges/{id}": { "get": { "tags": [ "StatementCharges" ], "summary": "Retrieves a specific charge by its ID.", "description": "Returns a single charge record included in the statement.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the charge.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "The select statement to filter the fields.", "schema": { "type": "string" } }, { "name": "statementId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Charge" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/statements/{statementId}/charges": { "get": { "tags": [ "StatementCharges" ], "summary": "Retrieves a list of charges for a specific statement.", "description": "Returns all charges included in the statement. Supports JSONL export for operations (Accept: application/jsonl).\nSupports filtering, sorting, and pagination via query parameters.", "parameters": [ { "name": "statementId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChargeListResponse" } } } } } } }, "/public/v1/billing/statements": { "post": { "tags": [ "Statements" ], "summary": "Creates a new statement.", "description": "Creates a new statement.", "requestBody": { "description": "The statement to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Statement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Statement" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Statement" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Statement" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Statements" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatementListResponse" } } } } } } }, "/public/v1/billing/statements/{id}": { "put": { "tags": [ "Statements" ], "summary": "Updates an existing statement.", "description": "Updates statement properties. Only provided fields will be modified.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the statement to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The statement details to update.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Statement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Statement" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Statement" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Statement" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Statements" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Statement" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/statements/{id}/cancel": { "post": { "tags": [ "Statements" ], "summary": "Cancels a statement.", "description": "Transitions statement to Cancelled status. Cancelled statements are excluded from billing.\nWhen called for a consolidated statement, children receive the status Queued and are detached from the consolidated parent.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the statement to cancel.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The statement data to be updated before action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Statement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Statement" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Statement" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Statement" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/statements/{id}/error": { "post": { "tags": [ "Statements" ], "summary": "Marks a statement as error.", "description": "Transitions statement to Error status, indicating a processing failure that requires attention.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the statement.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The statement data to be updated before action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Statement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Statement" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Statement" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Statement" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/statements/{id}/issue": { "post": { "tags": [ "Statements" ], "summary": "Issues a statement.", "description": "Transitions statement to Issued status, marking it as sent to the client.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the statement to issue.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The statement data to be updated before action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Statement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Statement" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Statement" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Statement" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/statements/{id}/pending": { "post": { "tags": [ "Statements" ], "summary": "Sets statement to pending.", "description": "Transitions statement to Pending status, indicating it is awaiting further processing.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the statement.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The statement data to be updated before action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Statement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Statement" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Statement" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Statement" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/statements/{id}/queue": { "post": { "tags": [ "Statements" ], "summary": "Queues a statement.", "description": "Transitions statement to Queued status for ERP integration processing.\nWhen called for a consolidated statement, children receive the status Consolidated.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the statement.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The statement data to be updated before action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Statement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Statement" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Statement" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Statement" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/statements/{id}/retry": { "post": { "tags": [ "Statements" ], "summary": "Retries a failed statement.", "description": "Resets statement to Generated status, allowing it to be reprocessed after a failure.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the statement to retry.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The statement data to be updated before action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Statement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Statement" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Statement" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Statement" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/statements/{id}/recalculate": { "post": { "tags": [ "Statements" ], "summary": "Recalculates a statement.", "description": "Recalculates totals and pricing for the statement without changing its status.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the statement.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The statement data to be updated before action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Statement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Statement" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Statement" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Statement" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/statements/{id}/children": { "post": { "tags": [ "Statements" ], "summary": "Adds a child statement to a consolidated parent statement.", "description": "Adds a child statement to a consolidated parent. The child must be in Queued status\nand will transition to Consolidating status. Parent statistics and prices are recalculated.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the consolidated parent statement.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The child statement containing ID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Statement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Statement" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Statement" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Statement" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/billing/statements/{id}/children/{childId}": { "delete": { "tags": [ "Statements" ], "summary": "Removes a child statement from a consolidated parent statement.", "description": "Removes a child statement from a consolidated parent. The child must be in Consolidating status\nand will transition to Generated status. Parent statistics and prices are recalculated.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the consolidated parent statement.", "required": true, "schema": { "type": "string" } }, { "name": "childId", "in": "path", "description": "The ID of the child statement to remove.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Statement" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/integration/categories": { "post": { "tags": [ "Categories" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateCategoryRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateCategoryRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateCategoryRequest" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtensionCategory" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Categories" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtensionCategoryListResponse" } } } } } } }, "/public/v1/integration/categories/{id}": { "put": { "tags": [ "Categories" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtensionCategory" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Categories" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtensionCategory" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/integration/categories/{id}/activate": { "post": { "tags": [ "Categories" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtensionCategory" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/integration/categories/{id}/deactivate": { "post": { "tags": [ "Categories" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtensionCategory" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/integration/extensions/{extensionId}/documents": { "get": { "tags": [ "Documents" ], "parameters": [ { "name": "extensionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentListResponse" } } } } } }, "post": { "tags": [ "Documents" ], "parameters": [ { "name": "extensionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "document": { "type": "object", "properties": { "Name": { "type": "string" }, "Description": { "type": "string" }, "Language": { "type": "string" }, "DocumentType": { "allOf": [ { "$ref": "#/components/schemas/DocumentType" } ] }, "Url": { "type": "string" } }, "description": "Json representation of the document" }, "file": { "type": "string", "format": "binary" } } }, "encoding": { "document": { "contentType": "application/json" }, "file": { "contentType": "application/octet-stream" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentEntity" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/integration/extensions/{extensionId}/documents/{id}": { "get": { "tags": [ "Documents" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "extensionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentEntity" } } } }, "301": { "description": "Moved Permanently" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Documents" ], "parameters": [ { "name": "extensionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Documents" ], "parameters": [ { "name": "extensionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentEntity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentEntity" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DocumentEntity" } } } }, "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/integration/extensions/{extensionId}/documents/{id}/publish": { "post": { "tags": [ "Documents" ], "parameters": [ { "name": "extensionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentEntity" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/integration/extensions/{extensionId}/documents/{id}/unpublish": { "post": { "tags": [ "Documents" ], "parameters": [ { "name": "extensionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentEntity" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/integration/extensions": { "post": { "tags": [ "Extension" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "Extension": { "type": "object", "properties": { "Name": { "type": "string" }, "ShortDescription": { "type": "string" }, "LongDescription": { "type": "string" }, "Website": { "type": "string" }, "Categories": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" } } }, "description": "Json representation of the Extension" }, "icon": { "type": "string", "format": "binary" } } }, "encoding": { "Extension": { "contentType": "application/json" }, "icon": { "contentType": "application/octet-stream" } } }, "application/json": { "schema": { "type": "object", "properties": { "Extension": { "type": "object", "properties": { "Name": { "type": "string" }, "ShortDescription": { "type": "string" }, "LongDescription": { "type": "string" }, "Website": { "type": "string" }, "Categories": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" } } }, "description": "Json representation of the Extension" }, "icon": { "type": "string", "format": "binary" } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Extension" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Extension" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtensionListResponse" } } } } } } }, "/public/v1/integration/extensions/{id}": { "put": { "tags": [ "Extension" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "extension": { "type": "object", "properties": { "Extension.Node.Name": { "type": "string" }, "Extension.Node.Children": { "type": "array", "items": { "$ref": "#/components/schemas/DeltaNode" } }, "Extension.Path": { "type": "string" }, "Extension.Data.Name": { "type": "string" }, "Extension.Data.ShortDescription": { "type": "string" }, "Extension.Data.LongDescription": { "type": "string" }, "Extension.Data.Website": { "type": "string" }, "Extension.Data.Categories": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" } }, "Extension.Data.Configuration.RootElement.ValueKind": { "allOf": [ { "$ref": "#/components/schemas/JsonValueKind" } ] }, "Extension.IsDefined": { "type": "boolean" } }, "description": "Json representation of the extension" }, "icon": { "type": "string", "format": "binary" } } }, "encoding": { "extension": { "contentType": "application/json" }, "icon": { "contentType": "application/octet-stream" } } }, "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "audit": { "allOf": [ { "$ref": "#/components/schemas/ExtensionAudit" } ] }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string" }, "icon": { "type": "string", "nullable": true }, "revision": { "type": "integer", "format": "int32" }, "vendor": { "allOf": [ { "$ref": "#/components/schemas/Account" } ] }, "shortDescription": { "type": "string", "nullable": true }, "longDescription": { "type": "string", "nullable": true }, "website": { "type": "string", "nullable": true }, "status": { "enum": [ "Draft", "Private", "Public", "Deleted" ], "type": "string" }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionCategory" }, "nullable": true }, "modules": { "type": "array", "items": { "$ref": "#/components/schemas/Module" }, "nullable": true }, "statistics": { "allOf": [ { "$ref": "#/components/schemas/ExtensionStatistics" } ] }, "configuration": { "nullable": true }, "meta": { "allOf": [ { "$ref": "#/components/schemas/ExtensionMeta" } ], "nullable": true }, "service": { "allOf": [ { "$ref": "#/components/schemas/ExtensionServiceDetails" } ], "nullable": true } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Extension" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Extension" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Extension" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Extension" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/integration/extensions/{id}/publish": { "post": { "tags": [ "Extension" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Extension" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/integration/extensions/{id}/unpublish": { "post": { "tags": [ "Extension" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Extension" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/integration/extensions/{id}/regenerate": { "post": { "tags": [ "Extension" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Extension" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/integration/extensions/{id}/token": { "post": { "tags": [ "Extension" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/integration/extensions/{id}/icon": { "get": { "tags": [ "Extension" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "307": { "description": "Temporary Redirect" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/integration/extensions/{id}/installations": { "get": { "tags": [ "Extension" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Installation" } } } } } } }, "/public/v1/integration/extensions/{id}/installations/{installationId}": { "get": { "tags": [ "Extension" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "installationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Installation" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/integration/installations": { "post": { "tags": [ "Installation" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateInstallationRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateInstallationRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateInstallationRequest" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Installation" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Installation" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstallationListResponse" } } } } } } }, "/public/v1/integration/installations/{id}": { "put": { "tags": [ "Installation" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Installation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Installation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Installation" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Installation" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Installation" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Installation" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Installation" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/integration/installations/{id}/redeem": { "post": { "tags": [ "Installation" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RedeemInstallationRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RedeemInstallationRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RedeemInstallationRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Installation" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/integration/installations/{id}/renew": { "post": { "tags": [ "Installation" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Installation" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/integration/installations/{id}/token": { "post": { "tags": [ "Installation" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/integration/installations/-/token": { "post": { "tags": [ "Installation" ], "parameters": [ { "name": "account.id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/integration/extensions/{extensionId}/instances": { "post": { "tags": [ "Instance" ], "parameters": [ { "name": "extensionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateInstanceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateInstanceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateInstanceRequest" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Instance" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Instance" ], "parameters": [ { "name": "extensionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstanceListResponse" } } } } } } }, "/public/v1/integration/extensions/{extensionId}/instances/{id}": { "get": { "tags": [ "Instance" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "extensionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Instance" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/integration/extensions/{extensionId}/media": { "get": { "tags": [ "Media" ], "parameters": [ { "name": "extensionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaListResponse" } } } } } }, "post": { "tags": [ "Media" ], "parameters": [ { "name": "extensionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "media": { "type": "object", "properties": { "Name": { "type": "string" }, "Description": { "type": "string" }, "MediaType": { "allOf": [ { "$ref": "#/components/schemas/MediaType" } ] }, "Url": { "type": "string" }, "DisplayOrder": { "type": "integer", "format": "int32" } }, "description": "Json representation of the media" }, "file": { "type": "string", "format": "binary" } } }, "encoding": { "media": { "contentType": "application/json" }, "file": { "contentType": "application/octet-stream" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Media" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/integration/extensions/{extensionId}/media/{id}": { "get": { "tags": [ "Media" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "extensionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Media" } } } }, "301": { "description": "Moved Permanently" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Media" ], "parameters": [ { "name": "extensionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Media" ], "parameters": [ { "name": "extensionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Media" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Media" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Media" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Media" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/integration/extensions/{extensionId}/media/{id}/publish": { "post": { "tags": [ "Media" ], "parameters": [ { "name": "extensionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Media" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/integration/extensions/{extensionId}/media/{id}/unpublish": { "post": { "tags": [ "Media" ], "parameters": [ { "name": "extensionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Media" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/integration/extensions/{extensionId}/media/{id}/image": { "get": { "tags": [ "Media" ], "parameters": [ { "name": "extensionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "307": { "description": "Temporary Redirect" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/integration/extensions/{extensionId}/terms": { "post": { "tags": [ "Terms" ], "parameters": [ { "name": "extensionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateTermRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateTermRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateTermRequest" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Term" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Terms" ], "parameters": [ { "name": "extensionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermListResponse" } } } } } } }, "/public/v1/integration/extensions/{extensionId}/terms/{id}": { "put": { "tags": [ "Terms" ], "parameters": [ { "name": "extensionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Term" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Term" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Term" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Term" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Terms" ], "parameters": [ { "name": "extensionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Terms" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "extensionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Term" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/integration/extensions/{extensionId}/terms/{id}/publish": { "post": { "tags": [ "Terms" ], "parameters": [ { "name": "extensionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Term" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/integration/extensions/{extensionId}/terms/{id}/unpublish": { "post": { "tags": [ "Terms" ], "parameters": [ { "name": "extensionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Term" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/integration/extensions/{extensionId}/terms/{termId}/variants": { "post": { "tags": [ "TermVariants" ], "parameters": [ { "name": "extensionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "termId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "variant": { "type": "object", "properties": { "Type": { "enum": [ "Online", "File" ], "type": "string" }, "AssetUrl": { "type": "string" }, "LanguageCode": { "type": "string" }, "Name": { "type": "string" }, "Description": { "type": "string" } }, "description": "Json representation of the variant" }, "file": { "type": "string", "format": "binary" } } }, "encoding": { "variant": { "contentType": "application/json" }, "file": { "contentType": "application/octet-stream" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermVariant" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "TermVariants" ], "parameters": [ { "name": "extensionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "termId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermVariantListResponse" } } } } } } }, "/public/v1/integration/extensions/{extensionId}/terms/{termId}/variants/{id}": { "put": { "tags": [ "TermVariants" ], "parameters": [ { "name": "termId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "extensionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTermVariant" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateTermVariant" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateTermVariant" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermVariant" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "TermVariants" ], "parameters": [ { "name": "termId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "extensionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "TermVariants" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "extensionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "termId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermVariant" } } } }, "301": { "description": "Moved Permanently" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/integration/extensions/{extensionId}/terms/{termId}/variants/{id}/publish": { "post": { "tags": [ "TermVariants" ], "parameters": [ { "name": "termId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "extensionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermVariant" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/integration/extensions/{extensionId}/terms/{termId}/variants/{id}/unpublish": { "post": { "tags": [ "TermVariants" ], "parameters": [ { "name": "termId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "extensionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermVariant" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/public-catalog/categories": { "post": { "tags": [ "Categories" ], "summary": "Creates a new category record in the public catalog.\nAccepts a request with necessary details to create the category.", "requestBody": { "description": "The details of the category to create, including name and optional description.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateCategoryRequest" } ], "description": "Represents a request to create a new category in the public catalog.\nContains the necessary properties for specifying category details." } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateCategoryRequest" } ], "description": "Represents a request to create a new category in the public catalog.\nContains the necessary properties for specifying category details." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateCategoryRequest" } ], "description": "Represents a request to create a new category in the public catalog.\nContains the necessary properties for specifying category details." } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryEntity" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Categories" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryEntityListResponse" } } } } } } }, "/public/v1/public-catalog/categories/{id}": { "put": { "tags": [ "Categories" ], "summary": "Updates an existing category record in the public catalog.", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the category to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "An instance of the Mpt.Framework.Application.Partials.Delta`1 class representing the updates to apply to the category.\nThe updates may include changes to properties such as name and description.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryEntity" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Categories" ], "summary": "Soft deletes an category record from the public catalog.", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the category to be deleted.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Categories" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryEntity" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/public-catalog/categories/{id}/publish": { "post": { "tags": [ "Categories" ], "summary": "Publishes an category by updating its status to published.", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the category to publish.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryEntity" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/public-catalog/categories/{id}/unpublish": { "post": { "tags": [ "Categories" ], "summary": "Unpublishes a specific category identified by its ID. This operation\nsets the category record to an unpublished state in the system.", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the category to unpublish.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryEntity" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/public-catalog/industries": { "post": { "tags": [ "Industries" ], "summary": "Creates a new industry record in the public catalog.\nAccepts a request with necessary details to create the industry.", "requestBody": { "description": "The details of the industry to create, including name and optional description.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateIndustryRequest" } ], "description": "Represents a request to create a new industry in the public catalog.\nContains the necessary properties for specifying industry details." } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateIndustryRequest" } ], "description": "Represents a request to create a new industry in the public catalog.\nContains the necessary properties for specifying industry details." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateIndustryRequest" } ], "description": "Represents a request to create a new industry in the public catalog.\nContains the necessary properties for specifying industry details." } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Industry" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Industries" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndustryListResponse" } } } } } } }, "/public/v1/public-catalog/industries/{id}": { "put": { "tags": [ "Industries" ], "summary": "Updates an existing industry record in the public catalog.", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the industry to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "An instance of the Mpt.Framework.Application.Partials.Delta`1 class representing the updates to apply to the industry.\nThe updates may include changes to properties such as name and description.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateIndustry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateIndustry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateIndustry" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Industry" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Industries" ], "summary": "Soft deletes an industry record from the public catalog.", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the industry to be deleted.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Industries" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Industry" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/public-catalog/industries/{id}/publish": { "post": { "tags": [ "Industries" ], "summary": "Publishes an industry by updating its status to published.", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the industry to publish.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Industry" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/public-catalog/industries/{id}/unpublish": { "post": { "tags": [ "Industries" ], "summary": "Unpublishes a specific industry identified by its ID. This operation\nsets the industry record to an unpublished state in the system.", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the industry to unpublish.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Industry" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/public-catalog/product-profiles/{productProfileId}/attachments": { "get": { "tags": [ "ProductProfileAttachment" ], "summary": "Lists attachments for the specified product profile.", "parameters": [ { "name": "productProfileId", "in": "path", "description": "Agreement id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductProfileAttachmentListResponse" } } } } } }, "post": { "tags": [ "ProductProfileAttachment" ], "summary": "Creates a new attachment for an product profile.", "parameters": [ { "name": "productProfileId", "in": "path", "description": "Product profile id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "attachment": { "type": "object", "properties": { "Name": { "type": "string", "description": "Attachment name" }, "Description": { "type": "string", "description": "Attachment description" } }, "description": "Json representation of the attachment" }, "file": { "type": "string", "description": "Attachment File", "format": "binary" } } }, "encoding": { "attachment": { "contentType": "application/json" }, "file": { "contentType": "application/octet-stream" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductProfileAttachment" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/public-catalog/product-profiles/{productProfileId}/attachments/{id}": { "get": { "tags": [ "ProductProfileAttachment" ], "summary": "Gets an attachment by id or redirects to its download.", "parameters": [ { "name": "productProfileId", "in": "path", "description": "Agreement id", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Attachment id", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Select expression", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductProfileAttachment" } } } }, "301": { "description": "Moved Permanently" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "ProductProfileAttachment" ], "summary": "Updates an existing product profile attachment.", "parameters": [ { "name": "productProfileId", "in": "path", "description": "Product profile id", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Attachment id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Updated attachment details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductProfileAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProductProfileAttachment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ProductProfileAttachment" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductProfileAttachment" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "ProductProfileAttachment" ], "summary": "Deletes an product profile attachment.", "parameters": [ { "name": "productProfileId", "in": "path", "description": "Product profile id", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Attachment id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/public-catalog/product-profiles/{productProfileId}/media": { "get": { "tags": [ "ProductProfileMedia" ], "summary": "Represent Get media for product profile.", "parameters": [ { "name": "productProfileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductProfileMediaListResponse" } } } } } }, "post": { "tags": [ "ProductProfileMedia" ], "summary": "Represent Add/Create media for product profile.", "parameters": [ { "name": "productProfileId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "media": { "type": "object", "properties": { "Name": { "type": "string", "description": "Media name" }, "Description": { "type": "string", "description": "Media description" }, "Type": { "allOf": [ { "$ref": "#/components/schemas/MediaType" } ], "description": "Media type" }, "Url": { "type": "string", "description": "Media url" }, "DisplayOrder": { "type": "integer", "description": "Media DisplayOrder", "format": "int32" } }, "description": "Json representation of the media" }, "file": { "type": "string", "description": "Media Files", "format": "binary" } } }, "encoding": { "media": { "contentType": "application/json" }, "file": { "contentType": "application/octet-stream" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductProfileMedia" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/public-catalog/product-profiles/{productProfileId}/media/{id}": { "get": { "tags": [ "ProductProfileMedia" ], "summary": "Represents get by media id.", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "productProfileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductProfileMedia" } } } }, "301": { "description": "Moved Permanently" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "ProductProfileMedia" ], "summary": "Update media for product profile.", "parameters": [ { "name": "productProfileId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductProfileMedia" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProductProfileMedia" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ProductProfileMedia" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductProfileMedia" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "ProductProfileMedia" ], "summary": "Delete media for product profile", "parameters": [ { "name": "productProfileId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/public-catalog/product-profiles/{productProfileId}/media/{id}/image": { "get": { "tags": [ "ProductProfileMedia" ], "summary": "Download Image.", "parameters": [ { "name": "productProfileId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "307": { "description": "Temporary Redirect" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/public-catalog/product-profiles": { "post": { "tags": [ "ProductProfiles" ], "summary": "Creates a new product-profile record in the public catalog.\nAccepts a request with necessary details to create the product profiles.", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "productProfile": { "type": "object", "properties": { "Name": { "type": "string" }, "ShortDescription": { "type": "string" }, "LongDescription": { "type": "string" }, "Featured": { "type": "boolean" }, "Website": { "type": "string" }, "LinkedIn": { "type": "string" }, "YouTube": { "type": "string" }, "XProfile": { "type": "string" }, "Categories": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" } }, "Industries": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" } }, "Segments": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" } }, "VendorProfile.Id": { "type": "string" } }, "description": "Json representation of the productProfile" }, "icon": { "type": "string", "format": "binary" } } }, "encoding": { "productProfile": { "contentType": "application/json" }, "icon": { "contentType": "application/octet-stream" } } }, "application/json": { "schema": { "type": "object", "properties": { "productProfile": { "type": "object", "properties": { "Name": { "type": "string" }, "ShortDescription": { "type": "string" }, "LongDescription": { "type": "string" }, "Featured": { "type": "boolean" }, "Website": { "type": "string" }, "LinkedIn": { "type": "string" }, "YouTube": { "type": "string" }, "XProfile": { "type": "string" }, "Categories": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" } }, "Industries": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" } }, "Segments": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" } }, "VendorProfile.Id": { "type": "string" } }, "description": "Json representation of the productProfile" }, "icon": { "type": "string", "format": "binary" } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductProfile" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "ProductProfiles" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductProfileListResponse" } } } } } } }, "/public/v1/public-catalog/product-profiles/{id}": { "put": { "tags": [ "ProductProfiles" ], "summary": "Updates an existing product-profile record in the public catalog.", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the product-profile to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "productProfile": { "type": "object", "properties": { "ProductProfile.Node.Name": { "type": "string" }, "ProductProfile.Node.Children": { "type": "array", "items": { "$ref": "#/components/schemas/DeltaNode" } }, "ProductProfile.Path": { "type": "string" }, "ProductProfile.Data.Name": { "type": "string" }, "ProductProfile.Data.ShortDescription": { "type": "string" }, "ProductProfile.Data.LongDescription": { "type": "string" }, "ProductProfile.Data.Featured": { "type": "boolean" }, "ProductProfile.Data.Website": { "type": "string" }, "ProductProfile.Data.LinkedIn": { "type": "string" }, "ProductProfile.Data.YouTube": { "type": "string" }, "ProductProfile.Data.XProfile": { "type": "string" }, "ProductProfile.Data.Categories": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" } }, "ProductProfile.Data.Industries": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" } }, "ProductProfile.Data.Segments": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" } }, "ProductProfile.Data.VendorProfile.Id": { "type": "string" }, "ProductProfile.Data.Products": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" } }, "ProductProfile.IsDefined": { "type": "boolean" } }, "description": "Json representation of the productProfile" }, "icon": { "type": "string", "description": "Icon file associated with the Product Profile.", "format": "binary" } } }, "encoding": { "productProfile": { "contentType": "application/json" }, "icon": { "contentType": "application/octet-stream" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProductProfile" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductProfile" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "ProductProfiles" ], "summary": "Soft deletes an product-profile record from the public catalog.", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the product profiles to be deleted.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "ProductProfiles" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductProfile" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/public-catalog/product-profiles/{id}/publish": { "post": { "tags": [ "ProductProfiles" ], "summary": "Publishes an product-profile by updating its status to published.", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the product profiles to publish.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductProfile" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/public-catalog/product-profiles/{id}/unpublish": { "post": { "tags": [ "ProductProfiles" ], "summary": "Unpublishes a specific product-profile identified by its ID. This operation\nsets the product profiles record to an unpublished state in the system.", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the product profiles to unpublish.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductProfile" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/public-catalog/product-profiles/{id}/icon": { "get": { "tags": [ "ProductProfiles" ], "summary": "Retrieves the icon associated with a product-profile record.", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the product-profile whose icon is requested.", "required": true, "schema": { "type": "string" } } ], "responses": { "307": { "description": "Temporary Redirect" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/public-catalog/segments": { "post": { "tags": [ "Segments" ], "summary": "Creates a new segment record in the public catalog.", "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateSegmentRequest" } ], "description": "Represents a request to create a new segment in the public catalog." } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateSegmentRequest" } ], "description": "Represents a request to create a new segment in the public catalog." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateSegmentRequest" } ], "description": "Represents a request to create a new segment in the public catalog." } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Segment" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Segments" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SegmentListResponse" } } } } } } }, "/public/v1/public-catalog/segments/{id}": { "put": { "tags": [ "Segments" ], "summary": "Updates an existing segment record in the public catalog.", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSegment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateSegment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateSegment" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Segment" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Segments" ], "summary": "Deletes a segment from the public catalog.", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Segments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Segment" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/public-catalog/segments/{id}/publish": { "post": { "tags": [ "Segments" ], "summary": "Publishes a segment in the public catalog.", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Segment" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/public-catalog/segments/{id}/unpublish": { "post": { "tags": [ "Segments" ], "summary": "Unpublishes a segment in the public catalog.", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Segment" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/public-catalog/vendor-profiles": { "post": { "tags": [ "VendorProfiles" ], "summary": "Creates a new vendor-profile record in the public catalog.\nAccepts a request with necessary details to create the vendor-profiles.", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "vendorProfile": { "type": "object", "properties": { "Name": { "type": "string" }, "Description": { "type": "string" }, "Featured": { "type": "boolean" }, "Website": { "type": "string" }, "LinkedIn": { "type": "string" }, "Facebook": { "type": "string" }, "YouTube": { "type": "string" }, "XProfile": { "type": "string" }, "Categories": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" } }, "ProductProfiles": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" } } }, "description": "Json representation of the vendorProfile" }, "icon": { "type": "string", "format": "binary" } } }, "encoding": { "vendorProfile": { "contentType": "application/json" }, "icon": { "contentType": "application/octet-stream" } } }, "application/json": { "schema": { "type": "object", "properties": { "vendorProfile": { "type": "object", "properties": { "Name": { "type": "string" }, "Description": { "type": "string" }, "Featured": { "type": "boolean" }, "Website": { "type": "string" }, "LinkedIn": { "type": "string" }, "Facebook": { "type": "string" }, "YouTube": { "type": "string" }, "XProfile": { "type": "string" }, "Categories": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" } }, "ProductProfiles": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" } } }, "description": "Json representation of the vendorProfile" }, "icon": { "type": "string", "format": "binary" } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorProfile" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "VendorProfiles" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorProfileListResponse" } } } } } } }, "/public/v1/public-catalog/vendor-profiles/{id}": { "put": { "tags": [ "VendorProfiles" ], "summary": "Updates an existing vendor-profile record in the public catalog.", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the vendor-profile to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "vendorProfile": { "type": "object", "properties": { "VendorProfile.Node.Name": { "type": "string" }, "VendorProfile.Node.Children": { "type": "array", "items": { "$ref": "#/components/schemas/DeltaNode" } }, "VendorProfile.Path": { "type": "string" }, "VendorProfile.Data.Name": { "type": "string" }, "VendorProfile.Data.Description": { "type": "string" }, "VendorProfile.Data.Featured": { "type": "boolean" }, "VendorProfile.Data.Website": { "type": "string" }, "VendorProfile.Data.LinkedIn": { "type": "string" }, "VendorProfile.Data.Facebook": { "type": "string" }, "VendorProfile.Data.YouTube": { "type": "string" }, "VendorProfile.Data.XProfile": { "type": "string" }, "VendorProfile.Data.Categories": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" } }, "VendorProfile.Data.ProductProfiles": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" } }, "VendorProfile.Data.Vendor.Id": { "type": "string" }, "VendorProfile.IsDefined": { "type": "boolean" } }, "description": "Json representation of the vendorProfile" }, "icon": { "type": "string", "description": "Icon file associated with the Vendor Profile.", "format": "binary" } } }, "encoding": { "vendorProfile": { "contentType": "application/json" }, "icon": { "contentType": "application/octet-stream" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVendorProfile" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorProfile" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "VendorProfiles" ], "summary": "Soft deletes an vendor-profile record from the public catalog.", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the vendor-profiles to be deleted.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "VendorProfiles" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorProfile" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/public-catalog/vendor-profiles/{id}/publish": { "post": { "tags": [ "VendorProfiles" ], "summary": "Publishes an vendor-profile by updating its status to published.", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the vendor-profiles to publish.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorProfile" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/public-catalog/vendor-profiles/{id}/unpublish": { "post": { "tags": [ "VendorProfiles" ], "summary": "Unpublishes a specific vendor-profile identified by its ID. This operation\nsets the vendor-profiles record to an unpublished state in the system.", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the vendor-profiles to unpublish.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorProfile" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/public-catalog/vendor-profiles/{id}/icon": { "get": { "tags": [ "VendorProfiles" ], "summary": "Retrieves the icon associated with a vendor-profile record.", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the vendor-profile whose icon is requested.", "required": true, "schema": { "type": "string" } } ], "responses": { "307": { "description": "Temporary Redirect" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/exchange/currencies": { "get": { "tags": [ "Currencies" ], "summary": "Gets a list of currencies.", "description": "Supports filtering, sorting, and pagination via query string parameters.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CurrencyListResponse" } } } } } }, "post": { "tags": [ "Currencies" ], "summary": "Creates a new currency.", "description": "Accepts multipart form data with a currency payload and an icon file.", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "currency": { "type": "object", "properties": { "Currency.Node.Name": { "type": "string" }, "Currency.Node.Children": { "type": "array", "items": { "$ref": "#/components/schemas/DeltaNode" } }, "Currency.Path": { "type": "string" }, "Currency.Data.Id": { "type": "string", "description": "The unique identifier of the currency." }, "Currency.Data.Name": { "type": "string", "description": "The name of the currency." }, "Currency.Data.Code": { "type": "string", "description": "The ISO code of currency" }, "Currency.Data.Precision": { "type": "integer", "description": "Precision of the currency", "format": "int32" }, "Currency.Data.Statistics.SellerCount": { "type": "integer", "description": "Number of sellers using currency", "format": "int32" }, "Currency.Data.Statistics.PairCount": { "type": "integer", "description": "Number of pairs", "format": "int32" }, "Currency.Data.Status": { "allOf": [ { "$ref": "#/components/schemas/CurrencyStatus" } ], "description": "The current status of the currency." }, "Currency.Data.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Currency.Data.Icon": { "type": "string" }, "Currency.Data.Revision": { "type": "integer", "format": "int32" }, "Currency.Data.Audit.Deleted.At": { "type": "string", "format": "date-time" }, "Currency.Data.Audit.Deleted.ById": { "type": "string" }, "Currency.Data.Audit.Deleted.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Currency.Data.Audit.Deleted.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Currency.Data.Audit.Deleted.By.Name": { "type": "string" }, "Currency.Data.Audit.Deleted.By.Icon": { "type": "string" }, "Currency.Data.Audit.Deleted.By.Revision": { "type": "integer", "format": "int32" }, "Currency.Data.Audit.Deleted.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Currency.Data.Audit.Deleted.By.Audit.Created.ById": { "type": "string" }, "Currency.Data.Audit.Deleted.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Currency.Data.Audit.Deleted.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Currency.Data.Audit.Deleted.By.Audit.Updated.ById": { "type": "string" }, "Currency.Data.Audit.Deleted.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Currency.Data.Audit.Deleted.By.Id": { "type": "string" }, "Currency.Data.Audit.Created.At": { "type": "string", "format": "date-time" }, "Currency.Data.Audit.Created.ById": { "type": "string" }, "Currency.Data.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Currency.Data.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Currency.Data.Audit.Created.By.Name": { "type": "string" }, "Currency.Data.Audit.Created.By.Icon": { "type": "string" }, "Currency.Data.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Currency.Data.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Currency.Data.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Currency.Data.Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Currency.Data.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Currency.Data.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Currency.Data.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Currency.Data.Audit.Created.By.Id": { "type": "string" }, "Currency.Data.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Currency.Data.Audit.Updated.ById": { "type": "string" }, "Currency.Data.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Currency.Data.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Currency.Data.Audit.Updated.By.Name": { "type": "string" }, "Currency.Data.Audit.Updated.By.Icon": { "type": "string" }, "Currency.Data.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Currency.Data.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Currency.Data.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Currency.Data.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Currency.Data.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Currency.Data.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Currency.Data.Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Currency.Data.Audit.Updated.By.Id": { "type": "string" }, "Currency.IsDefined": { "type": "boolean" } }, "description": "Json representation of the currency" }, "icon": { "type": "string", "description": "Icon for the new currency", "format": "binary" } } }, "encoding": { "currency": { "contentType": "application/json" }, "icon": { "contentType": "application/octet-stream" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/CurrencyDelta" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Currency" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/exchange/currencies/{id}": { "get": { "tags": [ "Currencies" ], "summary": "Retrieves a currency by ID.", "description": "Returns the currency with the specified ID. Use the select query parameter to specify which fields to include.", "parameters": [ { "name": "id", "in": "path", "description": "The currency ID.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional select statement to filter fields.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Currency" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Currencies" ], "summary": "Updates an existing currency.", "description": "Accepts multipart form data with a currency payload and an icon file.", "parameters": [ { "name": "id", "in": "path", "description": "The currency ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "currency": { "type": "object", "properties": { "Currency.Node.Name": { "type": "string" }, "Currency.Node.Children": { "type": "array", "items": { "$ref": "#/components/schemas/DeltaNode" } }, "Currency.Path": { "type": "string" }, "Currency.Data.Id": { "type": "string", "description": "The unique identifier of the currency." }, "Currency.Data.Name": { "type": "string", "description": "The name of the currency." }, "Currency.Data.Code": { "type": "string", "description": "The ISO code of currency" }, "Currency.Data.Precision": { "type": "integer", "description": "Precision of the currency", "format": "int32" }, "Currency.Data.Statistics.SellerCount": { "type": "integer", "description": "Number of sellers using currency", "format": "int32" }, "Currency.Data.Statistics.PairCount": { "type": "integer", "description": "Number of pairs", "format": "int32" }, "Currency.Data.Status": { "allOf": [ { "$ref": "#/components/schemas/CurrencyStatus" } ], "description": "The current status of the currency." }, "Currency.Data.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Currency.Data.Icon": { "type": "string" }, "Currency.Data.Revision": { "type": "integer", "format": "int32" }, "Currency.Data.Audit.Deleted.At": { "type": "string", "format": "date-time" }, "Currency.Data.Audit.Deleted.ById": { "type": "string" }, "Currency.Data.Audit.Deleted.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Currency.Data.Audit.Deleted.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Currency.Data.Audit.Deleted.By.Name": { "type": "string" }, "Currency.Data.Audit.Deleted.By.Icon": { "type": "string" }, "Currency.Data.Audit.Deleted.By.Revision": { "type": "integer", "format": "int32" }, "Currency.Data.Audit.Deleted.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Currency.Data.Audit.Deleted.By.Audit.Created.ById": { "type": "string" }, "Currency.Data.Audit.Deleted.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Currency.Data.Audit.Deleted.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Currency.Data.Audit.Deleted.By.Audit.Updated.ById": { "type": "string" }, "Currency.Data.Audit.Deleted.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Currency.Data.Audit.Deleted.By.Id": { "type": "string" }, "Currency.Data.Audit.Created.At": { "type": "string", "format": "date-time" }, "Currency.Data.Audit.Created.ById": { "type": "string" }, "Currency.Data.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Currency.Data.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Currency.Data.Audit.Created.By.Name": { "type": "string" }, "Currency.Data.Audit.Created.By.Icon": { "type": "string" }, "Currency.Data.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Currency.Data.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Currency.Data.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Currency.Data.Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Currency.Data.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Currency.Data.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Currency.Data.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Currency.Data.Audit.Created.By.Id": { "type": "string" }, "Currency.Data.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Currency.Data.Audit.Updated.ById": { "type": "string" }, "Currency.Data.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Currency.Data.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Currency.Data.Audit.Updated.By.Name": { "type": "string" }, "Currency.Data.Audit.Updated.By.Icon": { "type": "string" }, "Currency.Data.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Currency.Data.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Currency.Data.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Currency.Data.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Currency.Data.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Currency.Data.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Currency.Data.Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Currency.Data.Audit.Updated.By.Id": { "type": "string" }, "Currency.IsDefined": { "type": "boolean" } }, "description": "Json representation of the currency" }, "icon": { "type": "string", "description": "Icon for the new currency", "format": "binary" } } }, "encoding": { "currency": { "contentType": "application/json" }, "icon": { "contentType": "application/octet-stream" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/CurrencyDelta" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Currency" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Currencies" ], "summary": "Deletes currency by ID.", "parameters": [ { "name": "id", "in": "path", "description": "The currency ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/exchange/currencies/{id}/icon": { "get": { "tags": [ "Currencies" ], "summary": "Gets a download redirect for a currency icon.", "description": "Returns a temporary redirect to the stored icon URL.", "parameters": [ { "name": "id", "in": "path", "description": "The currency ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "307": { "description": "Temporary Redirect" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/exchange/pairs": { "get": { "tags": [ "Pairs" ], "summary": "Gets a list of currency pairs.", "description": "Supports filtering, sorting, and pagination via query string parameters.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PairListResponse" } } } } } }, "post": { "tags": [ "Pairs" ], "summary": "Creates a new pair or pairs of currencies.", "requestBody": { "description": "Bulk request for pairs creation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PairBulkData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PairBulkData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PairBulkData" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Pair" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Pairs" ], "summary": "Updates pairs from bulk data.", "requestBody": { "description": "Bulk pairs update.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PairBulkData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PairBulkData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PairBulkData" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Pair" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Pairs" ], "summary": "Deletes multiple pairs from the body.", "requestBody": { "description": "The pairs to delete.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PairBulkData" } ], "description": "Bulk operation data model" } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PairBulkData" } ], "description": "Bulk operation data model" } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PairBulkData" } ], "description": "Bulk operation data model" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Pair" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/exchange/pairs/{id}": { "get": { "tags": [ "Pairs" ], "summary": "Retrieves a currency pair by ID.", "description": "Returns the pair with the specified ID. Use the select query parameter to specify which fields to include.", "parameters": [ { "name": "id", "in": "path", "description": "The pair ID.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional select statement to filter fields.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pair" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/exchange/pairs/{pairId}/rates/{rateId}": { "get": { "tags": [ "Rates" ], "summary": "Retrieves a rate by ID within a pair.", "description": "Returns the rate with the specified ID for the given pair.", "parameters": [ { "name": "pairId", "in": "path", "description": "The pair ID.", "required": true, "schema": { "type": "string" } }, { "name": "rateId", "in": "path", "description": "The rate ID.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional RQL select statement to filter fields.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rate" } } } } } } }, "/public/v1/exchange/pairs/{pairId}/rates": { "get": { "tags": [ "Rates" ], "summary": "Gets a list of rates for a pair.", "description": "Supports filtering, sorting, and pagination via query string parameters.", "parameters": [ { "name": "pairId", "in": "path", "description": "The pair ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateListResponse" } } } } } }, "put": { "tags": [ "Rates" ], "summary": "Updates rates for a pair.", "description": "Updates one or more rates for the specified pair.", "parameters": [ { "name": "pairId", "in": "path", "description": "The pair ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Updated rate data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateBulkData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RateBulkData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RateBulkData" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Rate" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/exchange/pairs/-/rates": { "post": { "tags": [ "Rates" ], "summary": "Creates a new rate.", "description": "Creates one or more rates for a pair via bulk payload.", "requestBody": { "description": "The rate to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateBulkData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RateBulkData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RateBulkData" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Rate" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/exchange/rates": { "delete": { "tags": [ "Rates" ], "summary": "Deletes rates from bulk data.", "description": "Deletes one or more rates using a bulk payload.", "requestBody": { "description": "The rates to delete.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RateBulkData" } ], "description": "Bulk operation data model" } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RateBulkData" } ], "description": "Bulk operation data model" } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RateBulkData" } ], "description": "Bulk operation data model" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Rate" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/procurement/erp-items": { "get": { "tags": [ "ErpItems" ], "summary": "Get a list of ERP items", "description": "Supports filtering, sorting, and pagination via query string parameters.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErpItemListResponse" } } } } } }, "post": { "tags": [ "ErpItems" ], "summary": "Upsert ERP items", "description": "Accepts a single item or a list in the request body.", "requestBody": { "description": "ERP items to create or update.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ErpItemDelta" }, "description": "Wrapper allowing binding either a single JSON object or a JSON array of objects uniformly as a collection." } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ErpItemDelta" }, "description": "Wrapper allowing binding either a single JSON object or a JSON array of objects uniformly as a collection." } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ErpItemDelta" }, "description": "Wrapper allowing binding either a single JSON object or a JSON array of objects uniformly as a collection." } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErpItem" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "ErpItems" ], "summary": "Delete ERP items", "description": "Accepts a single item or a list in the request body.", "requestBody": { "description": "ERP items to delete.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ErpItemDelta" }, "description": "Wrapper allowing binding either a single JSON object or a JSON array of objects uniformly as a collection." } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ErpItemDelta" }, "description": "Wrapper allowing binding either a single JSON object or a JSON array of objects uniformly as a collection." } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ErpItemDelta" }, "description": "Wrapper allowing binding either a single JSON object or a JSON array of objects uniformly as a collection." } } } }, "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/procurement/erp-items/{id}": { "get": { "tags": [ "ErpItems" ], "summary": "Retrieve an ERP item by ID", "description": "Use the select query parameter to specify which fields to include.", "parameters": [ { "name": "id", "in": "path", "description": "The ERP item ID.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional select statement to filter fields.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErpItem" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/procurement/sales-orders": { "get": { "tags": [ "SalesOrders" ], "summary": "Get a list of sales orders", "description": "Supports filtering, sorting, and pagination via query string parameters.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesOrderListResponse" } } } } } }, "post": { "tags": [ "SalesOrders" ], "summary": "Upsert sales orders", "description": "Accepts a single item or a list in the request body.", "requestBody": { "description": "Sales orders to create or update.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderDelta" }, "description": "Wrapper allowing binding either a single JSON object or a JSON array of objects uniformly as a collection." } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderDelta" }, "description": "Wrapper allowing binding either a single JSON object or a JSON array of objects uniformly as a collection." } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderDelta" }, "description": "Wrapper allowing binding either a single JSON object or a JSON array of objects uniformly as a collection." } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesOrder" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "SalesOrders" ], "summary": "Delete sales orders", "description": "Accepts a single item or a list in the request body.", "requestBody": { "description": "Sales orders to delete.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderDelta" }, "description": "Wrapper allowing binding either a single JSON object or a JSON array of objects uniformly as a collection." } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderDelta" }, "description": "Wrapper allowing binding either a single JSON object or a JSON array of objects uniformly as a collection." } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderDelta" }, "description": "Wrapper allowing binding either a single JSON object or a JSON array of objects uniformly as a collection." } } } }, "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/procurement/sales-orders/{id}": { "get": { "tags": [ "SalesOrders" ], "summary": "Retrieve a sales order by ID", "description": "Use the select query parameter to specify which fields to include.", "parameters": [ { "name": "id", "in": "path", "description": "The sales order ID.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional select statement to filter fields.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesOrder" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/procurement/sales-orders/{id}/finalize": { "post": { "tags": [ "SalesOrders" ], "summary": "Finalize a sales order", "parameters": [ { "name": "id", "in": "path", "description": "The sales order identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesOrder" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/procurement/sales-orders/{id}/retry": { "post": { "tags": [ "SalesOrders" ], "summary": "Retry a sales order will try to finalize order again if the order is in an error status.", "parameters": [ { "name": "id", "in": "path", "description": "The sales order identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesOrder" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/procurement/sales-orders/{id}/attachments": { "get": { "tags": [ "SalesOrders" ], "summary": "Get sales order attachments", "description": "Supports filtering, sorting, and pagination via query string parameters.", "parameters": [ { "name": "id", "in": "path", "description": "The sales order ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesOrderAttachmentListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/procurement/sales-orders/{id}/attachments/{attachmentId}": { "get": { "tags": [ "SalesOrders" ], "summary": "Download a sales order attachment", "description": "The attachment ID must match the sales order ID with the SOA prefix.", "parameters": [ { "name": "id", "in": "path", "description": "The sales order ID.", "required": true, "schema": { "type": "string" } }, { "name": "attachmentId", "in": "path", "description": "The attachment ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/procurement/sales-quotes": { "get": { "tags": [ "SalesQuotes" ], "summary": "Get a list of sales quotes", "description": "Supports filtering, sorting, and pagination via query string parameters.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesQuoteListResponse" } } } } } }, "post": { "tags": [ "SalesQuotes" ], "summary": "Upsert sales quotes", "description": "Accepts a single item or a list in the request body.", "requestBody": { "description": "Sales quotes to create or update.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesQuoteDelta" }, "description": "Wrapper allowing binding either a single JSON object or a JSON array of objects uniformly as a collection." } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesQuoteDelta" }, "description": "Wrapper allowing binding either a single JSON object or a JSON array of objects uniformly as a collection." } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesQuoteDelta" }, "description": "Wrapper allowing binding either a single JSON object or a JSON array of objects uniformly as a collection." } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesQuote" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "SalesQuotes" ], "summary": "Delete sales quotes", "description": "Accepts a single item or a list in the request body.", "requestBody": { "description": "Sales quotes to delete.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesQuoteDelta" }, "description": "Wrapper allowing binding either a single JSON object or a JSON array of objects uniformly as a collection." } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesQuoteDelta" }, "description": "Wrapper allowing binding either a single JSON object or a JSON array of objects uniformly as a collection." } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesQuoteDelta" }, "description": "Wrapper allowing binding either a single JSON object or a JSON array of objects uniformly as a collection." } } } }, "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/procurement/sales-quotes/{id}": { "get": { "tags": [ "SalesQuotes" ], "summary": "Retrieve a sales quote by ID", "description": "Use the select query parameter to specify which fields to include.", "parameters": [ { "name": "id", "in": "path", "description": "The sales quote ID.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional select statement to filter fields.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesQuote" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/procurement/sales-quotes/{id}/finalize": { "post": { "tags": [ "SalesQuotes" ], "summary": "Finalize a sales quote", "parameters": [ { "name": "id", "in": "path", "description": "The sales quote identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesQuote" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/procurement/sales-quotes/{id}/reject": { "post": { "tags": [ "SalesQuotes" ], "summary": "Reject a sales quote", "parameters": [ { "name": "id", "in": "path", "description": "The sales quote identifier.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The sales quote.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesQuote" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SalesQuote" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SalesQuote" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesQuote" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/procurement/sales-quotes/{id}/retry": { "post": { "tags": [ "SalesQuotes" ], "summary": "Retry a sales quote will try to finalize or accept the quote again if the quote is in an error status.", "parameters": [ { "name": "id", "in": "path", "description": "The sales quote identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesQuote" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/procurement/sales-quotes/{id}/accept": { "post": { "tags": [ "SalesQuotes" ], "summary": "Accept a sales quote", "parameters": [ { "name": "id", "in": "path", "description": "The sales quote identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesQuote" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/procurement/sales-quotes/{id}/attachments": { "get": { "tags": [ "SalesQuotes" ], "summary": "Get sales quote attachments", "description": "Supports filtering, sorting, and pagination via query string parameters.", "parameters": [ { "name": "id", "in": "path", "description": "The sales quote ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesQuoteAttachmentListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/procurement/sales-quotes/{id}/attachments/{attachmentId}": { "get": { "tags": [ "SalesQuotes" ], "summary": "Download a sales quote attachment", "description": "The attachment ID must match the sales quote ID with the SQA prefix.", "parameters": [ { "name": "id", "in": "path", "description": "The sales quote ID.", "required": true, "schema": { "type": "string" } }, { "name": "attachmentId", "in": "path", "description": "The attachment ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/notifications/batches": { "post": { "tags": [ "Batches" ], "summary": "Creates a new message batch with attachments.", "description": "Creates and queues a batch of raw messages with file attachments.\nUse multipart/form-data content type to include files.", "operationId": "Multipart", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "Category.Id": { "type": "string" }, "Subject": { "type": "string", "deprecated": true }, "Body": { "type": "string", "deprecated": true }, "Contacts": { "type": "array", "items": { "$ref": "#/components/schemas/ContactReferenceDto" }, "deprecated": true }, "Account.Id": { "type": "string" }, "Buyer.Id": { "type": "string" }, "Buyer.ExternalIds.ErpCustomerId": { "type": "string" }, "Content.Templated.Template.Id": { "type": "string" }, "Content.Templated.Template.ExternalId": { "type": "string" }, "Content.Templated.Template.LanguageCode": { "type": "string" }, "Content.Templated.Data": { "type": "object", "additionalProperties": {} }, "Content.Templated.Test": { "type": "boolean" }, "Content.Raw.Category.Id": { "type": "string" }, "Content.Raw.Subject": { "type": "string" }, "Content.Raw.Body": { "type": "string" }, "Recipients.Account.Id": { "type": "string" }, "Recipients.Buyer.Id": { "type": "string" }, "Recipients.Buyer.ExternalIds.ErpCustomerId": { "type": "string" }, "Recipients.User.Id": { "type": "string" }, "Recipients.Contacts": { "type": "array", "items": { "$ref": "#/components/schemas/ContactReferenceDto" } }, "formCollection": { "type": "array", "items": { "$ref": "#/components/schemas/StringStringValuesKeyValuePair" }, "description": "The whole form collection" } } }, "encoding": { "Category.Id": { "style": "form" }, "Subject": { "style": "form" }, "Body": { "style": "form" }, "Contacts": { "style": "form" }, "Account.Id": { "style": "form" }, "Buyer.Id": { "style": "form" }, "Buyer.ExternalIds.ErpCustomerId": { "style": "form" }, "Content.Templated.Template.Id": { "style": "form" }, "Content.Templated.Template.ExternalId": { "style": "form" }, "Content.Templated.Template.LanguageCode": { "style": "form" }, "Content.Templated.Data": { "style": "form" }, "Content.Templated.Test": { "style": "form" }, "Content.Raw.Category.Id": { "style": "form" }, "Content.Raw.Subject": { "style": "form" }, "Content.Raw.Body": { "style": "form" }, "Recipients.Account.Id": { "style": "form" }, "Recipients.Buyer.Id": { "style": "form" }, "Recipients.Buyer.ExternalIds.ErpCustomerId": { "style": "form" }, "Recipients.User.Id": { "style": "form" }, "Recipients.Contacts": { "style": "form" }, "formCollection": { "style": "form" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/BatchRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Batch" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Batches" ], "summary": "Gets a list of resources.", "description": "Supports RQL filtering, sorting, and pagination via query string parameters.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/notifications/batches/{batchId}/attachments/{attachmentId}": { "get": { "tags": [ "Batches" ], "summary": "Gets a batch attachment.", "description": "Returns the attachment metadata. Use Accept header to control response format.", "parameters": [ { "name": "batchId", "in": "path", "description": "The batch ID.", "required": true, "schema": { "type": "string" } }, { "name": "attachmentId", "in": "path", "description": "The attachment ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/andrew-inset": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/appinstaller": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/applixware": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/appx": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/appxbundle": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/atom+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/atomcat+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/atomdeleted+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/atomsvc+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/atsc-dwd+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/atsc-held+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/atsc-rsat+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/automationml-aml+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/automationml-amlx+zip": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/bdoc": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/calendar+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/ccxml+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/cdfx+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/cdmi-capability": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/cdmi-container": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/cdmi-domain": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/cdmi-object": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/cdmi-queue": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/cu-seeme": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/cwl": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/dash-patch+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/dash+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/davmount+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/docbook+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/dssc+der": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/dssc+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/ecmascript": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/emma+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/emotionml+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/epub+zip": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/exi": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/express": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/fdf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/fdt+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/font-tdpfr": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/gml+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/gpx+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/gxf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/gzip": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/hjson": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/hyperstudio": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/inkml+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/ipfix": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/java-archive": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/java-serialized-object": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/java-vm": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/json5": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/lgr+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/lost+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/mac-binhex40": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/mac-compactpro": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/mads+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/marc": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/marcxml+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/mathematica": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/mathml+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/mbox": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/media-policy-dataset+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/mediaservercontrol+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/metalink+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/metalink4+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/mets+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/mmt-aei+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/mmt-usd+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/mods+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/mp21": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/mp4": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/msix": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/msixbundle": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/msword": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/mxf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/n-quads": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/n-triples": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/node": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/oda": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/oebps-package+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/ogg": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/omdoc+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/onenote": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/oxps": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/p2p-overlay+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/patch-ops-error+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/pdf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/pgp-encrypted": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/pgp-keys": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/pgp-signature": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/pkcs10": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/pkcs7-mime": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/pkcs7-signature": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/pkcs8": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/pkix-attr-cert": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/pkix-crl": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/pkix-pkipath": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/pkixcmp": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/pls+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/postscript": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/provenance+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/prs.cww": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/prs.xsf+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/pskc+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/raml+yaml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/rdf+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/reginfo+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/relax-ng-compact-syntax": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/resource-lists-diff+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/resource-lists+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/rls-services+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/route-apd+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/route-s-tsid+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/route-usd+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/rpki-ghostbusters": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/rpki-manifest": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/rpki-roa": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/rsd+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/rss+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/rtf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/sbml+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/scvp-cv-request": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/scvp-cv-response": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/scvp-vp-request": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/scvp-vp-response": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/sdp": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/senml+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/sensml+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/set-payment-initiation": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/set-registration-initiation": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/shf+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/sieve": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/smil+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/sparql-query": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/sparql-results+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/sql": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/srgs": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/srgs+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/sru+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/ssdl+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/ssml+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/swid+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/tei+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/thraud+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/timestamped-data": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/toml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/trig": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/ttml+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/ubjson": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/urc-ressheet+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/urc-targetdesc+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.1000minds.decision-model+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.3gpp.pic-bw-large": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.3gpp.pic-bw-small": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.3gpp.pic-bw-var": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.3gpp2.tcap": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.3m.post-it-notes": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.accpac.simply.aso": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.accpac.simply.imp": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.acucobol": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.acucorp": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.adobe.air-application-installer-package+zip": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.adobe.formscentral.fcdt": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.adobe.xdp+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.adobe.xfdf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.age": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ahead.space": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.airzip.filesecure.azf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.airzip.filesecure.azs": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.amazon.ebook": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.americandynamics.acc": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.amiga.ami": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.android.package-archive": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.anser-web-certificate-issue-initiation": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.anser-web-funds-transfer-initiation": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.antix.game-component": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.apple.installer+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.apple.keynote": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.apple.mpegurl": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.apple.numbers": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.apple.pages": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.apple.pkpass": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.aristanetworks.swi": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.astraea-software.iota": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.audiograph": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.balsamiq.bmml+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.blueice.multipass": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.bmi": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.businessobjects": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.chemdraw+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.chipnuts.karaoke-mmd": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.cinderella": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.citationstyles.style+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.claymore": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.cloanto.rp9": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.clonk.c4group": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.cluetrust.cartomobile-config-pkg": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.cluetrust.cartomobile-config": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.commonspace": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.contact.cmsg": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.cosmocaller": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.crick.clicker.keyboard": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.crick.clicker.palette": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.crick.clicker.template": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.crick.clicker.wordbank": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.crick.clicker": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.criticaltools.wbs+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ctc-posml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.cups-ppd": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.curl.car": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.curl.pcurl": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.dart": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.data-vision.rdz": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.dbf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.dece.data": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.dece.ttml+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.dece.unspecified": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.dece.zip": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.denovo.fcselayout-link": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.dna": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.dolby.mlp": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.dpgraph": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.dreamfactory": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ds-keypoint": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.dvb.ait": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.dvb.service": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.dynageo": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.enliven": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.epson.esf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.epson.msf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.epson.quickanime": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.epson.salt": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.epson.ssf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.eszigno3+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ezpix-album": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ezpix-package": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.fdsn.mseed": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.fdsn.seed": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.flographit": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.fluxtime.clip": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.framemaker": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.frogans.fnc": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.frogans.ltf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.fsc.weblaunch": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.fujitsu.oasys": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.fujitsu.oasys2": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.fujitsu.oasys3": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.fujitsu.oasysgp": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.fujitsu.oasysprs": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.fujixerox.ddd": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.fujixerox.docuworks.binder": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.fujixerox.docuworks": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.fuzzysheet": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.genomatix.tuxedo": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.geogebra.file": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.geogebra.slides": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.geogebra.tool": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.geometry-explorer": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.geonext": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.geoplan": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.geospace": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.gmx": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.google-apps.document": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.google-apps.presentation": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.google-apps.spreadsheet": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.google-earth.kml+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.google-earth.kmz": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.gov.sk.xmldatacontainer+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.grafeq": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.groove-account": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.groove-help": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.groove-identity-message": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.groove-injector": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.groove-tool-message": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.groove-tool-template": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.groove-vcard": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.hal+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.handheld-entertainment+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.hbci": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.hhe.lesson-player": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.hp-hpgl": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.hp-hpid": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.hp-hps": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.hp-jlyt": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.hp-pcl": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.hp-pclxl": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.hydrostatix.sof-data": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ibm.minipay": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ibm.modcap": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ibm.rights-management": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ibm.secure-container": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.iccprofile": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.igloader": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.immervision-ivp": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.immervision-ivu": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.insors.igm": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.intercon.formnet": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.intergeo": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.intu.qbo": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.intu.qfx": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ipunplugged.rcprofile": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.irepository.package+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.is-xpr": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.isac.fcs": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.jam": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.jcp.javame.midlet-rms": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.jisp": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.joost.joda-archive": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.kahootz": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.kde.karbon": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.kde.kchart": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.kde.kformula": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.kde.kivio": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.kde.kontour": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.kde.kpresenter": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.kde.kspread": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.kde.kword": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.kenameaapp": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.kidspiration": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.kinar": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.koan": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.kodak-descriptor": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.las.las+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.llamagraphics.life-balance.desktop": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.llamagraphics.life-balance.exchange+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.lotus-1-2-3": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.lotus-approach": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.lotus-freelance": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.lotus-notes": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.lotus-organizer": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.lotus-screencam": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.lotus-wordpro": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.macports.portpkg": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.mapbox-vector-tile": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.mcd": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.medcalcdata": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.mediastation.cdkey": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.mfer": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.mfmp": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.micrografx.flo": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.micrografx.igx": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.mif": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.mobius.daf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.mobius.dis": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.mobius.mbk": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.mobius.mqy": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.mobius.msl": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.mobius.plc": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.mobius.txf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.mophun.application": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.mophun.certificate": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.mozilla.xul+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ms-artgalry": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ms-cab-compressed": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ms-excel.addin.macroenabled.12": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ms-excel.sheet.binary.macroenabled.12": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ms-excel.sheet.macroenabled.12": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ms-excel.template.macroenabled.12": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ms-excel": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ms-fontobject": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ms-ims": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ms-lrm": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ms-officetheme": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ms-outlook": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ms-pki.seccat": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ms-pki.stl": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ms-powerpoint.addin.macroenabled.12": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ms-powerpoint.presentation.macroenabled.12": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ms-powerpoint.slide.macroenabled.12": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ms-powerpoint.slideshow.macroenabled.12": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ms-powerpoint.template.macroenabled.12": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ms-powerpoint": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ms-project": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ms-word.document.macroenabled.12": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ms-word.template.macroenabled.12": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ms-works": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ms-wpl": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ms-xpsdocument": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.mseq": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.musician": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.muvee.style": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.mynfc": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.nato.bindingdataobject+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.neurolanguage.nlu": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.nitf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.noblenet-directory": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.noblenet-sealer": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.noblenet-web": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.nokia.n-gage.data": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.nokia.n-gage.symbian.install": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.nokia.radio-preset": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.nokia.radio-presets": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.novadigm.edm": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.novadigm.edx": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.novadigm.ext": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.oasis.opendocument.chart-template": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.oasis.opendocument.chart": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.oasis.opendocument.database": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.oasis.opendocument.formula-template": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.oasis.opendocument.formula": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.oasis.opendocument.graphics-template": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.oasis.opendocument.graphics": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.oasis.opendocument.image-template": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.oasis.opendocument.image": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.oasis.opendocument.presentation-template": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.oasis.opendocument.presentation": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.oasis.opendocument.spreadsheet-template": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.oasis.opendocument.spreadsheet": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.oasis.opendocument.text-master": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.oasis.opendocument.text-template": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.oasis.opendocument.text-web": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.oasis.opendocument.text": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.olpc-sugar": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.oma.dd2+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.openblox.game+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.openofficeorg.extension": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.openstreetmap.data+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.openxmlformats-officedocument.presentationml.presentation": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.openxmlformats-officedocument.presentationml.slide": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.openxmlformats-officedocument.presentationml.slideshow": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.openxmlformats-officedocument.presentationml.template": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.template": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.openxmlformats-officedocument.wordprocessingml.document": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.openxmlformats-officedocument.wordprocessingml.template": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.osgeo.mapguide.package": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.osgi.dp": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.osgi.subsystem": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.palm": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.pawaafile": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.pg.format": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.pg.osasli": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.picsel": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.pmi.widget": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.pocketlearn": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.powerbuilder6": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.previewsystems.box": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.proteus.magazine": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.publishare-delta-tree": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.pvi.ptid1": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.pwg-xhtml-print+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.quark.quarkxpress": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.rar": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.realvnc.bed": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.recordare.musicxml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.recordare.musicxml+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.rig.cryptonote": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.rim.cod": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.rn-realmedia-vbr": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.rn-realmedia": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.route66.link66+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.sailingtracker.track": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.seemail": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.sema": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.semd": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.semf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.shana.informed.formdata": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.shana.informed.formtemplate": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.shana.informed.interchange": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.shana.informed.package": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.simtech-mindmapper": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.smaf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.smart.teacher": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.software602.filler.form+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.solent.sdkm+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.spotfire.dxp": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.spotfire.sfs": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.stardivision.calc": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.stardivision.draw": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.stardivision.impress": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.stardivision.math": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.stardivision.writer-global": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.stardivision.writer": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.stepmania.package": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.stepmania.stepchart": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.sun.wadl+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.sun.xml.calc.template": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.sun.xml.calc": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.sun.xml.draw.template": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.sun.xml.draw": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.sun.xml.impress.template": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.sun.xml.impress": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.sun.xml.math": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.sun.xml.writer.global": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.sun.xml.writer.template": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.sun.xml.writer": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.sus-calendar": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.svd": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.symbian.install": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.syncml.dm+wbxml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.syncml.dm+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.syncml.dmddf+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.syncml+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.tao.intent-module-archive": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.tcpdump.pcap": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.tmobile-livetv": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.trid.tpt": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.triscape.mxs": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.trueapp": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.ufdl": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.uiq.theme": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.umajin": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.unity": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.uoml+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.vcx": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.visionary": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.vsf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.wap.wbxml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.wap.wmlc": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.wap.wmlscriptc": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.webturbo": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.wolfram.player": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.wordperfect": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.wqd": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.wt.stf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.xara": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.xfdl": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.yamaha.hv-dic": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.yamaha.hv-script": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.yamaha.hv-voice": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.yamaha.openscoreformat.osfpvg+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.yamaha.openscoreformat": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.yamaha.smaf-audio": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.yamaha.smaf-phrase": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.yellowriver-custom-menu": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.zul": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/vnd.zzazz.deck+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/voicexml+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/wasm": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/watcherinfo+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/widget": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/wsdl+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/wspolicy+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-7z-compressed": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-abiword": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-ace-compressed": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-arj": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-authorware-bin": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-authorware-map": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-authorware-seg": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-bcpio": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-bittorrent": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-blorb": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-bzip": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-bzip2": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-cbr": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-cdlink": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-cfs-compressed": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-chat": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-chess-pgn": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-chrome-extension": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-cocoa": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-conference": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-cpio": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-debian-package": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-dgc-compressed": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-director": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-doom": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-dtbncx+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-dtbook+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-dtbresource+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-dvi": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-envoy": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-eva": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-font-bdf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-font-ghostscript": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-font-linux-psf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-font-pcf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-font-snf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-font-type1": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-freearc": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-futuresplash": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-gca-compressed": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-glulx": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-gnumeric": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-gramps-xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-gtar": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-hdf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-httpd-php": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-install-instructions": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-java-archive-diff": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-java-jnlp-file": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-keepass2": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-latex": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-lua-bytecode": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-lzh-compressed": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-makeself": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-mie": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-mobipocket-ebook": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-ms-application": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-ms-wmd": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-ms-wmz": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-ms-xbap": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-msbinder": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-mscardfile": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-msclip": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-msmediaview": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-msmetafile": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-msmoney": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-mspublisher": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-msschedule": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-msterminal": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-mswrite": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-netcdf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-ns-proxy-autoconfig": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-nzb": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-perl": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-pkcs12": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-pkcs7-certificates": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-pkcs7-certreqresp": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-redhat-package-manager": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-research-info-systems": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-sea": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-sh": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-shar": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-shockwave-flash": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-silverlight-app": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-stuffit": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-stuffitx": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-subrip": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-sv4cpio": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-sv4crc": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-t3vm-image": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-tads": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-tar": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-tcl": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-tex-tfm": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-tex": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-texinfo": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-tgif": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-ustar": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-virtualbox-hdd": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-virtualbox-ova": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-virtualbox-ovf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-virtualbox-vbox-extpack": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-virtualbox-vbox": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-virtualbox-vdi": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-virtualbox-vhd": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-virtualbox-vmdk": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-wais-source": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-xfig": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-xliff+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-xpinstall": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-xz": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-zmachine": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/xaml+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/xcap-att+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/xcap-caps+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/xcap-diff+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/xcap-el+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/xcap-ns+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/xenc+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/xhtml+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/xml-dtd": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/xop+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/xproc+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/xslt+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/xspf+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/xv+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/yang": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/yin+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/zip": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/3gpp": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/aac": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/amr": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/basic": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/midi": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/mobile-xmf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/mp3": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/mp4": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/mpeg": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/ogg": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/s3m": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/silk": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/vnd.dece.audio": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/vnd.digital-winds": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/vnd.dra": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/vnd.dts.hd": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/vnd.dts": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/vnd.lucent.voice": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/vnd.ms-playready.media.pya": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/vnd.nuera.ecelp4800": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/vnd.nuera.ecelp7470": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/vnd.nuera.ecelp9600": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/vnd.rip": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/wav": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/webm": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/x-aiff": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/x-caf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/x-flac": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/x-matroska": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/x-mpegurl": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/x-ms-wax": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/x-ms-wma": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/x-pn-realaudio-plugin": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/x-pn-realaudio": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "audio/xm": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "chemical/x-cdx": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "chemical/x-cif": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "chemical/x-cmdf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "chemical/x-cml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "chemical/x-csml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "chemical/x-xyz": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "font/collection": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "font/otf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "font/ttf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "font/woff": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "font/woff2": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/aces": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/apng": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/avci": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/avcs": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/avif": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/bmp": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/cgm": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/dicom-rle": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/dpx": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/fits": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/g3fax": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/gif": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/heic-sequence": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/heic": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/heif-sequence": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/heif": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/hej2k": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/hsj2": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/ief": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/jls": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/jp2": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/jpeg": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/jph": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/jphc": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/jpm": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/jpx": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/jxl": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/jxr": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/jxra": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/jxrs": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/jxs": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/jxsc": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/jxsi": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/jxss": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/ktx": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/ktx2": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/png": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/prs.btif": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/prs.pti": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/sgi": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/svg+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/t38": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/tiff-fx": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/tiff": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/vnd.adobe.photoshop": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/vnd.airzip.accelerator.azv": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/vnd.dece.graphic": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/vnd.djvu": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/vnd.dvb.subtitle": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/vnd.dwg": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/vnd.dxf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/vnd.fastbidsheet": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/vnd.fpx": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/vnd.fst": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/vnd.fujixerox.edmics-mmr": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/vnd.fujixerox.edmics-rlc": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/vnd.microsoft.icon": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/vnd.ms-dds": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/vnd.ms-modi": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/vnd.ms-photo": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/vnd.net-fpx": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/vnd.pco.b16": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/vnd.tencent.tap": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/vnd.valve.source.texture": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/vnd.wap.wbmp": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/vnd.xiff": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/vnd.zbrush.pcx": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/webp": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/x-3ds": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/x-cmu-raster": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/x-cmx": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/x-freehand": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/x-jng": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/x-mrsid-image": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/x-pict": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/x-portable-anymap": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/x-portable-bitmap": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/x-portable-graymap": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/x-portable-pixmap": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/x-rgb": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/x-tga": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/x-xbitmap": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/x-xpixmap": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "image/x-xwindowdump": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "message/disposition-notification": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "message/global-delivery-status": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "message/global-disposition-notification": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "message/global-headers": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "message/global": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "message/rfc822": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "model/3mf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "model/gltf-binary": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "model/iges": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "model/jt": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "model/mtl": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "model/step-xml+zip": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "model/step+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "model/step+zip": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "model/u3d": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "model/vnd.bary": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "model/vnd.cld": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "model/vnd.collada+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "model/vnd.dwf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "model/vnd.gdl": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "model/vnd.gtw": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "model/vnd.mts": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "model/vnd.opengex": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "model/vnd.parasolid.transmit.binary": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "model/vnd.parasolid.transmit.text": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "model/vnd.pytha.pyox": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "model/vnd.sap.vds": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "model/vnd.usda": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "model/vnd.usdz+zip": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "model/vnd.valve.source.compiled-map": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "model/vnd.vtu": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "model/vrml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "model/x3d+binary": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "model/x3d+vrml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "model/x3d+xml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/cache-manifest": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/calendar": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/coffeescript": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/css": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/jade": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/jsx": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/less": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/markdown": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/mathml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/mdx": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/n3": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/prs.lines.tag": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/richtext": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/sgml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/shex": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/slim": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/spdx": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/stylus": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/tab-separated-values": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/troff": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/turtle": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/uri-list": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/vcard": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/vnd.curl.dcurl": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/vnd.curl.mcurl": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/vnd.curl.scurl": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/vnd.curl": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/vnd.familysearch.gedcom": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/vnd.fly": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/vnd.fmi.flexstor": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/vnd.graphviz": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/vnd.in3d.3dml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/vnd.in3d.spot": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/vnd.sun.j2me.app-descriptor": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/vnd.wap.wml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/vnd.wap.wmlscript": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/vtt": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/wgsl": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/x-asm": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/x-c": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/x-component": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/x-fortran": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/x-handlebars-template": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/x-java-source": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/x-lua": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/x-markdown": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/x-nfo": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/x-opml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/x-pascal": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/x-processing": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/x-sass": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/x-scss": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/x-setext": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/x-sfv": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/x-suse-ymp": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/x-uuencode": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/x-vcalendar": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/x-vcard": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/yaml": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/3gpp": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/3gpp2": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/h261": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/h263": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/h264": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/iso.segment": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/jpeg": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/mj2": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/mp2t": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/mp4": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/mpeg": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/ogg": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/quicktime": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/vnd.dece.hd": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/vnd.dece.mobile": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/vnd.dece.pd": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/vnd.dece.sd": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/vnd.dece.video": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/vnd.dvb.file": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/vnd.fvt": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/vnd.mpegurl": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/vnd.ms-playready.media.pyv": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/vnd.uvvu.mp4": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/vnd.vivo": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/webm": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/x-f4v": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/x-fli": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/x-flv": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/x-m4v": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/x-matroska": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/x-mng": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/x-ms-asf": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/x-ms-vob": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/x-ms-wm": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/x-ms-wmv": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/x-ms-wmx": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/x-ms-wvx": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/x-msvideo": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/x-sgi-movie": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "video/x-smv": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "x-conference/x-cooltalk": { "schema": { "$ref": "#/components/schemas/Attachment" } } } }, "301": { "description": "Moved Permanently" } } } }, "/public/v1/notifications/batches/{id}": { "get": { "tags": [ "Batches" ], "summary": "Gets a resource by ID.", "description": "Returns the resource with the specified ID. Use the select query parameter to specify which fields to include.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional RQL select statement to filter fields.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Batch" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/notifications/categories": { "get": { "tags": [ "Categories" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryListResponse" } } } } } }, "post": { "tags": [ "Categories" ], "summary": "Creates a new category.", "description": "Creates a new notification category. The category is created in unpublished state.\nPublish the category to make it available for subscriptions.", "requestBody": { "description": "The category creation request.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateCategoryDto" } ], "description": "CreateCategoryDto" } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateCategoryDto" } ], "description": "CreateCategoryDto" } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateCategoryDto" } ], "description": "CreateCategoryDto" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Category" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/notifications/categories/{id}": { "put": { "tags": [ "Categories" ], "summary": "Updates a category.", "description": "Updates category properties. Only provided fields will be modified.", "parameters": [ { "name": "id", "in": "path", "description": "The category ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The update request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateCategory" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Category" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Categories" ], "summary": "Deletes a category.", "description": "Permanently removes the category. This operation is only allowed if DeleteAllowed is true.", "parameters": [ { "name": "id", "in": "path", "description": "The category ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Categories" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Category" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/notifications/categories/{id}/unpublish": { "post": { "tags": [ "Categories" ], "summary": "Unpublishes a category.", "description": "Unpublishes the category, making it unavailable for new subscriptions.\nExisting subscriptions are not affected.", "parameters": [ { "name": "id", "in": "path", "description": "The category ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Optional note for the unpublish action.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NoteDto" } ], "description": "Entity Note Dto" } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NoteDto" } ], "description": "Entity Note Dto" } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NoteDto" } ], "description": "Entity Note Dto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Category" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/notifications/categories/{id}/publish": { "post": { "tags": [ "Categories" ], "summary": "Publishes a category.", "description": "Publishes the category, making it available for subscriptions. Contacts can then subscribe to it.", "parameters": [ { "name": "id", "in": "path", "description": "The category ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Optional note for the publish action.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NoteDto" } ], "description": "Entity Note Dto" } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NoteDto" } ], "description": "Entity Note Dto" } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NoteDto" } ], "description": "Entity Note Dto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Category" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/notifications/contacts/{id}/block": { "post": { "tags": [ "Contacts" ], "summary": "Blocks a contact.", "description": "Blocks the contact, preventing them from receiving any notifications until unblocked.", "parameters": [ { "name": "id", "in": "path", "description": "The Contact ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contact" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/notifications/contacts": { "post": { "tags": [ "Contacts" ], "summary": "Creates a new contact.", "description": "Creates a new contact with the provided email address. Contacts can then be subscribed to categories.", "requestBody": { "description": "The request properties.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContactDto" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContactDto" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContactDto" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contact" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Contacts" ], "summary": "Gets a list of resources.", "description": "Supports RQL filtering, sorting, and pagination via query string parameters.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/notifications/contacts/{id}/unblock": { "post": { "tags": [ "Contacts" ], "summary": "Unblocks a contact.", "description": "Unblocks the contact, allowing them to receive notifications again.", "parameters": [ { "name": "id", "in": "path", "description": "The Contact ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contact" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/notifications/contacts/{id}": { "put": { "tags": [ "Contacts" ], "summary": "Updates an existing contact.", "description": "Updates contact properties. Only provided fields will be modified.", "parameters": [ { "name": "id", "in": "path", "description": "The Contact ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The request properties.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContactDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ContactDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contact" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Contacts" ], "summary": "Deletes a contact.", "description": "Permanently removes the contact and all associated subscriptions. This operation cannot be undone.", "parameters": [ { "name": "id", "in": "path", "description": "The Contact ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Contacts" ], "summary": "Gets a resource by ID.", "description": "Returns the resource with the specified ID. Use the select query parameter to specify which fields to include.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional RQL select statement to filter fields.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contact" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/notifications/accounts/{accountId}/categories/{categoryId}/contacts": { "get": { "tags": [ "Contacts" ], "summary": "Gets contacts for a category and account.", "description": "Returns contacts configured to receive notifications when all conditions are met:\nthe category is published, the subscriber is enabled, and the user is set as a recipient.\nUse filter(group.buyers.id,BUY-XXXX) to filter by buyer visibility.", "parameters": [ { "name": "accountId", "in": "path", "description": "The Account ID.", "required": true, "schema": { "type": "string" } }, { "name": "categoryId", "in": "path", "description": "The Category ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/notifications/directories": { "get": { "tags": [ "Directories" ], "summary": "Gets a list of resources.", "description": "Supports RQL filtering, sorting, and pagination via query string parameters.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectoryListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/notifications/directories/{id}": { "get": { "tags": [ "Directories" ], "summary": "Gets a resource by ID.", "description": "Returns the resource with the specified ID. Use the select query parameter to specify which fields to include.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional RQL select statement to filter fields.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Directory" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/notifications/footers": { "post": { "tags": [ "Footers" ], "summary": "Creates a new footer.", "description": "Creates a new footer for the specified language code with the provided content.", "requestBody": { "description": "The footer creation request.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FooterDto" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FooterDto" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FooterDto" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Footer" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Footers" ], "summary": "Gets a list of resources.", "description": "Supports RQL filtering, sorting, and pagination via query string parameters.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FooterListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/notifications/footers/{id}": { "put": { "tags": [ "Footers" ], "summary": "Updates a footer.", "description": "Updates footer content or sets it as default. Only provided fields will be modified. The language code cannot be changed.", "parameters": [ { "name": "id", "in": "path", "description": "The footer ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The update request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFooterDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateFooterDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateFooterDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Footer" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Footers" ], "summary": "Deletes a footer.", "description": "Permanently removes the footer. This operation cannot be undone.", "parameters": [ { "name": "id", "in": "path", "description": "The footer ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Footers" ], "summary": "Gets a resource by ID.", "description": "Returns the resource with the specified ID. Use the select query parameter to specify which fields to include.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional RQL select statement to filter fields.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Footer" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/notifications/messages": { "get": { "tags": [ "Messages" ], "summary": "Gets a list of resources.", "description": "Supports RQL filtering, sorting, and pagination via query string parameters.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/notifications/messages/{id}": { "get": { "tags": [ "Messages" ], "summary": "Gets a resource by ID.", "description": "Returns the resource with the specified ID. Use the select query parameter to specify which fields to include.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional RQL select statement to filter fields.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/notifications/templates/{id}/activate": { "post": { "tags": [ "NotificationTemplates" ], "summary": "Activates a notification template.", "description": "Activates the template, making it available for sending notifications. Only active templates can be used.", "parameters": [ { "name": "id", "in": "path", "description": "A notification template ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplate" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/notifications/templates": { "post": { "tags": [ "NotificationTemplates" ], "summary": "Creates a notification template.", "description": "Creates a new notification template in draft state. Add language variants and activate before use.", "requestBody": { "description": "A request DTO model.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NotificationTemplateDto" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NotificationTemplateDto" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NotificationTemplateDto" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplate" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "NotificationTemplates" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplateListResponse" } } } } } } }, "/public/v1/notifications/templates/{id}": { "delete": { "tags": [ "NotificationTemplates" ], "summary": "Deletes a notification template.", "description": "Permanently removes the template and all its language variants. This operation cannot be undone.", "parameters": [ { "name": "id", "in": "path", "description": "A notification template ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "NotificationTemplates" ], "summary": "Updates a notification template.", "description": "Updates template properties. Only provided fields will be modified.", "parameters": [ { "name": "id", "in": "path", "description": "A notification template ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "A request DTO model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplateDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NotificationTemplateDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplate" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "NotificationTemplates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplate" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/notifications/templates/{id}/disable": { "post": { "tags": [ "NotificationTemplates" ], "summary": "Disables a notification template.", "description": "Disables the template, making it unavailable for sending notifications.", "parameters": [ { "name": "id", "in": "path", "description": "A notification template ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplate" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/accounts/{accountId}/settings/notifications": { "get": { "tags": [ "Settings" ], "summary": "Gets account notification settings.", "description": "Retrieves the notification settings for the specified account.", "parameters": [ { "name": "accountId", "in": "path", "description": "The account ID.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional RQL select statement to filter fields.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountSettings" } } } } } }, "put": { "tags": [ "Settings" ], "summary": "Updates account notification settings.", "description": "Updates account notification settings. Only provided fields will be modified.", "parameters": [ { "name": "accountId", "in": "path", "description": "An account ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "A request DTO model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountSettingsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountSettingsDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AccountSettingsDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountSettings" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/notifications/subscribers/{id}": { "put": { "tags": [ "Subscribers" ], "summary": "Updates subscriber recipients.", "description": "Modifies the recipients (users and user groups) for the subscriber. Only provided fields will be modified.", "parameters": [ { "name": "id", "in": "path", "description": "The Subscriber ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The request properties.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSubscriber" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateSubscriber" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateSubscriber" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscriber" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Subscribers" ], "summary": "Gets a resource by ID.", "description": "Returns the resource with the specified ID. Use the select query parameter to specify which fields to include.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional RQL select statement to filter fields.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscriber" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/notifications/subscribers/{id}/enable": { "post": { "tags": [ "Subscribers" ], "summary": "Enables a subscriber.", "description": "Enables the subscriber, allowing notifications to be sent to configured recipients.", "parameters": [ { "name": "id", "in": "path", "description": "The Subscriber ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Subscriber properties to update (note).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateNoteSubscriber" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateNoteSubscriber" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateNoteSubscriber" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscriber" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/notifications/subscribers/{id}/disable": { "post": { "tags": [ "Subscribers" ], "summary": "Disables a subscriber.", "description": "Disables the subscriber, preventing notifications from being sent to recipients.", "parameters": [ { "name": "id", "in": "path", "description": "The Subscriber ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Subscriber properties to update (note).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateNoteSubscriber" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateNoteSubscriber" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateNoteSubscriber" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscriber" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/notifications/subscribers": { "get": { "tags": [ "Subscribers" ], "summary": "Gets a list of resources.", "description": "Supports RQL filtering, sorting, and pagination via query string parameters.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriberListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/notifications/templates/{templateId}/variants/{id}/activate": { "post": { "tags": [ "TemplateVariants" ], "summary": "Activates a template variant.", "description": "Activates the langauage variant for use by the template.", "parameters": [ { "name": "templateId", "in": "path", "description": "A notification template ID.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "A template variant ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateVariant" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/notifications/templates/{templateId}/variants": { "post": { "tags": [ "TemplateVariants" ], "summary": "Creates a template variant.", "description": "Adds a new language variant to the template with subject and body content for the specified language.", "parameters": [ { "name": "templateId", "in": "path", "description": "A notification template ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "A request DTO model.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TemplateVariantDto" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TemplateVariantDto" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TemplateVariantDto" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateVariant" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "TemplateVariants" ], "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateVariantListResponse" } } } } } } }, "/public/v1/notifications/templates/{templateId}/variants/{id}": { "delete": { "tags": [ "TemplateVariants" ], "summary": "Deletes a template variant.", "description": "Permanently removes the language variant from the template. This operation cannot be undone.", "parameters": [ { "name": "templateId", "in": "path", "description": "A notification template ID.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "A template variant ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "TemplateVariants" ], "summary": "Updates a template variant.", "description": "Updates the subject and/or body content of the language variant. Only provided fields will be modified.", "parameters": [ { "name": "templateId", "in": "path", "description": "A notification template ID.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "A template variant ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "A request DTO model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateVariantDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TemplateVariantDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TemplateVariantDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateVariant" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "TemplateVariants" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateVariant" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/notifications/templates/{templateId}/variants/{id}/disable": { "post": { "tags": [ "TemplateVariants" ], "summary": "Disables a template variant.", "description": "Disables the langauage variant from use by the template.", "parameters": [ { "name": "templateId", "in": "path", "description": "A notification template ID.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "A template variant ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateVariant" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/spotlight/objects": { "get": { "tags": [ "SpotlightObjects" ], "summary": "Get spotlight objects for the current account and buyer group", "description": "Retrieves collection of spotlight objects for the account from the user JWT and the buyer group resolved\nfor the requesting user. The collection can be filtered using RQL query parameters and supports\npagination and sorting. Available for all account types.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpotlightObjectListResponse" } } } } } } }, "/public/v1/spotlight/objects/-/refresh": { "post": { "tags": [ "SpotlightObjects" ], "summary": "Refresh spotlight cache for the current account and buyer group", "description": "Invalidates all spotlight cache keys for the account and buyer group taken from the current user context.\nAvailable for all account types.", "responses": { "204": { "description": "No Content" } } } }, "/public/v1/spotlight/objects/{id}/refresh": { "post": { "tags": [ "SpotlightObjects" ], "summary": "Refresh spotlight cache for a specific object in the current context", "description": "Invalidates the spotlight cache entry for the given object ID using the account and buyer group\nfrom the current user context. Available for all account types.", "parameters": [ { "name": "id", "in": "path", "description": "The spotlight object ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/public/v1/spotlight/queries": { "get": { "tags": [ "SpotlightQueries" ], "summary": "Get a list of spotlight queries", "description": "Supports filtering, sorting, and pagination via query string parameters.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpotlightQueryListResponse" } } } } } } }, "/public/v1/spotlight/queries/{id}": { "get": { "tags": [ "SpotlightQueries" ], "summary": "Retrieve a spotlight query by ID", "description": "Use the select query parameter to specify which fields to include.", "parameters": [ { "name": "id", "in": "path", "description": "The spotlight query ID.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional select statement to filter fields.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpotlightQuery" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "SpotlightQueries" ], "summary": "Update a spotlight query", "description": "Only provided fields are updated.", "parameters": [ { "name": "id", "in": "path", "description": "The spotlight query ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The update request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSpotlight" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateSpotlight" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateSpotlight" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpotlightQuery" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/accounts": { "get": { "tags": [ "Accounts" ], "summary": "List accounts", "description": "List accounts.\nAvailable for Operations account with platform account management permissions.\nReturns a paged list of accounts; supports RQL query parameters for filtering and selection.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountListResponse" }, "example": { "data": [ { "id": "ACC-1234-1234", "revision": 2, "name": "Contoso Ltd", "type": "Vendor", "status": "Active", "externalId": "WW-CON-123456" } ], "$meta": { "pagination": { "offset": 0, "limit": 10, "total": 1 } } } } } } } }, "post": { "tags": [ "Accounts" ], "summary": "Create account", "description": "Create a new account.\nAvailable for Operations account with platform account management permissions.\nCreates account record and optional user groups/modules scope.\nWhen used Content-type: application/json - account created without icon.\nWhen used Content-type: multipart/form-data - account created with icon, parts should account and logo.\nReturns the created account object.", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "account": { "type": "object", "properties": { "ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "ExternalId": { "type": "string" }, "ExternalName": { "type": "string" }, "Address.AddressLine1": { "type": "string" }, "Address.AddressLine2": { "type": "string" }, "Address.PostCode": { "type": "string" }, "Address.City": { "type": "string" }, "Address.State": { "type": "string" }, "Address.Country": { "type": "string" }, "TechnicalSupportEmail": { "type": "string" }, "Website": { "type": "string" }, "Description": { "type": "string" }, "Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Eligibility.Client": { "type": "boolean" }, "Eligibility.Partner": { "type": "boolean" }, "DefaultLanguageCode": { "type": "string" }, "Type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ] }, "Status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ] }, "Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Name": { "type": "string" }, "Icon": { "type": "string" }, "Revision": { "type": "integer", "format": "int32" }, "Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Created.ById": { "type": "string" }, "Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Created.By.Name": { "type": "string" }, "Audit.Created.By.Icon": { "type": "string" }, "Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Created.By.Id": { "type": "string" }, "Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Updated.ById": { "type": "string" }, "Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Updated.By.Name": { "type": "string" }, "Audit.Updated.By.Icon": { "type": "string" }, "Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Audit.Updated.By.Id": { "type": "string" }, "Id": { "type": "string" } }, "description": "Json representation of the account" }, "logo": { "type": "string", "format": "binary" } } }, "encoding": { "account": { "contentType": "application/json" }, "logo": { "contentType": "application/octet-stream" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountCreate" }, "example": { "name": "Contoso Ltd", "type": "Vendor", "externalId": "WW-CON-123456", "externalName": "Contoso", "website": "https://contoso.com", "description": "Enterprise customer account", "address": { "addressLine1": "123 Main Street", "addressLine2": "Apt 4B", "postCode": "12345", "city": "Cityville", "state": "S", "country": "ST" }, "eligibility": { "client": true, "partner": false }, "defaultLanguageCode": "en-US" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" }, "example": { "id": "ACC-1234-1234", "revision": 1, "name": "Contoso Ltd", "type": "Vendor", "status": "Active", "externalId": "WW-CON-123456", "externalName": "Contoso", "website": "https://contoso.com", "description": "Enterprise customer account", "address": { "addressLine1": "123 Main Street", "addressLine2": "Apt 4B", "postCode": "12345", "city": "Cityville", "state": "S", "country": "ST" }, "eligibility": { "client": true, "partner": false }, "audit": { "created": { "at": "2024-02-01T09:12:23+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "updated": { "at": "2024-02-01T09:12:23+00:00", "by": { "id": "USR-0001", "name": "Ops User" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/accounts/{id}": { "get": { "tags": [ "Accounts" ], "summary": "Get account by ID", "description": "Get account by ID.\nAvailable for Operations account with platform account management permissions.\nReturns a single account with id, name, type, status, address, eligibility, and audit.\nOptional select query parameter controls which fields are returned.", "parameters": [ { "name": "id", "in": "path", "description": "Account identifier.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional RQL select statement to limit returned fields.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" }, "example": { "id": "ACC-1234-1234", "revision": 2, "name": "Contoso Ltd", "type": "Vendor", "status": "Active", "externalId": "WW-CON-123456", "address": { "addressLine1": "123 Main Street", "postCode": "12345", "city": "Cityville", "state": "S", "country": "ST" }, "eligibility": { "client": true, "partner": false } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Accounts" ], "summary": "Update account", "description": "Update account.\nAvailable for Operations account with platform account management permissions.\nAccepts application/json or multipart/form-data (with optional icon).\nUpdates account fields such as name, address, website, and description.\nReturns the updated account object.", "parameters": [ { "name": "id", "in": "path", "description": "Account identifier.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "account": { "type": "object", "properties": { "ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "ExternalId": { "type": "string" }, "ExternalName": { "type": "string" }, "Address.AddressLine1": { "type": "string" }, "Address.AddressLine2": { "type": "string" }, "Address.PostCode": { "type": "string" }, "Address.City": { "type": "string" }, "Address.State": { "type": "string" }, "Address.Country": { "type": "string" }, "TechnicalSupportEmail": { "type": "string" }, "Website": { "type": "string" }, "Description": { "type": "string" }, "Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Eligibility.Client": { "type": "boolean" }, "Eligibility.Partner": { "type": "boolean" }, "DefaultLanguageCode": { "type": "string" }, "Type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ] }, "Status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ] }, "Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Name": { "type": "string" }, "Icon": { "type": "string" }, "Revision": { "type": "integer", "format": "int32" }, "Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Created.ById": { "type": "string" }, "Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Created.By.Name": { "type": "string" }, "Audit.Created.By.Icon": { "type": "string" }, "Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Created.By.Id": { "type": "string" }, "Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Updated.ById": { "type": "string" }, "Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Updated.By.Name": { "type": "string" }, "Audit.Updated.By.Icon": { "type": "string" }, "Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Audit.Updated.By.Id": { "type": "string" }, "Id": { "type": "string" } }, "description": "Json representation of the account" }, "logo": { "type": "string", "format": "binary" } } }, "encoding": { "account": { "contentType": "application/json" }, "logo": { "contentType": "application/octet-stream" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountUpdate" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" }, "example": { "id": "ACC-1234-1234", "revision": 2, "name": "Contoso Ltd", "icon": "/static/accounts/ACC-1234-1234/logo.png" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/accounts/{id}/enable": { "post": { "tags": [ "Accounts" ], "summary": "Enable account", "description": "Enable a disabled account.\nAvailable for Operations account with platform account management permissions.\nMoves the account to the Enabled state.\nReturns the updated account object.", "parameters": [ { "name": "id", "in": "path", "description": "Account identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" }, "example": { "id": "ACC-1234-1234", "revision": 2, "name": "Contoso Ltd", "status": "Enabled", "type": "Vendor", "audit": { "created": { "at": "2024-02-01T09:12:23+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "updated": { "at": "2024-02-02T10:00:00+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "enabled": { "at": "2024-02-02T10:00:00+00:00", "by": { "id": "USR-0001", "name": "Ops User" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/accounts/{id}/disable": { "post": { "tags": [ "Accounts" ], "summary": "Disable account", "description": "Disable an active account.\nAccess: Authenticated account with platform account management permissions.\nMoves the account to the Disabled state.\nReturns the updated account object.", "parameters": [ { "name": "id", "in": "path", "description": "Account identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" }, "example": { "id": "ACC-1234-1234", "revision": 2, "name": "Contoso Ltd", "status": "Disabled", "type": "Vendor", "audit": { "created": { "at": "2024-02-01T09:12:23+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "updated": { "at": "2024-02-02T10:05:00+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "disabled": { "at": "2024-02-02T10:05:00+00:00", "by": { "id": "USR-0001", "name": "Ops User" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/accounts/{id}/activate": { "post": { "tags": [ "Accounts" ], "summary": "Activate account", "description": "Activate account.\nAvailable for Operations account with platform account management permissions.\nMoves the account to Active state and sets the externalId from the request if sent.\nReturns the updated account object with audit.activated.", "parameters": [ { "name": "id", "in": "path", "description": "Account identifier.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Activation payload.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AccountActivate" } ] }, "example": { "externalId": "WW-CON-123456" } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AccountActivate" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AccountActivate" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" }, "example": { "id": "ACC-1234-1234", "revision": 2, "name": "Contoso Ltd", "status": "Active", "externalId": "WW-CON-123456", "audit": { "created": { "at": "2024-02-01T09:12:23+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "updated": { "at": "2024-02-02T10:10:00+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "activated": { "at": "2024-02-02T10:10:00+00:00", "by": { "id": "USR-0001", "name": "Ops User" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/accounts/{id}/deactivate": { "post": { "tags": [ "Accounts" ], "summary": "Deactivate account", "description": "Deactivate account.\nMoves the account from Active to Enabled.\nAvailable for Operations account with platform account management permissions.\nReturns the updated account object.", "parameters": [ { "name": "id", "in": "path", "description": "Account identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" }, "example": { "id": "ACC-1234-1234", "revision": 2, "name": "Contoso Ltd", "status": "Disabled", "type": "Vendor", "audit": { "created": { "at": "2024-01-15T09:12:23+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "updated": { "at": "2024-02-02T10:15:00+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "activated": { "at": "2024-02-02T15:15:00+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "deactivated": { "at": "2024-02-02T20:15:00+00:00", "by": { "id": "USR-0001", "name": "Ops User" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/accounts/{id}/validate": { "post": { "tags": [ "Accounts" ], "summary": "Validate account", "description": "Validate account payload and external identifiers.\nAvailable for Operations account with platform account management permissions.\nReturns validation result.\nUse this endpoint to check account externalId constraints before activation.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Validation payload.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AccountValidate" } ] }, "example": { "revision": 1, "externalId": "WW-CON-123456" } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AccountValidate" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AccountValidate" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" }, "example": { "revision": 2, "externalId": "WW-CON-123456" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/accounts/{id}/icon": { "get": { "tags": [ "Accounts" ], "summary": "Get account icon", "description": "Get account icon by identifier.\nAccess: Anonymous.\nReturns a redirect to the icon binary URL.\nUses a private blob cache profile for the response.", "parameters": [ { "name": "id", "in": "path", "description": "Account identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "307": { "description": "Temporary Redirect" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/{accountId}/users": { "post": { "tags": [ "AccountsUsersLegacy" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAccountUserDto" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAccountUserDto" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAccountUserDto" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUser" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true }, "get": { "tags": [ "AccountsUsersLegacy" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUserListResponse" } } } } }, "deprecated": true } }, "/public/v1/accounts/{accountId}/users/{userId}": { "put": { "tags": [ "AccountsUsersLegacy" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountUser" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AccountUser" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUser" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true }, "get": { "tags": [ "AccountsUsersLegacy" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUser" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true }, "delete": { "tags": [ "AccountsUsersLegacy" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true } }, "/public/v1/accounts/{accountId}/users/{userId}/accept-invite": { "post": { "tags": [ "AccountsUsersLegacy" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUserQueryLegacy" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true } }, "/public/v1/accounts/{accountId}/users/{userId}/resend-invite": { "post": { "tags": [ "AccountsUsersLegacy" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUserQueryLegacy" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true } }, "/public/v1/accounts/{accountId}/users/{userId}/send-new-invite": { "post": { "tags": [ "AccountsUsersLegacy" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUserQueryLegacy" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true } }, "/public/v1/accounts/{accountId}/users/{userId}/groups": { "post": { "tags": [ "AccountsUsersLegacy" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserGroupDto" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserGroupDto" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserGroupDto" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUser" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true }, "put": { "tags": [ "AccountsUsersLegacy" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupDto" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupDto" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUser" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true } }, "/public/v1/accounts/{accountId}/users/{userId}/groups/{userGroupId}": { "delete": { "tags": [ "AccountsUsersLegacy" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userGroupId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true } }, "/public/v1/accounts/accounts/{accountId}/users": { "get": { "tags": [ "AccountUsers" ], "summary": "List account users", "description": "List account users.\nAvailable for Operations accounts, and for Client and Vendor account for users of their account.\nReturns a paged list of users in the account; supports RQL query parameters. Excludes users with deleted invitation.", "parameters": [ { "name": "accountId", "in": "path", "description": "Account identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUserListResponse" }, "example": { "data": [ { "id": "USR-3758-7092", "icon": "/v1/accounts/users/USR-3758-7092/icon", "email": "john.doe@example.com", "status": "Active", "firstName": "John", "lastName": "Doe", "groups": [ { "id": "UGR-3758-7092", "name": "Billing Admins" } ], "account": { "id": "ACC-3758-7092", "type": "Client", "status": "Active", "name": "Example Account", "icon": "/v1/accounts/accounts/ACC-3758-7092/icon" }, "invitation": { "status": "Active" } } ], "$meta": { "pagination": { "offset": 0, "limit": 10, "total": 1 } } } } } } } }, "post": { "tags": [ "AccountUsers" ], "summary": "Create user (invite or add) inviting him into the account", "description": "Create account user.\nAvailable for all account types with platform account management permissions.\nAccepts user details and optional invitation. If invitation status is Active, adds existing user; otherwise sends invite.\nOnly Operational account can bypass invitation process.\nReturns the created account user object.", "parameters": [ { "name": "accountId", "in": "path", "description": "Account identifier.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Account user payload (user data, groups, optional invitation).", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAccountUserDto" } ] }, "example": { "user": { "email": "new.user@example.com", "firstName": "New", "lastName": "User" }, "groups": [ { "id": "UGR-3758-7092" } ], "invitation": { "status": "Invited" } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAccountUserDto" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAccountUserDto" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUser" }, "example": { "id": "USR-3758-7092", "email": "new.user@example.com", "firstName": "New", "lastName": "User", "status": "Invited", "groups": [ { "id": "UGR-3758-7092", "name": "test2" } ], "account": { "id": "ACC-3758-7092", "type": "Client", "status": "Active", "name": "Example Account", "icon": "/v1/accounts/accounts/ACC-3758-7092/icon" }, "invitation": { "url": "https://...", "status": "Invited" }, "audit": { "created": { "at": "2024-01-29T11:36:54.266+00:00", "by": { "id": "USR-1234-5678", "name": "Ops User" } }, "updated": { "at": "2026-02-10T16:02:12.522+00:00", "by": { "id": "USR-0000-0022", "name": "Ops User" } }, "invited": { "at": "2026-02-10T16:02:12.522+00:00", "by": { "id": "USR-0000-0022", "name": "Ops User" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/accounts/{accountId}/users/{userId}": { "get": { "tags": [ "AccountUsers" ], "summary": "Get account user by ID", "description": "Get account user by ID.\nAvailable for Operations account with platform account management permissions; Client account for users of their account.\nReturns a single account user with email, name, groups, account, invitation. Optional select query parameter controls returned fields.", "parameters": [ { "name": "accountId", "in": "path", "description": "Account identifier.", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "description": "User identifier (account user id).", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional RQL select statement to limit returned fields.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUser" }, "example": { "id": "USR-3758-7092", "icon": "/v1/accounts/users/USR-3758-7092/icon", "email": "john.doe@example.com", "status": "Active", "firstName": "John", "lastName": "Doe", "groups": [ { "id": "UGR-3758-7092", "name": "Billing Admins" } ], "account": { "id": "ACC-3758-7092", "type": "Client", "status": "Active", "name": "Example Account", "icon": "/v1/accounts/accounts/ACC-3758-7092/icon" }, "invitation": { "status": "Active" }, "audit": { "created": { "at": "2024-01-29T11:36:54.266+00:00", "by": { "id": "USR-1234-5678", "name": "John Doe" } }, "updated": { "at": "2026-02-10T16:02:12.522+00:00", "by": { "id": "USR-0000-0022", "name": "John Smith" } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "AccountUsers" ], "summary": "Update user in account", "description": "Update account user.\nAvailable for Operations account with platform account management permissions or to the user himself.\nAccepts a delta payload with fields to update (e.g. email, firstName, lastName, phone, settings).\nReturns the updated account user object.", "parameters": [ { "name": "accountId", "in": "path", "description": "Account identifier.", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "description": "User identifier.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Delta payload with updated fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUser" }, "example": { "firstName": "Updated", "lastName": "Name" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountUser" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AccountUser" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUser" }, "example": { "id": "USR-3758-7092", "revision": 2, "name": "Updated Name", "email": "new.user@example.com", "firstName": "Updated", "lastName": "Name", "status": "Active", "account": { "id": "ACC-3758-7092", "name": "Test Account" }, "groups": [ { "id": "UGR-3758-7092" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "AccountUsers" ], "summary": "Delete user from account", "description": "Delete user from account.\nAvailable for account users with platform account management permissions or to the user himself.\nWhen user removes himself from the account, that means leaving the account.\nReturns 204 No Content on success.", "parameters": [ { "name": "accountId", "in": "path", "description": "Account identifier.", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "description": "User identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/accounts/{accountId}/users/{userId}/groups": { "post": { "tags": [ "AccountUsers" ], "summary": "Add account user to group", "description": "Add account user to group.\nAvailable for Operations account with platform account management permissions, and for Client/Vendor accounts with Access Management permissions for users in the same account.\nAssigns the user to an additional user group. Returns the updated account user object with groups.", "parameters": [ { "name": "accountId", "in": "path", "description": "Account identifier.", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "description": "User identifier.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "User group reference (id).", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserGroupDto" } ] }, "example": { "id": "UGR-3758-7092" } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserGroupDto" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserGroupDto" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUser" }, "example": { "id": "USR-3758-7092", "email": "user@example.com", "firstName": "Test", "lastName": "User", "groups": [ { "id": "UGR-9712-9553" }, { "id": "UGR-4485-7083" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "AccountUsers" ], "summary": "Change account user groups", "description": "Change account user groups.\nAvailable for Operations account with platform account management permissions.\nReplaces the user's group membership with the provided list. Returns the updated account user object.", "parameters": [ { "name": "accountId", "in": "path", "description": "Account identifier.", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "description": "User identifier.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of user group references (id).", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupDto" } }, "example": [ { "id": "UGR-3758-7092" }, { "id": "UGR-7092-3758" } ] }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupDto" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupDto" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUser" }, "example": { "id": "USR-3758-7092", "groups": [ { "id": "UGR-3758-7092", "name": "test2" }, { "id": "UGR-7092-3758", "name": "Other" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/accounts/{accountId}/users/{userId}/groups/{userGroupId}": { "delete": { "tags": [ "AccountUsers" ], "summary": "Remove account user from group", "description": "Remove account user from group.\nAvailable for account users with platform account management permissions.\nRemoves the user from the specified user group.\nReturns 204 No Content on success.", "parameters": [ { "name": "accountId", "in": "path", "description": "Account identifier.", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "description": "User identifier.", "required": true, "schema": { "type": "string" } }, { "name": "userGroupId", "in": "path", "description": "User group identifier to remove the user from.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/accounts/{accountId}/users/{userId}/resend-invite": { "post": { "tags": [ "AccountUsers" ], "summary": "Resend invite", "description": "Resend invite.\nAvailable for account users with platform account management permissions.\nResends the invitation for the account user. Returns the updated account user object.", "parameters": [ { "name": "accountId", "in": "path", "description": "Account identifier.", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "description": "User identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUserQueryLegacy" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/accounts/{accountId}/users/{userId}/send-new-invite": { "post": { "tags": [ "AccountUsers" ], "summary": "Send new invite", "description": "Send new invite.\nAvailable for account users with platform account management permissions.\nSends a new invitation (e.g. after expiry). Returns the updated account user object.", "parameters": [ { "name": "accountId", "in": "path", "description": "Account identifier.", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "description": "User identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUserQueryLegacy" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/accounts/{accountId}/users/{userId}/accept-invite": { "post": { "tags": [ "AccountUsers" ], "summary": "Accept invite", "description": "Accept invite.\nAvailable for user with valid invitation. Accepts the invitation and completes the process of joining to the account.\nReturns the updated account user object.", "parameters": [ { "name": "accountId", "in": "path", "description": "Account identifier.", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "description": "User identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUserQueryLegacy" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/account-users": { "get": { "tags": [ "AccountUsersLegacy" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUserQueryLegacyListResponse" } } } } }, "deprecated": true }, "post": { "tags": [ "AccountUsersLegacy" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAccountUserDto" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAccountUserDto" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAccountUserDto" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUserQueryLegacy" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true } }, "/public/v1/accounts/account-users/{id}": { "get": { "tags": [ "AccountUsersLegacy" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUserQueryLegacy" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true }, "delete": { "tags": [ "AccountUsersLegacy" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true } }, "/public/v1/accounts/account-users/{id}/groups": { "post": { "tags": [ "AccountUsersLegacy" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserGroupDto" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserGroupDto" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserGroupDto" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUserQueryLegacy" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true }, "put": { "tags": [ "AccountUsersLegacy" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupDto" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupDto" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUserQueryLegacy" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true } }, "/public/v1/accounts/account-users/{id}/groups/{userGroupId}": { "delete": { "tags": [ "AccountUsersLegacy" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userGroupId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true } }, "/public/v1/accounts/account-users/{id}/accept-invite": { "post": { "tags": [ "AccountUsersLegacy" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUserQueryLegacy" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true } }, "/public/v1/accounts/account-users/{id}/resend-invite": { "post": { "tags": [ "AccountUsersLegacy" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUserQueryLegacy" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true } }, "/public/v1/accounts/account-users/{id}/send-new-invite": { "post": { "tags": [ "AccountUsersLegacy" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUserQueryLegacy" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true } }, "/public/v1/commerce/agreements": { "post": { "tags": [ "Agreements" ], "summary": "Creates a new agreement.", "requestBody": { "description": "Agreement details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Agreement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Agreement" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Agreement" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Agreement" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Agreements" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementListResponse" } } } } } } }, "/public/v1/commerce/agreements/{id}": { "put": { "tags": [ "Agreements" ], "summary": "Updates an existing agreement.", "parameters": [ { "name": "id", "in": "path", "description": "Agreement id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Updated agreement details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Agreement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Agreement" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Agreement" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Agreement" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Agreements" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Agreement" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/commerce/agreements/{id}/template": { "get": { "tags": [ "Agreements" ], "summary": "Renders an agreement template.", "parameters": [ { "name": "id", "in": "path", "description": "Agreement id", "required": true, "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "Template language code", "schema": { "type": "string" } }, { "name": "template.id", "in": "query", "description": "Template id", "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "Preferred language header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/commerce/agreements/{id}/render": { "get": { "tags": [ "Agreements" ], "summary": "Renders an agreement template.", "parameters": [ { "name": "id", "in": "path", "description": "Agreement id", "required": true, "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "Template language code", "schema": { "type": "string" } }, { "name": "template.id", "in": "query", "description": "Template id", "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "Preferred language header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/commerce/agreements/{agreementId}/attachments": { "get": { "tags": [ "AgreementsAttachments" ], "summary": "Lists attachments for the specified agreement.", "parameters": [ { "name": "agreementId", "in": "path", "description": "Agreement id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementAttachmentListResponse" } } } } } }, "post": { "tags": [ "AgreementsAttachments" ], "summary": "Creates a new attachment for an agreement.", "parameters": [ { "name": "agreementId", "in": "path", "description": "Agreement id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "attachment": { "type": "object", "properties": { "Name": { "type": "string" }, "Description": { "type": "string" }, "OrderId": { "type": "string" }, "Type": { "allOf": [ { "$ref": "#/components/schemas/AttachmentType" } ] }, "LicenseKey": { "type": "string" } }, "description": "Json representation of the attachment" }, "file": { "type": "string", "format": "binary" } } }, "encoding": { "attachment": { "contentType": "application/json" }, "file": { "contentType": "application/octet-stream" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementAttachmentEntity" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/commerce/agreements/{agreementId}/attachments/{id}": { "get": { "tags": [ "AgreementsAttachments" ], "summary": "Gets an attachment by id or redirects to its download.", "parameters": [ { "name": "agreementId", "in": "path", "description": "Agreement id", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Attachment id", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Select expression", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementAttachmentEntity" } } } }, "301": { "description": "Moved Permanently" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "AgreementsAttachments" ], "summary": "Updates an existing agreement attachment.", "parameters": [ { "name": "agreementId", "in": "path", "description": "Agreement id", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Attachment id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Updated attachment details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementAttachmentEntity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AgreementAttachmentEntity" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AgreementAttachmentEntity" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementAttachmentEntity" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "AgreementsAttachments" ], "summary": "Deletes an agreement attachment.", "parameters": [ { "name": "agreementId", "in": "path", "description": "Agreement id", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Attachment id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/api-tokens": { "get": { "tags": [ "ApiTokens" ], "summary": "List API tokens", "description": "List API tokens.\nAvailable for all account types (Operations account, Client account, Vendor account).\nReturns a paged list of API tokens; supports RQL query parameters for filtering and selection.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTokenListResponse" }, "example": { "data": [ { "id": "TKN-4134-7330", "revision": 2, "name": "Robot", "description": "Token for ERP integration", "status": "Active", "account": { "id": "ACC-1234-5678", "name": "Microsoft" }, "modules": [ { "id": "MOD-1756-1452" }, { "id": "MOD-9042-8216" } ] } ], "$meta": { "pagination": { "offset": 0, "limit": 10, "total": 1 } } } } } } } }, "post": { "tags": [ "ApiTokens" ], "summary": "Create API token", "description": "Create API token.\nAvailable for all account types (Operations account, Client account, Vendor account).\nAccepts account reference, name, optional description, and at least one module.\nReturns the created API token object with revision 1 and token value (returned only on create).", "requestBody": { "description": "API token payload.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateApiTokenDto" } ] }, "example": { "account": { "id": "ACC-1234-5678" }, "name": "Robot", "description": "Token for ERP integration", "modules": [ { "id": "MOD-1756-1452" }, { "id": "MOD-9042-8216" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateApiTokenDto" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateApiTokenDto" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiToken" }, "example": { "id": "TKN-4134-7330", "revision": 1, "name": "Robot", "description": "Token for ERP integration", "status": "Active", "token": "idt:TKN-4134-7330:z24kA...328f", "account": { "id": "ACC-1234-5678", "name": "Microsoft" }, "modules": [ { "id": "MOD-1756-1452" }, { "id": "MOD-9042-8216" } ], "audit": { "created": { "at": "2024-02-01T09:12:23+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "updated": { "at": "2024-02-01T09:12:23+00:00", "by": { "id": "USR-0001", "name": "Ops User" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/api-tokens/{id}": { "get": { "tags": [ "ApiTokens" ], "summary": "Get API token by ID", "description": "Get API token by ID.\nAvailable for all account types (Operations account, Client account, Vendor account).\nReturns a single API token; token value is not returned (only on create).\nOptional select query parameter controls which fields are returned.", "parameters": [ { "name": "id", "in": "path", "description": "API token identifier.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional RQL select statement to limit returned fields.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiToken" }, "example": { "id": "TKN-4134-7330", "revision": 2, "name": "Robot", "description": "Token for ERP integration", "status": "Active", "account": { "id": "ACC-1234-5678", "name": "Microsoft" }, "modules": [ { "id": "MOD-1756-1452" }, { "id": "MOD-9042-8216" } ] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "ApiTokens" ], "summary": "Update API token", "description": "Update API token.\nAvailable for all account types (Operations account, Client account, Vendor account).\nAccepts a delta payload with fields to update (e.g. name, description, icon, modules).\nReturns the updated API token object.", "parameters": [ { "name": "id", "in": "path", "description": "API token identifier.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Delta payload with updated fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiToken" }, "example": { "name": "Robot Updated", "description": "Updated description", "modules": [ { "id": "MOD-1756-1452" } ] } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiToken" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApiToken" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiToken" }, "example": { "id": "TKN-4134-7330", "revision": 2, "name": "Robot Updated", "description": "Updated description", "status": "Active", "account": { "id": "ACC-1234-5678", "name": "Microsoft" }, "modules": [ { "id": "MOD-1756-1452" } ], "audit": { "created": { "at": "2024-02-01T09:12:23+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "updated": { "at": "2024-02-02T10:00:00+00:00", "by": { "id": "USR-0001", "name": "Ops User" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "ApiTokens" ], "summary": "Delete API token", "description": "Delete API token.\nAvailable for all account types (Operations account, Client account, Vendor account).\nPermanently removes the API token; it can no longer be used for authentication.\nReturns 204 No Content on success.", "parameters": [ { "name": "id", "in": "path", "description": "API token identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/api-tokens/{id}/enable": { "post": { "tags": [ "ApiTokens" ], "summary": "Enable API token", "description": "Enable API token.\nChanges API token state to Active (e.g. from Disabled).\nAvailable for all account types (Operations account, Client account, Vendor account).\nReturns the updated API token object.", "parameters": [ { "name": "id", "in": "path", "description": "API token identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiToken" }, "example": { "id": "TKN-4134-7330", "revision": 2, "name": "Robot", "description": "Token for ERP integration", "status": "Active", "account": { "id": "ACC-1234-5678", "name": "Microsoft" }, "modules": [ { "id": "MOD-1756-1452" } ], "audit": { "created": { "at": "2024-02-01T09:12:23+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "updated": { "at": "2024-02-02T10:00:00+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "enabled": { "at": "2024-02-02T10:00:00+00:00", "by": { "id": "USR-0001", "name": "Ops User" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/api-tokens/{id}/disable": { "post": { "tags": [ "ApiTokens" ], "summary": "Disable API token", "description": "Disable API token.\nChanges API token state to Disabled.\nAvailable for all account types (Operations account, Client account, Vendor account).\nReturns the updated API token object.", "parameters": [ { "name": "id", "in": "path", "description": "API token identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiToken" }, "example": { "id": "TKN-4134-7330", "revision": 2, "name": "Robot", "description": "Token for ERP integration", "status": "Disabled", "account": { "id": "ACC-1234-5678", "name": "Microsoft" }, "modules": [ { "id": "MOD-1756-1452" } ], "audit": { "created": { "at": "2024-02-01T09:12:23+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "updated": { "at": "2024-02-02T10:05:00+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "disabled": { "at": "2024-02-02T10:05:00+00:00", "by": { "id": "USR-0001", "name": "Ops User" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/commerce/assets": { "post": { "tags": [ "Assets" ], "summary": "Creates a new asset.", "requestBody": { "description": "Asset details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Asset" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Asset" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Asset" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Assets" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetListResponse" } } } } } } }, "/public/v1/commerce/assets/{id}": { "put": { "tags": [ "Assets" ], "summary": "Updates an existing asset.", "parameters": [ { "name": "id", "in": "path", "description": "Asset id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Updated asset details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Asset" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Asset" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Asset" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Assets" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Asset" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/commerce/assets/{id}/terminate": { "post": { "tags": [ "Assets" ], "summary": "Terminates an existing asset.", "parameters": [ { "name": "id", "in": "path", "description": "Asset id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Termination details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Asset" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Asset" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Asset" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/commerce/assets/{id}/render": { "get": { "tags": [ "Assets" ], "summary": "Renders an asset template.", "parameters": [ { "name": "id", "in": "path", "description": "Asset id", "required": true, "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "Template language code", "schema": { "type": "string" } }, { "name": "template.id", "in": "query", "description": "Template id", "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "Preferred language header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/catalog/pricing-policies/{pricingPolicyId}/attachments": { "get": { "tags": [ "Attachments" ], "parameters": [ { "name": "pricingPolicyId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PricingPolicyAttachmentListResponse" } } } } } }, "post": { "tags": [ "Attachments" ], "parameters": [ { "name": "pricingPolicyId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "attachment": { "type": "object", "properties": { "Name": { "type": "string" }, "Description": { "type": "string" } }, "description": "Json representation of the attachment" }, "file": { "type": "string", "format": "binary" } } }, "encoding": { "attachment": { "contentType": "application/json" }, "file": { "contentType": "application/octet-stream" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PricingPolicyAttachment" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/catalog/pricing-policies/{pricingPolicyId}/attachments/{id}": { "get": { "tags": [ "Attachments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "pricingPolicyId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PricingPolicyAttachment" } } } }, "301": { "description": "Moved Permanently" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Attachments" ], "parameters": [ { "name": "pricingPolicyId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PricingPolicyAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PricingPolicyAttachment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PricingPolicyAttachment" } } } }, "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Attachments" ], "parameters": [ { "name": "pricingPolicyId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/catalog/authorizations": { "post": { "tags": [ "Authorizations" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAuthorizationRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAuthorizationRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAuthorizationRequest" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Authorization" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Authorizations" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizationListResponse" } } } } } } }, "/public/v1/catalog/authorizations/{id}": { "put": { "tags": [ "Authorizations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizationUpdate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthorizationUpdate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AuthorizationUpdate" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Authorization" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Authorizations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Authorizations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Authorization" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/buyers": { "post": { "tags": [ "Buyers" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "buyer": { "type": "object", "properties": { "ExternalIds.ErpCompanyContact": { "type": "string" }, "ExternalIds.ErpCustomer": { "type": "string" }, "ExternalIds.AccountExternalId": { "type": "string" }, "Status": { "allOf": [ { "$ref": "#/components/schemas/BuyerStatus" } ] }, "Address.AddressLine1": { "type": "string" }, "Address.AddressLine2": { "type": "string" }, "Address.PostCode": { "type": "string" }, "Address.City": { "type": "string" }, "Address.State": { "type": "string" }, "Address.Country": { "type": "string" }, "TaxId": { "type": "string" }, "Account.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Account.ExternalId": { "type": "string" }, "Account.ExternalName": { "type": "string" }, "Account.Address.AddressLine1": { "type": "string" }, "Account.Address.AddressLine2": { "type": "string" }, "Account.Address.PostCode": { "type": "string" }, "Account.Address.City": { "type": "string" }, "Account.Address.State": { "type": "string" }, "Account.Address.Country": { "type": "string" }, "Account.TechnicalSupportEmail": { "type": "string" }, "Account.Website": { "type": "string" }, "Account.Description": { "type": "string" }, "Account.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Account.Eligibility.Client": { "type": "boolean" }, "Account.Eligibility.Partner": { "type": "boolean" }, "Account.DefaultLanguageCode": { "type": "string" }, "Account.Type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ] }, "Account.Status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ] }, "Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Name": { "type": "string" }, "Account.Icon": { "type": "string" }, "Account.Revision": { "type": "integer", "format": "int32" }, "Account.Audit.Created.At": { "type": "string", "format": "date-time" }, "Account.Audit.Created.ById": { "type": "string" }, "Account.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Account.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Audit.Created.By.Name": { "type": "string" }, "Account.Audit.Created.By.Icon": { "type": "string" }, "Account.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Account.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Account.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Account.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Account.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Account.Audit.Created.By.Id": { "type": "string" }, "Account.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Account.Audit.Updated.ById": { "type": "string" }, "Account.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Account.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Audit.Updated.By.Name": { "type": "string" }, "Account.Audit.Updated.By.Icon": { "type": "string" }, "Account.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Account.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Account.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Account.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Account.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Account.Audit.Updated.By.Id": { "type": "string" }, "Account.Id": { "type": "string" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ParametrisedMessage" } }, "Sellers": { "type": "array", "items": { "$ref": "#/components/schemas/Seller" } }, "ErpLinks": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLink" } }, "Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Name": { "type": "string" }, "Icon": { "type": "string" }, "Revision": { "type": "integer", "format": "int32" }, "Audit.Activated.At": { "type": "string", "format": "date-time" }, "Audit.Activated.ById": { "type": "string" }, "Audit.Activated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Activated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Activated.By.Name": { "type": "string" }, "Audit.Activated.By.Icon": { "type": "string" }, "Audit.Activated.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Activated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Activated.By.Audit.Created.ById": { "type": "string" }, "Audit.Activated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Activated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Activated.By.Audit.Updated.ById": { "type": "string" }, "Audit.Activated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Activated.By.Id": { "type": "string" }, "Audit.Unassigned.At": { "type": "string", "format": "date-time" }, "Audit.Unassigned.ById": { "type": "string" }, "Audit.Unassigned.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Unassigned.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Unassigned.By.Name": { "type": "string" }, "Audit.Unassigned.By.Icon": { "type": "string" }, "Audit.Unassigned.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Unassigned.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Unassigned.By.Audit.Created.ById": { "type": "string" }, "Audit.Unassigned.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Unassigned.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Unassigned.By.Audit.Updated.ById": { "type": "string" }, "Audit.Unassigned.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Unassigned.By.Id": { "type": "string" }, "Audit.Disabled.At": { "type": "string", "format": "date-time" }, "Audit.Disabled.ById": { "type": "string" }, "Audit.Disabled.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Disabled.By.Name": { "type": "string" }, "Audit.Disabled.By.Icon": { "type": "string" }, "Audit.Disabled.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Disabled.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Disabled.By.Audit.Created.ById": { "type": "string" }, "Audit.Disabled.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Disabled.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Disabled.By.Audit.Updated.ById": { "type": "string" }, "Audit.Disabled.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Disabled.By.Id": { "type": "string" }, "Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Created.ById": { "type": "string" }, "Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Created.By.Name": { "type": "string" }, "Audit.Created.By.Icon": { "type": "string" }, "Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Created.By.Id": { "type": "string" }, "Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Updated.ById": { "type": "string" }, "Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Updated.By.Name": { "type": "string" }, "Audit.Updated.By.Icon": { "type": "string" }, "Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Updated.By.Id": { "type": "string" }, "Id": { "type": "string" } }, "description": "Json representation of the buyer" }, "logo": { "type": "string", "format": "binary" } } }, "encoding": { "buyer": { "contentType": "application/json" }, "logo": { "contentType": "application/octet-stream" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuyerCreate" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buyer" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Buyers" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuyerListResponse" } } } } } } }, "/public/v1/accounts/buyers/{id}/enable": { "post": { "tags": [ "Buyers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buyer" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/buyers/{id}/disable": { "post": { "tags": [ "Buyers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buyer" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/buyers/{id}/activate": { "post": { "tags": [ "Buyers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BuyerActivate" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BuyerActivate" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BuyerActivate" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buyer" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/buyers/{id}/deactivate": { "post": { "tags": [ "Buyers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buyer" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/buyers/{id}": { "delete": { "tags": [ "Buyers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Buyers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "buyer": { "type": "object", "properties": { "ExternalIds.ErpCompanyContact": { "type": "string" }, "ExternalIds.ErpCustomer": { "type": "string" }, "ExternalIds.AccountExternalId": { "type": "string" }, "Status": { "allOf": [ { "$ref": "#/components/schemas/BuyerStatus" } ] }, "Address.AddressLine1": { "type": "string" }, "Address.AddressLine2": { "type": "string" }, "Address.PostCode": { "type": "string" }, "Address.City": { "type": "string" }, "Address.State": { "type": "string" }, "Address.Country": { "type": "string" }, "TaxId": { "type": "string" }, "Account.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Account.ExternalId": { "type": "string" }, "Account.ExternalName": { "type": "string" }, "Account.Address.AddressLine1": { "type": "string" }, "Account.Address.AddressLine2": { "type": "string" }, "Account.Address.PostCode": { "type": "string" }, "Account.Address.City": { "type": "string" }, "Account.Address.State": { "type": "string" }, "Account.Address.Country": { "type": "string" }, "Account.TechnicalSupportEmail": { "type": "string" }, "Account.Website": { "type": "string" }, "Account.Description": { "type": "string" }, "Account.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Account.Eligibility.Client": { "type": "boolean" }, "Account.Eligibility.Partner": { "type": "boolean" }, "Account.DefaultLanguageCode": { "type": "string" }, "Account.Type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ] }, "Account.Status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ] }, "Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Name": { "type": "string" }, "Account.Icon": { "type": "string" }, "Account.Revision": { "type": "integer", "format": "int32" }, "Account.Audit.Created.At": { "type": "string", "format": "date-time" }, "Account.Audit.Created.ById": { "type": "string" }, "Account.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Account.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Audit.Created.By.Name": { "type": "string" }, "Account.Audit.Created.By.Icon": { "type": "string" }, "Account.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Account.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Account.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Account.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Account.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Account.Audit.Created.By.Id": { "type": "string" }, "Account.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Account.Audit.Updated.ById": { "type": "string" }, "Account.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Account.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Audit.Updated.By.Name": { "type": "string" }, "Account.Audit.Updated.By.Icon": { "type": "string" }, "Account.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Account.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Account.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Account.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Account.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Account.Audit.Updated.By.Id": { "type": "string" }, "Account.Id": { "type": "string" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ParametrisedMessage" } }, "Sellers": { "type": "array", "items": { "$ref": "#/components/schemas/Seller" } }, "ErpLinks": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLink" } }, "Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Name": { "type": "string" }, "Icon": { "type": "string" }, "Revision": { "type": "integer", "format": "int32" }, "Audit.Activated.At": { "type": "string", "format": "date-time" }, "Audit.Activated.ById": { "type": "string" }, "Audit.Activated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Activated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Activated.By.Name": { "type": "string" }, "Audit.Activated.By.Icon": { "type": "string" }, "Audit.Activated.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Activated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Activated.By.Audit.Created.ById": { "type": "string" }, "Audit.Activated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Activated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Activated.By.Audit.Updated.ById": { "type": "string" }, "Audit.Activated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Activated.By.Id": { "type": "string" }, "Audit.Unassigned.At": { "type": "string", "format": "date-time" }, "Audit.Unassigned.ById": { "type": "string" }, "Audit.Unassigned.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Unassigned.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Unassigned.By.Name": { "type": "string" }, "Audit.Unassigned.By.Icon": { "type": "string" }, "Audit.Unassigned.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Unassigned.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Unassigned.By.Audit.Created.ById": { "type": "string" }, "Audit.Unassigned.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Unassigned.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Unassigned.By.Audit.Updated.ById": { "type": "string" }, "Audit.Unassigned.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Unassigned.By.Id": { "type": "string" }, "Audit.Disabled.At": { "type": "string", "format": "date-time" }, "Audit.Disabled.ById": { "type": "string" }, "Audit.Disabled.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Disabled.By.Name": { "type": "string" }, "Audit.Disabled.By.Icon": { "type": "string" }, "Audit.Disabled.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Disabled.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Disabled.By.Audit.Created.ById": { "type": "string" }, "Audit.Disabled.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Disabled.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Disabled.By.Audit.Updated.ById": { "type": "string" }, "Audit.Disabled.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Disabled.By.Id": { "type": "string" }, "Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Created.ById": { "type": "string" }, "Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Created.By.Name": { "type": "string" }, "Audit.Created.By.Icon": { "type": "string" }, "Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Created.By.Id": { "type": "string" }, "Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Updated.ById": { "type": "string" }, "Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Updated.By.Name": { "type": "string" }, "Audit.Updated.By.Icon": { "type": "string" }, "Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Updated.By.Id": { "type": "string" }, "Id": { "type": "string" } }, "description": "Json representation of the buyer" }, "logo": { "type": "string", "format": "binary" } } }, "encoding": { "buyer": { "contentType": "application/json" }, "logo": { "contentType": "application/octet-stream" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuyerUpdate" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buyer" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Buyers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buyer" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/buyers/{id}/transfer": { "get": { "tags": [ "Buyers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "destinationAccountId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuyerTransferDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Buyers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BuyerTransfer" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BuyerTransfer" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BuyerTransfer" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buyer" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/buyers/{id}/validate": { "post": { "tags": [ "Buyers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BuyerValidate" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BuyerValidate" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BuyerValidate" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuyerValidate" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/buyers/{id}/synchronize": { "post": { "tags": [ "Buyers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buyer" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/buyers/{id}/icon": { "get": { "tags": [ "Buyers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "307": { "description": "Temporary Redirect" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/program/certificates": { "post": { "tags": [ "Certificate" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateCertificateRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateCertificateRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateCertificateRequest" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Certificate" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Certificate" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertificateListResponse" } } } } } } }, "/public/v1/program/certificates/{id}/terminate": { "post": { "tags": [ "Certificate" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TerminateCertificateRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TerminateCertificateRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TerminateCertificateRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Certificate" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/program/certificates/{id}": { "put": { "tags": [ "Certificate" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertificateUpdate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertificateUpdate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CertificateUpdate" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Certificate" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Certificate" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Certificate" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/program/certificates/{id}/render": { "get": { "tags": [ "Certificate" ], "summary": "Renders certificate template", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "language", "in": "query", "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/accounts/cloud-tenants": { "get": { "tags": [ "CloudTenants" ], "summary": "List cloud tenants", "description": "List cloud tenants.\nAvailable for Operations account with platform account management permissions.\nReturns a paged list of cloud tenants; supports RQL query parameters for filtering and selection.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudTenantListResponse" }, "example": { "data": [ { "id": "CLT-3206-7146", "revision": 2, "name": "AdAstraflex Germany", "status": "Active", "type": "CspAzure", "account": { "id": "ACC-2253-2884", "name": "AdAstrafleX" } } ], "$meta": { "pagination": { "offset": 0, "limit": 10, "total": 1 } } } } } } } }, "post": { "tags": [ "CloudTenants" ], "summary": "Create cloud tenant", "description": "Create cloud tenant.\nAvailable for Operations account with platform account management permissions.\nAccepts type, name, status, external IDs (pyraTenantId, cloudConsumptionId, providerId), and optional account reference.\nReturns the created cloud tenant object with revision 1.", "requestBody": { "description": "Cloud tenant payload.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateCloudTenantDto" } ] }, "example": { "type": "CspAzure", "name": "AdAstraflex Germany", "status": "Active", "externalIds": { "pyraTenantId": "c6469e97-302a-408a-8589-2122a0bb725d", "cloudConsumptionId": "012b2a18-1df0-473f-8759-c3c019b54486", "providerId": "7270638c-ca21-4500-ac82-25dca634566a" }, "account": { "id": "ACC-2253-2884" } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateCloudTenantDto" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateCloudTenantDto" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudTenant" }, "example": { "id": "CLT-3206-7146", "revision": 1, "name": "AdAstraflex Germany", "status": "Active", "type": "CspAzure", "account": { "id": "ACC-2253-2884", "name": "AdAstrafleX" }, "externalIds": { "pyraTenantId": "c6469e97-302a-408a-8589-2122a0bb725d", "cloudConsumptionId": "012b2a18-1df0-473f-8759-c3c019b54486", "providerId": "7270638c-ca21-4500-ac82-25dca634566a" }, "audit": { "created": { "at": "2024-02-01T09:12:23+00:00", "by": { "id": "TKN-9299-7556", "name": "Migration token" } }, "updated": { "at": "2024-02-01T09:12:23+00:00", "by": { "id": "TKN-9299-7556", "name": "Migration token" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/cloud-tenants/{id}": { "get": { "tags": [ "CloudTenants" ], "summary": "Get cloud tenant by ID", "description": "Get cloud tenant by ID.\nAvailable for Operations account with platform account management permissions.\nReturns a single cloud tenant with id, name, status, type, account, externalIds, and audit.\nOptional select query parameter controls which fields are returned.", "parameters": [ { "name": "id", "in": "path", "description": "Cloud tenant identifier.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional RQL select statement to limit returned fields.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudTenant" }, "example": { "id": "CLT-3206-7146", "revision": 2, "name": "AdAstraflex Germany", "status": "Active", "type": "CspAzure", "account": { "id": "ACC-2253-2884", "name": "AdAstrafleX" }, "externalIds": { "pyraTenantId": "c6469e97-302a-408a-8589-2122a0bb725d", "cloudConsumptionId": "012b2a18-1df0-473f-8759-c3c019b54486", "providerId": "7270638c-ca21-4500-ac82-25dca634566a" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "CloudTenants" ], "summary": "Delete cloud tenant", "description": "Delete cloud tenant.\nAvailable for Operations account with platform account management permissions.\nPermanently removes the cloud tenant record.\nReturns 204 No Content on success.", "parameters": [ { "name": "id", "in": "path", "description": "Cloud tenant identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "CloudTenants" ], "summary": "Update cloud tenant", "description": "Update cloud tenant.\nAvailable for Operations account with platform account management permissions.\nSupport partial update pattern (e.g. name, status).\nReturns the updated cloud tenant object.", "parameters": [ { "name": "id", "in": "path", "description": "Cloud tenant identifier.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Delta payload with updated fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudTenant" }, "example": { "name": "AdAstraflex Germany Updated", "status": "Active" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CloudTenant" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CloudTenant" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudTenant" }, "example": { "id": "CLT-3206-7146", "revision": 2, "name": "AdAstraflex Germany Updated", "status": "Active", "type": "CspAzure", "account": { "id": "ACC-2253-2884", "name": "AdAstrafleX" }, "externalIds": { "pyraTenantId": "c6469e97-302a-408a-8589-2122a0bb725d", "cloudConsumptionId": "012b2a18-1df0-473f-8759-c3c019b54486", "providerId": "7270638c-ca21-4500-ac82-25dca634566a" }, "audit": { "created": { "at": "2024-02-01T09:12:23+00:00", "by": { "id": "TKN-9299-7556", "name": "Migration token" } }, "updated": { "at": "2024-02-02T10:00:00+00:00", "by": { "id": "TKN-9299-7556", "name": "Migration token" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/catalog/products/{productId}/documents/{id}": { "get": { "tags": [ "Documents" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductDocument" } } } }, "301": { "description": "Moved Permanently" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Documents" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Documents" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductDocument" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProductDocument" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ProductDocument" } } } }, "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/catalog/products/{productId}/documents": { "post": { "tags": [ "Documents" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "document": { "type": "object", "properties": { "Name": { "type": "string" }, "Description": { "type": "string" }, "Language": { "type": "string" }, "DocumentType": { "allOf": [ { "$ref": "#/components/schemas/DocumentType" } ] }, "Url": { "type": "string" }, "DisplayOrder": { "type": "integer", "format": "int32" } }, "description": "Json representation of the document" }, "file": { "type": "string", "format": "binary" } } }, "encoding": { "document": { "contentType": "application/json" }, "file": { "contentType": "application/octet-stream" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Documents" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductDocumentListResponse" } } } } } } }, "/public/v1/catalog/products/{productId}/documents/{id}/review": { "post": { "tags": [ "Documents" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductDocument" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/catalog/products/{productId}/documents/{id}/publish": { "post": { "tags": [ "Documents" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductDocument" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/catalog/products/{productId}/documents/{id}/unpublish": { "post": { "tags": [ "Documents" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductDocument" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/program/enrollments": { "post": { "tags": [ "Enrollment" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateEnrollmentRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateEnrollmentRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateEnrollmentRequest" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Enrollment" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Enrollment" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrollmentListResponse" } } } } } } }, "/public/v1/program/enrollments/{id}/validate": { "post": { "tags": [ "Enrollment" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrollmentUpdate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EnrollmentUpdate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EnrollmentUpdate" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Enrollment" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/program/enrollments/{id}": { "put": { "tags": [ "Enrollment" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrollmentUpdate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EnrollmentUpdate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EnrollmentUpdate" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Enrollment" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Enrollment" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Enrollment" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Enrollment" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/program/enrollments/{id}/query": { "post": { "tags": [ "Enrollment" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/QueryEnrollmentRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/QueryEnrollmentRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/QueryEnrollmentRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Enrollment" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/program/enrollments/{id}/process": { "post": { "tags": [ "Enrollment" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProcessEnrollmentRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProcessEnrollmentRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProcessEnrollmentRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Enrollment" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/program/enrollments/{id}/complete": { "post": { "tags": [ "Enrollment" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompleteEnrollment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompleteEnrollment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CompleteEnrollment" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Enrollment" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/program/enrollments/{id}/submit": { "post": { "tags": [ "Enrollment" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Enrollment" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/program/enrollments/{id}/fail": { "post": { "tags": [ "Enrollment" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FailEnrollmentRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FailEnrollmentRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FailEnrollmentRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Enrollment" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/program/enrollments/{id}/render": { "get": { "tags": [ "Enrollment" ], "summary": "Renders enrollment template", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "language", "in": "query", "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/program/enrollments/{enrollmentId}/attachments/{id}": { "get": { "tags": [ "EnrollmentAttachments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "enrollmentId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrollmentAttachment" } } } }, "301": { "description": "Moved Permanently" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "EnrollmentAttachments" ], "parameters": [ { "name": "enrollmentId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "EnrollmentAttachments" ], "parameters": [ { "name": "enrollmentId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrollmentAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EnrollmentAttachment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EnrollmentAttachment" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrollmentAttachment" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/program/enrollments/{enrollmentId}/attachments": { "post": { "tags": [ "EnrollmentAttachments" ], "parameters": [ { "name": "enrollmentId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "attachment": { "type": "object", "properties": { "Name": { "type": "string" }, "Description": { "type": "string" } }, "description": "Json representation of the attachment" }, "file": { "type": "string", "format": "binary" } } }, "encoding": { "attachment": { "contentType": "application/json" }, "file": { "contentType": "application/octet-stream" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrollmentAttachment" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "EnrollmentAttachments" ], "parameters": [ { "name": "enrollmentId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrollmentAttachmentListResponse" } } } } } } }, "/public/v1/accounts/erp-links": { "get": { "tags": [ "ErpLinks" ], "summary": "List ERP links", "description": "List ERP links.\nAvailable for Operations account with platform account management permissions.\nReturns a paged list of ERP links; supports RQL query parameters for filtering and selection.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErpLinkListResponse" }, "example": { "data": [ { "id": "ERP-0808-7934-2576", "revision": 2, "name": "AGCO Corporation - SoftwareONE Argentina", "status": "Active", "companyName": "AGCO Corporation", "buyer": { "id": "BUY-0808-7934", "name": "AGCO Corporation" }, "seller": { "id": "SEL-1968-2576", "name": "SoftwareONE Argentina" } } ], "$meta": { "pagination": { "offset": 0, "limit": 10, "total": 1 } } } } } } } } }, "/public/v1/accounts/erp-links/{id}": { "get": { "tags": [ "ErpLinks" ], "summary": "Get ERP link by ID", "description": "Get ERP link by ID.\nAvailable for Operations account with platform account management permissions.\nReturns a single ERP link with buyer, seller, externalIds, address, and audit.\nOptional select query parameter controls which fields are returned.", "parameters": [ { "name": "id", "in": "path", "description": "ERP link identifier.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional RQL select statement to limit returned fields.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErpLink" }, "example": { "id": "ERP-0808-7934-2576", "revision": 2, "name": "AGCO Corporation - SoftwareONE Argentina", "status": "Active", "companyName": "AGCO Corporation", "buyer": { "id": "BUY-0808-7934", "name": "AGCO Corporation" }, "seller": { "id": "SEL-1968-2576", "name": "SoftwareONE Argentina", "icon": "/v1/accounts/sellers/SEL-1968-2576/icon" }, "externalIds": { "erpCompanyContact": "US-CON-183485", "erpCustomer": "US-SCU-117126", "accountExternalId": "WW-100502" }, "address": { "addressLine1": "4205 River Green Pkwy", "postCode": "30096", "city": "DULUTH", "state": "GA", "country": "US" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "ErpLinks" ], "summary": "Update ERP link", "description": "Update ERP link.\nAvailable for Operations account with platform account management permissions.\nAccepts application/json or multipart/form-data (with optional icon).\nUse JSON for field updates and multipart when uploading an icon.\nUpdates ERP link fields such as note, externalIds, or address.\nReturns the updated ERP link object.", "parameters": [ { "name": "id", "in": "path", "description": "ERP link identifier.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "erpLink": { "type": "object", "properties": { "ErpLink.Node.Name": { "type": "string" }, "ErpLink.Node.Children": { "type": "array", "items": { "$ref": "#/components/schemas/DeltaNode" } }, "ErpLink.Path": { "type": "string" }, "ErpLink.Data.Buyer.ExternalIds.ErpCompanyContact": { "type": "string" }, "ErpLink.Data.Buyer.ExternalIds.ErpCustomer": { "type": "string" }, "ErpLink.Data.Buyer.ExternalIds.AccountExternalId": { "type": "string" }, "ErpLink.Data.Buyer.Status": { "allOf": [ { "$ref": "#/components/schemas/BuyerStatus" } ] }, "ErpLink.Data.Buyer.Address.AddressLine1": { "type": "string" }, "ErpLink.Data.Buyer.Address.AddressLine2": { "type": "string" }, "ErpLink.Data.Buyer.Address.PostCode": { "type": "string" }, "ErpLink.Data.Buyer.Address.City": { "type": "string" }, "ErpLink.Data.Buyer.Address.State": { "type": "string" }, "ErpLink.Data.Buyer.Address.Country": { "type": "string" }, "ErpLink.Data.Buyer.TaxId": { "type": "string" }, "ErpLink.Data.Buyer.Account.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "ErpLink.Data.Buyer.Account.ExternalId": { "type": "string" }, "ErpLink.Data.Buyer.Account.ExternalName": { "type": "string" }, "ErpLink.Data.Buyer.Account.Address.AddressLine1": { "type": "string" }, "ErpLink.Data.Buyer.Account.Address.AddressLine2": { "type": "string" }, "ErpLink.Data.Buyer.Account.Address.PostCode": { "type": "string" }, "ErpLink.Data.Buyer.Account.Address.City": { "type": "string" }, "ErpLink.Data.Buyer.Account.Address.State": { "type": "string" }, "ErpLink.Data.Buyer.Account.Address.Country": { "type": "string" }, "ErpLink.Data.Buyer.Account.TechnicalSupportEmail": { "type": "string" }, "ErpLink.Data.Buyer.Account.Website": { "type": "string" }, "ErpLink.Data.Buyer.Account.Description": { "type": "string" }, "ErpLink.Data.Buyer.Account.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "ErpLink.Data.Buyer.Account.Eligibility.Client": { "type": "boolean" }, "ErpLink.Data.Buyer.Account.Eligibility.Partner": { "type": "boolean" }, "ErpLink.Data.Buyer.Account.DefaultLanguageCode": { "type": "string" }, "ErpLink.Data.Buyer.Account.Type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ] }, "ErpLink.Data.Buyer.Account.Status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ] }, "ErpLink.Data.Buyer.Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Buyer.Account.Name": { "type": "string" }, "ErpLink.Data.Buyer.Account.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Account.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Account.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Account.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Buyer.Account.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Buyer.Account.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Buyer.Account.Audit.Created.By.Name": { "type": "string" }, "ErpLink.Data.Buyer.Account.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Account.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Account.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "ErpLink.Data.Buyer.Account.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Account.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Buyer.Account.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Buyer.Account.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Account.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Account.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Buyer.Account.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Buyer.Account.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Buyer.Account.Audit.Updated.By.Name": { "type": "string" }, "ErpLink.Data.Buyer.Account.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Account.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Account.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Account.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Buyer.Account.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Buyer.Account.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "ErpLink.Data.Buyer.Account.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Account.Id": { "type": "string" }, "ErpLink.Data.Buyer.Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ParametrisedMessage" } }, "ErpLink.Data.Buyer.Sellers": { "type": "array", "items": { "$ref": "#/components/schemas/Seller" } }, "ErpLink.Data.Buyer.ErpLinks": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLink" } }, "ErpLink.Data.Buyer.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Buyer.Name": { "type": "string" }, "ErpLink.Data.Buyer.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Audit.Activated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Audit.Activated.ById": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Activated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Buyer.Audit.Activated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Buyer.Audit.Activated.By.Name": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Activated.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Activated.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Audit.Activated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Audit.Activated.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Activated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Buyer.Audit.Activated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Audit.Activated.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Activated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Buyer.Audit.Activated.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Unassigned.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Audit.Unassigned.ById": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Unassigned.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Buyer.Audit.Unassigned.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Buyer.Audit.Unassigned.By.Name": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Unassigned.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Unassigned.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Audit.Unassigned.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Audit.Unassigned.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Unassigned.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Buyer.Audit.Unassigned.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Audit.Unassigned.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Unassigned.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Buyer.Audit.Unassigned.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Disabled.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Audit.Disabled.ById": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Disabled.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Buyer.Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Buyer.Audit.Disabled.By.Name": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Disabled.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Disabled.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Audit.Disabled.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Audit.Disabled.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Disabled.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Buyer.Audit.Disabled.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Audit.Disabled.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Disabled.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Buyer.Audit.Disabled.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Buyer.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Buyer.Audit.Created.By.Name": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Buyer.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Buyer.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Buyer.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Buyer.Audit.Updated.By.Name": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Buyer.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Buyer.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Id": { "type": "string" }, "ErpLink.Data.Seller.ExternalId": { "type": "string" }, "ErpLink.Data.Seller.Status": { "allOf": [ { "$ref": "#/components/schemas/SellerStatus" } ] }, "ErpLink.Data.Seller.Currencies": { "type": "array", "items": { "$ref": "#/components/schemas/SellerCurrency" } }, "ErpLink.Data.Seller.Address.AddressLine1": { "type": "string" }, "ErpLink.Data.Seller.Address.AddressLine2": { "type": "string" }, "ErpLink.Data.Seller.Address.PostCode": { "type": "string" }, "ErpLink.Data.Seller.Address.City": { "type": "string" }, "ErpLink.Data.Seller.Address.State": { "type": "string" }, "ErpLink.Data.Seller.Address.Country": { "type": "string" }, "ErpLink.Data.Seller.Buyers": { "type": "array", "items": { "$ref": "#/components/schemas/Buyer" } }, "ErpLink.Data.Seller.ErpLink.Buyer.ExternalIds.ErpCompanyContact": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.ExternalIds.ErpCustomer": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.ExternalIds.AccountExternalId": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Status": { "allOf": [ { "$ref": "#/components/schemas/BuyerStatus" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Address.AddressLine1": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Address.AddressLine2": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Address.PostCode": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Address.City": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Address.State": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Address.Country": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.TaxId": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.ExternalId": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.ExternalName": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Address.AddressLine1": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Address.AddressLine2": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Address.PostCode": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Address.City": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Address.State": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Address.Country": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.TechnicalSupportEmail": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Website": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Description": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Eligibility.Client": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Eligibility.Partner": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.DefaultLanguageCode": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Created.By.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.By.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ParametrisedMessage" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Sellers": { "type": "array", "items": { "$ref": "#/components/schemas/Seller" } }, "ErpLink.Data.Seller.ErpLink.Buyer.ErpLinks": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLink" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.By.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.By.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.By.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.By.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.By.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Seller": { "allOf": [ { "$ref": "#/components/schemas/Seller" } ] }, "ErpLink.Data.Seller.ErpLink.BuyerId": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.SellerId": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.CompanyName": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Status": { "allOf": [ { "$ref": "#/components/schemas/ErpLinkStatus" } ] }, "ErpLink.Data.Seller.ErpLink.Note": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.ExternalIds.ErpCompanyContact": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.ExternalIds.ErpCustomer": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.ExternalIds.AccountExternalId": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Address.AddressLine1": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Address.AddressLine2": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Address.PostCode": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Address.City": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Address.State": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Address.Country": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.ShipTo": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLinkAddress" } }, "ErpLink.Data.Seller.ErpLink.BillTo": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLinkAddress" } }, "ErpLink.Data.Seller.ErpLink.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.By.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.By.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Seller.ErpLink.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Audit.Created.By.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.By.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Id": { "type": "string" }, "ErpLink.Data.Seller.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.Name": { "type": "string" }, "ErpLink.Data.Seller.Icon": { "type": "string" }, "ErpLink.Data.Seller.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Seller.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.Audit.Created.By.Name": { "type": "string" }, "ErpLink.Data.Seller.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "ErpLink.Data.Seller.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Seller.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Seller.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.Audit.Updated.By.Name": { "type": "string" }, "ErpLink.Data.Seller.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "ErpLink.Data.Seller.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Seller.Id": { "type": "string" }, "ErpLink.Data.BuyerId": { "type": "string" }, "ErpLink.Data.SellerId": { "type": "string" }, "ErpLink.Data.CompanyName": { "type": "string" }, "ErpLink.Data.Status": { "allOf": [ { "$ref": "#/components/schemas/ErpLinkStatus" } ] }, "ErpLink.Data.Note": { "type": "string" }, "ErpLink.Data.ExternalIds.ErpCompanyContact": { "type": "string" }, "ErpLink.Data.ExternalIds.ErpCustomer": { "type": "string" }, "ErpLink.Data.ExternalIds.AccountExternalId": { "type": "string" }, "ErpLink.Data.Address.AddressLine1": { "type": "string" }, "ErpLink.Data.Address.AddressLine2": { "type": "string" }, "ErpLink.Data.Address.PostCode": { "type": "string" }, "ErpLink.Data.Address.City": { "type": "string" }, "ErpLink.Data.Address.State": { "type": "string" }, "ErpLink.Data.Address.Country": { "type": "string" }, "ErpLink.Data.ShipTo": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLinkAddress" } }, "ErpLink.Data.BillTo": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLinkAddress" } }, "ErpLink.Data.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Name": { "type": "string" }, "ErpLink.Data.Icon": { "type": "string" }, "ErpLink.Data.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Audit.Blocked.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Audit.Blocked.ById": { "type": "string" }, "ErpLink.Data.Audit.Blocked.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Audit.Blocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Audit.Blocked.By.Name": { "type": "string" }, "ErpLink.Data.Audit.Blocked.By.Icon": { "type": "string" }, "ErpLink.Data.Audit.Blocked.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Audit.Blocked.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Audit.Blocked.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Audit.Blocked.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Audit.Blocked.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Audit.Blocked.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Audit.Blocked.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Audit.Blocked.By.Id": { "type": "string" }, "ErpLink.Data.Audit.Unblocked.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Audit.Unblocked.ById": { "type": "string" }, "ErpLink.Data.Audit.Unblocked.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Audit.Unblocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Audit.Unblocked.By.Name": { "type": "string" }, "ErpLink.Data.Audit.Unblocked.By.Icon": { "type": "string" }, "ErpLink.Data.Audit.Unblocked.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Audit.Unblocked.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Audit.Unblocked.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Audit.Unblocked.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Audit.Unblocked.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Audit.Unblocked.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Audit.Unblocked.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Audit.Unblocked.By.Id": { "type": "string" }, "ErpLink.Data.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Audit.Created.By.Name": { "type": "string" }, "ErpLink.Data.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Audit.Updated.By.Name": { "type": "string" }, "ErpLink.Data.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Id": { "type": "string" }, "ErpLink.IsDefined": { "type": "boolean" } }, "description": "Json representation of the erpLink" }, "logo": { "type": "string", "format": "binary" } } }, "encoding": { "erpLink": { "contentType": "application/json" }, "logo": { "contentType": "application/octet-stream" } } }, "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "audit": { "allOf": [ { "$ref": "#/components/schemas/ErpLinkAudit" } ] }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string" }, "icon": { "type": "string", "nullable": true }, "revision": { "type": "integer", "format": "int32" }, "buyer": { "allOf": [ { "$ref": "#/components/schemas/Buyer" } ] }, "seller": { "allOf": [ { "$ref": "#/components/schemas/Seller" } ] }, "companyName": { "type": "string", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/ErpLinkStatus" } ] }, "note": { "type": "string", "nullable": true }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/BuyerExternalIds" } ], "nullable": true }, "address": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "nullable": true }, "shipTo": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLinkAddress" }, "nullable": true }, "billTo": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLinkAddress" }, "nullable": true } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErpLink" }, "example": { "id": "ERP-0808-7934-2576", "revision": 2, "name": "AGCO Corporation - SoftwareONE Argentina", "status": "Active", "note": "Blocked due to validation", "audit": { "created": { "at": "2024-01-21T12:27:31+00:00", "by": { "id": "TKN-4113-7170", "name": "Navision Extension" } }, "updated": { "at": "2024-02-02T10:05:00+00:00", "by": { "id": "USR-0001", "name": "Ops User" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/erp-links/{id}/block": { "post": { "tags": [ "ErpLinks" ], "summary": "Block ERP link", "description": "Block ERP link.\nMoves the ERP link status to Blocked.\nAvailable for Operations account with platform account management permissions.\nReturns the updated ERP link object.", "parameters": [ { "name": "id", "in": "path", "description": "ERP link identifier.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Delta payload with updated fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErpLink" }, "example": { "note": "Blocked due to validation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErpLink" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ErpLink" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErpLink" }, "example": { "id": "ERP-0808-7934-2576", "revision": 2, "name": "AGCO Corporation - SoftwareONE Argentina", "status": "Blocked", "note": "Blocked due to validation", "audit": { "created": { "at": "2024-01-21T12:27:31+00:00", "by": { "id": "TKN-4113-7170", "name": "Navision Extension" } }, "updated": { "at": "2024-02-02T10:10:00+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "blocked": { "at": "2024-02-02T10:10:00+00:00", "by": { "id": "USR-0001", "name": "Ops User" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/erp-links/{id}/unblock": { "post": { "tags": [ "ErpLinks" ], "summary": "Unblock ERP link", "description": "Unblock ERP link.\nMoves the ERP link status to Active.\nAvailable for Operations account with platform account management permissions.\nReturns the updated ERP link object.", "parameters": [ { "name": "id", "in": "path", "description": "ERP link identifier.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Delta payload with updated fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErpLink" }, "example": { "note": "Unblocked after review" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErpLink" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ErpLink" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErpLink" }, "example": { "id": "ERP-0808-7934-2576", "revision": 2, "name": "AGCO Corporation - SoftwareONE Argentina", "status": "Active", "note": "Unblocked after review", "audit": { "created": { "at": "2024-01-21T12:27:31+00:00", "by": { "id": "TKN-4113-7170", "name": "Navision Extension" } }, "updated": { "at": "2024-02-02T10:15:00+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "blocked": { "at": "2024-02-02T15:15:00+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "unblocked": { "at": "2024-02-02T20:15:00+00:00", "by": { "id": "USR-0001", "name": "Ops User" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/catalog/products/{productId}/item-groups": { "post": { "tags": [ "ItemGroups" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateItemGroupRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateItemGroupRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateItemGroupRequest" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemGroup" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "ItemGroups" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemGroupListResponse" } } } } } } }, "/public/v1/catalog/products/{productId}/item-groups/{id}": { "put": { "tags": [ "ItemGroups" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateItemGroupRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateItemGroupRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateItemGroupRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemGroup" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "ItemGroups" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "ItemGroups" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemGroup" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/licensees": { "get": { "tags": [ "Licensees" ], "summary": "List licensees", "description": "List licensees.\nAvailable for Client and Operations accounts.\nReturns a paged list of licensees; supports RQL query parameters for filtering and selection.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicenseeListResponse" }, "example": { "data": [ { "id": "LCE-8893-6916-0000", "revision": 2, "name": "Rolls-Royce Canada Limited", "status": "Active", "buyer": { "id": "BUY-8928-0965", "name": "Rolls-Royce Canada Limited" }, "seller": { "id": "SEL-4717-3953", "name": "SoftwareOne Canada, Inc." } } ], "$meta": { "pagination": { "offset": 0, "limit": 10, "total": 1 } } } } } } } }, "post": { "tags": [ "Licensees" ], "summary": "Create licensee", "description": "Create licensee.\nAvailable for Client and Operations accounts.\nAccepts application/json or multipart/form-data (with optional icon).\nCreates a licensee to link Buyer and Seller.\nReturns the created licensee object.", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "licensee": { "type": "object", "properties": { "ExternalId": { "type": "string" }, "Status": { "allOf": [ { "$ref": "#/components/schemas/LicenseeStatus" } ] }, "Address.AddressLine1": { "type": "string" }, "Address.AddressLine2": { "type": "string" }, "Address.PostCode": { "type": "string" }, "Address.City": { "type": "string" }, "Address.State": { "type": "string" }, "Address.Country": { "type": "string" }, "UseBuyerAddress": { "type": "boolean" }, "Description": { "type": "string" }, "Account.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Account.ExternalId": { "type": "string" }, "Account.ExternalName": { "type": "string" }, "Account.Address.AddressLine1": { "type": "string" }, "Account.Address.AddressLine2": { "type": "string" }, "Account.Address.PostCode": { "type": "string" }, "Account.Address.City": { "type": "string" }, "Account.Address.State": { "type": "string" }, "Account.Address.Country": { "type": "string" }, "Account.TechnicalSupportEmail": { "type": "string" }, "Account.Website": { "type": "string" }, "Account.Description": { "type": "string" }, "Account.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Account.Eligibility.Client": { "type": "boolean" }, "Account.Eligibility.Partner": { "type": "boolean" }, "Account.DefaultLanguageCode": { "type": "string" }, "Account.Type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ] }, "Account.Status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ] }, "Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Name": { "type": "string" }, "Account.Icon": { "type": "string" }, "Account.Revision": { "type": "integer", "format": "int32" }, "Account.Audit.Created.At": { "type": "string", "format": "date-time" }, "Account.Audit.Created.ById": { "type": "string" }, "Account.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Account.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Audit.Created.By.Name": { "type": "string" }, "Account.Audit.Created.By.Icon": { "type": "string" }, "Account.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Account.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Account.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Account.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Account.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Account.Audit.Created.By.Id": { "type": "string" }, "Account.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Account.Audit.Updated.ById": { "type": "string" }, "Account.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Account.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Audit.Updated.By.Name": { "type": "string" }, "Account.Audit.Updated.By.Icon": { "type": "string" }, "Account.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Account.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Account.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Account.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Account.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Account.Audit.Updated.By.Id": { "type": "string" }, "Account.Id": { "type": "string" }, "Buyer.ExternalIds.ErpCompanyContact": { "type": "string" }, "Buyer.ExternalIds.ErpCustomer": { "type": "string" }, "Buyer.ExternalIds.AccountExternalId": { "type": "string" }, "Buyer.Status": { "allOf": [ { "$ref": "#/components/schemas/BuyerStatus" } ] }, "Buyer.Address.AddressLine1": { "type": "string" }, "Buyer.Address.AddressLine2": { "type": "string" }, "Buyer.Address.PostCode": { "type": "string" }, "Buyer.Address.City": { "type": "string" }, "Buyer.Address.State": { "type": "string" }, "Buyer.Address.Country": { "type": "string" }, "Buyer.TaxId": { "type": "string" }, "Buyer.Account.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Buyer.Account.ExternalId": { "type": "string" }, "Buyer.Account.ExternalName": { "type": "string" }, "Buyer.Account.Address.AddressLine1": { "type": "string" }, "Buyer.Account.Address.AddressLine2": { "type": "string" }, "Buyer.Account.Address.PostCode": { "type": "string" }, "Buyer.Account.Address.City": { "type": "string" }, "Buyer.Account.Address.State": { "type": "string" }, "Buyer.Account.Address.Country": { "type": "string" }, "Buyer.Account.TechnicalSupportEmail": { "type": "string" }, "Buyer.Account.Website": { "type": "string" }, "Buyer.Account.Description": { "type": "string" }, "Buyer.Account.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Buyer.Account.Eligibility.Client": { "type": "boolean" }, "Buyer.Account.Eligibility.Partner": { "type": "boolean" }, "Buyer.Account.DefaultLanguageCode": { "type": "string" }, "Buyer.Account.Type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ] }, "Buyer.Account.Status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ] }, "Buyer.Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Account.Name": { "type": "string" }, "Buyer.Account.Icon": { "type": "string" }, "Buyer.Account.Revision": { "type": "integer", "format": "int32" }, "Buyer.Account.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Account.Audit.Created.ById": { "type": "string" }, "Buyer.Account.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Buyer.Account.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Account.Audit.Created.By.Name": { "type": "string" }, "Buyer.Account.Audit.Created.By.Icon": { "type": "string" }, "Buyer.Account.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Buyer.Account.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Buyer.Account.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Account.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Account.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Account.Audit.Created.By.Id": { "type": "string" }, "Buyer.Account.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Account.Audit.Updated.ById": { "type": "string" }, "Buyer.Account.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Buyer.Account.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Account.Audit.Updated.By.Name": { "type": "string" }, "Buyer.Account.Audit.Updated.By.Icon": { "type": "string" }, "Buyer.Account.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Buyer.Account.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Account.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Buyer.Account.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Account.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Buyer.Account.Audit.Updated.By.Id": { "type": "string" }, "Buyer.Account.Id": { "type": "string" }, "Buyer.Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ParametrisedMessage" } }, "Buyer.Sellers": { "type": "array", "items": { "$ref": "#/components/schemas/Seller" } }, "Buyer.ErpLinks": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLink" } }, "Buyer.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Name": { "type": "string" }, "Buyer.Icon": { "type": "string" }, "Buyer.Revision": { "type": "integer", "format": "int32" }, "Buyer.Audit.Activated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Activated.ById": { "type": "string" }, "Buyer.Audit.Activated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Buyer.Audit.Activated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Audit.Activated.By.Name": { "type": "string" }, "Buyer.Audit.Activated.By.Icon": { "type": "string" }, "Buyer.Audit.Activated.By.Revision": { "type": "integer", "format": "int32" }, "Buyer.Audit.Activated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Activated.By.Audit.Created.ById": { "type": "string" }, "Buyer.Audit.Activated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Activated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Activated.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Audit.Activated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Activated.By.Id": { "type": "string" }, "Buyer.Audit.Unassigned.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Unassigned.ById": { "type": "string" }, "Buyer.Audit.Unassigned.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Buyer.Audit.Unassigned.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Audit.Unassigned.By.Name": { "type": "string" }, "Buyer.Audit.Unassigned.By.Icon": { "type": "string" }, "Buyer.Audit.Unassigned.By.Revision": { "type": "integer", "format": "int32" }, "Buyer.Audit.Unassigned.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Unassigned.By.Audit.Created.ById": { "type": "string" }, "Buyer.Audit.Unassigned.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Unassigned.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Unassigned.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Audit.Unassigned.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Unassigned.By.Id": { "type": "string" }, "Buyer.Audit.Disabled.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Disabled.ById": { "type": "string" }, "Buyer.Audit.Disabled.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Buyer.Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Audit.Disabled.By.Name": { "type": "string" }, "Buyer.Audit.Disabled.By.Icon": { "type": "string" }, "Buyer.Audit.Disabled.By.Revision": { "type": "integer", "format": "int32" }, "Buyer.Audit.Disabled.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Disabled.By.Audit.Created.ById": { "type": "string" }, "Buyer.Audit.Disabled.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Disabled.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Disabled.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Audit.Disabled.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Disabled.By.Id": { "type": "string" }, "Buyer.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Created.ById": { "type": "string" }, "Buyer.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Buyer.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Audit.Created.By.Name": { "type": "string" }, "Buyer.Audit.Created.By.Icon": { "type": "string" }, "Buyer.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Buyer.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Buyer.Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Created.By.Id": { "type": "string" }, "Buyer.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Updated.ById": { "type": "string" }, "Buyer.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Buyer.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Audit.Updated.By.Name": { "type": "string" }, "Buyer.Audit.Updated.By.Icon": { "type": "string" }, "Buyer.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Buyer.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Buyer.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Updated.By.Id": { "type": "string" }, "Buyer.Id": { "type": "string" }, "Seller.ExternalId": { "type": "string" }, "Seller.Status": { "allOf": [ { "$ref": "#/components/schemas/SellerStatus" } ] }, "Seller.Currencies": { "type": "array", "items": { "$ref": "#/components/schemas/SellerCurrency" } }, "Seller.Address.AddressLine1": { "type": "string" }, "Seller.Address.AddressLine2": { "type": "string" }, "Seller.Address.PostCode": { "type": "string" }, "Seller.Address.City": { "type": "string" }, "Seller.Address.State": { "type": "string" }, "Seller.Address.Country": { "type": "string" }, "Seller.Buyers": { "type": "array", "items": { "$ref": "#/components/schemas/Buyer" } }, "Seller.ErpLink.Buyer.ExternalIds.ErpCompanyContact": { "type": "string" }, "Seller.ErpLink.Buyer.ExternalIds.ErpCustomer": { "type": "string" }, "Seller.ErpLink.Buyer.ExternalIds.AccountExternalId": { "type": "string" }, "Seller.ErpLink.Buyer.Status": { "allOf": [ { "$ref": "#/components/schemas/BuyerStatus" } ] }, "Seller.ErpLink.Buyer.Address.AddressLine1": { "type": "string" }, "Seller.ErpLink.Buyer.Address.AddressLine2": { "type": "string" }, "Seller.ErpLink.Buyer.Address.PostCode": { "type": "string" }, "Seller.ErpLink.Buyer.Address.City": { "type": "string" }, "Seller.ErpLink.Buyer.Address.State": { "type": "string" }, "Seller.ErpLink.Buyer.Address.Country": { "type": "string" }, "Seller.ErpLink.Buyer.TaxId": { "type": "string" }, "Seller.ErpLink.Buyer.Account.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Seller.ErpLink.Buyer.Account.ExternalId": { "type": "string" }, "Seller.ErpLink.Buyer.Account.ExternalName": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Address.AddressLine1": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Address.AddressLine2": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Address.PostCode": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Address.City": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Address.State": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Address.Country": { "type": "string" }, "Seller.ErpLink.Buyer.Account.TechnicalSupportEmail": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Website": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Description": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Seller.ErpLink.Buyer.Account.Eligibility.Client": { "type": "boolean" }, "Seller.ErpLink.Buyer.Account.Eligibility.Partner": { "type": "boolean" }, "Seller.ErpLink.Buyer.Account.DefaultLanguageCode": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ] }, "Seller.ErpLink.Buyer.Account.Status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ] }, "Seller.ErpLink.Buyer.Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Account.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Account.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Account.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ParametrisedMessage" } }, "Seller.ErpLink.Buyer.Sellers": { "type": "array", "items": { "$ref": "#/components/schemas/Seller" } }, "Seller.ErpLink.Buyer.ErpLinks": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLink" } }, "Seller.ErpLink.Buyer.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Audit.Activated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Activated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Buyer.Audit.Activated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Audit.Activated.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Activated.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Unassigned.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Disabled.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Buyer.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Audit.Created.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Buyer.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Audit.Updated.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Id": { "type": "string" }, "Seller.ErpLink.Seller.ExternalId": { "type": "string" }, "Seller.ErpLink.Seller.Status": { "allOf": [ { "$ref": "#/components/schemas/SellerStatus" } ] }, "Seller.ErpLink.Seller.Currencies": { "type": "array", "items": { "$ref": "#/components/schemas/SellerCurrency" } }, "Seller.ErpLink.Seller.Address.AddressLine1": { "type": "string" }, "Seller.ErpLink.Seller.Address.AddressLine2": { "type": "string" }, "Seller.ErpLink.Seller.Address.PostCode": { "type": "string" }, "Seller.ErpLink.Seller.Address.City": { "type": "string" }, "Seller.ErpLink.Seller.Address.State": { "type": "string" }, "Seller.ErpLink.Seller.Address.Country": { "type": "string" }, "Seller.ErpLink.Seller.Buyers": { "type": "array", "items": { "$ref": "#/components/schemas/Buyer" } }, "Seller.ErpLink.Seller.ErpLink": { "allOf": [ { "$ref": "#/components/schemas/ErpLink" } ] }, "Seller.ErpLink.Seller.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Seller.Name": { "type": "string" }, "Seller.ErpLink.Seller.Icon": { "type": "string" }, "Seller.ErpLink.Seller.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Seller.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Seller.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Seller.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Seller.Audit.Created.By.Name": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Seller.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.ErpLink.Seller.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Seller.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Seller.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Seller.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Seller.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Seller.Audit.Updated.By.Name": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Seller.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Seller.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Seller.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.ErpLink.Seller.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Seller.Id": { "type": "string" }, "Seller.ErpLink.BuyerId": { "type": "string" }, "Seller.ErpLink.SellerId": { "type": "string" }, "Seller.ErpLink.CompanyName": { "type": "string" }, "Seller.ErpLink.Status": { "allOf": [ { "$ref": "#/components/schemas/ErpLinkStatus" } ] }, "Seller.ErpLink.Note": { "type": "string" }, "Seller.ErpLink.ExternalIds.ErpCompanyContact": { "type": "string" }, "Seller.ErpLink.ExternalIds.ErpCustomer": { "type": "string" }, "Seller.ErpLink.ExternalIds.AccountExternalId": { "type": "string" }, "Seller.ErpLink.Address.AddressLine1": { "type": "string" }, "Seller.ErpLink.Address.AddressLine2": { "type": "string" }, "Seller.ErpLink.Address.PostCode": { "type": "string" }, "Seller.ErpLink.Address.City": { "type": "string" }, "Seller.ErpLink.Address.State": { "type": "string" }, "Seller.ErpLink.Address.Country": { "type": "string" }, "Seller.ErpLink.ShipTo": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLinkAddress" } }, "Seller.ErpLink.BillTo": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLinkAddress" } }, "Seller.ErpLink.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Name": { "type": "string" }, "Seller.ErpLink.Icon": { "type": "string" }, "Seller.ErpLink.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Audit.Blocked.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Blocked.ById": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Audit.Blocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Audit.Blocked.By.Name": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.Icon": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Audit.Blocked.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Blocked.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Audit.Blocked.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Blocked.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Audit.Blocked.By.Id": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Unblocked.ById": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Audit.Unblocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Audit.Unblocked.By.Name": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.Icon": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Audit.Unblocked.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Unblocked.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Audit.Unblocked.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Unblocked.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Audit.Unblocked.By.Id": { "type": "string" }, "Seller.ErpLink.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Audit.Created.By.Name": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Audit.Updated.By.Name": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Id": { "type": "string" }, "Seller.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Name": { "type": "string" }, "Seller.Icon": { "type": "string" }, "Seller.Revision": { "type": "integer", "format": "int32" }, "Seller.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Audit.Created.ById": { "type": "string" }, "Seller.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Audit.Created.By.Name": { "type": "string" }, "Seller.Audit.Created.By.Icon": { "type": "string" }, "Seller.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Audit.Created.By.Id": { "type": "string" }, "Seller.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Audit.Updated.ById": { "type": "string" }, "Seller.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Audit.Updated.By.Name": { "type": "string" }, "Seller.Audit.Updated.By.Icon": { "type": "string" }, "Seller.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.Audit.Updated.By.Id": { "type": "string" }, "Seller.Id": { "type": "string" }, "Eligibility.Client": { "type": "boolean" }, "Eligibility.Partner": { "type": "boolean" }, "Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Name": { "type": "string" }, "Icon": { "type": "string" }, "Revision": { "type": "integer", "format": "int32" }, "Audit.Disabled.At": { "type": "string", "format": "date-time" }, "Audit.Disabled.ById": { "type": "string" }, "Audit.Disabled.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Disabled.By.Name": { "type": "string" }, "Audit.Disabled.By.Icon": { "type": "string" }, "Audit.Disabled.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Disabled.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Disabled.By.Audit.Created.ById": { "type": "string" }, "Audit.Disabled.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Disabled.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Disabled.By.Audit.Updated.ById": { "type": "string" }, "Audit.Disabled.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Disabled.By.Id": { "type": "string" }, "Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Created.ById": { "type": "string" }, "Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Created.By.Name": { "type": "string" }, "Audit.Created.By.Icon": { "type": "string" }, "Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Created.By.Id": { "type": "string" }, "Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Updated.ById": { "type": "string" }, "Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Updated.By.Name": { "type": "string" }, "Audit.Updated.By.Icon": { "type": "string" }, "Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Updated.By.Id": { "type": "string" }, "Id": { "type": "string" } }, "description": "Json representation of the licensee" }, "logo": { "type": "string", "format": "binary" } } }, "encoding": { "licensee": { "contentType": "application/json" }, "logo": { "contentType": "application/octet-stream" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/LicenseeCreate" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Licensee" }, "example": { "id": "LCE-8893-6916-0000", "revision": 1, "name": "Rolls-Royce Canada Limited", "status": "Active", "icon": "/static/accounts/LCE-8893-6916-0000/logo.png", "audit": { "created": { "at": "2024-02-01T09:12:23+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "updated": { "at": "2024-02-01T09:12:23+00:00", "by": { "id": "USR-0001", "name": "Ops User" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/licensees/{id}": { "get": { "tags": [ "Licensees" ], "summary": "Get licensee by ID", "description": "Get licensee by ID.\nAvailable for Client and Operations accounts.\nReturns a single licensee with buyer, seller, address, and audit.\nOptional select query parameter controls which fields are returned.", "parameters": [ { "name": "id", "in": "path", "description": "Licensee identifier.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional RQL select statement to limit returned fields.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Licensee" }, "example": { "id": "LCE-8893-6916-0000", "revision": 2, "name": "Rolls-Royce Canada Limited", "externalId": "WW-CON-12345678", "status": "Active", "buyer": { "id": "BUY-8928-0965", "name": "Rolls-Royce Canada Limited" }, "seller": { "id": "SEL-4717-3953", "name": "SoftwareOne Canada, Inc." }, "address": { "addressLine1": "123 Main Street", "postCode": "12345", "city": "Cityville", "state": "S", "country": "ST" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Licensees" ], "summary": "Update licensee", "description": "Update licensee.\nAvailable for Client and Operations accounts.\nAccepts application/json or multipart/form-data (with optional icon).\nUpdates licensee fields such as name, address, description, or contacts.\nReturns the updated licensee object.", "parameters": [ { "name": "id", "in": "path", "description": "Licensee identifier.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "licensee": { "type": "object", "properties": { "ExternalId": { "type": "string" }, "Status": { "allOf": [ { "$ref": "#/components/schemas/LicenseeStatus" } ] }, "Address.AddressLine1": { "type": "string" }, "Address.AddressLine2": { "type": "string" }, "Address.PostCode": { "type": "string" }, "Address.City": { "type": "string" }, "Address.State": { "type": "string" }, "Address.Country": { "type": "string" }, "UseBuyerAddress": { "type": "boolean" }, "Description": { "type": "string" }, "Account.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Account.ExternalId": { "type": "string" }, "Account.ExternalName": { "type": "string" }, "Account.Address.AddressLine1": { "type": "string" }, "Account.Address.AddressLine2": { "type": "string" }, "Account.Address.PostCode": { "type": "string" }, "Account.Address.City": { "type": "string" }, "Account.Address.State": { "type": "string" }, "Account.Address.Country": { "type": "string" }, "Account.TechnicalSupportEmail": { "type": "string" }, "Account.Website": { "type": "string" }, "Account.Description": { "type": "string" }, "Account.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Account.Eligibility.Client": { "type": "boolean" }, "Account.Eligibility.Partner": { "type": "boolean" }, "Account.DefaultLanguageCode": { "type": "string" }, "Account.Type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ] }, "Account.Status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ] }, "Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Name": { "type": "string" }, "Account.Icon": { "type": "string" }, "Account.Revision": { "type": "integer", "format": "int32" }, "Account.Audit.Created.At": { "type": "string", "format": "date-time" }, "Account.Audit.Created.ById": { "type": "string" }, "Account.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Account.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Audit.Created.By.Name": { "type": "string" }, "Account.Audit.Created.By.Icon": { "type": "string" }, "Account.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Account.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Account.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Account.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Account.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Account.Audit.Created.By.Id": { "type": "string" }, "Account.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Account.Audit.Updated.ById": { "type": "string" }, "Account.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Account.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Audit.Updated.By.Name": { "type": "string" }, "Account.Audit.Updated.By.Icon": { "type": "string" }, "Account.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Account.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Account.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Account.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Account.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Account.Audit.Updated.By.Id": { "type": "string" }, "Account.Id": { "type": "string" }, "Buyer.ExternalIds.ErpCompanyContact": { "type": "string" }, "Buyer.ExternalIds.ErpCustomer": { "type": "string" }, "Buyer.ExternalIds.AccountExternalId": { "type": "string" }, "Buyer.Status": { "allOf": [ { "$ref": "#/components/schemas/BuyerStatus" } ] }, "Buyer.Address.AddressLine1": { "type": "string" }, "Buyer.Address.AddressLine2": { "type": "string" }, "Buyer.Address.PostCode": { "type": "string" }, "Buyer.Address.City": { "type": "string" }, "Buyer.Address.State": { "type": "string" }, "Buyer.Address.Country": { "type": "string" }, "Buyer.TaxId": { "type": "string" }, "Buyer.Account.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Buyer.Account.ExternalId": { "type": "string" }, "Buyer.Account.ExternalName": { "type": "string" }, "Buyer.Account.Address.AddressLine1": { "type": "string" }, "Buyer.Account.Address.AddressLine2": { "type": "string" }, "Buyer.Account.Address.PostCode": { "type": "string" }, "Buyer.Account.Address.City": { "type": "string" }, "Buyer.Account.Address.State": { "type": "string" }, "Buyer.Account.Address.Country": { "type": "string" }, "Buyer.Account.TechnicalSupportEmail": { "type": "string" }, "Buyer.Account.Website": { "type": "string" }, "Buyer.Account.Description": { "type": "string" }, "Buyer.Account.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Buyer.Account.Eligibility.Client": { "type": "boolean" }, "Buyer.Account.Eligibility.Partner": { "type": "boolean" }, "Buyer.Account.DefaultLanguageCode": { "type": "string" }, "Buyer.Account.Type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ] }, "Buyer.Account.Status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ] }, "Buyer.Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Account.Name": { "type": "string" }, "Buyer.Account.Icon": { "type": "string" }, "Buyer.Account.Revision": { "type": "integer", "format": "int32" }, "Buyer.Account.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Account.Audit.Created.ById": { "type": "string" }, "Buyer.Account.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Buyer.Account.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Account.Audit.Created.By.Name": { "type": "string" }, "Buyer.Account.Audit.Created.By.Icon": { "type": "string" }, "Buyer.Account.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Buyer.Account.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Buyer.Account.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Account.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Account.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Account.Audit.Created.By.Id": { "type": "string" }, "Buyer.Account.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Account.Audit.Updated.ById": { "type": "string" }, "Buyer.Account.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Buyer.Account.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Account.Audit.Updated.By.Name": { "type": "string" }, "Buyer.Account.Audit.Updated.By.Icon": { "type": "string" }, "Buyer.Account.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Buyer.Account.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Account.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Buyer.Account.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Account.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Buyer.Account.Audit.Updated.By.Id": { "type": "string" }, "Buyer.Account.Id": { "type": "string" }, "Buyer.Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ParametrisedMessage" } }, "Buyer.Sellers": { "type": "array", "items": { "$ref": "#/components/schemas/Seller" } }, "Buyer.ErpLinks": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLink" } }, "Buyer.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Name": { "type": "string" }, "Buyer.Icon": { "type": "string" }, "Buyer.Revision": { "type": "integer", "format": "int32" }, "Buyer.Audit.Activated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Activated.ById": { "type": "string" }, "Buyer.Audit.Activated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Buyer.Audit.Activated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Audit.Activated.By.Name": { "type": "string" }, "Buyer.Audit.Activated.By.Icon": { "type": "string" }, "Buyer.Audit.Activated.By.Revision": { "type": "integer", "format": "int32" }, "Buyer.Audit.Activated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Activated.By.Audit.Created.ById": { "type": "string" }, "Buyer.Audit.Activated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Activated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Activated.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Audit.Activated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Activated.By.Id": { "type": "string" }, "Buyer.Audit.Unassigned.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Unassigned.ById": { "type": "string" }, "Buyer.Audit.Unassigned.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Buyer.Audit.Unassigned.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Audit.Unassigned.By.Name": { "type": "string" }, "Buyer.Audit.Unassigned.By.Icon": { "type": "string" }, "Buyer.Audit.Unassigned.By.Revision": { "type": "integer", "format": "int32" }, "Buyer.Audit.Unassigned.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Unassigned.By.Audit.Created.ById": { "type": "string" }, "Buyer.Audit.Unassigned.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Unassigned.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Unassigned.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Audit.Unassigned.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Unassigned.By.Id": { "type": "string" }, "Buyer.Audit.Disabled.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Disabled.ById": { "type": "string" }, "Buyer.Audit.Disabled.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Buyer.Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Audit.Disabled.By.Name": { "type": "string" }, "Buyer.Audit.Disabled.By.Icon": { "type": "string" }, "Buyer.Audit.Disabled.By.Revision": { "type": "integer", "format": "int32" }, "Buyer.Audit.Disabled.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Disabled.By.Audit.Created.ById": { "type": "string" }, "Buyer.Audit.Disabled.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Disabled.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Disabled.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Audit.Disabled.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Disabled.By.Id": { "type": "string" }, "Buyer.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Created.ById": { "type": "string" }, "Buyer.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Buyer.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Audit.Created.By.Name": { "type": "string" }, "Buyer.Audit.Created.By.Icon": { "type": "string" }, "Buyer.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Buyer.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Buyer.Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Created.By.Id": { "type": "string" }, "Buyer.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Updated.ById": { "type": "string" }, "Buyer.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Buyer.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Audit.Updated.By.Name": { "type": "string" }, "Buyer.Audit.Updated.By.Icon": { "type": "string" }, "Buyer.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Buyer.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Buyer.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Updated.By.Id": { "type": "string" }, "Buyer.Id": { "type": "string" }, "Seller.ExternalId": { "type": "string" }, "Seller.Status": { "allOf": [ { "$ref": "#/components/schemas/SellerStatus" } ] }, "Seller.Currencies": { "type": "array", "items": { "$ref": "#/components/schemas/SellerCurrency" } }, "Seller.Address.AddressLine1": { "type": "string" }, "Seller.Address.AddressLine2": { "type": "string" }, "Seller.Address.PostCode": { "type": "string" }, "Seller.Address.City": { "type": "string" }, "Seller.Address.State": { "type": "string" }, "Seller.Address.Country": { "type": "string" }, "Seller.Buyers": { "type": "array", "items": { "$ref": "#/components/schemas/Buyer" } }, "Seller.ErpLink.Buyer.ExternalIds.ErpCompanyContact": { "type": "string" }, "Seller.ErpLink.Buyer.ExternalIds.ErpCustomer": { "type": "string" }, "Seller.ErpLink.Buyer.ExternalIds.AccountExternalId": { "type": "string" }, "Seller.ErpLink.Buyer.Status": { "allOf": [ { "$ref": "#/components/schemas/BuyerStatus" } ] }, "Seller.ErpLink.Buyer.Address.AddressLine1": { "type": "string" }, "Seller.ErpLink.Buyer.Address.AddressLine2": { "type": "string" }, "Seller.ErpLink.Buyer.Address.PostCode": { "type": "string" }, "Seller.ErpLink.Buyer.Address.City": { "type": "string" }, "Seller.ErpLink.Buyer.Address.State": { "type": "string" }, "Seller.ErpLink.Buyer.Address.Country": { "type": "string" }, "Seller.ErpLink.Buyer.TaxId": { "type": "string" }, "Seller.ErpLink.Buyer.Account.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Seller.ErpLink.Buyer.Account.ExternalId": { "type": "string" }, "Seller.ErpLink.Buyer.Account.ExternalName": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Address.AddressLine1": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Address.AddressLine2": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Address.PostCode": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Address.City": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Address.State": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Address.Country": { "type": "string" }, "Seller.ErpLink.Buyer.Account.TechnicalSupportEmail": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Website": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Description": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Seller.ErpLink.Buyer.Account.Eligibility.Client": { "type": "boolean" }, "Seller.ErpLink.Buyer.Account.Eligibility.Partner": { "type": "boolean" }, "Seller.ErpLink.Buyer.Account.DefaultLanguageCode": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ] }, "Seller.ErpLink.Buyer.Account.Status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ] }, "Seller.ErpLink.Buyer.Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Account.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Account.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Account.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ParametrisedMessage" } }, "Seller.ErpLink.Buyer.Sellers": { "type": "array", "items": { "$ref": "#/components/schemas/Seller" } }, "Seller.ErpLink.Buyer.ErpLinks": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLink" } }, "Seller.ErpLink.Buyer.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Audit.Activated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Activated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Buyer.Audit.Activated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Audit.Activated.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Activated.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Unassigned.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Disabled.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Buyer.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Audit.Created.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Buyer.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Audit.Updated.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Id": { "type": "string" }, "Seller.ErpLink.Seller.ExternalId": { "type": "string" }, "Seller.ErpLink.Seller.Status": { "allOf": [ { "$ref": "#/components/schemas/SellerStatus" } ] }, "Seller.ErpLink.Seller.Currencies": { "type": "array", "items": { "$ref": "#/components/schemas/SellerCurrency" } }, "Seller.ErpLink.Seller.Address.AddressLine1": { "type": "string" }, "Seller.ErpLink.Seller.Address.AddressLine2": { "type": "string" }, "Seller.ErpLink.Seller.Address.PostCode": { "type": "string" }, "Seller.ErpLink.Seller.Address.City": { "type": "string" }, "Seller.ErpLink.Seller.Address.State": { "type": "string" }, "Seller.ErpLink.Seller.Address.Country": { "type": "string" }, "Seller.ErpLink.Seller.Buyers": { "type": "array", "items": { "$ref": "#/components/schemas/Buyer" } }, "Seller.ErpLink.Seller.ErpLink": { "allOf": [ { "$ref": "#/components/schemas/ErpLink" } ] }, "Seller.ErpLink.Seller.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Seller.Name": { "type": "string" }, "Seller.ErpLink.Seller.Icon": { "type": "string" }, "Seller.ErpLink.Seller.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Seller.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Seller.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Seller.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Seller.Audit.Created.By.Name": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Seller.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.ErpLink.Seller.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Seller.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Seller.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Seller.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Seller.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Seller.Audit.Updated.By.Name": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Seller.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Seller.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Seller.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.ErpLink.Seller.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Seller.Id": { "type": "string" }, "Seller.ErpLink.BuyerId": { "type": "string" }, "Seller.ErpLink.SellerId": { "type": "string" }, "Seller.ErpLink.CompanyName": { "type": "string" }, "Seller.ErpLink.Status": { "allOf": [ { "$ref": "#/components/schemas/ErpLinkStatus" } ] }, "Seller.ErpLink.Note": { "type": "string" }, "Seller.ErpLink.ExternalIds.ErpCompanyContact": { "type": "string" }, "Seller.ErpLink.ExternalIds.ErpCustomer": { "type": "string" }, "Seller.ErpLink.ExternalIds.AccountExternalId": { "type": "string" }, "Seller.ErpLink.Address.AddressLine1": { "type": "string" }, "Seller.ErpLink.Address.AddressLine2": { "type": "string" }, "Seller.ErpLink.Address.PostCode": { "type": "string" }, "Seller.ErpLink.Address.City": { "type": "string" }, "Seller.ErpLink.Address.State": { "type": "string" }, "Seller.ErpLink.Address.Country": { "type": "string" }, "Seller.ErpLink.ShipTo": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLinkAddress" } }, "Seller.ErpLink.BillTo": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLinkAddress" } }, "Seller.ErpLink.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Name": { "type": "string" }, "Seller.ErpLink.Icon": { "type": "string" }, "Seller.ErpLink.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Audit.Blocked.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Blocked.ById": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Audit.Blocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Audit.Blocked.By.Name": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.Icon": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Audit.Blocked.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Blocked.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Audit.Blocked.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Blocked.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Audit.Blocked.By.Id": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Unblocked.ById": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Audit.Unblocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Audit.Unblocked.By.Name": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.Icon": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Audit.Unblocked.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Unblocked.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Audit.Unblocked.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Unblocked.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Audit.Unblocked.By.Id": { "type": "string" }, "Seller.ErpLink.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Audit.Created.By.Name": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Audit.Updated.By.Name": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Id": { "type": "string" }, "Seller.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Name": { "type": "string" }, "Seller.Icon": { "type": "string" }, "Seller.Revision": { "type": "integer", "format": "int32" }, "Seller.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Audit.Created.ById": { "type": "string" }, "Seller.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Audit.Created.By.Name": { "type": "string" }, "Seller.Audit.Created.By.Icon": { "type": "string" }, "Seller.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Audit.Created.By.Id": { "type": "string" }, "Seller.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Audit.Updated.ById": { "type": "string" }, "Seller.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Audit.Updated.By.Name": { "type": "string" }, "Seller.Audit.Updated.By.Icon": { "type": "string" }, "Seller.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.Audit.Updated.By.Id": { "type": "string" }, "Seller.Id": { "type": "string" }, "Eligibility.Client": { "type": "boolean" }, "Eligibility.Partner": { "type": "boolean" }, "Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Name": { "type": "string" }, "Icon": { "type": "string" }, "Revision": { "type": "integer", "format": "int32" }, "Audit.Disabled.At": { "type": "string", "format": "date-time" }, "Audit.Disabled.ById": { "type": "string" }, "Audit.Disabled.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Disabled.By.Name": { "type": "string" }, "Audit.Disabled.By.Icon": { "type": "string" }, "Audit.Disabled.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Disabled.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Disabled.By.Audit.Created.ById": { "type": "string" }, "Audit.Disabled.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Disabled.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Disabled.By.Audit.Updated.ById": { "type": "string" }, "Audit.Disabled.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Disabled.By.Id": { "type": "string" }, "Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Created.ById": { "type": "string" }, "Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Created.By.Name": { "type": "string" }, "Audit.Created.By.Icon": { "type": "string" }, "Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Created.By.Id": { "type": "string" }, "Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Updated.ById": { "type": "string" }, "Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Updated.By.Name": { "type": "string" }, "Audit.Updated.By.Icon": { "type": "string" }, "Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Updated.By.Id": { "type": "string" }, "Id": { "type": "string" } }, "description": "Json representation of the licensee" }, "logo": { "type": "string", "format": "binary" } } }, "encoding": { "licensee": { "contentType": "application/json" }, "logo": { "contentType": "application/octet-stream" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/LicenseeUpdate" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Licensee" }, "example": { "id": "LCE-8893-6916-0000", "revision": 2, "name": "Rolls-Royce Canada Limited", "icon": "/static/accounts/LCE-8893-6916-0000/logo.png", "audit": { "created": { "at": "2024-02-01T09:12:23+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "updated": { "at": "2024-02-02T10:25:00+00:00", "by": { "id": "USR-0001", "name": "Ops User" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Licensees" ], "summary": "Delete licensee", "description": "Delete licensee.\nAvailable for Operations account.\nRemoves the licensee record.\nReturns 204 No Content on success.", "parameters": [ { "name": "id", "in": "path", "description": "Licensee identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/licensees/{id}/enable": { "post": { "tags": [ "Licensees" ], "summary": "Enable licensee", "description": "Enable licensee.\nMoves the licensee status to Enabled.\nAvailable for Client and Operations accounts.\nReturns the updated licensee object.", "parameters": [ { "name": "id", "in": "path", "description": "Licensee identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Licensee" }, "example": { "id": "LCE-8893-6916-0000", "revision": 2, "name": "Rolls-Royce Canada Limited", "status": "Enabled", "audit": { "created": { "at": "2024-02-01T09:12:23+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "updated": { "at": "2024-02-02T10:30:00+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "enabled": { "at": "2024-02-02T10:30:00+00:00", "by": { "id": "USR-0001", "name": "Ops User" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/licensees/{id}/disable": { "post": { "tags": [ "Licensees" ], "summary": "Disable licensee", "description": "Disable licensee.\nMoves the licensee status to Disabled.\nAvailable for Client and Operations accounts.\nReturns the updated licensee object.", "parameters": [ { "name": "id", "in": "path", "description": "Licensee identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Licensee" }, "example": { "id": "LCE-8893-6916-0000", "revision": 2, "name": "Rolls-Royce Canada Limited", "status": "Disabled", "audit": { "created": { "at": "2024-02-01T09:12:23+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "updated": { "at": "2024-02-02T10:35:00+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "disabled": { "at": "2024-02-02T10:35:00+00:00", "by": { "id": "USR-0001", "name": "Ops User" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/licensees/{id}/icon": { "get": { "tags": [ "Licensees" ], "summary": "Get licensee icon", "description": "Get licensee icon.\nAccess: Public.\nReturns a redirect to the icon binary URL.\nUses a private blob cache profile for the response.", "parameters": [ { "name": "id", "in": "path", "description": "Licensee identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "307": { "description": "Temporary Redirect" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/commerce/lines": { "get": { "tags": [ "Lines" ], "summary": "Lists all agreement lines across the marketplace.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementLineListResponse" } } } } } } }, "/public/v1/commerce/agreements/{agreementId}/lines": { "get": { "tags": [ "Lines" ], "summary": "Lists agreement lines for the specified agreement.", "parameters": [ { "name": "agreementId", "in": "path", "description": "Agreement id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementLineListResponse" } } } } } } }, "/public/v1/commerce/subscriptions/{subscriptionId}/lines": { "get": { "tags": [ "Lines" ], "summary": "Lists agreement lines for the specified subscription.", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "Subscription id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementLineListResponse" } } } } } } }, "/public/v1/commerce/orders/{orderId}/lines": { "get": { "tags": [ "Lines" ], "summary": "Lists order lines for the specified order.", "parameters": [ { "name": "orderId", "in": "path", "description": "Order id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderLineListResponse" } } } } } } }, "/public/v1/commerce/assets/{assetId}/lines": { "get": { "tags": [ "Lines" ], "summary": "Lists agreement lines for the specified asset.", "parameters": [ { "name": "assetId", "in": "path", "description": "Asset id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementLineListResponse" } } } } } } }, "/public/v1/catalog/listings": { "post": { "tags": [ "Listing" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateListingRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateListingRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateListingRequest" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Listing" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Listing" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListingListResponse" } } } } } } }, "/public/v1/catalog/listings/{id}": { "put": { "tags": [ "Listing" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListingUpdate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ListingUpdate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ListingUpdate" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Listing" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Listing" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Listing" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Listing" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/modules": { "get": { "tags": [ "Modules" ], "summary": "List modules", "description": "List modules.\nAvailable for Operations account with platform account management permissions.\nReturns a paged list of modules; supports RQL query parameters for filtering and selection.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModuleListResponse" }, "example": { "data": [ { "id": "MOD-1234", "revision": 1, "name": "Invoices", "description": "Invoices module", "accountTypes": [ "vendor", "client", "operations" ], "settings": { "sharedAccount": true, "configurable": true, "default": true, "paid": false }, "filters": { "group.buyers": [ "selected", "all" ] } } ], "$meta": { "pagination": { "offset": 0, "limit": 10, "total": 1 } } } } } } } } }, "/public/v1/accounts/modules/{id}": { "get": { "tags": [ "Modules" ], "summary": "Get module by ID", "description": "Get module by ID.\nAvailable for Operations account with platform account management permissions.\nReturns a single module with id, name, description, accountTypes, settings, and filters.\nOptional select query parameter controls which fields are returned.", "parameters": [ { "name": "id", "in": "path", "description": "Module identifier.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional RQL select statement to limit returned fields.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Module" }, "example": { "id": "MOD-1234", "name": "Invoices", "description": "Invoices module", "accountTypes": [ "vendor", "client", "operations" ], "settings": { "sharedAccount": true, "configurable": true, "default": true, "paid": false }, "filters": { "group.buyers": [ "selected", "all" ] } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/commerce/orders/{orderId}/assets": { "get": { "tags": [ "OrderAssets" ], "summary": "Lists assets for the specified order.", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderAssetListResponse" } } } } } }, "post": { "tags": [ "OrderAssets" ], "summary": "Creates a new asset for the order.", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Asset details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderAsset" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderAsset" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OrderAsset" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderAsset" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/commerce/orders/{orderId}/assets/{id}": { "get": { "tags": [ "OrderAssets" ], "summary": "Gets an order asset by id.", "parameters": [ { "name": "id", "in": "path", "description": "Order asset id", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Select expression", "schema": { "type": "string" } }, { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderAsset" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "OrderAssets" ], "summary": "Updates an existing order asset.", "parameters": [ { "name": "id", "in": "path", "description": "Order asset id", "required": true, "schema": { "type": "string" } }, { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Updated asset details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderAsset" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderAsset" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OrderAsset" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderAsset" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "OrderAssets" ], "summary": "Deletes an existing order asset.", "parameters": [ { "name": "id", "in": "path", "description": "Order asset id", "required": true, "schema": { "type": "string" } }, { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/commerce/orders/{orderId}/assets/{id}/render": { "get": { "tags": [ "OrderAssets" ], "summary": "Renders an order asset template.", "parameters": [ { "name": "id", "in": "path", "description": "Order asset id", "required": true, "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "Template language code", "schema": { "type": "string" } }, { "name": "template.id", "in": "query", "description": "Template id", "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "Preferred language header", "schema": { "type": "string" } }, { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/commerce/orders": { "post": { "tags": [ "Orders" ], "summary": "Creates a new order for an agreement or creates a purchase order with a new agreement.", "requestBody": { "description": "Order details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Order" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Orders" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderListResponse" } } } } } } }, "/public/v1/commerce/orders/{id}": { "put": { "tags": [ "Orders" ], "summary": "Updates an order. Immutable fields such as state and agreement assignment cannot be changed.", "parameters": [ { "name": "id", "in": "path", "description": "Order id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Updated order details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Order" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Orders" ], "summary": "Deletes an order. Only draft orders can be deleted.", "parameters": [ { "name": "id", "in": "path", "description": "Order id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Delete details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Order" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Orders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/commerce/orders/{id}/process": { "post": { "tags": [ "Orders" ], "summary": "Places an order and sets its status to processing.", "parameters": [ { "name": "id", "in": "path", "description": "Order id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Order details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Order" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/commerce/orders/{id}/query": { "post": { "tags": [ "Orders" ], "summary": "Query's an order, returning it to the client for updates.", "parameters": [ { "name": "id", "in": "path", "description": "Order id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Order details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Order" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/commerce/orders/{id}/complete": { "post": { "tags": [ "Orders" ], "summary": "Completes an order and updates the related agreement.", "parameters": [ { "name": "id", "in": "path", "description": "Order id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Order details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Order" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/commerce/orders/{id}/quote": { "post": { "tags": [ "Orders" ], "summary": "Quotes an order.", "parameters": [ { "name": "id", "in": "path", "description": "Order id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Quote details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Order" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/commerce/orders/{id}/fail": { "post": { "tags": [ "Orders" ], "summary": "Fails an order and sets its status to failed.", "parameters": [ { "name": "id", "in": "path", "description": "Order id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Failure details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Order" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/commerce/orders/{id}/validate": { "post": { "tags": [ "Orders" ], "summary": "Validates an order by invoking the vendor connector validation workflow.", "parameters": [ { "name": "id", "in": "path", "description": "Order id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Validation details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Order" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/commerce/orders/{id}/template": { "get": { "tags": [ "Orders" ], "summary": "Renders an order template.", "parameters": [ { "name": "id", "in": "path", "description": "Order id", "required": true, "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "Template language code", "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "Preferred language header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/commerce/orders/{id}/render": { "get": { "tags": [ "Orders" ], "summary": "Renders an order template.", "parameters": [ { "name": "id", "in": "path", "description": "Order id", "required": true, "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "Template language code", "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "Preferred language header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/commerce/orders/{id}/notify": { "post": { "tags": [ "Orders" ], "summary": "Sends an order notification to a user.", "parameters": [ { "name": "id", "in": "path", "description": "Order id", "required": true, "schema": { "type": "string" } }, { "name": "X-Use-Template", "in": "header", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Notification request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrderNotificationRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrderNotificationRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrderNotificationRequest" } ] } } } }, "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/commerce/orders/{orderId}/subscriptions": { "get": { "tags": [ "OrderSubscriptions" ], "summary": "Lists subscriptions for the specified order.", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderSubscriptionListResponse" } } } } } }, "post": { "tags": [ "OrderSubscriptions" ], "summary": "Creates a new subscription for the order.", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Subscription details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderSubscription" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderSubscription" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OrderSubscription" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/commerce/orders/{orderId}/subscriptions/{id}": { "get": { "tags": [ "OrderSubscriptions" ], "summary": "Gets an order subscription by id.", "parameters": [ { "name": "id", "in": "path", "description": "Order subscription id", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Select expression", "schema": { "type": "string" } }, { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "OrderSubscriptions" ], "summary": "Updates an existing order subscription.", "parameters": [ { "name": "id", "in": "path", "description": "Order subscription id", "required": true, "schema": { "type": "string" } }, { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Subscription details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderSubscription" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderSubscription" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OrderSubscription" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "OrderSubscriptions" ], "summary": "Deletes an order subscription.", "parameters": [ { "name": "id", "in": "path", "description": "Order subscription id", "required": true, "schema": { "type": "string" } }, { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/commerce/orders/{orderId}/subscriptions/{id}/render": { "get": { "tags": [ "OrderSubscriptions" ], "summary": "Renders an order subscription template.", "parameters": [ { "name": "id", "in": "path", "description": "Order subscription id", "required": true, "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "Template language code", "schema": { "type": "string" } }, { "name": "template.id", "in": "query", "description": "Template id", "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "Preferred language header", "schema": { "type": "string" } }, { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/catalog/products/{productId}/parameter-groups": { "post": { "tags": [ "ParameterGroups" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateParameterGroupRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateParameterGroupRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateParameterGroupRequest" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParameterGroup" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "ParameterGroups" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParameterGroupListResponse" } } } } } } }, "/public/v1/catalog/products/{productId}/parameter-groups/{id}": { "put": { "tags": [ "ParameterGroups" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateParameterGroupRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateParameterGroupRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateParameterGroupRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParameterGroup" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "ParameterGroups" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "ParameterGroups" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParameterGroup" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/catalog/products/{productId}/parameters": { "post": { "tags": [ "Parameters" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateParameterDefinitionRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateParameterDefinitionRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateParameterDefinitionRequest" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParameterDefinition" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Parameters" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParameterDefinitionListResponse" } } } } } } }, "/public/v1/catalog/products/{productId}/parameters/{id}": { "put": { "tags": [ "Parameters" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateParameter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateParameter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateParameter" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParameterDefinition" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Parameters" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Parameters" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParameterDefinition" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/catalog/price-lists": { "post": { "tags": [ "PriceLists" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreatePriceListRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreatePriceListRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreatePriceListRequest" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriceList" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "PriceLists" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriceListListResponse" } } } } } } }, "/public/v1/catalog/price-lists/{id}": { "put": { "tags": [ "PriceLists" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriceListUpdate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PriceListUpdate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PriceListUpdate" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriceList" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "PriceLists" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "PriceLists" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriceList" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/catalog/price-lists/{priceListId}/items/{id}": { "put": { "tags": [ "PriceListsItems" ], "parameters": [ { "name": "priceListId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriceListItemUpdate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PriceListItemUpdate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PriceListItemUpdate" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriceListItem" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "PriceListsItems" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "priceListId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriceListItem" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/catalog/price-lists/{priceListId}/items": { "get": { "tags": [ "PriceListsItems" ], "parameters": [ { "name": "priceListId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriceListItemListResponse" } } } } } } }, "/public/v1/catalog/pricing-policies": { "post": { "tags": [ "PricingPolicies" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreatePricingPolicyRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreatePricingPolicyRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreatePricingPolicyRequest" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PricingPolicy" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "PricingPolicies" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PricingPolicyListResponse" } } } } } } }, "/public/v1/catalog/pricing-policies/{id}": { "put": { "tags": [ "PricingPolicies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PricingPolicy" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PricingPolicy" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PricingPolicy" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PricingPolicy" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "PricingPolicies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "PricingPolicies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PricingPolicy" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/catalog/pricing-policies/{id}/activate": { "post": { "tags": [ "PricingPolicies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/catalog/pricing-policies/{id}/disable": { "post": { "tags": [ "PricingPolicies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PricingPolicy" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/catalog/items": { "post": { "tags": [ "ProductItems" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateProductItemRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateProductItemRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateProductItemRequest" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductItem" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "ProductItems" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductItemListResponse" } } } } } } }, "/public/v1/catalog/items/{id}": { "delete": { "tags": [ "ProductItems" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "ProductItems" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProductItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateProductItem" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateProductItem" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductItem" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "ProductItems" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductItem" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/catalog/items/{id}/review": { "post": { "tags": [ "ProductItems" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/catalog/items/{id}/publish": { "post": { "tags": [ "ProductItems" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductItem" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/catalog/items/{id}/unpublish": { "post": { "tags": [ "ProductItems" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductItem" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/catalog/products/{productId}/items": { "get": { "tags": [ "ProductItems" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductItemListResponse" } } } } } } }, "/public/v1/catalog/products/{productId}/items/{id}": { "get": { "tags": [ "ProductItems" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductItem" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/catalog/products/{productId}/media/{id}": { "get": { "tags": [ "ProductMedia" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductMedia" } } } }, "301": { "description": "Moved Permanently" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "ProductMedia" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "ProductMedia" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductMedia" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProductMedia" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ProductMedia" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductMedia" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/catalog/products/{productId}/media": { "post": { "tags": [ "ProductMedia" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "media": { "type": "object", "properties": { "Name": { "type": "string" }, "Description": { "type": "string" }, "MediaType": { "allOf": [ { "$ref": "#/components/schemas/MediaType" } ] }, "Url": { "type": "string" }, "DisplayOrder": { "type": "integer", "format": "int32" } }, "description": "Json representation of the media" }, "file": { "type": "string", "format": "binary" } } }, "encoding": { "media": { "contentType": "application/json" }, "file": { "contentType": "application/octet-stream" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductMedia" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "ProductMedia" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductMediaListResponse" } } } } } } }, "/public/v1/catalog/products/{productId}/media/{id}/review": { "post": { "tags": [ "ProductMedia" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductMedia" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/catalog/products/{productId}/media/{id}/publish": { "post": { "tags": [ "ProductMedia" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductMedia" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/catalog/products/{productId}/media/{id}/unpublish": { "post": { "tags": [ "ProductMedia" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductMedia" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/catalog/products/{productId}/media/{id}/image": { "get": { "tags": [ "ProductMedia" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "307": { "description": "Temporary Redirect" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/catalog/products": { "post": { "tags": [ "Products" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "product": { "type": "object", "properties": { "Name": { "type": "string" }, "ShortDescription": { "type": "string" }, "LongDescription": { "type": "string" }, "Website": { "type": "string" } }, "description": "Json representation of the product" }, "icon": { "type": "string", "format": "binary" } } }, "encoding": { "product": { "contentType": "application/json" }, "icon": { "contentType": "application/octet-stream" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Products" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductListResponse" } } } } } } }, "/public/v1/catalog/products/{id}": { "put": { "tags": [ "Products" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "product": { "type": "object", "properties": { "Product.Node.Name": { "type": "string" }, "Product.Node.Children": { "type": "array", "items": { "$ref": "#/components/schemas/DeltaNode" } }, "Product.Path": { "type": "string" }, "Product.Data.Name": { "type": "string" }, "Product.Data.ShortDescription": { "type": "string" }, "Product.Data.LongDescription": { "type": "string" }, "Product.Data.ExternalIds.Operations": { "type": "string" }, "Product.Data.ExternalIds.DefaultErpItem": { "type": "string" }, "Product.Data.Website": { "type": "string" }, "Product.IsDefined": { "type": "boolean" } }, "description": "Json representation of the product" }, "icon": { "type": "string", "format": "binary" } } }, "encoding": { "product": { "contentType": "application/json" }, "icon": { "contentType": "application/octet-stream" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductUpdate" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Products" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Products" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/catalog/products/{id}/settings": { "put": { "tags": [ "Products" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConfigureSettingsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConfigureSettingsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConfigureSettingsRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/catalog/products/{id}/review": { "post": { "tags": [ "Products" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/catalog/products/{id}/publish": { "post": { "tags": [ "Products" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/catalog/products/{id}/unpublish": { "post": { "tags": [ "Products" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/catalog/products/{id}/icon": { "get": { "tags": [ "Products" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "307": { "description": "Temporary Redirect" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/program/programs/{programId}/documents/{id}": { "get": { "tags": [ "ProgramDocuments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramDocument" } } } }, "301": { "description": "Moved Permanently" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "ProgramDocuments" ], "parameters": [ { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "ProgramDocuments" ], "parameters": [ { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramDocument" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProgramDocument" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ProgramDocument" } } } }, "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/program/programs/{programId}/documents": { "post": { "tags": [ "ProgramDocuments" ], "parameters": [ { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "document": { "type": "object", "properties": { "Name": { "type": "string" }, "Description": { "type": "string" }, "Language": { "type": "string" }, "DocumentType": { "allOf": [ { "$ref": "#/components/schemas/DocumentType" } ] }, "Url": { "type": "string" }, "DisplayOrder": { "type": "integer", "format": "int32" } }, "description": "Json representation of the document" }, "file": { "type": "string", "format": "binary" } } }, "encoding": { "document": { "contentType": "application/json" }, "file": { "contentType": "application/octet-stream" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramDocument" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "ProgramDocuments" ], "parameters": [ { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramDocumentListResponse" } } } } } } }, "/public/v1/program/programs/{programId}/documents/{id}/publish": { "post": { "tags": [ "ProgramDocuments" ], "parameters": [ { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramDocument" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/program/programs/{programId}/documents/{id}/unpublish": { "post": { "tags": [ "ProgramDocuments" ], "parameters": [ { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramDocument" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/program/programs/{programId}/media/{id}": { "get": { "tags": [ "ProgramMedia" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramMedia" } } } }, "301": { "description": "Moved Permanently" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "ProgramMedia" ], "parameters": [ { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "ProgramMedia" ], "parameters": [ { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramMedia" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProgramMedia" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ProgramMedia" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramMedia" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/program/programs/{programId}/media": { "post": { "tags": [ "ProgramMedia" ], "parameters": [ { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "media": { "type": "object", "properties": { "Name": { "type": "string" }, "Description": { "type": "string" }, "MediaType": { "allOf": [ { "$ref": "#/components/schemas/MediaType" } ] }, "Url": { "type": "string" }, "DisplayOrder": { "type": "integer", "format": "int32" } }, "description": "Json representation of the media" }, "file": { "type": "string", "format": "binary" } } }, "encoding": { "media": { "contentType": "application/json" }, "file": { "contentType": "application/octet-stream" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramMedia" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "ProgramMedia" ], "parameters": [ { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramMediaListResponse" } } } } } } }, "/public/v1/program/programs/{programId}/media/{id}/publish": { "post": { "tags": [ "ProgramMedia" ], "parameters": [ { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramMedia" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/program/programs/{programId}/media/{id}/unpublish": { "post": { "tags": [ "ProgramMedia" ], "parameters": [ { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramMedia" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/program/programs/{programId}/media/{id}/image": { "get": { "tags": [ "ProgramMedia" ], "parameters": [ { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "307": { "description": "Temporary Redirect" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/program/programs/{programId}/parameter-groups": { "post": { "tags": [ "ProgramParameterGroups" ], "parameters": [ { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateProgramParameterGroupRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateProgramParameterGroupRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateProgramParameterGroupRequest" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramParameterGroup" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "ProgramParameterGroups" ], "parameters": [ { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramParameterGroupListResponse" } } } } } } }, "/public/v1/program/programs/{programId}/parameter-groups/{id}": { "put": { "tags": [ "ProgramParameterGroups" ], "parameters": [ { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramParameterGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProgramParameterGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ProgramParameterGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramParameterGroup" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "ProgramParameterGroups" ], "parameters": [ { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "ProgramParameterGroups" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramParameterGroup" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/program/programs/{programId}/parameters": { "post": { "tags": [ "ProgramParameters" ], "parameters": [ { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateProgramParameterDefinitionRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateProgramParameterDefinitionRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateProgramParameterDefinitionRequest" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramParameterDefinition" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "ProgramParameters" ], "parameters": [ { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramParameterDefinitionListResponse" } } } } } } }, "/public/v1/program/programs/{programId}/parameters/{id}": { "put": { "tags": [ "ProgramParameters" ], "parameters": [ { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProgramParameter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateProgramParameter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateProgramParameter" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramParameterDefinition" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "ProgramParameters" ], "parameters": [ { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "ProgramParameters" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramParameterDefinition" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/program/programs": { "post": { "tags": [ "Programs" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "Program": { "type": "object", "properties": { "Name": { "type": "string" }, "ShortDescription": { "type": "string" }, "LongDescription": { "type": "string" }, "Website": { "type": "string" }, "ApplicableTo": { "enum": [ "Buyer", "Licensee" ], "type": "string" }, "Eligibility.Client": { "type": "boolean" }, "Eligibility.Partner": { "type": "boolean" } }, "description": "Json representation of the Program" }, "icon": { "type": "string", "format": "binary" } } }, "encoding": { "Program": { "contentType": "application/json" }, "icon": { "contentType": "application/octet-stream" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Program" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Programs" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramListResponse" } } } } } } }, "/public/v1/program/programs/{id}": { "put": { "tags": [ "Programs" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "program": { "type": "object", "properties": { "Program.Node.Name": { "type": "string" }, "Program.Node.Children": { "type": "array", "items": { "$ref": "#/components/schemas/DeltaNode" } }, "Program.Path": { "type": "string" }, "Program.Data.Name": { "type": "string" }, "Program.Data.ShortDescription": { "type": "string" }, "Program.Data.LongDescription": { "type": "string" }, "Program.Data.Website": { "type": "string" }, "Program.Data.Eligibility.Client": { "type": "boolean" }, "Program.Data.Eligibility.Partner": { "type": "boolean" }, "Program.Data.ApplicableTo": { "enum": [ "Buyer", "Licensee" ], "type": "string" }, "Program.Data.Products": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" } }, "Program.IsDefined": { "type": "boolean" } }, "description": "Json representation of the program" }, "icon": { "type": "string", "format": "binary" } } }, "encoding": { "program": { "contentType": "application/json" }, "icon": { "contentType": "application/octet-stream" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProgramUpdateDelta" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Program" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Programs" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Programs" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Program" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/program/programs/{id}/settings": { "put": { "tags": [ "Programs" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConfigureProgramSettingsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConfigureProgramSettingsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConfigureProgramSettingsRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Program" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/program/programs/{id}/publish": { "post": { "tags": [ "Programs" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Program" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/program/programs/{id}/unpublish": { "post": { "tags": [ "Programs" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Program" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/program/programs/{id}/icon": { "get": { "tags": [ "Programs" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "307": { "description": "Temporary Redirect" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/program/programs/{programId}/templates": { "post": { "tags": [ "ProgramTemplates" ], "parameters": [ { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateProgramTemplateRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateProgramTemplateRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateProgramTemplateRequest" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramTemplate" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "ProgramTemplates" ], "parameters": [ { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramTemplateListResponse" } } } } } } }, "/public/v1/program/programs/{programId}/templates/{id}": { "put": { "tags": [ "ProgramTemplates" ], "parameters": [ { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramTemplateUpdate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProgramTemplateUpdate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ProgramTemplateUpdate" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramTemplate" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "ProgramTemplates" ], "parameters": [ { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "ProgramTemplates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramTemplate" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/program/programs/{programId}/terms": { "post": { "tags": [ "ProgramTermsAndConditions" ], "parameters": [ { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateProgramTermsAndConditionsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateProgramTermsAndConditionsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateProgramTermsAndConditionsRequest" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramTermsAndConditions" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "ProgramTermsAndConditions" ], "parameters": [ { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramTermsAndConditionsListResponse" } } } } } } }, "/public/v1/program/programs/{programId}/terms/{id}": { "put": { "tags": [ "ProgramTermsAndConditions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateProgramTermsAndConditionsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateProgramTermsAndConditionsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateProgramTermsAndConditionsRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramTermsAndConditions" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "ProgramTermsAndConditions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "ProgramTermsAndConditions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramTermsAndConditions" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/program/programs/{programId}/terms/{id}/publish": { "post": { "tags": [ "ProgramTermsAndConditions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramTermsAndConditions" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/program/programs/{programId}/terms/{id}/unpublish": { "post": { "tags": [ "ProgramTermsAndConditions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramTermsAndConditions" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/program/programs/{programId}/terms/{programTermsAndConditionsId}/variants": { "post": { "tags": [ "ProgramTermsAndConditionsVariant" ], "parameters": [ { "name": "programTermsAndConditionsId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "variant": { "type": "object", "properties": { "Type": { "enum": [ "Online", "File" ], "type": "string" }, "AssetUrl": { "type": "string" }, "LanguageCode": { "type": "string" }, "Name": { "type": "string" }, "Description": { "type": "string" } }, "description": "Json representation of the variant" }, "file": { "type": "string", "format": "binary" } } }, "encoding": { "variant": { "contentType": "application/json" }, "file": { "contentType": "application/octet-stream" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramTermsAndConditionsVariant" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "ProgramTermsAndConditionsVariant" ], "parameters": [ { "name": "programTermsAndConditionsId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramTermsAndConditionsVariantListResponse" } } } } } } }, "/public/v1/program/programs/{programId}/terms/{programTermsAndConditionsId}/variants/{id}": { "put": { "tags": [ "ProgramTermsAndConditionsVariant" ], "parameters": [ { "name": "programTermsAndConditionsId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramTermsVariantUpdate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProgramTermsVariantUpdate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ProgramTermsVariantUpdate" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramTermsAndConditionsVariant" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "ProgramTermsAndConditionsVariant" ], "parameters": [ { "name": "programTermsAndConditionsId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "ProgramTermsAndConditionsVariant" ], "parameters": [ { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "programTermsAndConditionsId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramTermsAndConditionsVariant" } } } }, "301": { "description": "Moved Permanently" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/program/programs/{programId}/terms/{programTermsAndConditionsId}/variants/{id}/publish": { "post": { "tags": [ "ProgramTermsAndConditionsVariant" ], "parameters": [ { "name": "programTermsAndConditionsId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramTermsAndConditionsVariant" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/program/programs/{programId}/terms/{programTermsAndConditionsId}/variants/{id}/unpublish": { "post": { "tags": [ "ProgramTermsAndConditionsVariant" ], "parameters": [ { "name": "programTermsAndConditionsId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "programId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramTermsAndConditionsVariant" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/accounts/sellers": { "get": { "tags": [ "Sellers" ], "summary": "List sellers", "description": "List sellers.\nAvailable for Client, Vendor and Operations accounts.\nReturns a paged list of sellers; supports RQL query parameters for filtering and selection.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SellerListResponse" }, "example": { "data": [ { "id": "SEL-7295-4834", "revision": 2, "name": "SoftwareOne AG", "externalId": "SWO_CH", "status": "Active", "currencies": [ "USD" ] } ], "$meta": { "pagination": { "offset": 0, "limit": 10, "total": 1 } } } } } } } }, "post": { "tags": [ "Sellers" ], "summary": "Create seller", "description": "Create seller.\nAvailable for Operations account with platform account management permissions.\nAccepts application/json.\nReturns the created seller object.", "requestBody": { "description": "Seller payload.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SellerCreate" } ] }, "example": { "name": "SoftwareOne AG", "externalId": "SWO_CH", "status": "Active", "currencies": [ "USD" ], "address": { "addressLine1": "Some street", "addressLine2": "Apt 4B", "postCode": "P0S C0D3", "city": "Some city", "state": "SS", "country": "CH" } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SellerCreate" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SellerCreate" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Seller" }, "example": { "id": "SEL-7295-4834", "revision": 1, "name": "SoftwareOne AG", "externalId": "SWO_CH", "status": "Active", "currencies": [ "USD" ], "address": { "addressLine1": "Some street", "addressLine2": "Apt 4B", "postCode": "P0S C0D3", "city": "Some city", "state": "SS", "country": "CH" }, "audit": { "created": { "at": "2024-02-01T09:12:23+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "updated": { "at": "2024-02-01T09:12:23+00:00", "by": { "id": "USR-0001", "name": "Ops User" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/sellers/{id}": { "get": { "tags": [ "Sellers" ], "summary": "Get seller by ID", "description": "Get seller by ID.\nAvailable for Client, Vendor and Operations accounts.\nReturns a single seller with id, name, status, address, currencies, and audit.\nOptional select query parameter controls which fields are returned.", "parameters": [ { "name": "id", "in": "path", "description": "Seller identifier.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional RQL select statement to limit returned fields.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Seller" }, "example": { "id": "SEL-7295-4834", "revision": 2, "name": "SoftwareOne AG", "externalId": "SWO_CH", "status": "Active", "currencies": [ "USD" ], "address": { "addressLine1": "Some street", "postCode": "P0S C0D3", "city": "Some city", "state": "SS", "country": "CH" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Sellers" ], "summary": "Update seller", "description": "Update seller.\nAvailable for Operations account with platform account management permissions.\nAccepts application/json or multipart/form-data (with optional icon).\nUpdates seller fields such as name, address, or external identifiers.\nReturns the updated seller object.", "parameters": [ { "name": "id", "in": "path", "description": "Seller identifier.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "seller": { "type": "object", "properties": { "Seller.Node.Name": { "type": "string" }, "Seller.Node.Children": { "type": "array", "items": { "$ref": "#/components/schemas/DeltaNode" } }, "Seller.Path": { "type": "string" }, "Seller.Data.ExternalId": { "type": "string" }, "Seller.Data.Status": { "allOf": [ { "$ref": "#/components/schemas/SellerStatus" } ] }, "Seller.Data.Currencies": { "type": "array", "items": { "$ref": "#/components/schemas/SellerCurrency" } }, "Seller.Data.Address.AddressLine1": { "type": "string" }, "Seller.Data.Address.AddressLine2": { "type": "string" }, "Seller.Data.Address.PostCode": { "type": "string" }, "Seller.Data.Address.City": { "type": "string" }, "Seller.Data.Address.State": { "type": "string" }, "Seller.Data.Address.Country": { "type": "string" }, "Seller.Data.Buyers": { "type": "array", "items": { "$ref": "#/components/schemas/Buyer" } }, "Seller.Data.ErpLink.Buyer.ExternalIds.ErpCompanyContact": { "type": "string" }, "Seller.Data.ErpLink.Buyer.ExternalIds.ErpCustomer": { "type": "string" }, "Seller.Data.ErpLink.Buyer.ExternalIds.AccountExternalId": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Status": { "allOf": [ { "$ref": "#/components/schemas/BuyerStatus" } ] }, "Seller.Data.ErpLink.Buyer.Address.AddressLine1": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Address.AddressLine2": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Address.PostCode": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Address.City": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Address.State": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Address.Country": { "type": "string" }, "Seller.Data.ErpLink.Buyer.TaxId": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Seller.Data.ErpLink.Buyer.Account.ExternalId": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.ExternalName": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Address.AddressLine1": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Address.AddressLine2": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Address.PostCode": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Address.City": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Address.State": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Address.Country": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.TechnicalSupportEmail": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Website": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Description": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Seller.Data.ErpLink.Buyer.Account.Eligibility.Client": { "type": "boolean" }, "Seller.Data.ErpLink.Buyer.Account.Eligibility.Partner": { "type": "boolean" }, "Seller.Data.ErpLink.Buyer.Account.DefaultLanguageCode": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ] }, "Seller.Data.ErpLink.Buyer.Account.Status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ] }, "Seller.Data.ErpLink.Buyer.Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Buyer.Account.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Data.ErpLink.Buyer.Account.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Buyer.Account.Audit.Created.By.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Created.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.Data.ErpLink.Buyer.Account.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Buyer.Account.Audit.Created.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.By.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ParametrisedMessage" } }, "Seller.Data.ErpLink.Buyer.Sellers": { "type": "array", "items": { "$ref": "#/components/schemas/Seller" } }, "Seller.Data.ErpLink.Buyer.ErpLinks": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLink" } }, "Seller.Data.ErpLink.Buyer.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Buyer.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Audit.Activated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Audit.Activated.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Activated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Data.ErpLink.Buyer.Audit.Activated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Buyer.Audit.Activated.By.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Activated.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Activated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Audit.Activated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Audit.Activated.By.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Activated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Buyer.Audit.Activated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Audit.Activated.By.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Activated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Buyer.Audit.Activated.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.By.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.By.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.By.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.By.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.By.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.By.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Data.ErpLink.Buyer.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Buyer.Audit.Created.By.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Created.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Buyer.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Buyer.Audit.Created.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Data.ErpLink.Buyer.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Buyer.Audit.Updated.By.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Updated.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Buyer.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Buyer.Audit.Updated.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Id": { "type": "string" }, "Seller.Data.ErpLink.Seller.ExternalId": { "type": "string" }, "Seller.Data.ErpLink.Seller.Status": { "allOf": [ { "$ref": "#/components/schemas/SellerStatus" } ] }, "Seller.Data.ErpLink.Seller.Currencies": { "type": "array", "items": { "$ref": "#/components/schemas/SellerCurrency" } }, "Seller.Data.ErpLink.Seller.Address.AddressLine1": { "type": "string" }, "Seller.Data.ErpLink.Seller.Address.AddressLine2": { "type": "string" }, "Seller.Data.ErpLink.Seller.Address.PostCode": { "type": "string" }, "Seller.Data.ErpLink.Seller.Address.City": { "type": "string" }, "Seller.Data.ErpLink.Seller.Address.State": { "type": "string" }, "Seller.Data.ErpLink.Seller.Address.Country": { "type": "string" }, "Seller.Data.ErpLink.Seller.Buyers": { "type": "array", "items": { "$ref": "#/components/schemas/Buyer" } }, "Seller.Data.ErpLink.Seller.ErpLink": { "allOf": [ { "$ref": "#/components/schemas/ErpLink" } ] }, "Seller.Data.ErpLink.Seller.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Seller.Name": { "type": "string" }, "Seller.Data.ErpLink.Seller.Icon": { "type": "string" }, "Seller.Data.ErpLink.Seller.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Seller.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Seller.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Seller.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Data.ErpLink.Seller.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Seller.Audit.Created.By.Name": { "type": "string" }, "Seller.Data.ErpLink.Seller.Audit.Created.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Seller.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Seller.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.Data.ErpLink.Seller.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Seller.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Seller.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Seller.Audit.Created.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Seller.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Seller.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Seller.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Data.ErpLink.Seller.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Seller.Audit.Updated.By.Name": { "type": "string" }, "Seller.Data.ErpLink.Seller.Audit.Updated.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Seller.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Seller.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Seller.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Seller.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Seller.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.Data.ErpLink.Seller.Audit.Updated.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Seller.Id": { "type": "string" }, "Seller.Data.ErpLink.BuyerId": { "type": "string" }, "Seller.Data.ErpLink.SellerId": { "type": "string" }, "Seller.Data.ErpLink.CompanyName": { "type": "string" }, "Seller.Data.ErpLink.Status": { "allOf": [ { "$ref": "#/components/schemas/ErpLinkStatus" } ] }, "Seller.Data.ErpLink.Note": { "type": "string" }, "Seller.Data.ErpLink.ExternalIds.ErpCompanyContact": { "type": "string" }, "Seller.Data.ErpLink.ExternalIds.ErpCustomer": { "type": "string" }, "Seller.Data.ErpLink.ExternalIds.AccountExternalId": { "type": "string" }, "Seller.Data.ErpLink.Address.AddressLine1": { "type": "string" }, "Seller.Data.ErpLink.Address.AddressLine2": { "type": "string" }, "Seller.Data.ErpLink.Address.PostCode": { "type": "string" }, "Seller.Data.ErpLink.Address.City": { "type": "string" }, "Seller.Data.ErpLink.Address.State": { "type": "string" }, "Seller.Data.ErpLink.Address.Country": { "type": "string" }, "Seller.Data.ErpLink.ShipTo": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLinkAddress" } }, "Seller.Data.ErpLink.BillTo": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLinkAddress" } }, "Seller.Data.ErpLink.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Name": { "type": "string" }, "Seller.Data.ErpLink.Icon": { "type": "string" }, "Seller.Data.ErpLink.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Audit.Blocked.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Audit.Blocked.ById": { "type": "string" }, "Seller.Data.ErpLink.Audit.Blocked.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Data.ErpLink.Audit.Blocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Audit.Blocked.By.Name": { "type": "string" }, "Seller.Data.ErpLink.Audit.Blocked.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Audit.Blocked.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Audit.Blocked.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Audit.Blocked.By.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Audit.Blocked.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Audit.Blocked.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Audit.Blocked.By.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Audit.Blocked.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Audit.Blocked.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Audit.Unblocked.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Audit.Unblocked.ById": { "type": "string" }, "Seller.Data.ErpLink.Audit.Unblocked.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Data.ErpLink.Audit.Unblocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Audit.Unblocked.By.Name": { "type": "string" }, "Seller.Data.ErpLink.Audit.Unblocked.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Audit.Unblocked.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Audit.Unblocked.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Audit.Unblocked.By.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Audit.Unblocked.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Audit.Unblocked.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Audit.Unblocked.By.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Audit.Unblocked.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Audit.Unblocked.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Data.ErpLink.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Audit.Created.By.Name": { "type": "string" }, "Seller.Data.ErpLink.Audit.Created.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Audit.Created.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Data.ErpLink.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Audit.Updated.By.Name": { "type": "string" }, "Seller.Data.ErpLink.Audit.Updated.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Audit.Updated.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Id": { "type": "string" }, "Seller.Data.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.Name": { "type": "string" }, "Seller.Data.Icon": { "type": "string" }, "Seller.Data.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.Audit.Created.ById": { "type": "string" }, "Seller.Data.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Data.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.Audit.Created.By.Name": { "type": "string" }, "Seller.Data.Audit.Created.By.Icon": { "type": "string" }, "Seller.Data.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.Data.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.Data.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.Audit.Created.By.Id": { "type": "string" }, "Seller.Data.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.Audit.Updated.ById": { "type": "string" }, "Seller.Data.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Data.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.Audit.Updated.By.Name": { "type": "string" }, "Seller.Data.Audit.Updated.By.Icon": { "type": "string" }, "Seller.Data.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.Data.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.Data.Audit.Updated.By.Id": { "type": "string" }, "Seller.Data.Id": { "type": "string" }, "Seller.IsDefined": { "type": "boolean" } }, "description": "Json representation of the seller" }, "logo": { "type": "string", "format": "binary" } } }, "encoding": { "seller": { "contentType": "application/json" }, "logo": { "contentType": "application/octet-stream" } } }, "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ] }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string" }, "icon": { "type": "string", "nullable": true }, "revision": { "type": "integer", "format": "int32" }, "externalId": { "type": "string", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/SellerStatus" } ], "nullable": true }, "currencies": { "type": "array", "items": { "$ref": "#/components/schemas/SellerCurrency" }, "nullable": true }, "address": { "allOf": [ { "$ref": "#/components/schemas/Address" } ] }, "erpLink": { "allOf": [ { "$ref": "#/components/schemas/ErpLink" } ], "nullable": true } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Seller" }, "example": { "id": "SEL-7295-4834", "revision": 2, "name": "SoftwareOne AG", "icon": "/static/accounts/SEL-7295-4834/logo.png", "audit": { "created": { "at": "2024-02-01T09:12:23+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "updated": { "at": "2024-02-02T10:20:00+00:00", "by": { "id": "USR-0001", "name": "Ops User" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Sellers" ], "summary": "Delete seller", "description": "Delete seller.\nAvailable for Operations account with platform account management permissions.\nRemoves the seller record.\nReturns 204 No Content on success.", "parameters": [ { "name": "id", "in": "path", "description": "Seller identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/sellers/{id}/activate": { "post": { "tags": [ "Sellers" ], "summary": "Activate seller", "description": "Activate seller.\nChanges seller state to Active.\nAvailable for Operations account with platform account management permissions.\nReturns the updated seller object.", "parameters": [ { "name": "id", "in": "path", "description": "Seller identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Seller" }, "example": { "id": "SEL-7295-4834", "revision": 2, "name": "SoftwareOne AG", "externalId": "SWO_CH", "status": "Active", "icon": null, "currencies": [ "USD" ], "audit": { "created": { "at": "2024-02-01T09:12:23+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "updated": { "at": "2024-02-02T10:00:00+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "activated": { "at": "2024-02-02T10:00:00+00:00", "by": { "id": "USR-0001", "name": "Ops User" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/sellers/{id}/deactivate": { "post": { "tags": [ "Sellers" ], "summary": "Deactivate seller", "description": "Deactivate seller.\nChanges seller state to Offline (e.g for maintenance).\nAvailable for Operations account with platform account management permissions.\nReturns the updated seller object.", "parameters": [ { "name": "id", "in": "path", "description": "Seller identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Seller" }, "example": { "id": "SEL-7295-4834", "revision": 2, "name": "SoftwareOne AG", "externalId": "SWO_CH", "status": "Offline", "audit": { "created": { "at": "2024-02-01T09:12:23+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "updated": { "at": "2024-02-02T10:05:00+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "offline": { "at": "2024-02-02T10:05:00+00:00", "by": { "id": "USR-0001", "name": "Ops User" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/sellers/{id}/disable": { "post": { "tags": [ "Sellers" ], "summary": "Disable seller", "description": "Disable seller.\nChanges seller state to Disabled.\nAvailable for Operations account with platform account management permissions.\nReturns the updated seller object.", "parameters": [ { "name": "id", "in": "path", "description": "Seller identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Seller" }, "example": { "id": "SEL-7295-4834", "revision": 2, "name": "SoftwareOne AG", "externalId": "SWO_CH", "status": "Disabled", "audit": { "created": { "at": "2024-02-01T09:12:23+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "updated": { "at": "2024-02-02T10:10:00+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "disabled": { "at": "2024-02-02T10:10:00+00:00", "by": { "id": "USR-0001", "name": "Ops User" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/sellers/{id}/icon": { "get": { "tags": [ "Sellers" ], "summary": "Get seller icon", "description": "Get seller icon.\nAvailable for public access (no authentication required).\nReturns a redirect (307) to the icon binary URL.\nResponse uses a private blob cache profile.", "parameters": [ { "name": "id", "in": "path", "description": "Seller identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "307": { "description": "Temporary Redirect" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/services": { "get": { "tags": [ "Services" ], "summary": "List service identities", "description": "List service identities.\nReturns a paged list of internal platform service identities; supports RQL query parameters.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceListResponse" }, "example": { "data": [ { "id": "SVC-1234", "revision": 1, "name": "Billing", "description": "Billing component", "icon": null, "status": "Active" } ], "$meta": { "pagination": { "offset": 0, "limit": 10, "total": 1 } } } } } } } } }, "/public/v1/accounts/services/{id}": { "get": { "tags": [ "Services" ], "summary": "Get service identity by ID", "description": "Get service identity by ID.\nReturns a single service identity with id, name, description, icon, and status.\nOptional select query parameter controls which fields are returned.", "parameters": [ { "name": "id", "in": "path", "description": "Service identity identifier.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional RQL select statement to limit returned fields.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Service" }, "example": { "id": "SVC-1234", "name": "Billing", "description": "Billing component", "icon": null, "status": "Active" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/commerce/agreements/{agreementId}/split": { "get": { "tags": [ "SplitBillingAgreement" ], "summary": "Gets split billing allocations for an agreement.", "parameters": [ { "name": "agreementId", "in": "path", "description": "Agreement id", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Select expression", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SplitBillingAgreement" } } } } } }, "post": { "tags": [ "SplitBillingAgreement" ], "summary": "Activates split billing for an agreement.", "parameters": [ { "name": "agreementId", "in": "path", "description": "Agreement id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Split billing details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SplitBillingAgreement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SplitBillingAgreement" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SplitBillingAgreement" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SplitBillingAgreement" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "SplitBillingAgreement" ], "summary": "Updates split billing allocations for an agreement.", "parameters": [ { "name": "agreementId", "in": "path", "description": "Agreement id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Updated split billing details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SplitBillingAgreement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SplitBillingAgreement" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SplitBillingAgreement" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SplitBillingAgreement" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/commerce/subscriptions/{subscriptionId}/split": { "get": { "tags": [ "SplitBillingSubscription" ], "summary": "Gets split billing allocations for a subscription.", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "Subscription id", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Select expression", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SplitBillingSubscription" } } } } } }, "put": { "tags": [ "SplitBillingSubscription" ], "summary": "Updates split billing allocations for a subscription.", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "Subscription id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Updated split billing details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SplitBillingSubscription" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SplitBillingSubscription" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SplitBillingSubscription" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SplitBillingSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/commerce/subscriptions": { "post": { "tags": [ "Subscriptions" ], "summary": "Creates a new subscription.", "requestBody": { "description": "Subscription details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Subscription" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Subscriptions" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionListResponse" } } } } } } }, "/public/v1/commerce/subscriptions/{id}": { "put": { "tags": [ "Subscriptions" ], "summary": "Updates an existing subscription.", "parameters": [ { "name": "id", "in": "path", "description": "Subscription id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Updated subscription details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Subscription" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Subscriptions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/commerce/subscriptions/{id}/terminate": { "post": { "tags": [ "Subscriptions" ], "summary": "Terminates an existing subscription.", "parameters": [ { "name": "id", "in": "path", "description": "Subscription id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Termination details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Subscription" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/commerce/subscriptions/{id}/render": { "get": { "tags": [ "Subscriptions" ], "summary": "Renders a subscription template.", "parameters": [ { "name": "id", "in": "path", "description": "Subscription id", "required": true, "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "Template language code", "schema": { "type": "string" } }, { "name": "template.id", "in": "query", "description": "Template id", "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "Preferred language header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/catalog/products/{productId}/templates": { "post": { "tags": [ "Templates" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateTemplateRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateTemplateRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateTemplateRequest" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Templates" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateListResponse" } } } } } } }, "/public/v1/catalog/products/{productId}/templates/{id}": { "put": { "tags": [ "Templates" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateUpdate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TemplateUpdate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TemplateUpdate" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Templates" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/catalog/products/{productId}/terms": { "post": { "tags": [ "TermsAndConditions" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateTermsAndConditionsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateTermsAndConditionsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateTermsAndConditionsRequest" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermsAndConditions" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "TermsAndConditions" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermsAndConditionsListResponse" } } } } } } }, "/public/v1/catalog/products/{productId}/terms/{id}": { "put": { "tags": [ "TermsAndConditions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateTermsAndConditionsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateTermsAndConditionsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateTermsAndConditionsRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermsAndConditions" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "TermsAndConditions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "TermsAndConditions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermsAndConditions" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/catalog/products/{productId}/terms/{id}/review": { "post": { "tags": [ "TermsAndConditions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermsAndConditions" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/catalog/products/{productId}/terms/{id}/publish": { "post": { "tags": [ "TermsAndConditions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermsAndConditions" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/catalog/products/{productId}/terms/{id}/unpublish": { "post": { "tags": [ "TermsAndConditions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermsAndConditions" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/catalog/products/{productId}/terms/{termsAndConditionsId}/variants": { "post": { "tags": [ "TermsAndConditionsVariant" ], "parameters": [ { "name": "termsAndConditionsId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "variant": { "type": "object", "properties": { "Type": { "enum": [ "Online", "File" ], "type": "string" }, "AssetUrl": { "type": "string" }, "LanguageCode": { "type": "string" }, "Name": { "type": "string" }, "Description": { "type": "string" } }, "description": "Json representation of the variant" }, "file": { "type": "string", "format": "binary" } } }, "encoding": { "variant": { "contentType": "application/json" }, "file": { "contentType": "application/octet-stream" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermsAndConditionsVariant" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "TermsAndConditionsVariant" ], "parameters": [ { "name": "termsAndConditionsId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermsAndConditionsVariantListResponse" } } } } } } }, "/public/v1/catalog/products/{productId}/terms/{termsAndConditionsId}/variants/{id}": { "put": { "tags": [ "TermsAndConditionsVariant" ], "parameters": [ { "name": "termsAndConditionsId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermsVariantUpdate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TermsVariantUpdate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TermsVariantUpdate" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermsAndConditionsVariant" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "TermsAndConditionsVariant" ], "parameters": [ { "name": "termsAndConditionsId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "TermsAndConditionsVariant" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "termsAndConditionsId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermsAndConditionsVariant" } } } }, "301": { "description": "Moved Permanently" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/catalog/products/{productId}/terms/{termsAndConditionsId}/variants/{id}/review": { "post": { "tags": [ "TermsAndConditionsVariant" ], "parameters": [ { "name": "termsAndConditionsId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermsAndConditionsVariant" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/catalog/products/{productId}/terms/{termsAndConditionsId}/variants/{id}/publish": { "post": { "tags": [ "TermsAndConditionsVariant" ], "parameters": [ { "name": "termsAndConditionsId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermsAndConditionsVariant" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/catalog/products/{productId}/terms/{termsAndConditionsId}/variants/{id}/unpublish": { "post": { "tags": [ "TermsAndConditionsVariant" ], "parameters": [ { "name": "termsAndConditionsId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermsAndConditionsVariant" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/catalog/units-of-measure": { "post": { "tags": [ "UnitsOfMeasure" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateUnitOfMeasureRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateUnitOfMeasureRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateUnitOfMeasureRequest" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitOfMeasure" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "UnitsOfMeasure" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitOfMeasureListResponse" } } } } } } }, "/public/v1/catalog/units-of-measure/{id}": { "put": { "tags": [ "UnitsOfMeasure" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateUnitOfMeasureRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateUnitOfMeasureRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateUnitOfMeasureRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitOfMeasure" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "UnitsOfMeasure" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitOfMeasure" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/user-groups": { "get": { "tags": [ "UserGroups" ], "summary": "List user groups", "description": "List user groups.\nReturns a paged list of user groups; supports RQL query parameters for filtering and selection.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupListResponse" }, "example": { "data": [ { "id": "UGR-5116-6265", "revision": 2, "name": "Test-1", "description": "Group for access management", "isDefault": false, "account": { "id": "ACC-1234-5678", "name": "Microsoft" }, "modules": [ { "id": "MOD-1756-1452" }, { "id": "MOD-9042-8216" } ] } ], "$meta": { "pagination": { "offset": 0, "limit": 10, "total": 1 } } } } } } } }, "post": { "tags": [ "UserGroups" ], "summary": "Create user group", "description": "Create user group.\nAccepts account reference, name, optional description and logo, modules (at least one), and optional buyers and extensions.\nReturns the created user group object with revision 1.", "requestBody": { "description": "User group payload.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateUserGroupDto" } ] }, "example": { "account": { "id": "ACC-1234-5678" }, "name": "Rolls-Royce", "description": "The best car producer ever", "modules": [ { "id": "MOD-1756-1452" }, { "id": "MOD-9042-8216" } ], "buyers": null, "extensions": null } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateUserGroupDto" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateUserGroupDto" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroup" }, "example": { "id": "UGR-5116-6265", "revision": 1, "name": "Rolls-Royce", "description": "The best car producer ever", "isDefault": false, "account": { "id": "ACC-1234-5678", "name": "Microsoft" }, "modules": [ { "id": "MOD-1756-1452" }, { "id": "MOD-9042-8216" } ], "audit": { "created": { "at": "2024-02-01T09:12:23+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "updated": { "at": "2024-02-01T09:12:23+00:00", "by": { "id": "USR-0001", "name": "Ops User" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/user-groups/{id}": { "get": { "tags": [ "UserGroups" ], "summary": "Get user group by ID", "description": "Get user group by ID.\nReturns a single user group with id, name, description, account, modules, users, buyers, and default flag.\nOptional select query parameter controls which fields are returned.", "parameters": [ { "name": "id", "in": "path", "description": "User group identifier.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional RQL select statement to limit returned fields.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroup" }, "example": { "id": "UGR-5116-6265", "revision": 2, "name": "Test-1", "description": "Group for access management", "isDefault": false, "account": { "id": "ACC-1234-5678", "name": "Microsoft" }, "modules": [ { "id": "MOD-1756-1452", "name": "Access management" }, { "id": "MOD-9042-8216", "name": "Account management" } ], "users": [ { "id": "USR-0000-0016", "name": "Astha Pruthi" } ] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "UserGroups" ], "summary": "Update user group", "description": "Update user group.\nAccepts a delta payload with fields to update (e.g. name, description, logo, modules, buyers).\nReturns the updated user group object.", "parameters": [ { "name": "id", "in": "path", "description": "User group identifier.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Delta payload with updated fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroup" }, "example": { "name": "Rolls-Royce Updated", "description": "Updated description", "modules": [ { "id": "MOD-1756-1452" } ] } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroup" }, "example": { "id": "UGR-5116-6265", "revision": 2, "name": "Rolls-Royce Updated", "description": "Updated description", "isDefault": false, "account": { "id": "ACC-1234-5678", "name": "Microsoft" }, "modules": [ { "id": "MOD-1756-1452" } ], "audit": { "created": { "at": "2024-02-01T09:12:23+00:00", "by": { "id": "USR-0001", "name": "Ops User" } }, "updated": { "at": "2024-02-02T10:00:00+00:00", "by": { "id": "USR-0001", "name": "Ops User" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "UserGroups" ], "summary": "Delete user group", "description": "Delete user group.\nPermanently removes the user group; the group can be deleted only if no users are assigned.\nReturns 204 No Content on success.", "parameters": [ { "name": "id", "in": "path", "description": "User group identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/users": { "get": { "tags": [ "Users" ], "summary": "List users", "description": "List users.\nAvailable for Operations account with platform account management permissions and for Client and Vendor accounts for own users.\nReturns a paged list of users; supports RQL query parameters for filtering, sorting, and selecting fields.\nUse the select parameter to limit fields for performance; default response includes audit and basic profile fields.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserListResponse" }, "example": { "data": [ { "id": "USR-3758-7092", "revision": 3, "name": "John Doe", "icon": "/v1/accounts/users/USR-3758-7092/icon", "email": "john.doe@example.com", "status": "Active", "firstName": "John", "lastName": "Doe", "lastLoginAt": "2026-02-02T10:00:00+00:00", "settings": { "cultureCode": "en-US", "languageCode": "en-US" }, "currentAccount": { "id": "ACC-3758-7092", "type": "Client", "status": "Active", "name": "Example Account", "icon": "/v1/accounts/accounts/ACC-3758-7092/icon" }, "audit": { "created": { "at": "2024-02-02T10:00:00+00:00", "by": { "id": "USR-1234-5678", "name": "John Doe" } }, "updated": { "at": "2026-02-02T10:00:00+00:00", "by": { "id": "USR-0000-0022", "name": "John Smith" } } } } ], "$meta": { "pagination": { "offset": 0, "limit": 10, "total": 1 } } } } } } } } }, "/public/v1/accounts/users/{uniqueFilter}": { "get": { "tags": [ "Users" ], "summary": "Get user by ID or unique filter", "description": "Get user by ID or unique filter.\nIf uniqueFilter is a user ID, returns a full user representation (respecting optional select).\nOtherwise, resolves a user by the provided unique filter and returns a minimal payload containing id, email, status and audit.invitationAcceptedAt.", "parameters": [ { "name": "uniqueFilter", "in": "path", "description": "User identifier (USR-...) or user email address.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional RQL select statement to limit returned fields (only applied when requesting by user ID).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" }, "example": { "id": "USR-3758-7092", "email": "john.doe@example.com", "status": "Active", "audit": { "invitationAcceptedAt": "2026-02-02T10:00:00+00:00" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Users" ], "summary": "Update user (multipart form)", "description": "Updates user fields and optionally uploads or deletes user icon using multipart/form-data payload.\nReturns the updated user object.", "parameters": [ { "name": "uniqueFilter", "in": "path", "description": "User identifier (USR-...) or user email address.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "user": { "type": "object", "properties": { "User.Node.Name": { "type": "string" }, "User.Node.Children": { "type": "array", "items": { "$ref": "#/components/schemas/DeltaNode" } }, "User.Path": { "type": "string" }, "User.Data.Email": { "type": "string" }, "User.Data.Status": { "type": "string" }, "User.Data.Phone.Prefix": { "type": "string" }, "User.Data.Phone.Number": { "type": "string" }, "User.Data.FirstName": { "type": "string" }, "User.Data.LastName": { "type": "string" }, "User.Data.LastLoginAt": { "type": "string", "format": "date-time" }, "User.Data.Settings.CultureCode": { "type": "string" }, "User.Data.Settings.DateFormat": { "type": "string" }, "User.Data.Settings.LanguageCode": { "type": "string" }, "User.Data.Settings.NumberFormat.DecimalSeparator": { "type": "string" }, "User.Data.Settings.NumberFormat.GroupSeparator": { "type": "string" }, "User.Data.Settings.TimeFormat": { "type": "string" }, "User.Data.Settings.TimeZone": { "type": "string" }, "User.Data.Accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } }, "User.Data.CurrentAccount.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "User.Data.CurrentAccount.ExternalId": { "type": "string" }, "User.Data.CurrentAccount.ExternalName": { "type": "string" }, "User.Data.CurrentAccount.Address.AddressLine1": { "type": "string" }, "User.Data.CurrentAccount.Address.AddressLine2": { "type": "string" }, "User.Data.CurrentAccount.Address.PostCode": { "type": "string" }, "User.Data.CurrentAccount.Address.City": { "type": "string" }, "User.Data.CurrentAccount.Address.State": { "type": "string" }, "User.Data.CurrentAccount.Address.Country": { "type": "string" }, "User.Data.CurrentAccount.TechnicalSupportEmail": { "type": "string" }, "User.Data.CurrentAccount.Website": { "type": "string" }, "User.Data.CurrentAccount.Description": { "type": "string" }, "User.Data.CurrentAccount.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "User.Data.CurrentAccount.Eligibility.Client": { "type": "boolean" }, "User.Data.CurrentAccount.Eligibility.Partner": { "type": "boolean" }, "User.Data.CurrentAccount.DefaultLanguageCode": { "type": "string" }, "User.Data.CurrentAccount.Type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ] }, "User.Data.CurrentAccount.Status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ] }, "User.Data.CurrentAccount.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "User.Data.CurrentAccount.Name": { "type": "string" }, "User.Data.CurrentAccount.Icon": { "type": "string" }, "User.Data.CurrentAccount.Revision": { "type": "integer", "format": "int32" }, "User.Data.CurrentAccount.Audit.Created.At": { "type": "string", "format": "date-time" }, "User.Data.CurrentAccount.Audit.Created.ById": { "type": "string" }, "User.Data.CurrentAccount.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "User.Data.CurrentAccount.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "User.Data.CurrentAccount.Audit.Created.By.Name": { "type": "string" }, "User.Data.CurrentAccount.Audit.Created.By.Icon": { "type": "string" }, "User.Data.CurrentAccount.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "User.Data.CurrentAccount.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "User.Data.CurrentAccount.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "User.Data.CurrentAccount.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "User.Data.CurrentAccount.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "User.Data.CurrentAccount.Audit.Created.By.Id": { "type": "string" }, "User.Data.CurrentAccount.Audit.Updated.At": { "type": "string", "format": "date-time" }, "User.Data.CurrentAccount.Audit.Updated.ById": { "type": "string" }, "User.Data.CurrentAccount.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "User.Data.CurrentAccount.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "User.Data.CurrentAccount.Audit.Updated.By.Name": { "type": "string" }, "User.Data.CurrentAccount.Audit.Updated.By.Icon": { "type": "string" }, "User.Data.CurrentAccount.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "User.Data.CurrentAccount.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "User.Data.CurrentAccount.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "User.Data.CurrentAccount.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "User.Data.CurrentAccount.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "User.Data.CurrentAccount.Audit.Updated.By.Id": { "type": "string" }, "User.Data.CurrentAccount.Id": { "type": "string" }, "User.Data.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "User.Data.Name": { "type": "string" }, "User.Data.Icon": { "type": "string" }, "User.Data.Revision": { "type": "integer", "format": "int32" }, "User.Data.Audit.InvitationAcceptedAt": { "type": "string", "format": "date-time" }, "User.Data.Audit.Created.At": { "type": "string", "format": "date-time" }, "User.Data.Audit.Created.ById": { "type": "string" }, "User.Data.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "User.Data.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "User.Data.Audit.Created.By.Name": { "type": "string" }, "User.Data.Audit.Created.By.Icon": { "type": "string" }, "User.Data.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "User.Data.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "User.Data.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "User.Data.Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "User.Data.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "User.Data.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "User.Data.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "User.Data.Audit.Created.By.Id": { "type": "string" }, "User.Data.Audit.Updated.At": { "type": "string", "format": "date-time" }, "User.Data.Audit.Updated.ById": { "type": "string" }, "User.Data.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "User.Data.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "User.Data.Audit.Updated.By.Name": { "type": "string" }, "User.Data.Audit.Updated.By.Icon": { "type": "string" }, "User.Data.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "User.Data.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "User.Data.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "User.Data.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "User.Data.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "User.Data.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "User.Data.Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "User.Data.Audit.Updated.By.Id": { "type": "string" }, "User.Data.Id": { "type": "string" }, "User.IsDefined": { "type": "boolean" } }, "description": "Json representation of the user" }, "icon": { "type": "string", "format": "binary" } } }, "encoding": { "user": { "contentType": "application/json" }, "icon": { "contentType": "application/octet-stream" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserDelta" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Users" ], "summary": "Delete user", "description": "Deletes a user from platform.\nAvailable for Operations account with platform account management permissions or to the user himself.\nReturns 204 No Content on success.", "parameters": [ { "name": "uniqueFilter", "in": "path", "description": "User identifier (USR-...) or user email address.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/users/{uniqueFilter}/set-password": { "post": { "tags": [ "Users" ], "summary": "Set user password", "description": "Sets a new password for the user.\nIntended for password-based users; updates are applied immediately.\nReturns the updated user object.", "parameters": [ { "name": "uniqueFilter", "in": "path", "description": "User identifier (USR-...) or user email address.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Password payload (current and new password).", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SetPasswordDto" } ] }, "example": { "currentPassword": "OldPassword123", "password": "NewPassword123!" } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SetPasswordDto" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SetPasswordDto" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/users/{uniqueFilter}/unblock": { "post": { "tags": [ "Users" ], "summary": "Unblock user", "description": "Unblocks a user and restores access.\nReturns the updated user object.", "parameters": [ { "name": "uniqueFilter", "in": "path", "description": "User identifier (USR-...) or user email address.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/users/{uniqueFilter}/block": { "post": { "tags": [ "Users" ], "summary": "Block user", "description": "Blocks a user and prevents access.\nReturns the updated user object.", "parameters": [ { "name": "uniqueFilter", "in": "path", "description": "User identifier (USR-...) or user email address.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/users/{uniqueFilter}/sso-check": { "get": { "tags": [ "Users" ], "summary": "Check whether SSO is enabled (deprecated)", "description": "Deprecated - use the `/accounts/users/{userId}/sso` endpoint instead.\nReturns an object with boolean `isSso` property.", "parameters": [ { "name": "uniqueFilter", "in": "path", "description": "User identifier (USR-...) or user email address.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true } }, "/public/v1/accounts/users/{uniqueFilter}/sso": { "get": { "tags": [ "Users" ], "summary": "Check SSO status", "description": "Returns SSO status for the user.\nPossible values: `enabled`, `disabled`.", "parameters": [ { "name": "uniqueFilter", "in": "path", "description": "User identifier (USR-...) or user email address.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/users/{uniqueFilter}/icon": { "get": { "tags": [ "Users" ], "summary": "Get user icon", "description": "Returns a temporary redirect to the user's icon download URL.", "parameters": [ { "name": "uniqueFilter", "in": "path", "description": "User identifier (USR-...) or user email address.", "required": true, "schema": { "type": "string" } } ], "responses": { "307": { "description": "Temporary Redirect" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/users/{uniqueFilter}/accounts": { "get": { "tags": [ "Users" ], "summary": "List accounts associated with the user", "description": "Returns accounts associated with the user (extended account view).\nSupports select query parameter; userId is always included.", "parameters": [ { "name": "uniqueFilter", "in": "path", "description": "User identifier (USR-...) or user email address.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "RQL select statement.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserExtendedAccountListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/users/{uniqueFilter}/accounts/{accountId}": { "put": { "tags": [ "Users" ], "summary": "Update user's account settings", "description": "Updates user settings within the specified account (extended account view) using a delta payload.\nReturns the updated user-account object.", "parameters": [ { "name": "uniqueFilter", "in": "path", "description": "User identifier (USR-...) or user email address.", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "description": "Account identifier.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional RQL select statement to limit returned fields.", "schema": { "type": "string" } } ], "requestBody": { "description": "Delta payload with fields to update.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserExtendedAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserExtendedAccount" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserExtendedAccount" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserExtendedAccount" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/notifications/webhooks": { "get": { "tags": [ "Webhooks" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookListResponse" } } } } } }, "post": { "tags": [ "Webhooks" ], "summary": "Creates a new webhook", "parameters": [ { "name": "select", "in": "query", "description": "RQL select statements", "schema": { "type": "string" } } ], "requestBody": { "description": "Details of the webhook to create", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateWebhookRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateWebhookRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateWebhookRequest" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/notifications/webhooks/{id}": { "get": { "tags": [ "Webhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Webhooks" ], "summary": "Updates webhook.", "parameters": [ { "name": "id", "in": "path", "description": "Id of webhook to update", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "RQL select statements", "schema": { "type": "string" } } ], "requestBody": { "description": "Update details of webhook", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateWebhookRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateWebhookRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateWebhookRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Webhooks" ], "summary": "Deletes webhook.", "parameters": [ { "name": "id", "in": "path", "description": "Id of webhook to be deleted", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/notifications/webhooks/{id}/enable": { "post": { "tags": [ "Webhooks" ], "summary": "Enables webhook.", "parameters": [ { "name": "id", "in": "path", "description": "Id of webhook to be deleted", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/notifications/webhooks/{id}/disable": { "post": { "tags": [ "Webhooks" ], "summary": "Disables webhook.", "parameters": [ { "name": "id", "in": "path", "description": "Id of webhook to be deleted", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/chats/{chatId}/answers": { "get": { "tags": [ "Answer" ], "summary": "List all answers for a chat", "description": "ListAnswers\nRetrieves all answers associated with the specified chat.\nReturns a paginated list with support for filtering, sorting, and field selection via query parameters.\nSoft-deleted answers are excluded from results.\nAvailable for authenticated chat participants.", "parameters": [ { "name": "chatId", "in": "path", "description": "The unique identifier of the chat", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnswerListResponse" }, "example": { "data": [ { "id": "ANS-1234-5678-9012", "name": "Customer Onboarding", "form": { "id": "FRM-1234-5678-9012", "name": "Customer Onboarding" }, "chat": { "id": "CHT-1234-5678-9012", "name": "Support Request" }, "status": "Draft", "isDeleted": false, "parameters": [ { "id": "HPD-1234-5678-9012", "externalId": "customer-name", "value": null, "constraints": { "required": true, "readonly": false, "visibility": "All" }, "error": null, "groups": [ { "id": "PGR-1234-5678-9012", "displayOrder": 1 } ] } ], "revision": 2, "audit": { "created": { "at": "2024-02-02T10:00:00+00:00", "by": "user@example.com" }, "updated": { "at": "2024-02-02T12:00:00+00:00", "by": "user@example.com" } } } ], "total": 1 } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Answer" ], "summary": "Create a new answer from a published form", "description": "CreateAnswer\nCreates a new answer within the specified chat by initializing parameters from a published form template.\nAll form parameters are created with null values and constraints copied from their definitions.\nThe form must have Published status; otherwise, a 400 error is returned.\nAvailable for authenticated chat participants.", "parameters": [ { "name": "chatId", "in": "path", "description": "The unique identifier of the chat", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The answer object containing the form reference (form.id is required)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Answer" }, "example": { "form": { "id": "FRM-1234-5678-9012" } } }, "text/json": { "schema": { "$ref": "#/components/schemas/Answer" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Answer" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Answer" }, "example": { "id": "ANS-1234-5678-9012", "name": "Customer Onboarding", "form": { "id": "FRM-1234-5678-9012", "name": "Customer Onboarding" }, "chat": { "id": "CHT-1234-5678-9012", "name": "Support Request" }, "status": "Draft", "isDeleted": false, "parameters": [ { "id": "HPD-1234-5678-9012", "externalId": "customer-name", "value": null, "constraints": { "required": true, "readonly": false, "visibility": "All" }, "error": null, "groups": [ { "id": "PGR-1234-5678-9012", "displayOrder": 1 } ] } ], "revision": 1, "audit": { "created": { "at": "2024-02-02T10:00:00+00:00", "by": "user@example.com" }, "updated": { "at": "2024-02-02T10:00:00+00:00", "by": "user@example.com" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/chats/{chatId}/answers/{id}": { "get": { "tags": [ "Answer" ], "summary": "Retrieve an answer by ID", "description": "GetAnswer\nRetrieves a specific answer within the specified chat by its unique identifier.\nSupports RQL select parameter for field filtering to optimize response payload.\nReturns 404 if the answer does not exist, does not belong to the chat, or has been deleted.\nAvailable for authenticated chat participants.", "parameters": [ { "name": "chatId", "in": "path", "description": "The unique identifier of the chat", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier of the answer", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional RQL select statement to filter fields", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Answer" }, "example": { "id": "ANS-1234-5678-9012", "name": "Customer Onboarding", "form": { "id": "FRM-1234-5678-9012", "name": "Customer Onboarding" }, "chat": { "id": "CHT-1234-5678-9012", "name": "Support Request" }, "status": "Submitted", "isDeleted": false, "parameters": [ { "id": "HPD-1234-5678-9012", "externalId": "customer-name", "value": "John Doe", "constraints": { "required": true, "readonly": false, "visibility": "All" }, "error": null, "groups": [ { "id": "PGR-1234-5678-9012", "displayOrder": 1 } ] } ], "revision": 2, "audit": { "created": { "at": "2024-02-02T10:00:00+00:00", "by": "user@example.com" }, "updated": { "at": "2024-02-02T12:00:00+00:00", "by": "user@example.com" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Answer" ], "summary": "Update answer parameter values", "description": "UpdateAnswer\nUpdates parameter values for the specified answer within the chat.\nAll form parameters must be included in the request; parameters can be identified by parameterId or externalId.\nRole-based restrictions apply: in Submitted status only the assignee can update, in Querying only the reporter, and Accepted answers cannot be updated.\nAvailable for authenticated chat participants with role-based restrictions per answer status.", "parameters": [ { "name": "chatId", "in": "path", "description": "The unique identifier of the chat", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier of the answer", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Representation of the answer business object with parameter updates", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Answer" }, "example": { "parameters": [ { "id": "HPD-1234-5678-9012", "value": "John Doe", "groups": [ { "id": "PGR-1234-5678-9012" } ] } ] } }, "text/json": { "schema": { "$ref": "#/components/schemas/Answer" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Answer" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Answer" }, "example": { "id": "ANS-1234-5678-9012", "name": "Customer Onboarding", "form": { "id": "FRM-1234-5678-9012", "name": "Customer Onboarding" }, "chat": { "id": "CHT-1234-5678-9012", "name": "Support Request" }, "status": "Draft", "isDeleted": false, "parameters": [ { "id": "HPD-1234-5678-9012", "externalId": "customer-name", "value": "John Doe", "constraints": { "required": true, "readonly": false, "visibility": "All" }, "error": null, "groups": [ { "id": "PGR-1234-5678-9012", "displayOrder": 1 } ] } ], "revision": 2, "audit": { "created": { "at": "2024-02-02T10:00:00+00:00", "by": "user@example.com" }, "updated": { "at": "2024-02-02T12:00:00+00:00", "by": "user@example.com" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Answer" ], "summary": "Soft-delete an answer", "description": "DeleteAnswer\nMarks the specified answer as deleted (soft delete) within the chat.\nThe answer remains in the database but is excluded from all query results.\nRecords a deletion audit event with timestamp and actor information.\nAvailable for authenticated chat participants.", "parameters": [ { "name": "chatId", "in": "path", "description": "The unique identifier of the chat", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier of the answer", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/chats/{chatId}/answers/{id}/validate": { "post": { "tags": [ "Answer" ], "summary": "Validates answer parameter values", "description": "ValidateAnswer\nValidates parameter values for the specified answer within the chat.\nAll form parameters must be included in the request; parameters can be identified by parameterId or externalId.\nRole-based restrictions apply: in Submitted status only the assignee can update, in Querying only the reporter, and Accepted answers cannot be updated.\nAvailable for authenticated chat participants with role-based restrictions per answer status.", "parameters": [ { "name": "chatId", "in": "path", "description": "The unique identifier of the chat", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier of the answer", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Representation of the answer business object with parameter updates", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Answer" }, "example": { "parameters": [ { "id": "HPD-1234-5678-9012", "value": "John Doe", "groups": [ { "id": "PGR-1234-5678-9012" } ] } ] } }, "text/json": { "schema": { "$ref": "#/components/schemas/Answer" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Answer" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Answer" }, "example": { "id": "ANS-1234-5678-9012", "name": "Customer Onboarding", "form": { "id": "FRM-1234-5678-9012", "name": "Customer Onboarding" }, "chat": { "id": "CHT-1234-5678-9012", "name": "Support Request" }, "status": "Draft", "isDeleted": false, "parameters": [ { "id": "HPD-1234-5678-9012", "externalId": "customer-name", "value": "John Doe", "constraints": { "required": true, "readonly": false, "visibility": "All" }, "error": null, "groups": [ { "id": "PGR-1234-5678-9012", "displayOrder": 1 } ] } ], "revision": 2, "audit": { "created": { "at": "2024-02-02T10:00:00+00:00", "by": "user@example.com" }, "updated": { "at": "2024-02-02T12:00:00+00:00", "by": "user@example.com" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/chats/{chatId}/answers/{id}/submit": { "post": { "tags": [ "Answer" ], "summary": "Submit an answer for review", "description": "SubmitAnswer\nTransitions the answer status to Mpt.Helpdesk.Models.Answers.AnswerStatus.Submitted, triggering automated parameter validation against Required and Capacity constraints.\nIf validation fails, system errors are set on invalid parameters and the operation returns 400.\nValid from Mpt.Helpdesk.Models.Answers.AnswerStatus.Draft or Mpt.Helpdesk.Models.Answers.AnswerStatus.Querying status; returns 400 for invalid transitions.\nAvailable for authenticated chat participants.", "parameters": [ { "name": "chatId", "in": "path", "description": "The unique identifier of the chat", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier of the answer", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Answer" }, "example": { "id": "ANS-1234-5678-9012", "name": "Customer Onboarding", "form": { "id": "FRM-1234-5678-9012", "name": "Customer Onboarding" }, "chat": { "id": "CHT-1234-5678-9012", "name": "Support Request" }, "status": "Submitted", "isDeleted": false, "parameters": [ { "id": "HPD-1234-5678-9012", "externalId": "customer-name", "value": "John Doe", "constraints": { "required": true, "readonly": false, "visibility": "All" }, "error": null, "groups": [ { "id": "PGR-1234-5678-9012", "displayOrder": 1 } ] } ], "revision": 3, "audit": { "created": { "at": "2024-02-02T10:00:00+00:00", "by": "user@example.com" }, "updated": { "at": "2024-02-02T14:00:00+00:00", "by": "user@example.com" }, "submitted": { "at": "2024-02-02T14:00:00+00:00", "by": "user@example.com" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/chats/{chatId}/answers/{id}/accept": { "post": { "tags": [ "Answer" ], "summary": "Accept the answer and lock all parameters", "description": "AcceptAnswer\nTransitions the answer status to Mpt.Helpdesk.Models.Answers.AnswerStatus.Accepted, setting all parameters to read-only and clearing all errors.\nThis is a terminal state; no further modifications are allowed after acceptance.\nValid only from Mpt.Helpdesk.Models.Answers.AnswerStatus.Submitted status; returns 400 for invalid transitions.\nAvailable for the assignee (form owner) only.", "parameters": [ { "name": "chatId", "in": "path", "description": "The unique identifier of the chat", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier of the answer", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Answer" }, "example": { "id": "ANS-1234-5678-9012", "name": "Customer Onboarding", "form": { "id": "FRM-1234-5678-9012", "name": "Customer Onboarding" }, "chat": { "id": "CHT-1234-5678-9012", "name": "Support Request" }, "status": "Accepted", "isDeleted": false, "parameters": [ { "id": "HPD-1234-5678-9012", "externalId": "customer-name", "value": "John Doe", "constraints": { "required": true, "readonly": true, "visibility": "All" }, "error": null, "groups": [ { "id": "PGR-1234-5678-9012", "displayOrder": 1 } ] } ], "revision": 4, "audit": { "created": { "at": "2024-02-02T10:00:00+00:00", "by": "user@example.com" }, "updated": { "at": "2024-02-02T16:00:00+00:00", "by": "admin@example.com" }, "accepted": { "at": "2024-02-02T16:00:00+00:00", "by": "admin@example.com" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/chats/{chatId}/answers/{id}/query": { "post": { "tags": [ "Answer" ], "summary": "Request changes from the reporter", "description": "QueryAnswer\nTransitions the answer status to Mpt.Helpdesk.Models.Answers.AnswerStatus.Querying, indicating the assignee has requested changes from the reporter.\nThe assignee should set error details on problematic parameters via update before invoking this action.\nValid only from Mpt.Helpdesk.Models.Answers.AnswerStatus.Submitted status; returns 400 for invalid transitions.\nAvailable for the assignee (form owner) only.", "parameters": [ { "name": "chatId", "in": "path", "description": "The unique identifier of the chat", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier of the answer", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Answer" }, "example": { "id": "ANS-1234-5678-9012", "name": "Customer Onboarding", "form": { "id": "FRM-1234-5678-9012", "name": "Customer Onboarding" }, "chat": { "id": "CHT-1234-5678-9012", "name": "Support Request" }, "status": "Querying", "isDeleted": false, "parameters": [ { "id": "HPD-1234-5678-9012", "externalId": "customer-name", "value": "John Doe", "constraints": { "required": true, "readonly": false, "visibility": "All" }, "error": { "message": "Please provide the full legal name" }, "groups": [ { "id": "PGR-1234-5678-9012", "displayOrder": 1 } ] } ], "revision": 3, "audit": { "created": { "at": "2024-02-02T10:00:00+00:00", "by": "user@example.com" }, "updated": { "at": "2024-02-02T15:00:00+00:00", "by": "admin@example.com" }, "queried": { "at": "2024-02-02T15:00:00+00:00", "by": "admin@example.com" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/chats": { "get": { "tags": [ "Chat" ], "summary": "Get a list of chats", "description": "Supports filtering, sorting, and pagination via query string parameters.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatListResponse" } } } } } }, "post": { "tags": [ "Chat" ], "summary": "Create a new Chat", "description": "Creates a chat with an icon using multipart form data.", "parameters": [ { "name": "chat", "in": "query", "description": "Representation of the Chat business object.", "schema": { "allOf": [ { "$ref": "#/components/schemas/ChatDelta" } ] } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Chat" }, "encoding": { "icon": { "style": "form" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/Chat" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Chat" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Chat" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/chats/{id}": { "get": { "tags": [ "Chat" ], "summary": "Retrieve a chat by ID", "description": "Use the select query parameter to specify which fields to include.", "parameters": [ { "name": "id", "in": "path", "description": "The chat ID.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional select statement to filter fields.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Chat" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Chat" ], "summary": "Update an existing Chat", "description": "Updates a chat and allows replacing its icon using multipart form data.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the Chat to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Representation of the Chat business object.", "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Chat" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Chat" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Chat" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/chats/{id}/icon": { "get": { "tags": [ "Chat" ], "summary": "Get a download redirect for a chat icon", "description": "Returns a temporary redirect to the stored icon URL.", "parameters": [ { "name": "id", "in": "path", "description": "The chat ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "307": { "description": "Temporary Redirect" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/chats/{chatId}/attachments": { "get": { "tags": [ "ChatAttachment" ], "summary": "Get a list of chat attachments", "description": "The chat ID is provided in the route. Supports filtering, sorting, and pagination via query string parameters.", "parameters": [ { "name": "chatId", "in": "path", "description": "The chat ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatAttachmentListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "ChatAttachment" ], "summary": "Add attachments to an existing chat entry", "description": "Accepts multipart form data with attachment files.", "parameters": [ { "name": "chatId", "in": "path", "description": "The chat ID.", "required": true, "schema": { "type": "string" } }, { "name": "attachment", "in": "query", "description": "Attachment field in JSON format representing the attachment data", "schema": { "allOf": [ { "$ref": "#/components/schemas/ChatAttachmentDelta" } ] } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ChatAttachment" }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatAttachment" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/chats/{chatId}/attachments/{id}": { "get": { "tags": [ "ChatAttachment" ], "summary": "Retrieve a chat attachment by ID", "description": "The chat ID is provided in the route. Use the select query parameter to specify which fields to include.", "parameters": [ { "name": "chatId", "in": "path", "description": "The chat ID.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The chat attachment ID.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional select statement to filter fields.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatAttachment" } } } }, "301": { "description": "Moved Permanently" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "ChatAttachment" ], "summary": "Update a chat attachment data", "description": "The chat ID is provided in the route.", "parameters": [ { "name": "chatId", "in": "path", "description": "The chat ID.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The chat attachment ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "JSON payload containing the updated data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatAttachment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChatAttachment" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatAttachment" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "ChatAttachment" ], "summary": "Delete a chat attachment by ID", "description": "The chat ID is provided in the route.", "parameters": [ { "name": "chatId", "in": "path", "description": "The chat ID.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The chat attachment ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/chats/{chatId}/participants": { "get": { "tags": [ "ChatParticipant" ], "summary": "Get a list of chat participants", "description": "Supports filtering, sorting, and pagination via query string parameters.", "parameters": [ { "name": "chatId", "in": "path", "description": "The chat ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatParticipantListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "ChatParticipant" ], "summary": "Add new chat participants", "description": "When a single participant is added, returns a single participant entity. For multiple, returns a list.", "parameters": [ { "name": "chatId", "in": "path", "description": "The chat ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Participants to add.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChatParticipantDelta" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChatParticipantDelta" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChatParticipantDelta" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChatParticipant" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/chats/{chatId}/participants/{id}": { "get": { "tags": [ "ChatParticipant" ], "summary": "Get a chat participant", "description": "Use the select query parameter to specify which fields to include.", "parameters": [ { "name": "chatId", "in": "path", "description": "The chat ID.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The participant ID.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional RQL select statement to filter fields.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatParticipant" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "ChatParticipant" ], "summary": "Update an existing participant", "description": "The chat ID is provided in the route.", "parameters": [ { "name": "chatId", "in": "path", "description": "The chat ID.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The participant ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The update request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatParticipant" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatParticipant" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChatParticipant" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatParticipant" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "ChatParticipant" ], "summary": "Remove a participant from the chat", "description": "The chat ID is provided in the route.", "parameters": [ { "name": "chatId", "in": "path", "description": "The chat ID.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The participant ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/feedback": { "get": { "tags": [ "Feedback" ], "summary": "Get a list of feedbacks", "description": "Supports filtering, sorting, and pagination via query string parameters.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedbackListResponse" } } } } } }, "post": { "tags": [ "Feedback" ], "summary": "Create a new feedback entry", "description": "Creates a feedback entry with attachments using multipart form data.", "parameters": [ { "name": "feedback", "in": "query", "description": "Representation of the Feedback business object.", "schema": { "allOf": [ { "$ref": "#/components/schemas/FeedbackDelta" } ] } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Feedback" }, "encoding": { "file": { "style": "form" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/Feedback" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Feedback" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/feedback/{id}": { "get": { "tags": [ "Feedback" ], "summary": "Retrieve a feedback by ID", "description": "Use the select query parameter to specify which fields to include.", "parameters": [ { "name": "id", "in": "path", "description": "The feedback ID.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional select statement to filter fields.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Feedback" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Feedback" ], "summary": "Update an existing feedback", "description": "The feedback ID is provided in the route.", "parameters": [ { "name": "id", "in": "path", "description": "The feedback ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Representation of the Feedback business object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Feedback" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Feedback" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Feedback" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Feedback" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Feedback" ], "summary": "Delete feedback by ID", "description": "The feedback ID is provided in the route.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the feedback to archive.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/feedback/{id}/review": { "post": { "tags": [ "Feedback" ], "summary": "Update feedback review status", "description": "Marks the feedback as reviewed.", "parameters": [ { "name": "id", "in": "path", "description": "The feedback ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "A cancellation token.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CancellationToken" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CancellationToken" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CancellationToken" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Feedback" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/feedback/{feedbackId}/attachments": { "get": { "tags": [ "FeedbackAttachment" ], "summary": "Get attachments for a feedback entry", "description": "Supports filtering, sorting, and pagination via query string parameters.", "parameters": [ { "name": "feedbackId", "in": "path", "description": "The feedback ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedbackAttachmentListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "FeedbackAttachment" ], "summary": "Add attachments to an existing feedback entry", "description": "Accepts multipart form data with attachment files.", "parameters": [ { "name": "feedbackId", "in": "path", "description": "The feedback ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "attachment": { "type": "object", "properties": { "Name": { "type": "string", "description": "The name of the attachment." }, "Description": { "type": "string", "description": "The description of the attachment." } }, "description": "Json representation of the attachment" }, "file": { "type": "string", "description": "The file of the attachment.", "format": "binary" } } }, "encoding": { "attachment": { "contentType": "application/json" }, "file": { "contentType": "application/octet-stream" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedbackAttachment" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/feedback/{feedbackId}/attachments/{attachmentId}": { "get": { "tags": [ "FeedbackAttachment" ], "summary": "Get attachment for a feedback entry", "parameters": [ { "name": "feedbackId", "in": "path", "description": "The feedback ID.", "required": true, "schema": { "type": "string" } }, { "name": "attachmentId", "in": "path", "description": "The feedback attachment ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedbackAttachment" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "FeedbackAttachment" ], "summary": "Update a feedback attachment", "description": "The feddback ID and feedback attachment id are provided in the route.", "parameters": [ { "name": "feedbackId", "in": "path", "description": "The feedback ID.", "required": true, "schema": { "type": "string" } }, { "name": "attachmentId", "in": "path", "description": "The feedback attachment ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The update request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedbackAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FeedbackAttachment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FeedbackAttachment" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedbackAttachment" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "FeedbackAttachment" ], "summary": "Delete a feedback attachment by ID", "description": "The feedback ID is provided in the route.", "parameters": [ { "name": "attachmentId", "in": "path", "description": "The feedback attachment ID.", "required": true, "schema": { "type": "string" } }, { "name": "feedbackId", "in": "path", "description": "The feedback ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/feedback/{feedbackId}/attachments/{attachmentId}/download": { "get": { "tags": [ "FeedbackAttachment" ], "summary": "Get a download redirect for a feedback attachment", "description": "Returns a temporary redirect to the stored attachment URL.", "parameters": [ { "name": "feedbackId", "in": "path", "description": "The feedback ID.", "required": true, "schema": { "type": "string" } }, { "name": "attachmentId", "in": "path", "description": "The attachment ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "307": { "description": "Temporary Redirect" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/forms/{formId}/parameters": { "get": { "tags": [ "FormParameters" ], "summary": "List all parameters in a form", "description": "ListFormParameters\nRetrieves all parameters belonging to parameter groups within the specified form.\nReturns a paginated list with support for filtering, sorting, and field selection via OData query parameters.\nParameters are aggregated across all parameter groups associated with the form.\nAvailable for Operations accounts with helpdesk administration permissions.", "parameters": [ { "name": "formId", "in": "path", "description": "The unique identifier of the form", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderedParameterDefinitionListResponse" }, "example": { "data": [ { "id": "param-123", "label": "Customer Name", "dataType": "String", "groupId": "group-456", "displayOrder": 1, "revision": 2, "audit": { "created": { "at": "2024-02-02T10:00:00+00:00", "by": "admin@example.com" }, "updated": { "at": "2024-02-02T12:00:00+00:00", "by": "admin@example.com" } } } ], "total": 1 } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/helpdesk/forms/{formId}/parameters/{id}": { "get": { "tags": [ "FormParameters" ], "summary": "Retrieve a parameter within a form by ID", "description": "GetFormParameter\nRetrieves a specific parameter that belongs to a parameter group within the specified form.\nSupports RQL select parameter for field filtering to optimize response payload.\nReturns 404 if the parameter does not exist, does not belong to the form, or the user lacks access.\nAvailable for Operations accounts with helpdesk administration permissions.", "parameters": [ { "name": "formId", "in": "path", "description": "The unique identifier of the form", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier of the parameter", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional RQL select statement to filter fields", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderedParameterDefinition" }, "example": { "id": "param-123", "label": "Customer Name", "description": "Full name of the customer", "dataType": "String", "groupId": "group-456", "displayOrder": 1, "required": true, "revision": 2, "audit": { "created": { "at": "2024-02-02T10:00:00+00:00", "by": "admin@example.com" }, "updated": { "at": "2024-02-02T12:00:00+00:00", "by": "admin@example.com" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/helpdesk/forms": { "get": { "tags": [ "Forms" ], "summary": "Get a list of forms", "description": "Supports filtering, sorting, and pagination via query string parameters.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Forms" ], "summary": "Create a new Form", "description": "Creates a new form from the request payload.", "requestBody": { "description": "Representation of the Form business object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Form" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Form" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/forms/{id}": { "get": { "tags": [ "Forms" ], "summary": "Retrieve a form by ID", "description": "Use the select query parameter to specify which fields to include.", "parameters": [ { "name": "id", "in": "path", "description": "The form ID.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional select statement to filter fields.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Forms" ], "summary": "Update an existing form", "description": "The form ID is provided in the route.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the form to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Representation of the form business object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Form" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Form" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Forms" ], "summary": "Delete a Form", "description": "The form ID is provided in the route.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the form to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/forms/{id}/publish": { "post": { "tags": [ "Forms" ], "summary": "Publish a Form", "description": "The form ID is provided in the route.", "parameters": [ { "name": "id", "in": "path", "description": "The form ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/forms/{id}/unpublish": { "post": { "tags": [ "Forms" ], "summary": "Unpublish a Form", "description": "The form ID is provided in the route.", "parameters": [ { "name": "id", "in": "path", "description": "The form ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/chats/{chatId}/links": { "get": { "tags": [ "Link" ], "summary": "Get a list of chat links", "description": "The chat ID is provided in the route. Supports filtering, sorting, and pagination via query string parameters.", "parameters": [ { "name": "chatId", "in": "path", "description": "The chat ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatLinkListResponse" } } } } } }, "post": { "tags": [ "Link" ], "summary": "Create a new Link", "description": "Creates a new link from the request payload.", "parameters": [ { "name": "chatId", "in": "path", "description": "The chat ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Representation of the Link business object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatLink" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatLink" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChatLink" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatLink" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/chats/{chatId}/links/{id}": { "put": { "tags": [ "Link" ], "summary": "Update a chat link", "description": "The chat ID is provided in the route.", "parameters": [ { "name": "id", "in": "path", "description": "The chat link ID.", "required": true, "schema": { "type": "string" } }, { "name": "chatId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The update request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatLink" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatLink" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChatLink" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatLink" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Link" ], "summary": "Delete a chat link by ID", "description": "The chat ID is provided in the route.", "parameters": [ { "name": "id", "in": "path", "description": "The chat link ID.", "required": true, "schema": { "type": "string" } }, { "name": "chatId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/chats/{chatId}/messages": { "get": { "tags": [ "Message" ], "summary": "Get a list of messages for a chat", "description": "Supports filtering, sorting, and pagination via query string parameters.", "parameters": [ { "name": "chatId", "in": "path", "description": "The chat ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatMessageListResponse" } } } } } }, "post": { "tags": [ "Message" ], "summary": "Create a new message in a chat", "description": "The chat ID is provided in the route.", "parameters": [ { "name": "chatId", "in": "path", "description": "The chat ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The message to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatMessage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatMessage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChatMessage" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/chats/{chatId}/messages/{id}": { "get": { "tags": [ "Message" ], "summary": "Retrieve a message by ID", "description": "The chat ID is provided in the route. Use the select query parameter to specify which fields to include.", "parameters": [ { "name": "chatId", "in": "path", "description": "The chat ID.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The message ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatMessage" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Message" ], "summary": "Update an existing message", "description": "The chat ID is provided in the route.", "parameters": [ { "name": "chatId", "in": "path", "description": "The chat ID.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The message ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The update request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatMessage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatMessage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChatMessage" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Message" ], "summary": "Delete a message by ID", "description": "The chat ID is provided in the route.", "parameters": [ { "name": "chatId", "in": "path", "description": "The chat ID.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The message ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/parameter-groups/{groupId}/parameters": { "get": { "tags": [ "OrderedParameterDefinition" ], "summary": "List parameters in a parameter group", "description": "ListGroupParameters\nRetrieves all parameter definitions associated with the specified parameter group.\nReturns a paginated list with support for filtering, sorting, and field selection via RQL query parameters.\nThe group property is automatically excluded from the response to avoid circular references.\nAvailable for Operations accounts with helpdesk administration permissions.", "parameters": [ { "name": "groupId", "in": "path", "description": "The unique identifier of the parameter group", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderedParameterDefinitionListResponse" }, "example": { "data": [ { "id": "param-123", "label": "Customer Name", "description": "Full name of the customer", "type": "String", "displayOrder": 1, "required": true, "revision": 2, "audit": { "created": { "at": "2024-02-02T10:00:00+00:00", "by": "admin@example.com" }, "updated": { "at": "2024-02-02T12:00:00+00:00", "by": "admin@example.com" } } } ], "total": 1 } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "OrderedParameterDefinition" ], "summary": "Add parameter to a parameter group", "description": "AddParameterToGroup\nAssociates an existing parameter definition with the specified parameter group and assigns a display order.\nThe parameter definition must already exist and will be added to the group's parameter collection.\nReturns the created ordered parameter definition with generated ID and audit information.\nAvailable for Operations accounts with helpdesk administration permissions.", "parameters": [ { "name": "groupId", "in": "path", "description": "The unique identifier of the parameter group", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Representation of the ordered parameter business object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderedParameterDefinition" }, "example": { "id": "param-def-789", "displayOrder": 2 } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderedParameterDefinition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OrderedParameterDefinition" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderedParameterDefinition" }, "example": { "id": "param-def-789", "groupId": "group-456", "displayOrder": 2, "label": "Customer Email", "type": "String", "revision": 1, "audit": { "created": { "at": "2024-02-02T10:00:00+00:00", "by": "admin@example.com" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/parameter-groups/{groupId}/parameters/{id}": { "get": { "tags": [ "OrderedParameterDefinition" ], "summary": "Retrieve a parameter within parameter group by ID", "description": "GetGroupParameter\nRetrieves a specific parameter definition that belongs to the specified parameter group.\nSupports RQL select parameter for field filtering to optimize response payload.\nReturns 404 if the parameter does not exist, does not belong to the group, or the user lacks access.\nAvailable for Operations accounts with helpdesk administration permissions.", "parameters": [ { "name": "groupId", "in": "path", "description": "The unique identifier of the parameter group", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier of the parameter", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional RQL select statement to filter fields", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderedParameterDefinition" }, "example": { "id": "param-123", "label": "Customer Name", "description": "Full name of the customer", "type": "String", "displayOrder": 1, "scope": "Form", "phase": "Request", "constraints": { "required": true, "readonly": false }, "revision": 2, "audit": { "created": { "at": "2024-02-02T10:00:00+00:00", "by": "admin@example.com" }, "updated": { "at": "2024-02-02T12:00:00+00:00", "by": "admin@example.com" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "OrderedParameterDefinition" ], "summary": "Update parameter display order within a group", "description": "UpdateParameterInGroup\nUpdates the display order of a parameter definition within the specified parameter group.\nOnly the display order can be modified; other properties are managed through the base parameter definition endpoint.\nReturns the updated ordered parameter definition with incremented revision and audit information.\nAvailable for Operations accounts with helpdesk administration permissions.", "parameters": [ { "name": "groupId", "in": "path", "description": "The unique identifier of the parameter group", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier of the parameter to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Representation of the ordered parameter business object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderedParameterDefinition" }, "example": { "displayOrder": 3 } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderedParameterDefinition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OrderedParameterDefinition" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderedParameterDefinition" }, "example": { "id": "ordered-param-123", "groupId": "group-456", "displayOrder": 3, "label": "Customer Email", "type": "String", "revision": 2, "audit": { "created": { "at": "2024-02-02T10:00:00+00:00", "by": "admin@example.com" }, "updated": { "at": "2024-02-02T14:00:00+00:00", "by": "admin@example.com" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "OrderedParameterDefinition" ], "summary": "Remove parameter from a parameter group", "description": "RemoveParameterFromGroup\nRemoves the association between a parameter definition and the specified parameter group.\nThe parameter definition itself is not deleted and can still be used with other groups.\nReturns 204 No Content on successful removal.\nAvailable for Operations accounts with helpdesk administration permissions.", "parameters": [ { "name": "groupId", "in": "path", "description": "The unique identifier of the parameter group", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier of the parameter to remove", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/forms/{formId}/parameter-groups": { "get": { "tags": [ "OrderedParameterGroup" ], "summary": "List parameter groups in a form", "description": "ListFormParameterGroups\nRetrieves all parameter groups associated with the specified form.\nReturns a paginated list ordered by display order with support for filtering and field selection.\nEach group contains metadata about the number of parameters and display order within the form.\nAvailable for Operations accounts with helpdesk administration permissions.", "parameters": [ { "name": "formId", "in": "path", "description": "The unique identifier of the form", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderedParameterGroupListResponse" }, "example": { "data": [ { "id": "group-123", "label": "Customer Information", "description": "Basic customer details", "formId": "form-456", "displayOrder": 1, "revision": 2, "statistics": { "parameters": 5, "forms": 1 }, "audit": { "created": { "at": "2024-02-02T10:00:00+00:00", "by": "admin@example.com" }, "updated": { "at": "2024-02-02T12:00:00+00:00", "by": "admin@example.com" } } } ], "total": 1 } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "OrderedParameterGroup" ], "summary": "Add parameter group to a form", "description": "AddParameterGroupToForm\nAssociates an existing parameter group with the specified form and assigns a display order.\nThe parameter group must already exist and will be added to the form's group collection.\nReturns the created ordered parameter group with generated ID and audit information.\nAvailable for Operations accounts with helpdesk administration permissions.", "parameters": [ { "name": "formId", "in": "path", "description": "The unique identifier of the form", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Representation of the ordered parameter group business object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderedParameterGroup" }, "example": { "groupId": "group-789", "displayOrder": 2 } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderedParameterGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OrderedParameterGroup" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderedParameterGroup" }, "example": { "id": "ordered-123", "groupId": "group-789", "formId": "form-456", "displayOrder": 2, "label": "Customer Information", "revision": 1, "audit": { "created": { "at": "2024-02-02T10:00:00+00:00", "by": "admin@example.com" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/forms/{formId}/parameter-groups/{id}": { "get": { "tags": [ "OrderedParameterGroup" ], "summary": "Retrieve a parameter group within a form by ID", "description": "GetFormParameterGroup\nRetrieves a specific parameter group associated with the specified form.\nSupports RQL select parameter for field filtering to optimize response payload.\nReturns 404 if the parameter group does not exist, does not belong to the form, or the user lacks access.\nAvailable for Operations accounts with helpdesk administration permissions.", "parameters": [ { "name": "formId", "in": "path", "description": "The unique identifier of the form", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier of the parameter group", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional RQL select statement to filter fields", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderedParameterGroup" }, "example": { "id": "group-123", "label": "Customer Information", "description": "Basic customer details", "formId": "form-456", "displayOrder": 1, "revision": 2, "statistics": { "parameters": 5, "forms": 1 }, "audit": { "created": { "at": "2024-02-02T10:00:00+00:00", "by": "admin@example.com" }, "updated": { "at": "2024-02-02T12:00:00+00:00", "by": "admin@example.com" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "OrderedParameterGroup" ], "summary": "Update parameter group display order within a form", "description": "UpdateParameterGroupInForm\nUpdates the display order of a parameter group within the specified form.\nOnly the display order can be modified; other properties are managed through the base parameter group endpoint.\nReturns the updated ordered parameter group with incremented revision and audit information.\nAvailable for Operations accounts with helpdesk administration permissions.", "parameters": [ { "name": "formId", "in": "path", "description": "The unique identifier of the form", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier of the parameter group", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Representation of the ordered parameter group business object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderedParameterGroup" }, "example": { "displayOrder": 3 } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderedParameterGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OrderedParameterGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderedParameterGroup" }, "example": { "id": "ordered-123", "groupId": "group-789", "formId": "form-456", "displayOrder": 3, "label": "Customer Information", "revision": 2, "audit": { "created": { "at": "2024-02-02T10:00:00+00:00", "by": "admin@example.com" }, "updated": { "at": "2024-02-02T14:00:00+00:00", "by": "admin@example.com" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "OrderedParameterGroup" ], "summary": "Remove parameter group from a form", "description": "RemoveParameterGroupFromForm\nRemoves the association between a parameter group and the specified form.\nThe parameter group itself is not deleted and can still be used with other forms.\nReturns 204 No Content on successful removal.\nAvailable for Operations accounts with helpdesk administration permissions.", "parameters": [ { "name": "formId", "in": "path", "description": "The unique identifier of the form", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier of the parameter group", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/parameters": { "post": { "tags": [ "Parameter" ], "summary": "Create a new parameter definition.", "description": "Creates a new parameter definition from the request payload.", "requestBody": { "description": "Representation of the parameter definition business object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HelpdeskParameterDefinition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HelpdeskParameterDefinition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/HelpdeskParameterDefinition" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HelpdeskParameterDefinition" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Parameter" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HelpdeskParameterDefinitionListResponse" } } } } } } }, "/public/v1/helpdesk/parameters/{id}": { "put": { "tags": [ "Parameter" ], "summary": "Updates existing parameter definition.", "description": "Updates existing parameter definition.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the parameter definition to be updated.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Representation of the parameter definition business object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HelpdeskParameterDefinition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HelpdeskParameterDefinition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/HelpdeskParameterDefinition" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HelpdeskParameterDefinition" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Parameter" ], "summary": "Deletes existing parameter definition.", "description": "Deletes existing parameter definition.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the parameter definition to be deleted.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Parameter" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HelpdeskParameterDefinition" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/helpdesk/parameter-groups": { "post": { "tags": [ "ParameterGroup" ], "summary": "Create a new parameter group", "description": "Creates a new parameter group from the request payload.", "requestBody": { "description": "Representation of the parameter group business object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HelpdeskParameterGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HelpdeskParameterGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/HelpdeskParameterGroup" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HelpdeskParameterGroup" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "ParameterGroup" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HelpdeskParameterGroupListResponse" } } } } } } }, "/public/v1/helpdesk/parameter-groups/{id}": { "put": { "tags": [ "ParameterGroup" ], "summary": "Update an existing parameter group", "description": "The parameter group ID is provided in the route.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the parameter group to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Representation of the parameter group business object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HelpdeskParameterGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HelpdeskParameterGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/HelpdeskParameterGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HelpdeskParameterGroup" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "ParameterGroup" ], "summary": "Delete an existing parameter group", "description": "The parameter group ID is provided in the route.", "parameters": [ { "name": "id", "in": "path", "description": "The parameter group ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "ParameterGroup" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HelpdeskParameterGroup" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/helpdesk/parameter-groups/{parameterGroupId}/forms": { "get": { "tags": [ "ParameterGroupForm" ], "summary": "List forms linked to a parameter group", "description": "ListParameterGroupForms\nRetrieves all forms associated with the specified parameter group.\nReturns a paginated list with support for filtering and field selection.\nAvailable for Operations accounts with helpdesk administration permissions.", "parameters": [ { "name": "parameterGroupId", "in": "path", "description": "The unique identifier of the parameter group", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParameterGroupFormListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/helpdesk/parameter-groups/{parameterGroupId}/forms/{id}": { "get": { "tags": [ "ParameterGroupForm" ], "summary": "Retrieve a form linked to a parameter group by ID", "description": "GetParameterGroupForm\nRetrieves a specific form associated with the specified parameter group.\nSupports RQL select parameter for field filtering to optimize response payload.\nReturns 404 if the form does not exist or is not linked to the parameter group.\nAvailable for Operations accounts with helpdesk administration permissions.", "parameters": [ { "name": "parameterGroupId", "in": "path", "description": "The unique identifier of the parameter group", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier of the form", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional RQL select statement to filter fields", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParameterGroupForm" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/helpdesk/queues": { "get": { "tags": [ "Queue" ], "summary": "Get a list of queues", "description": "Supports filtering, sorting, and pagination via query string parameters.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueueListResponse" } } } } } }, "post": { "tags": [ "Queue" ], "summary": "Create a new queue", "description": "Creates a queue with an icon using multipart form data.", "parameters": [ { "name": "queue", "in": "query", "description": "Representation of the Queue business object.", "schema": { "allOf": [ { "$ref": "#/components/schemas/QueueDelta" } ] } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Queue" }, "encoding": { "icon": { "style": "form" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/Queue" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Queue" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/queues/{id}": { "get": { "tags": [ "Queue" ], "summary": "Retrieve a queue by ID", "description": "Use the select query parameter to specify which fields to include.", "parameters": [ { "name": "id", "in": "path", "description": "The queue ID.", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Optional select statement to filter fields.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Queue" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Queue" ], "summary": "Update an existing queue", "description": "Updates a queue and allows replacing its icon using multipart form data.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the queue to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Representation of the queue business object.", "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Queue" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Queue" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Queue" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "415": { "description": "Unsupported Media Type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Queue" ], "summary": "Delete an existing queue", "description": "The queue ID is provided in the route.", "parameters": [ { "name": "id", "in": "path", "description": "The queue ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/queues/{id}/activate": { "post": { "tags": [ "Queue" ], "summary": "Activate a queue", "description": "Sets the queue status to Active.", "parameters": [ { "name": "id", "in": "path", "description": "The queue ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Queue" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/queues/{id}/disable": { "post": { "tags": [ "Queue" ], "summary": "Disable a queue", "description": "Sets the queue status to Disabled.", "parameters": [ { "name": "id", "in": "path", "description": "The queue ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Queue" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/queues/{id}/icon": { "get": { "tags": [ "Queue" ], "summary": "Get a queue icon", "description": "Returns a temporary redirect to the stored icon URL.", "parameters": [ { "name": "id", "in": "path", "description": "The queue ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "307": { "description": "Temporary Redirect" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/cases": { "post": { "tags": [ "SupportCases" ], "summary": "Creates a new support case.", "requestBody": { "description": "Representation of the support case business object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportCase" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupportCase" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SupportCase" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportCase" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "SupportCases" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportCaseListResponse" } } } } } } }, "/public/v1/helpdesk/cases/{id}": { "put": { "tags": [ "SupportCases" ], "summary": "Update an existing support case", "description": "The support case ID is provided in the route.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the support case to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Representation of the support case business object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportCase" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupportCase" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SupportCase" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportCase" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "SupportCases" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportCase" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/helpdesk/cases/{id}/query": { "post": { "tags": [ "SupportCases" ], "summary": "Sets a support case to Mpt.Helpdesk.Models.Cases.SupportCaseStatus.Querying status.", "description": "The support case ID is provided in the route.\nThe Payload must contain only the Mpt.Helpdesk.Models.Cases.SupportCase.QueryPrompt property.", "parameters": [ { "name": "id", "in": "path", "description": "The support case ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Representation of the support case business object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportCase" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupportCase" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SupportCase" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportCase" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/cases/{id}/process": { "post": { "tags": [ "SupportCases" ], "summary": "Sets a support case to Mpt.Helpdesk.Models.Cases.SupportCaseStatus.Processing status.", "description": "The support case ID is provided in the route.", "parameters": [ { "name": "id", "in": "path", "description": "The support case ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportCase" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/public/v1/helpdesk/cases/{id}/complete": { "post": { "tags": [ "SupportCases" ], "summary": "Sets a support case to Mpt.Helpdesk.Models.Cases.SupportCaseStatus.Completed status.", "description": "The support case ID is provided in the route.", "parameters": [ { "name": "id", "in": "path", "description": "The support case ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportCase" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } } }, "components": { "schemas": { "AccountStatus": { "enum": [ "Active", "Enabled", "Disabled" ], "type": "string" }, "AccountType": { "enum": [ "Client", "Vendor", "Operations" ], "type": "string" }, "ListMetadata": { "type": "object", "properties": { "pagination": { "allOf": [ { "$ref": "#/components/schemas/PaginationMetadata" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "omitted": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "PaginationMetadata": { "type": "object", "properties": { "offset": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "limit": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "total": { "type": "integer", "format": "int32", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "PlatformAccount": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Task": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/TaskAuditBag" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/TaskStatus" } ], "description": "Task status: a new task is created in the Queued (default) or Blocked status.", "nullable": true, "example": "Queued", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "code": { "type": "string", "description": "Task code for the workflow, prefixed with the service namespace.", "example": "platform.accounts.buyers.transfer", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "queue": { "type": "string", "description": "Queue name for task execution, prefixed with the controlling service namespace.", "example": "marketplace/platform/internal/buyers/commands", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "object": { "allOf": [ { "$ref": "#/components/schemas/TaskPlatform" } ], "description": "Reference to the business object related to the task.", "example": { "id": "BUY-1190-0394" }, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "description": "Parameterized task description.", "example": "Transferring buyer 'BUY-1190-0394' to account 'ACC-5563-4382'", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "parent": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/TaskRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "progress": { "type": "number", "description": "Progress in percent. 0-100 or not defined for not yet started task.", "format": "float", "nullable": true, "example": 45.5, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "eta": { "type": "string", "description": "Estimated finish time, if any.", "format": "date-time", "nullable": true, "example": "2026-02-02T14:30:00+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "parameters": { "description": "Optional parameters to store task-specific metadata.", "nullable": true, "example": { "BuyerId": "BUY-1190-0394", "TargetAccountId": "ACC-5563-4382" }, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "result": { "type": "string", "description": "Result URI or reference to the result resource.", "nullable": true, "example": "/public/v1/accounts/buyers/BUY-1190-0394", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "description": "External identifier for task correlation.", "nullable": true, "example": "3f7e7800-b929-4bf3-a969-a8ed5354ff27", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "owner": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PlatformIdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "access": { "type": "array", "items": { "$ref": "#/components/schemas/PlatformAccountRef" }, "description": "List of accounts having access to the task and its result.", "example": [ { "id": "ACC-0000-0001", "name": "SoftwareONE Operations" } ], "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "The Task represents the state of an asynchronous, usually long running operation." }, "PlatformIdentity": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "PlatformObjectAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "PlatformObjectEvent": { "type": "object", "properties": { "at": { "type": "string", "format": "date-time", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PlatformIdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "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 } }, "additionalProperties": {} }, "TaskAuditBag": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "started": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "completed": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "failed": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "rescheduled": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "queued": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "TaskListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Task" } } }, "additionalProperties": false }, "TaskStatus": { "enum": [ "Queued", "Processing", "Completed", "Failed", "Rescheduled" ], "type": "string" }, "TaskLog": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "task": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/TaskRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "severity": { "allOf": [ { "$ref": "#/components/schemas/TaskLogSeverity" } ], "example": "Info", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "message": { "type": "string", "example": "Applying changes to database and external systems.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "timestamp": { "type": "string", "format": "date-time", "example": "2026-02-02T12:15:00+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "progress": { "type": "number", "format": "float", "nullable": true, "example": 90, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "eta": { "type": "string", "format": "date-time", "nullable": true, "example": "2026-02-02T14:30:00+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "parameters": { "nullable": true, "example": { "Step": "transfer" }, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "TaskLogListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/TaskLog" } } }, "additionalProperties": false }, "TaskPlatform": { "type": "object", "properties": { "id": { "type": "string", "example": "BUY-1190-0394", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "nullable": true, "example": "Buyer Account", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "example": "/public/v1/accounts/buyers/BUY-1190-0394/icon", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "TaskLogSeverity": { "enum": [ "Debug", "Info", "Warning", "Error", "Failure" ], "type": "string" }, "AuditEventType": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": false }, "AuditEventTypeDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/AuditEventType" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "AuditEventTypeListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AuditEventType" } } }, "additionalProperties": false }, "AuditRecord": { "type": "object", "properties": { "id": { "type": "string" }, "event": { "type": "string" }, "summary": { "type": "string" }, "details": { "type": "string" }, "object": { "allOf": [ { "$ref": "#/components/schemas/EventObject" } ] }, "timestamp": { "type": "string", "format": "date-time" }, "actor": { "allOf": [ { "$ref": "#/components/schemas/EventActor" } ] }, "documents": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/JsonNode" }, "nullable": true }, "viewers": { "type": "array", "items": { "$ref": "#/components/schemas/EventViewer" } }, "request": { "allOf": [ { "$ref": "#/components/schemas/AuditRecordRequest" } ] }, "type": { "allOf": [ { "$ref": "#/components/schemas/AuditRecordType" } ] }, "revision": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AuditRecordApiRequest": { "type": "object", "properties": { "ip": { "type": "string" }, "geolocation": { "allOf": [ { "$ref": "#/components/schemas/GeolocationData" } ], "nullable": true }, "userAgent": { "type": "string" } }, "additionalProperties": false }, "AuditRecordDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/AuditRecord" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "AuditRecordListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AuditRecord" } } }, "additionalProperties": false }, "AccountExternalIds": { "type": "object", "properties": { "pyraTenantId": { "type": "string", "format": "uuid", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AuditRecordLogInfo": { "type": "object", "properties": { "requestId": { "type": "string" }, "operationId": { "type": "string" } }, "additionalProperties": false }, "AuditRecordMessageInfo": { "type": "object", "properties": { "id": { "type": "string" } }, "additionalProperties": false }, "AuditRecordRequest": { "type": "object", "properties": { "api": { "allOf": [ { "$ref": "#/components/schemas/AuditRecordApiRequest" } ], "nullable": true }, "worker": { "allOf": [ { "$ref": "#/components/schemas/AuditRecordWorkerRequest" } ], "nullable": true }, "log": { "allOf": [ { "$ref": "#/components/schemas/AuditRecordLogInfo" } ], "nullable": true }, "message": { "allOf": [ { "$ref": "#/components/schemas/AuditRecordMessageInfo" } ], "nullable": true } }, "additionalProperties": false }, "AuditRecordType": { "enum": [ "Private", "Public" ], "type": "string" }, "AuditRecordWorkerRequest": { "type": "object", "properties": { "workerName": { "type": "string" } }, "additionalProperties": false }, "DeltaNode": { "type": "object", "properties": { "name": { "type": "string" }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/DeltaNode" }, "readOnly": true } }, "additionalProperties": false }, "EventActor": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "icon": { "type": "string", "nullable": true }, "account": { "allOf": [ { "$ref": "#/components/schemas/EventActorAccount" } ] } }, "additionalProperties": false }, "EventActorAccount": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "icon": { "type": "string", "nullable": true }, "accountType": { "type": "string" } }, "additionalProperties": false }, "EventObject": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string", "nullable": true }, "icon": { "type": "string", "nullable": true }, "objectType": { "type": "string" } }, "additionalProperties": false }, "EventViewer": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string", "nullable": true }, "type": { "type": "string" }, "icon": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GeolocationData": { "type": "object", "properties": { "countryCode": { "type": "string" }, "countryName": { "type": "string" }, "region": { "type": "string" } }, "additionalProperties": false }, "JsonNode": { "type": "object", "properties": { "options": { "allOf": [ { "$ref": "#/components/schemas/JsonNodeOptions" } ], "nullable": true, "readOnly": true }, "parent": { "allOf": [ { "$ref": "#/components/schemas/JsonNode" } ], "nullable": true, "readOnly": true }, "root": { "allOf": [ { "$ref": "#/components/schemas/JsonNode" } ], "readOnly": true } }, "additionalProperties": false }, "JsonNodeOptions": { "type": "object", "properties": { "propertyNameCaseInsensitive": { "type": "boolean" } }, "additionalProperties": false }, "StringDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "type": "string", "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "Account": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/AccountExternalIds" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalName": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "technicalSupportEmail": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "website": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupRef" }, "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "eligibility": { "allOf": [ { "$ref": "#/components/schemas/Eligibility" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "defaultLanguageCode": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Address": { "type": "object", "properties": { "addressLine1": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "addressLine2": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "postCode": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "city": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "state": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "country": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AccountUserBuyerVisibility": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "user": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/UserRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "buyerVisibility": { "allOf": [ { "$ref": "#/components/schemas/BuyerVisibility" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "buyers": { "type": "array", "items": { "$ref": "#/components/schemas/BuyerRef" }, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AgreementAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "active": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "provisioning": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "terminated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Agreement": { "type": "object", "properties": { "id": { "type": "string" }, "audit": { "allOf": [ { "$ref": "#/components/schemas/AgreementAudit" } ] }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string" }, "icon": { "type": "string", "nullable": true }, "revision": { "type": "integer", "format": "int32" }, "status": { "allOf": [ { "$ref": "#/components/schemas/AgreementStatus" } ] }, "listing": { "allOf": [ { "$ref": "#/components/schemas/Listing" } ] }, "authorization": { "allOf": [ { "$ref": "#/components/schemas/Authorization" } ] }, "vendor": { "allOf": [ { "$ref": "#/components/schemas/Account" } ] }, "client": { "allOf": [ { "$ref": "#/components/schemas/Account" } ] }, "price": { "allOf": [ { "$ref": "#/components/schemas/AgreementSummaryPrice" } ] }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "template": { "allOf": [ { "$ref": "#/components/schemas/Template" } ], "nullable": true }, "error": { "allOf": [ { "$ref": "#/components/schemas/ParametrisedMessage" } ], "nullable": true }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementLine" }, "nullable": true }, "assets": { "type": "array", "items": { "$ref": "#/components/schemas/Asset" }, "nullable": true }, "subscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription" }, "nullable": true }, "parameters": { "allOf": [ { "$ref": "#/components/schemas/ParameterBag" } ] }, "licensee": { "allOf": [ { "$ref": "#/components/schemas/Licensee" } ] }, "buyer": { "allOf": [ { "$ref": "#/components/schemas/Buyer" } ] }, "seller": { "allOf": [ { "$ref": "#/components/schemas/Seller" } ] }, "product": { "allOf": [ { "$ref": "#/components/schemas/Product" } ] }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/ExternalIds" } ] }, "split": { "allOf": [ { "$ref": "#/components/schemas/SplitBillingAgreement" } ], "nullable": true }, "termsAndConditions": { "type": "array", "items": { "$ref": "#/components/schemas/CommerceTermsAndConditions" } }, "certificates": { "type": "array", "items": { "$ref": "#/components/schemas/Certificate" } } }, "additionalProperties": false }, "AgreementLineAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "terminated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "deleted": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AgreementLine": { "type": "object", "properties": { "id": { "type": "string" }, "audit": { "allOf": [ { "$ref": "#/components/schemas/AgreementLineAudit" } ] }, "quantity": { "type": "integer", "format": "int32" }, "item": { "allOf": [ { "$ref": "#/components/schemas/ProductItem" } ] }, "price": { "allOf": [ { "$ref": "#/components/schemas/AgreementLinePrice" } ] }, "order": { "allOf": [ { "$ref": "#/components/schemas/Order" } ], "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/AgreementLineStatus" } ] }, "subscription": { "allOf": [ { "$ref": "#/components/schemas/Subscription" } ] }, "asset": { "allOf": [ { "$ref": "#/components/schemas/Asset" } ] }, "agreement": { "allOf": [ { "$ref": "#/components/schemas/Agreement" } ] }, "client": { "allOf": [ { "$ref": "#/components/schemas/Account" } ] }, "vendor": { "allOf": [ { "$ref": "#/components/schemas/Account" } ] }, "buyer": { "allOf": [ { "$ref": "#/components/schemas/Buyer" } ] }, "seller": { "allOf": [ { "$ref": "#/components/schemas/Seller" } ] }, "product": { "allOf": [ { "$ref": "#/components/schemas/Product" } ] }, "description": { "type": "string", "nullable": true }, "info": { "allOf": [ { "$ref": "#/components/schemas/PriceInfo" } ] } }, "additionalProperties": false }, "AssetAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "draft": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "active": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "terminated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AgreementLinePrice": { "type": "object", "properties": { "currency": { "type": "string" }, "markup": { "type": "number", "format": "double" }, "margin": { "type": "number", "format": "double" }, "defaultMarkupSource": { "allOf": [ { "$ref": "#/components/schemas/MarkupSourcePrice" } ], "nullable": true }, "markupSource": { "allOf": [ { "$ref": "#/components/schemas/MarkupSourcePrice" } ], "nullable": true }, "unitSP": { "type": "number", "format": "double", "nullable": true }, "unitPP": { "type": "number", "format": "double", "nullable": true }, "PPx1": { "type": "number", "format": "double", "nullable": true }, "SPx1": { "type": "number", "format": "double", "nullable": true }, "SPxY": { "type": "number", "format": "double", "nullable": true }, "SPxM": { "type": "number", "format": "double", "nullable": true }, "PPxY": { "type": "number", "format": "double", "nullable": true }, "PPxM": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "AgreementLineStatus": { "enum": [ "Active", "Terminated", "Deleted", "Expired" ], "type": "string" }, "AgreementStatus": { "enum": [ "New", "Draft", "Provisioning", "Updating", "Active", "Terminated", "Failed", "Deleted" ], "type": "string" }, "AgreementSummaryPrice": { "type": "object", "properties": { "currency": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "markup": { "type": "number", "format": "double", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "margin": { "type": "number", "format": "double", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "defaultMarkupSource": { "allOf": [ { "$ref": "#/components/schemas/MarkupSourcePrice" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "markupSource": { "allOf": [ { "$ref": "#/components/schemas/MarkupSourcePrice" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "SPxY": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "SPxM": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "PPxY": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "PPxM": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "defaultMarkup": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "defaultMargin": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "billingCurrency": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "source": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Operations" ] } } }, "additionalProperties": false }, "AnalyticsInfo": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/AnalyticsStatus" } ], "description": "The current status of the analytics operation.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Analytics insofmation." }, "AnalyticsResult": { "type": "object", "properties": { "range": { "allOf": [ { "$ref": "#/components/schemas/DateRange" } ], "description": "Date range for the analytics data.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "buckets": { "type": "array", "items": { "$ref": "#/components/schemas/Bucket" }, "description": "Buckets of grouped data.", "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents analytics result data with date-based buckets and aggregated values." }, "AnalyticsResultListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AnalyticsResult" } } }, "additionalProperties": false }, "AnalyticsStatus": { "enum": [ "Pending", "Running", "Ready", "Failed" ], "type": "string", "description": "Specifies the status of an analytics operation." }, "Asset": { "type": "object", "properties": { "id": { "type": "string" }, "audit": { "allOf": [ { "$ref": "#/components/schemas/AssetAudit" } ] }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string" }, "revision": { "type": "integer", "format": "int32" }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/ExternalIds" } ] }, "status": { "allOf": [ { "$ref": "#/components/schemas/AssetStatus" } ] }, "price": { "allOf": [ { "$ref": "#/components/schemas/AssetSummaryPrice" } ] }, "template": { "allOf": [ { "$ref": "#/components/schemas/Template" } ], "nullable": true }, "parameters": { "allOf": [ { "$ref": "#/components/schemas/AssetParameterBag" } ] }, "terms": { "allOf": [ { "$ref": "#/components/schemas/TermsEntity" } ] }, "agreement": { "allOf": [ { "$ref": "#/components/schemas/Agreement" } ] }, "product": { "allOf": [ { "$ref": "#/components/schemas/Product" } ] }, "priceList": { "allOf": [ { "$ref": "#/components/schemas/PriceList" } ] }, "listing": { "allOf": [ { "$ref": "#/components/schemas/Listing" } ] }, "licensee": { "allOf": [ { "$ref": "#/components/schemas/Licensee" } ] }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementLine" }, "nullable": true } }, "additionalProperties": false }, "AssetParameterBag": { "type": "object", "properties": { "fulfillment": { "type": "array", "items": { "$ref": "#/components/schemas/CommerceParameter" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "BillingError": { "type": "object", "properties": { "errorCode": { "type": "string", "description": "Represents the error code associated with the billing entity.", "example": "ERR-001", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "errorMessage": { "type": "string", "description": "Represents the error message providing details about the issue.", "example": "Invalid billing data provided.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "id": { "type": "string", "description": "Represents the unique identifier for the error, if applicable.", "nullable": true, "example": "12345", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "message": { "type": "string", "description": "Represents the detailed message associated with the error, if applicable.", "nullable": true, "example": "Failed to process the billing entity due to missing data.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an error related to a billing entity." }, "AssetStatus": { "enum": [ "New", "Draft", "Active", "Terminated" ], "type": "string" }, "AssetSummaryPrice": { "type": "object", "properties": { "currency": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "markup": { "type": "number", "format": "double", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "margin": { "type": "number", "format": "double", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "defaultMarkupSource": { "allOf": [ { "$ref": "#/components/schemas/MarkupSourcePrice" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "markupSource": { "allOf": [ { "$ref": "#/components/schemas/MarkupSourcePrice" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "PPx1": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "SPx1": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "defaultMarkup": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "defaultMargin": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } } }, "additionalProperties": false }, "Authorization": { "type": "object", "properties": { "id": { "type": "string" }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ] }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string" }, "revision": { "type": "integer", "format": "int32" }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/AuthorizationExternalIdBag" } ] }, "currency": { "type": "string" }, "notes": { "type": "string", "nullable": true }, "product": { "allOf": [ { "$ref": "#/components/schemas/Product" } ] }, "vendor": { "allOf": [ { "$ref": "#/components/schemas/Account" } ] }, "owner": { "allOf": [ { "$ref": "#/components/schemas/Seller" } ] }, "statistics": { "allOf": [ { "$ref": "#/components/schemas/AuthorizationStatistics" } ] }, "journal": { "allOf": [ { "$ref": "#/components/schemas/AuthorizationJournal" } ] }, "eligibility": { "allOf": [ { "$ref": "#/components/schemas/AuthorizationEligibility" } ] }, "settings": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AuthorizationEligibility": { "type": "object", "properties": { "client": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "partner": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AuthorizationExternalIdBag": { "type": "object", "properties": { "operations": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AuthorizationJournal": { "type": "object", "properties": { "firstInvoiceDate": { "type": "string", "format": "date-time", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "frequency": { "enum": [ "1m", "6m", "1y", "3m", "3y", "one-time" ], "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AuthorizationStatistics": { "type": "object", "properties": { "subscriptions": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "agreements": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "sellers": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "listings": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "BackupDetails": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/BackupStatus" } ], "description": "Status of the backup.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "date": { "type": "string", "description": "Date and time of the backup action, if available.", "format": "date-time", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents the details of a backup operation, including its status and date." }, "BackupStatus": { "enum": [ "Pending", "Exporting", "Exported", "Verifying", "Completed", "Failed", "Skipped" ], "type": "string", "description": "Represents the status of a backup operation." }, "BillingAttachmentType": { "enum": [ "Attachment", "Input", "Output" ], "type": "string", "description": "Represents the type of billing attachment." }, "BuyerExternalIds": { "type": "object", "properties": { "erpCompanyContact": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "erpCustomer": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "accountExternalId": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "BillingErpAttributes": { "type": "object", "properties": { "postingDate": { "type": "string", "description": "The date when the invoice was posted.", "format": "date-time", "nullable": true, "example": "2025-05-01T10:00:00+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "documentDate": { "type": "string", "description": "The date when the document was created.", "format": "date-time", "nullable": true, "example": "2025-04-30T10:00:00+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalDocumentNo": { "type": "string", "description": "The external document number associated with the invoice.", "nullable": true, "example": "OC 4500355450", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalDocumentNo2": { "type": "string", "description": "The second external document number associated with the invoice.", "nullable": true, "example": "4540599242", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "yourReference": { "type": "string", "description": "Can be the custom reference (free text) or the statement ID (fixed format).", "nullable": true, "example": "Custom reference: US-PSI-1525628 RITM55345369 Wrong SCU; Statement ID: SOMM-8224-9785-1293-2113", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Attributes related to ERP systems for an invoice or credit memo." }, "BillingExternalIds": { "type": "object", "properties": { "operations": { "type": "string", "description": "Represents the identifier used for operations in the billing system.", "nullable": true, "example": "OPS-12345", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "vendor": { "type": "string", "description": "Represents the identifier used for vendors in the billing system.", "nullable": true, "example": "VND-67890", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents external identifiers associated with billing entities." }, "BillingParametrisedMessage": { "type": "object", "properties": { "message": { "type": "string", "description": "Gets the message associated with the current object.", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "parameters": { "description": "Gets the parameters associated with the current request or operation.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a message with associated parameters for use in parameterized communication or formatting scenarios." }, "BillingType": { "enum": [ "Automated", "Manual", "Consolidated" ], "type": "string", "description": "Represents the type of billing process." }, "Bucket": { "type": "object", "properties": { "id": { "type": "string", "description": "Bucket identifier.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "description": "Bucket name.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "description": "Bucket icon.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "value": { "type": "number", "description": "Aggregated monetary value.", "format": "double", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "conversion": { "allOf": [ { "$ref": "#/components/schemas/CurrencyConversion" } ], "description": "Type of currency conversion applied to this bucket.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a bucket for grouping analytics data." }, "Buyer": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/BuyerAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/BuyerExternalIds" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/BuyerStatus" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "taxId": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ParametrisedMessage" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Operations" ] } }, "sellers": { "type": "array", "items": { "$ref": "#/components/schemas/SellerRef" }, "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "BuyerAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "activated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unassigned": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "disabled": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Certificate": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/CertificateAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "program": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProgramRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "vendor": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/CertificateExternalIds" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "client": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "applicableTo": { "allOf": [ { "$ref": "#/components/schemas/ProgramApplicableTo" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "buyer": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BuyerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Operations" ] } }, "licensee": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/LicenseeRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Operations" ] } }, "eligibility": { "allOf": [ { "$ref": "#/components/schemas/ProgramEligibility" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/CertificateStatus" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "statusNotes": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "expirationDate": { "type": "string", "format": "date", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "template": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProgramTemplateRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Operations" ] } }, "parameters": { "allOf": [ { "$ref": "#/components/schemas/ProgramParameterBag" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "terms": { "type": "array", "items": { "$ref": "#/components/schemas/CertificateTermsRef" }, "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "BuyerStatus": { "enum": [ "Active", "Enabled", "Disabled", "Deleted", "Unassigned", "Conflict", "Mismatch" ], "type": "string" }, "BuyerVisibility": { "enum": [ "All", "Selected", "NotApplicable" ], "type": "string" }, "CapacitySettings": { "type": "object", "properties": { "min": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "max": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CategoryAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "published": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unpublished": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CategoryEntity": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/CategoryAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "parentCategory": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/CategoryEntityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "enum": [ "Draft", "Published", "Unpublished", "Deleted" ], "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CertificateAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "activated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "pending": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "terminated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "expired": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updating": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CertificateTerms": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/ProgramTermsAndConditionsAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayOrder": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "program": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProgramRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "accepted": { "type": "string", "format": "date-time", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "acceptedBy": { "allOf": [ { "$ref": "#/components/schemas/ExtendedIdentity" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CertificateExternalIds": { "type": "object", "properties": { "vendor": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CertificateStatus": { "enum": [ "Draft", "Pending", "Updating", "Active", "Terminated", "Expired", "Deleted" ], "type": "string" }, "CommerceTermsAndConditions": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/TermsAndConditionsAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayOrder": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "product": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "accepted": { "type": "string", "format": "date-time", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "acceptedBy": { "allOf": [ { "$ref": "#/components/schemas/ExtendedIdentity" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Charge": { "type": "object", "properties": { "audit": { "allOf": [ { "$ref": "#/components/schemas/ChargeAuditBag" } ], "description": "Represents a container for audit-related events for a charge", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "id": { "type": "string", "description": "The unique identifier of the charge.", "example": "CHG-1234-1234-1234-1234-1234", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/ChargeExternalIds" } ], "description": "Contains external identifiers associated with the charge.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "search": { "allOf": [ { "$ref": "#/components/schemas/ChargeSearchBag" } ], "description": "Contains search-related details for the charge.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "period": { "allOf": [ { "$ref": "#/components/schemas/DatePeriod" } ], "description": "Represents the period during which the charge is applicable.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "quantity": { "type": "number", "description": "Indicates the quantity associated with the charge.", "format": "double", "example": 10.5, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "price": { "allOf": [ { "$ref": "#/components/schemas/ChargePrice" } ], "description": "Contains pricing details for the charge.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "allOf": [ { "$ref": "#/components/schemas/ChargeDescription" } ], "description": "Contains a description of the charge, if applicable.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/ChargeAttributes" } ], "description": "Contains additional attributes for the charge.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "journal": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/JournalRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "ledger": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/LedgerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "customLedger": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/CustomLedgerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "parent": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ChargeRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "billingType": { "allOf": [ { "$ref": "#/components/schemas/BillingType" } ], "description": "Indicates the billing type of the charge, defaulting to automated.", "readOnly": true, "example": "Automated", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "upload": { "allOf": [ { "$ref": "#/components/schemas/ChargeStatusBag" } ], "description": "Contains the upload status and related details for the charge, visible to vendors or operations.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "licensee": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/LicenseeRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "agreement": { "allOf": [ { "$ref": "#/components/schemas/Agreement" } ], "description": "The agreement associated with the charge, if applicable.", "nullable": true, "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "subscription": { "allOf": [ { "$ref": "#/components/schemas/Subscription" } ], "description": "The subscription associated with the charge, if applicable.", "nullable": true, "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "line": { "allOf": [ { "$ref": "#/components/schemas/AgreementLine" } ], "description": "The line associated with the charge, if applicable.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "order": { "allOf": [ { "$ref": "#/components/schemas/Order" } ], "description": "The order associated with the charge, if applicable.", "nullable": true, "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "asset": { "allOf": [ { "$ref": "#/components/schemas/Asset" } ], "description": "The asset associated with the charge, if applicable.", "nullable": true, "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "item": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductItemRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "authorization": { "allOf": [ { "$ref": "#/components/schemas/Authorization" } ], "description": "The authorization details associated with the charge, if applicable.", "nullable": true, "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "statement": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/StatementRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "statementType": { "allOf": [ { "$ref": "#/components/schemas/StatementType" } ], "description": "Indicates the type of statement associated with the charge.", "example": "Debit", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "processing": { "allOf": [ { "$ref": "#/components/schemas/ChargeStatusBag" } ], "description": "Contains the processing status and related details for the charge, visible to operations.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "erpData": { "allOf": [ { "$ref": "#/components/schemas/ErpData" } ], "description": "Contains ERP-related data for the charge.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "buyer": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BuyerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "vendor": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "seller": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SellerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "split": { "allOf": [ { "$ref": "#/components/schemas/ChargeSplit" } ], "description": "Contains details about the charge split, if applicable.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "reconciliation": { "allOf": [ { "$ref": "#/components/schemas/Reconciliation" } ], "description": "Contains reconciliation info for the journal charge.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a charge in the billing system." }, "ChargeAttributes": { "type": "object", "properties": { "documentNumber": { "type": "string", "description": "The document number associated with the charge.", "example": "DOC-12345", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "orderType": { "type": "string", "description": "The type of order associated with the charge.", "example": "PurchaseOrder", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalDocumentNo": { "type": "string", "description": "The primary external document number associated with the charge, if applicable.", "nullable": true, "example": "EXT-67890", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalDocumentNo2": { "type": "string", "description": "An additional external document number associated with the charge, if applicable.", "nullable": true, "example": "EXT2-54321", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "yourReference": { "type": "string", "description": "A reference provided by the customer for the charge, if applicable.", "nullable": true, "example": "CUST-REF-001", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "agreementVendorId": { "type": "string", "description": "An identifier for the vendor's agreement related to the charge, if applicable.", "nullable": true, "example": "170ec08e-f43c-4831-aeb2-0d6455e1acf5", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "segment": { "type": "string", "description": "Represents the segment associated with the charge.", "nullable": true, "example": "Segment-A", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents additional attributes associated with a charge in the billing system." }, "ChargeAuditBag": { "type": "object", "properties": { "reconciled": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the charge was reconciled.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "reset": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the charge was reset (undoing previous reconcile actions).", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a container for audit-related events for a charge" }, "ChargeDescription": { "type": "object", "properties": { "value1": { "type": "string", "description": "The first value of the description, if applicable.", "nullable": true, "example": "Monthly subscription charge", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "value2": { "type": "string", "description": "The second value of the description, if applicable.", "nullable": true, "example": "Includes additional services", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a description of a charge." }, "ChargeExternalIds": { "type": "object", "properties": { "reference": { "type": "string", "description": "A reference identifier for the charge, if applicable.", "nullable": true, "example": "REF-67890", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "invoice": { "type": "string", "description": "The invoice identifier associated with the charge.", "example": "INV-12345", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "vendor": { "type": "string", "description": "The vendor identifier associated with the charge.", "example": "VND-54321", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents external identifiers associated with a charge." }, "ChargeListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Charge" } } }, "additionalProperties": false }, "ChargeMarkupSource": { "enum": [ "Subscription", "Line", "Agreement", "Asset" ], "type": "string", "description": "Specifies the source of the markup value." }, "ChargePrice": { "type": "object", "properties": { "currency": { "allOf": [ { "$ref": "#/components/schemas/PriceCurrency" } ], "description": "Specifies the currency details for the charge, including purchase and sale values.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "markup": { "type": "number", "description": "Represents the markup value applied to the charge.", "format": "double", "nullable": true, "example": 15.5, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "markupSource": { "allOf": [ { "$ref": "#/components/schemas/ChargeMarkupSource" } ], "description": "Specifies the source of the markup value.", "nullable": true, "example": "Line", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "margin": { "type": "number", "description": "Represents the margin value calculated for the charge.", "format": "double", "nullable": true, "example": 20, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "unitPP": { "type": "number", "description": "Represents the unit purchase price of the charge.", "format": "double", "nullable": true, "example": 100, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "PPx1": { "type": "number", "description": "Represents an total purchase price value for the charge.", "format": "double", "nullable": true, "example": 1000, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "unitBSP": { "type": "number", "description": "Represents the unit sale price of the charge in buyer currency.", "format": "double", "nullable": true, "example": 120, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "BSPx1": { "type": "number", "description": "Represents an total sale price value for the charge in buyer currency.", "format": "double", "nullable": true, "example": 1200, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "unitSP": { "type": "number", "description": "Represents the unit sale price of the charge.", "format": "double", "nullable": true, "example": 120, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "SPx1": { "type": "number", "description": "Represents an total sale price value for the charge.", "format": "double", "nullable": true, "example": 1200, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } } }, "additionalProperties": false, "description": "Represents the pricing details of a charge, including currency, markup, margin, and unit prices." }, "ChargeSearch": { "type": "object", "properties": { "criteria": { "type": "string", "description": "The search criterion used for the charge.", "example": "externalIds.Vendor", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "value": { "type": "string", "description": "The value associated with the search criterion.", "example": "EXT-12345", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a search criterion and its value for a charge." }, "ChargeSearchBag": { "type": "object", "properties": { "source": { "allOf": [ { "$ref": "#/components/schemas/ChargeSourceSearch" } ], "description": "Contains subscription-related search details for the charge, if applicable.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "order": { "allOf": [ { "$ref": "#/components/schemas/ChargeSearch" } ], "description": "Contains order-related search details for the charge, if applicable.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "item": { "allOf": [ { "$ref": "#/components/schemas/ChargeSearch" } ], "description": "Contains item-related search details for the charge, if applicable.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents search-related details for a charge." }, "ChargeSourceSearch": { "type": "object", "properties": { "criteria": { "type": "string", "description": "The search criterion used for the charge.", "example": "externalIds.Vendor", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "value": { "type": "string", "description": "The value associated with the search criterion.", "example": "EXT-12345", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "allOf": [ { "$ref": "#/components/schemas/JournalChargeSource" } ], "description": "Source type", "example": "Subscription", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a search criterion and its value for a charge." }, "ChargeSplit": { "type": "object", "properties": { "percentage": { "type": "number", "description": "The percentage of the charge allocated to this split.", "format": "double", "example": 50, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents the details of a charge split." }, "ChargeStatus": { "enum": [ "Ready", "Error", "Split", "Skipped", "Ignored", "Reconciling" ], "type": "string", "description": "Represents the various statuses a charge can have in the billing system." }, "ChargeStatusBag": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ChargeStatus" } ], "description": "Indicates the current status of the charge.", "example": "Ready", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "errors": { "type": "array", "items": { "type": "string" }, "description": "Contains a list of error messages associated with the charge, if any.", "nullable": true, "example": [ "Invalid charge amount", "Missing buyer information" ], "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents the status and associated errors of a charge in the billing system." }, "CommerceParameter": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "allOf": [ { "$ref": "#/components/schemas/ParameterType" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "phase": { "allOf": [ { "$ref": "#/components/schemas/ParameterPhase" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "scope": { "allOf": [ { "$ref": "#/components/schemas/ParameterScope" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "multiple": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "error": { "allOf": [ { "$ref": "#/components/schemas/ParametrisedMessage" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "constraints": { "allOf": [ { "$ref": "#/components/schemas/ParameterConstraints" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayValue": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "value": { "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Eligibility": { "type": "object", "properties": { "client": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "partner": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Constraints": { "type": "object", "properties": { "hidden": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "readonly": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "required": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "capacity": { "allOf": [ { "$ref": "#/components/schemas/CapacitySettings" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CreateBillingAttachmentRequest": { "type": "object", "properties": { "attachment": { "type": "object", "properties": { "Name": { "type": "string", "description": "The name of the attachment." }, "Description": { "type": "string", "description": "The description of the attachment." } }, "description": "Json representation of the attachment" }, "file": { "type": "string", "description": "The file of the attachment.", "format": "binary", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } } }, "CreditMemo": { "type": "object", "properties": { "audit": { "allOf": [ { "$ref": "#/components/schemas/CreditMemoAuditBag" } ], "description": "Represents a container for audit-related events for a credit memo", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "id": { "type": "string", "description": "The unique identifier of the credit memo.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "countryCode": { "type": "string", "description": "The country code.", "example": "IE", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "documentNo": { "type": "string", "description": "The document number assigned by the ERP system.", "example": "DOC-67890", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/BillingErpAttributes" } ], "description": "ERP attributes associated with the entity.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "erpData": { "allOf": [ { "$ref": "#/components/schemas/CreditMemoErpData" } ], "description": "ERP-specific data related to the credit memo.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/ErpExternalIds" } ], "description": "Credit memo external ids.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "agreement": { "allOf": [ { "$ref": "#/components/schemas/Agreement" } ], "description": "The agreement associated with the credit memo.", "nullable": true, "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "buyer": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BuyerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "client": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "licensee": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/LicenseeRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/CreditMemoLine" }, "description": "The list of credit memo lines associated with the credit memo.", "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "price": { "allOf": [ { "$ref": "#/components/schemas/CreditMemoPriceSummary" } ], "description": "Pricing details of the credit memo.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "product": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "seller": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SellerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/CreditMemoStatus" } ], "description": "The current status of the credit memo.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "vendor": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "statement": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/StatementRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "analytics": { "allOf": [ { "$ref": "#/components/schemas/AnalyticsInfo" } ], "description": "Analytics information related to the credit memo.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a credit memo in the billing system." }, "CreditMemoAttachment": { "type": "object", "properties": { "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "description": "Name of the attachment.", "example": "raw records data", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "allOf": [ { "$ref": "#/components/schemas/BillingAttachmentType" } ], "description": "Specifies the type of the attachment, such as input, output, or general attachment.", "example": "Input", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "filename": { "type": "string", "description": "Represents the name of the file associated with the attachment.", "example": "invoice.pdf", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "size": { "type": "integer", "description": "Indicates the size of the file in bytes.", "format": "int64", "nullable": true, "example": 102400, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contentType": { "type": "string", "description": "Represents the MIME type of the file content.", "example": "application/pdf", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "description": "Provides a description of the attachment.", "example": "Invoice for March 2025", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "isDeleted": { "type": "boolean", "description": "Indicates whether the attachment has been marked as deleted.", "example": false, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "id": { "type": "string", "description": "The unique identifier of the attachment.", "example": "CMA-1234-1234", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "creditMemo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/CreditMemoRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "isExternal": { "type": "boolean", "description": "Indicates whether the attachment is stored externally", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an attachment associated with a credit memo in the billing system." }, "CreditMemoAttachmentDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/CreditMemoAttachment" } ], "description": "Represents an attachment associated with a credit memo in the billing system.", "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "CreditMemoAttachmentListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CreditMemoAttachment" } } }, "additionalProperties": false }, "CreditMemoAuditBag": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "issued": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the credit memo reached the \"Issued\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a container for audit-related events for a credit memo" }, "CreditMemoErpData": { "type": "object", "properties": { "addresses": { "allOf": [ { "$ref": "#/components/schemas/ErpAddressList" } ], "description": "The list of addresses associated with the credit memo.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "appliesToDocNo": { "type": "string", "description": "The document number to which this credit memo applies.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "currencyCode": { "type": "string", "description": "The currency code of the credit memo.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "documentDate": { "type": "string", "description": "The document date of the credit memo.", "format": "date-time", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "documentNo": { "type": "string", "description": "The document number of the credit memo.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalDocumentNo": { "type": "string", "description": "The external document number of the credit memo.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalDocumentNo2": { "type": "string", "description": "The second external document number of the credit memo.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "insideSalesCode": { "type": "string", "description": "The inside sales code associated with the credit memo.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "navisionCountryCode": { "type": "string", "description": "The Navision country code of the credit memo.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "postingDate": { "type": "string", "description": "The posting date of the credit memo.", "format": "date-time", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "description": "The revision of the invoice, used for versioning control.", "format": "int64", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "rowVersion": { "type": "integer", "description": "The row version of the credit memo, used for concurrency control.", "format": "int64", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "responsibilityCenterCode": { "type": "string", "description": "The responsibility center code of the credit memo.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "salesPersonCode": { "type": "string", "description": "The sales person code of the credit memo.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "shipmentMethodCode": { "type": "string", "description": "The shipment method code of the credit memo.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "vatRegistrationNo": { "type": "string", "description": "The VAT registration number of the credit memo.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "yourReference": { "type": "string", "description": "The reference provided by the customer.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents ERP-specific data related to a credit memo." }, "CreditMemoLine": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the credit memo line.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "description": "The description of the credit memo line.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description2": { "type": "string", "description": "The secondary description (aka additional info) of the credit memo line.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "documentNo": { "type": "string", "description": "The document number associated with the credit memo line.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "erpData": { "allOf": [ { "$ref": "#/components/schemas/CreditMemoLineErpData" } ], "description": "The ERP-specific data related to the credit memo line.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "itemNo": { "type": "string", "description": "The item number for the credit memo line.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "lineNo": { "type": "integer", "description": "The line number for the credit memo line.", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "period": { "allOf": [ { "$ref": "#/components/schemas/DatePeriod" } ], "description": "The period associated with the credit memo line.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "price": { "allOf": [ { "$ref": "#/components/schemas/CreditMemoLinePrice" } ], "description": "The price details for the credit memo line.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a line item in a credit memo, containing details such as amounts, descriptions, and identifiers." }, "CreditMemoLineErpData": { "type": "object", "properties": { "contractNo": { "type": "string", "description": "The contract number associated with the credit memo line.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "countryOfUsage": { "type": "string", "description": "The country of usage for the credit memo line.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "dataOrigin": { "type": "integer", "description": "The data origin for the credit memo line.", "format": "int32", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalPositionNo": { "type": "string", "description": "The external position number for the credit memo line.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "navisionCountryCode": { "type": "string", "description": "The Navision country code for the credit memo line.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "parentItemNo": { "type": "string", "description": "The parent item number for the credit memo line.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "primary": { "allOf": [ { "$ref": "#/components/schemas/ErpCode" } ], "description": "The primary code details for the credit memo line, if any.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "secondary": { "allOf": [ { "$ref": "#/components/schemas/ErpCode" } ], "description": "The secondary code details for the credit memo line, if any.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "rowVersion": { "type": "integer", "description": "The row version of the credit memo line, for concurrency control.", "format": "int64", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "responsibilityCenterCode": { "type": "string", "description": "The responsibility center code for the credit memo line.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "swoPurchaseOrderNo": { "type": "string", "description": "The SWO purchase order number for the credit memo line.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "type": "integer", "description": "The type of the credit memo line.", "format": "int32", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unitOfMeasure": { "type": "string", "description": "The unit of measure for the credit memo line.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "varAgreementNo": { "type": "string", "description": "The VAR agreement number for the credit memo line.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "varPartnerNo": { "type": "string", "description": "The VAR partner number for the credit memo line.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents ERP-specific data related to a credit memo line." }, "CreditMemoLinePrice": { "type": "object", "properties": { "amount": { "type": "number", "description": "The amount for the credit memo line, visible to clients or operations.", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "amountIncludingVat": { "type": "number", "description": "The amount including VAT for the credit memo line, visible to clients or operations.", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "discountAmount": { "type": "number", "description": "The discount amount for the credit memo line, visible to clients or operations.", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "invoiceDiscountAmount": { "type": "number", "description": "The invoice discount amount for the credit memo line, visible to clients or operations.", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "lineAmount": { "type": "number", "description": "The line amount for the credit memo line, visible to clients or operations.", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "purchaseCurrencyCode": { "type": "string", "description": "The currency used for the purchase price, visible only to operations.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Operations" ] } }, "purchaseCurrencyFactor": { "type": "number", "description": "The factor applied to the purchase currency, visible only to operations.", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "purchasePrice": { "type": "number", "description": "The purchase price for the credit memo line, visible only to operations.", "format": "double", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "purchasePriceLcy": { "type": "number", "description": "The purchase price in local currency for the credit memo line, visible only to operations.", "format": "double", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "purchasePriceTotal": { "type": "number", "description": "The total purchase price for the credit memo line, visible only to operations.", "format": "double", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "purchasePriceTotalLcy": { "type": "number", "description": "The total purchase price in local currency for the credit memo line, visible only to operations.", "format": "double", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "quantity": { "type": "integer", "description": "The quantity for the credit memo line.", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "salesMarkup": { "type": "number", "description": "The sales markup for the credit memo line, visible only to operations.", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "salesMargin": { "type": "number", "description": "The sales margin for the credit memo line, visible only to operations.", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "unitPrice": { "type": "number", "description": "The unit price for the credit memo line.", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "vatBaseAmount": { "type": "number", "description": "The VAT base amount for the credit memo line.", "format": "double", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "vatCalculationType": { "type": "integer", "description": "The VAT calculation type for the credit memo line.", "format": "int32", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "vatPercent": { "type": "number", "description": "The VAT percentage for the credit memo line.", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents the price details of a credit memo line." }, "CreditMemoListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CreditMemo" } } }, "additionalProperties": false }, "CreditMemoPriceSummary": { "type": "object", "properties": { "currency": { "type": "string", "description": "The currency of the credit memo.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "currencyFactor": { "type": "number", "description": "The factor applied to the currency, used for conversion or adjustments.", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "currencyFactor2": { "type": "number", "description": "The second factor applied to the currency, used for conversion or adjustments.", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "margin": { "type": "number", "description": "The margin value of the credit memo, visible to operations.", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "markup": { "type": "number", "description": "The markup value of the credit memo, visible to operations.", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "totalPP": { "type": "number", "description": "The total purchase price (PP) of the credit memo, visible to operations.", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "totalSP": { "type": "number", "description": "The total selling price (SP) of the credit memo, visible to clients or operations.", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "totalST": { "type": "number", "description": "The total sales tax (ST) of the credit memo, visible to clients or operations.", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "totalGT": { "type": "number", "description": "The total gross amount (GT) of the credit memo, visible to clients or operations.", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a summary of price details for a credit memo." }, "CreditMemoStatus": { "enum": [ "Issued" ], "type": "string" }, "CurrencyConversion": { "enum": [ "None", "Historical", "Current" ], "type": "string" }, "CustomLedger": { "type": "object", "properties": { "audit": { "allOf": [ { "$ref": "#/components/schemas/CustomLedgerAuditBag" } ], "description": "Represents a container for audit-related events for a custom ledger", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "id": { "type": "string", "description": "The unique identifier of the custom ledger.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "description": "Name of the custom ledger.", "example": "Quarterly Revenue Ledger", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/BillingExternalIds" } ], "description": "External identifiers associated with the custom ledger.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "seller": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SellerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "vendor": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "billingStartDate": { "type": "string", "description": "The start date of the billing period for the custom ledger.", "format": "date-time", "example": "2025-01-01T00:00:00+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "billingEndDate": { "type": "string", "description": "The end date of the billing period for the custom ledger.", "format": "date-time", "example": "2025-03-31T23:59:59+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "notes": { "type": "string", "description": "Additional notes or comments about the custom ledger.", "nullable": true, "example": "Includes all transactions for Q1 2025.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/CustomLedgerStatus" } ], "description": "The current status of the custom ledger.", "example": "Validated", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "assignee": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PlatformIdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "price": { "allOf": [ { "$ref": "#/components/schemas/CustomLedgerPriceSummary" } ], "description": "Pricing details associated with the custom ledger.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "processing": { "allOf": [ { "$ref": "#/components/schemas/ProcessingSummary" } ], "description": "Processing status and related details for the custom ledger, visible to operations.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "error": { "allOf": [ { "$ref": "#/components/schemas/BillingError" } ], "description": "Error details associated with the custom ledger, if any.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "backup": { "allOf": [ { "$ref": "#/components/schemas/BackupDetails" } ], "description": "Backup details for the custom ledger.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } } }, "additionalProperties": false, "description": "Represents a custom ledger in the billing system." }, "CustomLedgerAttachment": { "type": "object", "properties": { "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "description": "Name of the attachment.", "example": "raw records data", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "allOf": [ { "$ref": "#/components/schemas/BillingAttachmentType" } ], "description": "Specifies the type of the attachment, such as input, output, or general attachment.", "example": "Input", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "filename": { "type": "string", "description": "Represents the name of the file associated with the attachment.", "example": "invoice.pdf", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "size": { "type": "integer", "description": "Indicates the size of the file in bytes.", "format": "int64", "nullable": true, "example": 102400, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contentType": { "type": "string", "description": "Represents the MIME type of the file content.", "example": "application/pdf", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "description": "Provides a description of the attachment.", "example": "Invoice for March 2025", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "isDeleted": { "type": "boolean", "description": "Indicates whether the attachment has been marked as deleted.", "example": false, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "id": { "type": "string", "description": "The unique identifier of the attachment.", "example": "CLA-1234-1234", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "customLedger": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/CustomLedgerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an attachment associated with a custom ledger in the billing system." }, "CustomLedgerAttachmentDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/CustomLedgerAttachment" } ], "description": "Represents an attachment associated with a custom ledger in the billing system.", "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "CustomLedgerAttachmentListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomLedgerAttachment" } } }, "additionalProperties": false }, "CustomLedgerAuditBag": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "draft": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the custom ledger reached the \"Draft\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "deleted": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the custom ledger reached the \"Deleted\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "validating": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the custom ledger reached the \"Validating\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "validated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the custom ledger reached the \"Validated\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "error": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the custom ledger reached the \"Error\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "generating": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the custom ledger reached the \"Generating\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "generated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the custom ledger reached the \"Generated\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "queued": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the custom ledger reached the \"Queued\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "completed": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the custom ledger reached the \"Completed\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a container for audit-related events for a custom ledger" }, "CustomLedgerDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/CustomLedger" } ], "description": "Represents a custom ledger in the billing system.", "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "CustomLedgerListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomLedger" } } }, "additionalProperties": false }, "CustomLedgerPriceSummary": { "type": "object", "properties": { "markup": { "type": "number", "description": "Represents the markup value applied to the pricing.", "format": "double", "example": 15.5, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "margin": { "type": "number", "description": "Represents the margin value calculated for the pricing.", "format": "double", "example": 20, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "totalPP": { "type": "number", "description": "Represents the total purchase price.", "format": "double", "example": 1000, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "totalBSP": { "type": "number", "description": "Represents the total sale price in buyer currency.", "format": "double", "example": 1200, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "currency": { "allOf": [ { "$ref": "#/components/schemas/PriceCurrency" } ], "description": "Specifies the currency details for the pricing, including purchase and sale values.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "totalSP": { "type": "number", "description": "Represents the total sale price.", "format": "double", "example": 1200, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a detailed summary of pricing for a custom ledger, including currency and totals." }, "CustomLedgerStatus": { "enum": [ "Draft", "Deleted", "Validating", "Validated", "Error", "Generating", "Generated", "Queued", "Completed" ], "type": "string", "description": "Represents the various statuses a custom ledger can have in the billing system." }, "DatePeriod": { "type": "object", "properties": { "start": { "type": "string", "description": "The start date and time of the period.", "format": "date-time", "example": "2025-01-01T00:00:00+00:00" }, "end": { "type": "string", "description": "The end date and time of the period.", "format": "date-time", "example": "2025-01-31T23:59:59+00:00" } }, "additionalProperties": false, "description": "Represents the period during which a charge is applicable." }, "DateRange": { "type": "object", "properties": { "from": { "type": "string", "description": "Start date of the range.", "format": "date", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "to": { "type": "string", "description": "End date of the range.", "format": "date", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a date range with from and to dates." }, "ErpAuditBag": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "synced": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ErpAddress": { "type": "object", "properties": { "name": { "type": "string", "description": "The primary name associated with the address.", "example": "Microsoft Corporation", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name2": { "type": "string", "description": "The secondary name associated with the address.", "nullable": true, "example": "Latin America Collections", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "email": { "type": "string", "description": "The email associated with the address.", "nullable": true, "example": "no-reply@company.com", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "customerNo": { "type": "string", "description": "The customer number associated with the address.", "nullable": true, "example": "AR-SCU-100064", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "addressLine1": { "type": "string", "description": "The first line of the address.", "example": "Cazadores de Coquimbo 2860", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "addressLine2": { "type": "string", "description": "The second line of the address.", "nullable": true, "example": "Munro", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "addressLine3": { "type": "string", "description": "The third line of the address.", "nullable": true, "example": "Cuyo 3367", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "city": { "type": "string", "description": "The city of the address.", "nullable": true, "example": "Carapachay", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "postCode": { "type": "string", "description": "The postal code of the address.", "nullable": true, "example": "75284-841", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "county": { "type": "string", "description": "The county/state/region of the address.", "nullable": true, "example": "Buenos Aires", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "country": { "type": "string", "description": "The country of the address.", "nullable": true, "example": "AR", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contactName": { "type": "string", "description": "The contact name associated with the address.", "nullable": true, "example": "John Smith", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contactNo": { "type": "string", "description": "The contact number associated with the address.", "nullable": true, "example": "AR-CON-100260", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contactEmail": { "type": "string", "description": "The contact email associated with the address.", "nullable": true, "example": "john.smith@company.com", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contactPhone": { "type": "string", "description": "The contact phone number associated with the address.", "nullable": true, "example": "+541123456789", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "code": { "type": "string", "description": "The code associated with the address.", "nullable": true, "example": "CON-100333", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an address with various details such as name, address lines, city, postcode, country, and contact name." }, "ErpAddressList": { "type": "object", "properties": { "billTo": { "allOf": [ { "$ref": "#/components/schemas/ErpAddress" } ], "description": "The bill to address.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "licenseTo": { "allOf": [ { "$ref": "#/components/schemas/ErpAddress" } ], "description": "The license to address.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "sellTo": { "allOf": [ { "$ref": "#/components/schemas/ErpAddress" } ], "description": "The sell to address.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "shipTo": { "allOf": [ { "$ref": "#/components/schemas/ErpAddress" } ], "description": "The ship to address.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a list of addresses for billing purposes." }, "ErpAttributes": { "type": "object", "properties": { "navision": { "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ErpCode": { "type": "object", "properties": { "identifier": { "type": "string", "description": "The unique identifier for the ERP code.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "value": { "type": "string", "description": "The value of the ERP code.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "version": { "type": "string", "description": "The version of the ERP code.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents ERP-specific data related to a credit memo line or invoice line." }, "ErpData": { "type": "object", "properties": { "erpCountryCode": { "type": "string", "description": "The country code used in the ERP system.", "example": "US", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "defaultErpProductId": { "type": "string", "description": "The default product identifier used in the ERP system.", "example": "PROD-12345", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "defaultErpProductName": { "type": "string", "description": "The default product name used in the ERP system.", "example": "Standard Product", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "cdg": { "type": "string", "description": "The CDG (Customer Designation Group) value associated with the ERP data.", "example": "CDG-001", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "scu": { "type": "string", "description": "The SCU (Service Configuration Unit) value associated with the ERP data.", "example": "SCU-123", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "cco": { "type": "string", "description": "The CCO (Customer Configuration Option) value associated with the ERP data.", "example": "CCO-456", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "erpItemId": { "type": "string", "description": "The item identifier used in the ERP system.", "example": "ITEM-789", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents ERP-related data associated with a charge in the billing system." }, "ErpLink": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/ErpLinkAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "buyer": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BuyerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "seller": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SellerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "companyName": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/ErpLinkStatus" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "note": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/BuyerExternalIds" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "address": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } } }, "additionalProperties": false }, "ErpExternalIds": { "type": "object", "properties": { "statement": { "type": "string", "description": "Statement identifier.", "nullable": true, "example": "SOM-6707-9575-2243-2374", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "customer": { "type": "string", "description": "Bill to customer identifier.", "nullable": true, "example": "BUY-1366-0012", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "agreement": { "type": "string", "description": "Agreement identifier.", "nullable": true, "example": "AGR-0027-6450-2635", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents invoice references ." }, "ErpItem": { "type": "object", "properties": { "id": { "type": "string" }, "audit": { "allOf": [ { "$ref": "#/components/schemas/ErpAuditBag" } ] }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string" }, "revision": { "type": "integer", "format": "int32" }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/ErpAttributes" } ], "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/ErpItemStatus" } ], "nullable": true }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/ErpItemExternalIds" } ], "nullable": true }, "itemCategoryCode": { "type": "string", "nullable": true }, "licenseModelCode": { "type": "string", "nullable": true }, "manufacturerCode": { "type": "string", "nullable": true }, "vendor": { "allOf": [ { "$ref": "#/components/schemas/VendorProfile" } ], "nullable": true }, "product": { "allOf": [ { "$ref": "#/components/schemas/ProductProfile" } ], "nullable": true } }, "additionalProperties": false }, "ErpItemExternalIds": { "type": "object", "properties": { "operations": { "type": "string", "nullable": true }, "vendor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ErpItemStatus": { "enum": [ "Active", "Deleted", "Blocked" ], "type": "string" }, "ErpLinkAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "blocked": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unblocked": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ExtendedIdentity": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "firstName": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "lastName": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "email": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ErpLinkStatus": { "enum": [ "Active", "Blocked" ], "type": "string" }, "ErpPayment": { "type": "object", "properties": { "methodCode": { "type": "string", "description": "Gets or sets the payment method code.", "example": "BANK", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "termsCode": { "type": "string", "description": "Gets or sets the payment terms code.", "nullable": true, "example": "30DAYS", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents payment data for ERP systems." }, "ErpReferenceNumber": { "type": "object", "properties": { "eInvoiceNo": { "type": "string", "description": "The e-invoice number associated with the invoice.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "orderNo": { "type": "string", "description": "The order number associated with the invoice. Also known as \"Sales Order ID\".", "example": "CA-SCO-149880", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "ppqNo": { "type": "string", "description": "The PPQ number associated with the invoice.", "nullable": true, "example": "CA-PPQ-113048", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "quoteNo": { "type": "string", "description": "The quote number associated with the invoice.", "nullable": true, "example": "CA-QUO-145988", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents reference numbers associated with an ERP system." }, "Industry": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/IndustryAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "enum": [ "Draft", "Published", "Unpublished", "Deleted" ], "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ExternalIds": { "type": "object", "properties": { "client": { "type": "string", "nullable": true }, "operations": { "type": "string", "nullable": true }, "vendor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Filters": { "type": "object", "properties": { "group.buyers": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "IndustryAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "published": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unpublished": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ItemGroup": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "label": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayOrder": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "default": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "multiple": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "required": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "itemCount": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "product": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Invoice": { "type": "object", "properties": { "audit": { "allOf": [ { "$ref": "#/components/schemas/InvoiceAuditBag" } ], "description": "Represents a container for audit-related events for an invoice", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "id": { "type": "string", "description": "The unique identifier of the invoice.", "example": "INV-123-456-789", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "countryCode": { "type": "string", "description": "The country code.", "example": "IE", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "documentNo": { "type": "string", "description": "The document number assigned by the ERP system.", "example": "DOC-67890", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/ErpExternalIds" } ], "description": "Invoice external ids.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "buyer": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BuyerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "seller": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SellerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/InvoiceErpAttributes" } ], "description": "ERP attributes associated with the entity.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/InvoiceStatus" } ], "description": "The current status of the invoice.", "example": "Active", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "statement": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/StatementRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "agreement": { "allOf": [ { "$ref": "#/components/schemas/Agreement" } ], "description": "The agreement linked to the invoice, if any.", "nullable": true, "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "billingType": { "allOf": [ { "$ref": "#/components/schemas/BillingType" } ], "description": "The billing type associated with the invoice.", "example": "Automated", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "client": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "clientId": { "type": "string", "description": "The client identifier associated with the invoice, if any.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "licensee": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/LicenseeRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "product": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "vendor": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "erpData": { "allOf": [ { "$ref": "#/components/schemas/InvoiceErpData" } ], "description": "ERP-specific data related to the invoice, if available.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "price": { "allOf": [ { "$ref": "#/components/schemas/InvoicePrice" } ], "description": "Pricing details of the invoice, if available.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceLine" }, "description": "The list of invoice lines associated with the invoice.", "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "analytics": { "allOf": [ { "$ref": "#/components/schemas/AnalyticsInfo" } ], "description": "Analytics information related to the credit invoice.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an invoice entity in the billing system." }, "InvoiceAttachment": { "type": "object", "properties": { "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "description": "Name of the attachment.", "example": "raw records data", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "allOf": [ { "$ref": "#/components/schemas/BillingAttachmentType" } ], "description": "Specifies the type of the attachment, such as input, output, or general attachment.", "example": "Input", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "filename": { "type": "string", "description": "Represents the name of the file associated with the attachment.", "example": "invoice.pdf", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "size": { "type": "integer", "description": "Indicates the size of the file in bytes.", "format": "int64", "nullable": true, "example": 102400, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contentType": { "type": "string", "description": "Represents the MIME type of the file content.", "example": "application/pdf", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "description": "Provides a description of the attachment.", "example": "Invoice for March 2025", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "isDeleted": { "type": "boolean", "description": "Indicates whether the attachment has been marked as deleted.", "example": false, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "id": { "type": "string", "description": "The unique identifier of the attachment.", "example": "INA-1234-1234", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "invoice": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/InvoiceRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "isExternal": { "type": "boolean", "description": "Indicates whether the attachment is stored externally", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an attachment associated with an invoice in the billing system." }, "InvoiceAttachmentDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/InvoiceAttachment" } ], "description": "Represents an attachment associated with an invoice in the billing system.", "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "InvoiceAttachmentListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceAttachment" } } }, "additionalProperties": false }, "InvoiceAuditBag": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "issued": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the invoice reached the \"Issued\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "paid": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the invoice reached the \"Paid\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "overdue": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the invoice reached the \"Overdue\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a container for audit-related events for an invoice" }, "InvoiceErpAttributes": { "type": "object", "properties": { "postingDate": { "type": "string", "description": "The date when the invoice was posted.", "format": "date-time", "nullable": true, "example": "2025-05-01T10:00:00+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "documentDate": { "type": "string", "description": "The date when the document was created.", "format": "date-time", "nullable": true, "example": "2025-04-30T10:00:00+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalDocumentNo": { "type": "string", "description": "The external document number associated with the invoice.", "nullable": true, "example": "OC 4500355450", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalDocumentNo2": { "type": "string", "description": "The second external document number associated with the invoice.", "nullable": true, "example": "4540599242", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "yourReference": { "type": "string", "description": "Can be the custom reference (free text) or the statement ID (fixed format).", "nullable": true, "example": "Custom reference: US-PSI-1525628 RITM55345369 Wrong SCU; Statement ID: SOMM-8224-9785-1293-2113", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "dueDate": { "type": "string", "description": "The due date for the invoice payment.", "format": "date-time", "nullable": true, "example": "2025-05-15T23:59:59+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "orderNo": { "type": "string", "description": "The order number associated with the invoice. Also known as \"Sales Order ID\".", "nullable": true, "example": "CA-SCO-149880", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "quoteNo": { "type": "string", "description": "The quote number associated with the invoice.", "nullable": true, "example": "CA-QUO-145988", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Attributes related to ERP systems for an invoice." }, "InvoiceErpData": { "type": "object", "properties": { "erpId": { "type": "string", "description": "The ERP system identifier for the invoice.", "nullable": true, "example": "ERP-12345", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "documentNo": { "type": "string", "description": "The document number assigned by the ERP system.", "example": "DOC-67890", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "countryCode": { "type": "string", "description": "The country code of the credit memo.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "documentDate": { "type": "string", "description": "The date when the document was created.", "format": "date-time", "nullable": true, "example": "2025-04-30T10:00:00+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "dueDate": { "type": "string", "description": "The due date for the invoice payment.", "format": "date-time", "nullable": true, "example": "2025-05-15T23:59:59+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalDocumentNo": { "type": "string", "description": "The external document number associated with the invoice.", "nullable": true, "example": "OC 4500355450", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalDocumentNo2": { "type": "string", "description": "The second external document number associated with the invoice.", "nullable": true, "example": "4540599242", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "balanceDue": { "type": "number", "description": "The remaining balance due on the invoice.", "format": "double", "nullable": true, "example": 1500.75, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "invoiceTotal": { "type": "number", "description": "The total amount of the invoice.", "format": "double", "nullable": true, "example": 2000, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "postingDate": { "type": "string", "description": "The date when the invoice was posted.", "format": "date-time", "example": "2025-05-01T10:00:00+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "description": "The revision of the invoice, used for versioning control.", "format": "int64", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "rowVersion": { "type": "integer", "description": "The row version of the invoice, used for concurrency control.", "format": "int64", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "yourReference": { "type": "string", "description": "Can be the custom reference (free text) or the statement ID (fixed format).", "nullable": true, "example": "Custom reference: US-PSI-1525628 RITM55345369 Wrong SCU; Statement ID: SOMM-8224-9785-1293-2113", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "addresses": { "allOf": [ { "$ref": "#/components/schemas/ErpAddressList" } ], "description": "The list of addresses associated with the invoice.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "referenceNumber": { "allOf": [ { "$ref": "#/components/schemas/ErpReferenceNumber" } ], "description": "The additional identifiers related to the invoice.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "payment": { "allOf": [ { "$ref": "#/components/schemas/ErpPayment" } ], "description": "The payment data associated with the invoice.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents ERP-specific data related to an invoice." }, "InvoiceLine": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the invoice line.", "example": "INL-123-123-123", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "description": "The primary description of the line item.", "nullable": true, "example": "Microsoft 365 Business Standard", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description2": { "type": "string", "description": "The secondary description of the line item, if any.", "nullable": true, "example": "Includes Office apps and cloud services", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "documentNo": { "type": "string", "description": "The document number associated with the invoice line.", "example": "DOC-98765", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "erpData": { "allOf": [ { "$ref": "#/components/schemas/InvoiceLineErpData" } ], "description": "The ERP-specific data related to the credit memo line.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "itemNo": { "type": "string", "description": "The item number associated with the line item.", "nullable": true, "example": "SKU-001", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "lineNo": { "type": "integer", "description": "The line number within the invoice.", "format": "int32", "example": 1, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "period": { "allOf": [ { "$ref": "#/components/schemas/DatePeriod" } ], "description": "The period associated with the line item, if any.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "price": { "allOf": [ { "$ref": "#/components/schemas/InvoiceLinePrice" } ], "description": "The price details for the line.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a line item in an invoice." }, "InvoiceLineErpData": { "type": "object", "properties": { "contractNo": { "type": "string", "description": "The contract number associated with the line.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "countryOfUsage": { "type": "string", "description": "The country of usage for the line.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "dataOrigin": { "type": "integer", "description": "The data origin for the line.", "format": "int32", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalPositionNo": { "type": "string", "description": "The external position number for the line.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "navisionCountryCode": { "type": "string", "description": "The Navision country code for the line.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "parentItemNo": { "type": "string", "description": "The parent item number for the line.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "primary": { "allOf": [ { "$ref": "#/components/schemas/ErpCode" } ], "description": "The primary code details for the line, if any.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "secondary": { "allOf": [ { "$ref": "#/components/schemas/ErpCode" } ], "description": "The secondary code details for the line, if any.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "rowVersion": { "type": "integer", "description": "The row version of the line item for concurrency control.", "format": "int64", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "responsibilityCenterCode": { "type": "string", "description": "The responsibility center code for the line.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "swoPurchaseOrderNo": { "type": "string", "description": "The SWO purchase order number for the line.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "type": "integer", "description": "The type of the line.", "format": "int32", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unitOfMeasure": { "type": "string", "description": "The unit of measure for the line.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "varAgreementNo": { "type": "string", "description": "The VAR agreement number for the line.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "varPartnerNo": { "type": "string", "description": "The VAR partner number for the line.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "msrp": { "type": "number", "description": "The manufacturer's suggested retail price (MSRP) for the line item.", "format": "double", "example": 15, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "timestamp": { "type": "integer", "description": "The timestamp of the line item for concurrency control.", "format": "int64", "example": 1682937600, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "sellToContactNo": { "type": "string", "description": "The contact number for the sell-to party, if any.", "nullable": true, "example": "CONTACT-001", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalDocumentNo": { "type": "string", "description": "The external document number associated with the line item.", "nullable": true, "example": "EXTDOC-001", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalDocumentNo2": { "type": "string", "description": "An additional external document number, if any.", "nullable": true, "example": "EXTDOC2-001", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "yourReference": { "type": "string", "description": "The reference provided by the customer for the line item.", "nullable": true, "example": "CUSTREF-001", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents ERP-specific data related to a invoice line." }, "InvoiceLinePrice": { "type": "object", "properties": { "amount": { "type": "number", "description": "The net amount of the invoice line, visible to clients or operations.", "format": "double", "example": 1000, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "amountIncludingVat": { "type": "number", "description": "The total amount including VAT, visible to clients or operations.", "format": "double", "example": 1140, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "discountAmount": { "type": "number", "description": "The discount amount applied to the invoice line, visible to clients or operations.", "format": "double", "example": 15, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "lineAmount": { "type": "number", "description": "The total line amount after applying discounts, visible to clients or operations.", "format": "double", "example": 950, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "purchaseCurrencyCode": { "type": "string", "description": "The currency used for the purchase price, visible only to operations.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Operations" ] } }, "purchaseCurrencyFactor": { "type": "number", "description": "The factor applied to the purchase currency, visible only to operations.", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "purchasePrice": { "type": "number", "description": "The purchase price, visible only to operations.", "format": "double", "nullable": true, "example": 10, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "purchasePriceLcy": { "type": "number", "description": "The purchase price in local currency, visible only to operations.", "format": "double", "nullable": true, "example": 200, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "purchasePriceTotal": { "type": "number", "description": "The total purchase price, visible only to operations.", "format": "double", "nullable": true, "example": 100, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "purchasePriceTotalLcy": { "type": "number", "description": "The total purchase price in local currency, visible only to operations.", "format": "double", "nullable": true, "example": 2000, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "quantity": { "type": "integer", "description": "The quantity for the credit memo line.", "format": "int32", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "salesMarkup": { "type": "number", "description": "The sales markup percentage for the invoice line, visible only to operations.", "format": "double", "nullable": true, "example": 10, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "salesMargin": { "type": "number", "description": "The sales margin percentage for the invoice line, visible only to operations.", "format": "double", "nullable": true, "example": 15, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "unitPrice": { "type": "number", "description": "The unit price for the credit memo line.", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "vatBaseAmount": { "type": "number", "description": "The base amount used for VAT calculation.", "format": "double", "example": 100, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "vatCalculationType": { "type": "integer", "description": "The VAT calculation type for the line.", "format": "int32", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "vatPercent": { "type": "number", "description": "The VAT percentage for the line.", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents the price details of an invoice line." }, "InvoiceListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice" } } }, "additionalProperties": false }, "InvoicePrice": { "type": "object", "properties": { "currency": { "type": "string", "description": "The currency used for the invoice pricing.", "example": "EUR", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "currencyFactor": { "type": "number", "description": "The factor applied to the currency, used for conversion or adjustments.", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "currencyFactor2": { "type": "number", "description": "The second factor applied to the currency, used for conversion or adjustments.", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "markup": { "type": "number", "description": "The markup applied to the invoice, visible to operations.", "format": "double", "nullable": true, "example": 10, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "margin": { "type": "number", "description": "The margin applied to the invoice, visible to operations.", "format": "double", "nullable": true, "example": 13.04, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "totalPP": { "type": "number", "description": "The total purchase price, visible to operations.", "format": "double", "nullable": true, "example": 100, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "totalSP": { "type": "number", "description": "The total selling price, visible to clients or operations.", "format": "double", "nullable": true, "example": 115, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "totalST": { "type": "number", "description": "The total sales tax, visible to clients or operations.", "format": "double", "nullable": true, "example": 13, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "totalGT": { "type": "number", "description": "The total gross amount, visible to clients or operations.", "format": "double", "nullable": true, "example": 14.95, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } } }, "additionalProperties": false, "description": "Represents the pricing details of an invoice." }, "InvoiceStatus": { "enum": [ "Issued", "Paid", "Overdue" ], "type": "string", "description": "Represents the various statuses an invoice can have in the billing system." }, "Licensee": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/LicenseeAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/LicenseeStatus" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "useBuyerAddress": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "buyer": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BuyerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "seller": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SellerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "eligibility": { "allOf": [ { "$ref": "#/components/schemas/Eligibility" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Journal": { "type": "object", "properties": { "audit": { "allOf": [ { "$ref": "#/components/schemas/JournalAuditBag" } ], "description": "Represents a container for audit-related events for a journal", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "id": { "type": "string", "description": "The unique identifier of the journal entry.", "example": "BJO-1234-1234", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "description": "Name of the journal.", "example": "29 Nov 2024 #1", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "description": "A description of the journal entry.", "example": "Monthly revenue journal entry", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/BillingExternalIds" } ], "description": "External identifiers associated with the journal entry.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "notes": { "type": "string", "description": "Additional notes or comments about the journal entry.", "nullable": true, "example": "Includes adjustments for Q1 2025", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/JournalStatus" } ], "description": "The current status of the journal entry.", "example": "Validated", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "vendor": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "owner": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SellerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "product": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "authorization": { "allOf": [ { "$ref": "#/components/schemas/Authorization" } ], "description": "Authorization details associated with the journal entry.", "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "dueDate": { "type": "string", "description": "The due date for the journal entry.", "format": "date-time", "example": "2025-05-15T23:59:59+00:00", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "assignee": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PlatformIdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "price": { "allOf": [ { "$ref": "#/components/schemas/JournalPriceSummary" } ], "description": "Pricing details associated with the journal entry.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "upload": { "allOf": [ { "$ref": "#/components/schemas/JournalUploadSummary" } ], "description": "Upload summary details for the journal entry, visible to vendors or operations.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "processing": { "allOf": [ { "$ref": "#/components/schemas/ProcessingSummary" } ], "description": "Processing status and related details for the journal entry, visible to operations.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "error": { "allOf": [ { "$ref": "#/components/schemas/BillingError" } ], "description": "Error details associated with the journal entry, if any.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "backup": { "allOf": [ { "$ref": "#/components/schemas/BackupDetails" } ], "description": "Backup details for the journal.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } } }, "additionalProperties": false, "description": "Represents a journal entry in the billing system." }, "JournalAttachment": { "type": "object", "properties": { "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "description": "Name of the attachment.", "example": "raw records data", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "allOf": [ { "$ref": "#/components/schemas/BillingAttachmentType" } ], "description": "Specifies the type of the attachment, such as input, output, or general attachment.", "example": "Input", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "filename": { "type": "string", "description": "Represents the name of the file associated with the attachment.", "example": "invoice.pdf", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "size": { "type": "integer", "description": "Indicates the size of the file in bytes.", "format": "int64", "nullable": true, "example": 102400, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contentType": { "type": "string", "description": "Represents the MIME type of the file content.", "example": "application/pdf", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "description": "Provides a description of the attachment.", "example": "Invoice for March 2025", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "isDeleted": { "type": "boolean", "description": "Indicates whether the attachment has been marked as deleted.", "example": false, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "id": { "type": "string", "description": "The unique identifier of the attachment.", "example": "JOA-1234-1234", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "journal": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/JournalRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "vendor": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an attachment associated with a journal in the billing system." }, "JournalAttachmentDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/JournalAttachment" } ], "description": "Represents an attachment associated with a journal in the billing system.", "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "JournalAttachmentListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/JournalAttachment" } } }, "additionalProperties": false }, "JournalAuditBag": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "draft": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the journal reached the \"Draft\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "deleted": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the journal reached the \"Deleted\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "error": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the journal reached the \"Error\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "validating": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the journal reached the \"Validating\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "validated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the journal reached the \"Validated\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "review": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the journal reached the \"Review\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "enquiring": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the journal reached the \"Enquiring\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "generating": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the journal reached the \"Generating\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "generated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the journal reached the \"Generated\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "accepted": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the journal reached the \"Accepted\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "completed": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the journal reached the \"Completed\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a container for audit-related events for a journal" }, "JournalCharge": { "type": "object", "properties": { "audit": { "allOf": [ { "$ref": "#/components/schemas/ChargeAuditBag" } ], "description": "Represents a container for audit-related events for a charge", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "id": { "type": "string", "description": "The unique identifier of the charge.", "example": "CHG-1234-1234-1234-1234-1234", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/ChargeExternalIds" } ], "description": "Contains external identifiers associated with the charge.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "search": { "allOf": [ { "$ref": "#/components/schemas/ChargeSearchBag" } ], "description": "Contains search-related details for the charge.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "period": { "allOf": [ { "$ref": "#/components/schemas/DatePeriod" } ], "description": "Represents the period during which the charge is applicable.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "quantity": { "type": "number", "description": "Indicates the quantity associated with the charge.", "format": "double", "example": 10.5, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "price": { "allOf": [ { "$ref": "#/components/schemas/ChargePrice" } ], "description": "Contains pricing details for the charge.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "allOf": [ { "$ref": "#/components/schemas/ChargeDescription" } ], "description": "Contains a description of the charge, if applicable.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/ChargeAttributes" } ], "description": "Contains additional attributes for the charge.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "journal": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/JournalRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "ledger": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/LedgerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "customLedger": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/CustomLedgerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "parent": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ChargeRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "upload": { "allOf": [ { "$ref": "#/components/schemas/ChargeStatusBag" } ], "description": "Contains the upload status and related details for the charge, visible to vendors or operations.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "licensee": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/LicenseeRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "agreement": { "allOf": [ { "$ref": "#/components/schemas/Agreement" } ], "description": "The agreement associated with the charge, if applicable.", "nullable": true, "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "subscription": { "allOf": [ { "$ref": "#/components/schemas/Subscription" } ], "description": "The subscription associated with the charge, if applicable.", "nullable": true, "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "line": { "allOf": [ { "$ref": "#/components/schemas/AgreementLine" } ], "description": "The line associated with the charge, if applicable.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "order": { "allOf": [ { "$ref": "#/components/schemas/Order" } ], "description": "The order associated with the charge, if applicable.", "nullable": true, "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "asset": { "allOf": [ { "$ref": "#/components/schemas/Asset" } ], "description": "The asset associated with the charge, if applicable.", "nullable": true, "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "item": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductItemRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "authorization": { "allOf": [ { "$ref": "#/components/schemas/Authorization" } ], "description": "The authorization details associated with the charge, if applicable.", "nullable": true, "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "statement": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/StatementRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "statementType": { "allOf": [ { "$ref": "#/components/schemas/StatementType" } ], "description": "Indicates the type of statement associated with the charge.", "example": "Debit", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "processing": { "allOf": [ { "$ref": "#/components/schemas/ChargeStatusBag" } ], "description": "Contains the processing status and related details for the charge, visible to operations.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "erpData": { "allOf": [ { "$ref": "#/components/schemas/ErpData" } ], "description": "Contains ERP-related data for the charge.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "buyer": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BuyerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "vendor": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "seller": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SellerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "split": { "allOf": [ { "$ref": "#/components/schemas/ChargeSplit" } ], "description": "Contains details about the charge split, if applicable.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "reconciliation": { "allOf": [ { "$ref": "#/components/schemas/Reconciliation" } ], "description": "Contains reconciliation info for the journal charge.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "billingType": { "allOf": [ { "$ref": "#/components/schemas/BillingType" } ], "description": "Specifies that the billing type for this charge is automated.", "readOnly": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a charge associated with a journal in the billing system." }, "JournalChargeDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/JournalCharge" } ], "description": "Represents a charge associated with a journal in the billing system.", "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "JournalChargeSource": { "enum": [ "Unknown", "Agreement", "Subscription", "Asset" ], "type": "string", "description": "Represents the source of a charge in a journal entry." }, "JournalDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/Journal" } ], "description": "Represents a journal entry in the billing system.", "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "JournalListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Journal" } } }, "additionalProperties": false }, "JournalPriceSummary": { "type": "object", "properties": { "markup": { "type": "number", "description": "Represents the markup value applied to the pricing.", "format": "double", "example": 15.5, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "margin": { "type": "number", "description": "Represents the margin value calculated for the pricing.", "format": "double", "example": 20, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "totalPP": { "type": "number", "description": "Represents the total purchase price.", "format": "double", "example": 1000, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "totalBSP": { "type": "number", "description": "Represents the total sale price in buyer currency.", "format": "double", "example": 1200, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "currency": { "type": "string", "description": "Specifies the currency for the pricing.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a detailed summary of pricing." }, "JournalSeller": { "type": "object", "properties": { "externalId": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/SellerStatus" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "journal": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/JournalRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a seller associated with a journal entry in the billing system." }, "JournalSellerListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/JournalSeller" } } }, "additionalProperties": false }, "JournalStatus": { "enum": [ "Draft", "Deleted", "Error", "Validating", "Validated", "Review", "Reconciling", "Enquiring", "Generating", "Generated", "Accepted", "Queued", "Completed", "Resetting" ], "type": "string", "description": "Represents the various statuses a journal can have in the billing system." }, "JournalUploadSummary": { "type": "object", "properties": { "total": { "type": "integer", "description": "The total number of items in the upload.", "format": "int32", "example": 100, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "split": { "type": "integer", "description": "The number of items that were split during the upload.", "format": "int32", "example": 10, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "ready": { "type": "integer", "description": "The number of items that are ready for processing.", "format": "int32", "example": 85, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "error": { "type": "integer", "description": "The number of items that encountered errors during the upload.", "format": "int32", "example": 5, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a summary of the upload status for a journal entry." }, "Ledger": { "type": "object", "properties": { "audit": { "allOf": [ { "$ref": "#/components/schemas/LedgerAuditBag" } ], "description": "Represents a container for audit-related events for a ledger", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "id": { "type": "string", "description": "The unique identifier of the ledger.", "example": "BLE-1234-1234-1234-1234", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "journal": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/JournalRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/LedgerStatus" } ], "description": "The current status of the ledger.", "example": "Generated", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "authorization": { "allOf": [ { "$ref": "#/components/schemas/Authorization" } ], "description": "Authorization details associated with the ledger.", "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "owner": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SellerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "seller": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SellerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "product": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "assignee": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PlatformIdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "price": { "allOf": [ { "$ref": "#/components/schemas/LedgerPriceSummary" } ], "description": "Pricing details associated with the ledger.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "processing": { "allOf": [ { "$ref": "#/components/schemas/ProcessingSummary" } ], "description": "Processing status and related details for the ledger, visible to operations.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "error": { "allOf": [ { "$ref": "#/components/schemas/BillingError" } ], "description": "Error details associated with the ledger, if any.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "backup": { "allOf": [ { "$ref": "#/components/schemas/BackupDetails" } ], "description": "Backup details for the ledger.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } } }, "additionalProperties": false, "description": "Represents a ledger in the billing system." }, "LedgerAttachment": { "type": "object", "properties": { "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "description": "Name of the attachment.", "example": "raw records data", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "allOf": [ { "$ref": "#/components/schemas/BillingAttachmentType" } ], "description": "Specifies the type of the attachment, such as input, output, or general attachment.", "example": "Input", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "filename": { "type": "string", "description": "Represents the name of the file associated with the attachment.", "example": "invoice.pdf", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "size": { "type": "integer", "description": "Indicates the size of the file in bytes.", "format": "int64", "nullable": true, "example": 102400, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contentType": { "type": "string", "description": "Represents the MIME type of the file content.", "example": "application/pdf", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "description": "Provides a description of the attachment.", "example": "Invoice for March 2025", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "isDeleted": { "type": "boolean", "description": "Indicates whether the attachment has been marked as deleted.", "example": false, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "id": { "type": "string", "description": "The unique identifier of the attachment.", "example": "LEA-1234-1234", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "ledger": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/LedgerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an attachment associated with a ledger in the billing system." }, "LedgerAttachmentDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/LedgerAttachment" } ], "description": "Represents an attachment associated with a ledger in the billing system.", "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "LedgerAttachmentListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerAttachment" } } }, "additionalProperties": false }, "LedgerAuditBag": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "rating": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the ledger reached the \"Rating\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "error": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the ledger reached the \"Error\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "review": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the ledger reached the \"Review\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "generating": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the ledger reached the \"Generating\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "generated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the ledger reached the \"Generated\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "queued": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the ledger reached the \"Queued\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "completed": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the ledger reached the \"Completed\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a container for audit-related events for a ledger" }, "LedgerDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/Ledger" } ], "description": "Represents a ledger in the billing system.", "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "LedgerListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Ledger" } } }, "additionalProperties": false }, "LedgerPriceSummary": { "type": "object", "properties": { "markup": { "type": "number", "description": "Represents the markup value applied to the pricing.", "format": "double", "example": 15.5, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "margin": { "type": "number", "description": "Represents the margin value calculated for the pricing.", "format": "double", "example": 20, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "totalPP": { "type": "number", "description": "Represents the total purchase price.", "format": "double", "example": 1000, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "totalBSP": { "type": "number", "description": "Represents the total sale price in buyer currency.", "format": "double", "example": 1200, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "currency": { "type": "string", "description": "Specifies the currency for the pricing.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a detailed summary of pricing for a ledger." }, "LedgerStatus": { "enum": [ "Rating", "Error", "Review", "Generating", "Generated", "Queued", "Completed" ], "type": "string", "description": "Represents the various statuses a ledger can have in the billing system." }, "LicenseeAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "disabled": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Listing": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "authorization": { "allOf": [ { "$ref": "#/components/schemas/Authorization" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "product": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "vendor": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "seller": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SellerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "priceList": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PriceListRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "primary": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "notes": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "statistics": { "allOf": [ { "$ref": "#/components/schemas/ListingStatistics" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "eligibility": { "allOf": [ { "$ref": "#/components/schemas/ListingEligibility" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "LicenseeStatus": { "enum": [ "Active", "Enabled", "Disabled", "Deleted" ], "type": "string" }, "ListingEligibility": { "type": "object", "properties": { "client": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "partner": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Module": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "code": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "accountTypes": { "type": "array", "items": { "type": "string" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "filters": { "allOf": [ { "$ref": "#/components/schemas/Filters" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "settings": { "allOf": [ { "$ref": "#/components/schemas/ModuleSettings" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ListingStatistics": { "type": "object", "properties": { "subscriptions": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "agreements": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ManualOverrideAuditBag": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "active": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the override reached the \"Active\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "disabled": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the override reached the \"Disabled\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a container for audit-related events for a manual override" }, "MarkupSource": { "enum": [ "Unknown", "PriceList", "PricingPolicy", "Manual" ], "type": "string" }, "MarkupSourcePrice": { "type": "object", "properties": { "type": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Operations" ] } }, "ref": { "allOf": [ { "$ref": "#/components/schemas/MarkupSourceRefPrice" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } } }, "additionalProperties": false }, "MarkupSourceRefPrice": { "type": "object", "properties": { "id": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Operations" ] } }, "name": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Operations" ] } } }, "additionalProperties": false }, "ModuleSettingsEligibility": { "type": "object", "properties": { "multi": { "type": "boolean" }, "single": { "type": "boolean" } }, "additionalProperties": false }, "ModuleSettings": { "type": "object", "properties": { "sharedAccount": { "type": "boolean", "deprecated": true }, "configurable": { "type": "boolean" }, "default": { "type": "boolean" }, "paid": { "type": "boolean" }, "type": { "type": "array", "items": { "type": "string" }, "x-rql": { "core": true, "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "obsolete": { "type": "boolean" }, "eligibility": { "allOf": [ { "$ref": "#/components/schemas/ModuleSettingsEligibility" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "NumberFormat": { "type": "object", "properties": { "decimalSeparator": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "groupSeparator": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "OrderAssetAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "draft": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "active": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "terminated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Order": { "type": "object", "properties": { "id": { "type": "string" }, "audit": { "allOf": [ { "$ref": "#/components/schemas/OrderAudit" } ] }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32" }, "type": { "allOf": [ { "$ref": "#/components/schemas/OrderType" } ] }, "status": { "allOf": [ { "$ref": "#/components/schemas/OrderStatus" } ] }, "notes": { "type": "string", "nullable": true }, "comments": { "type": "string", "nullable": true }, "statusNotes": { "allOf": [ { "$ref": "#/components/schemas/ParametrisedMessage" } ], "nullable": true }, "template": { "allOf": [ { "$ref": "#/components/schemas/Template" } ], "nullable": true }, "listing": { "allOf": [ { "$ref": "#/components/schemas/Listing" } ] }, "authorization": { "allOf": [ { "$ref": "#/components/schemas/Authorization" } ] }, "agreement": { "allOf": [ { "$ref": "#/components/schemas/Agreement" } ] }, "assignee": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ], "nullable": true }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/ExternalIds" } ] }, "price": { "allOf": [ { "$ref": "#/components/schemas/OrderSummaryPrice" } ] }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLine" } }, "subscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/OrderSubscription" } }, "assets": { "type": "array", "items": { "$ref": "#/components/schemas/OrderAsset" } }, "parameters": { "allOf": [ { "$ref": "#/components/schemas/ParameterBag" } ] }, "error": { "allOf": [ { "$ref": "#/components/schemas/ParametrisedMessage" } ], "nullable": true }, "product": { "allOf": [ { "$ref": "#/components/schemas/Product" } ] }, "client": { "allOf": [ { "$ref": "#/components/schemas/Account" } ] }, "licensee": { "allOf": [ { "$ref": "#/components/schemas/Licensee" } ] }, "buyer": { "allOf": [ { "$ref": "#/components/schemas/Buyer" } ] }, "seller": { "allOf": [ { "$ref": "#/components/schemas/Seller" } ] }, "vendor": { "allOf": [ { "$ref": "#/components/schemas/Account" } ] }, "billTo": { "allOf": [ { "$ref": "#/components/schemas/Buyer" } ], "nullable": true }, "pricingPolicy": { "allOf": [ { "$ref": "#/components/schemas/PricingPolicy" } ], "nullable": true }, "termsAndConditions": { "type": "array", "items": { "$ref": "#/components/schemas/CommerceTermsAndConditions" } }, "certificates": { "type": "array", "items": { "$ref": "#/components/schemas/Certificate" } }, "defaultMarkupSource": { "allOf": [ { "$ref": "#/components/schemas/MarkupSource" } ], "nullable": true } }, "additionalProperties": false }, "OrderAsset": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/OrderAssetAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/ExternalIds" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/AssetStatus" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "price": { "allOf": [ { "$ref": "#/components/schemas/AssetSummaryPrice" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "template": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/TemplateRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "parameters": { "allOf": [ { "$ref": "#/components/schemas/AssetParameterBag" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "terms": { "allOf": [ { "$ref": "#/components/schemas/TermsEntity" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLine" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "OrderAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "completed": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "deleted": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "failed": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "processing": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "querying": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "quoted": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "OrderSubscriptionAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "active": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "terminated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "terminating": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updating": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "OrderLine": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "oldQuantity": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "quantity": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "price": { "allOf": [ { "$ref": "#/components/schemas/OrderLinePrice" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "item": { "allOf": [ { "$ref": "#/components/schemas/ProductItem" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "subscription": { "allOf": [ { "$ref": "#/components/schemas/OrderSubscription" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "asset": { "allOf": [ { "$ref": "#/components/schemas/OrderAsset" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "agreement": { "allOf": [ { "$ref": "#/components/schemas/Agreement" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "order": { "allOf": [ { "$ref": "#/components/schemas/Order" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "client": { "allOf": [ { "$ref": "#/components/schemas/Account" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "vendor": { "allOf": [ { "$ref": "#/components/schemas/Account" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "buyer": { "allOf": [ { "$ref": "#/components/schemas/Buyer" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "seller": { "allOf": [ { "$ref": "#/components/schemas/Seller" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "product": { "allOf": [ { "$ref": "#/components/schemas/Product" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "info": { "allOf": [ { "$ref": "#/components/schemas/PriceInfo" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "OrderLinePrice": { "type": "object", "properties": { "currency": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "markup": { "type": "number", "format": "double", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "margin": { "type": "number", "format": "double", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "defaultMarkupSource": { "allOf": [ { "$ref": "#/components/schemas/MarkupSourcePrice" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "markupSource": { "allOf": [ { "$ref": "#/components/schemas/MarkupSourcePrice" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "unitSP": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "unitPP": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "PPx1": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "SPx1": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "SPxY": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "SPxM": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "PPxY": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "PPxM": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } } }, "additionalProperties": false }, "OrderStatus": { "enum": [ "New", "Draft", "Deleted", "Processing", "Querying", "Failed", "Completed", "Quoted" ], "type": "string" }, "OrderSubscription": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/OrderSubscriptionAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "startDate": { "type": "string", "format": "date-time", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "terminationDate": { "type": "string", "format": "date-time", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/ExternalIds" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "terms": { "allOf": [ { "$ref": "#/components/schemas/TermsEntity" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "product": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "autoRenew": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/OrderSubscriptionStatus" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "commitmentDate": { "type": "string", "format": "date-time", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "parameters": { "allOf": [ { "$ref": "#/components/schemas/SubscriptionParameterBag" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "agreement": { "allOf": [ { "$ref": "#/components/schemas/Agreement" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "price": { "allOf": [ { "$ref": "#/components/schemas/SubscriptionSummaryPrice" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLine" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "template": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/TemplateRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "PhoneNumber": { "type": "object", "properties": { "prefix": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "number": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "OrderSubscriptionStatus": { "enum": [ "Draft", "Active", "Deleted", "Updating", "Terminating", "Terminated" ], "type": "string" }, "OrderSummaryPrice": { "type": "object", "properties": { "currency": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "markup": { "type": "number", "format": "double", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "margin": { "type": "number", "format": "double", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "defaultMarkupSource": { "allOf": [ { "$ref": "#/components/schemas/MarkupSourcePrice" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "markupSource": { "allOf": [ { "$ref": "#/components/schemas/MarkupSourcePrice" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "defaultMarkup": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "PPx1": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "SPx1": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "SPxY": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "SPxM": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "PPxY": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "PPxM": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } } }, "additionalProperties": false }, "OrderType": { "enum": [ "Purchase", "Change", "Termination", "Configuration" ], "type": "string" }, "OriginalValues": { "type": "object", "properties": { "subscription": { "allOf": [ { "$ref": "#/components/schemas/Subscription" } ], "description": "The original subscription entity, if applicable.", "nullable": true, "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "agreement": { "allOf": [ { "$ref": "#/components/schemas/Agreement" } ], "description": "The original agreement entity, if applicable.", "nullable": true, "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "line": { "allOf": [ { "$ref": "#/components/schemas/AgreementLine" } ], "description": "The original line entity, if applicable.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "order": { "allOf": [ { "$ref": "#/components/schemas/Order" } ], "description": "The original order entity, if applicable.", "nullable": true, "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Values assigned during initial journal calculation." }, "Override": { "type": "object", "properties": { "audit": { "allOf": [ { "$ref": "#/components/schemas/ManualOverrideAuditBag" } ], "description": "Represents a container for audit-related events for a manual override" }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32" }, "id": { "type": "string", "description": "The unique identifier of the manual override.", "example": "BOV-1234-1234" }, "client": { "allOf": [ { "$ref": "#/components/schemas/Account" } ], "description": "Specifies the client account associated with the manual override." }, "vendor": { "allOf": [ { "$ref": "#/components/schemas/Account" } ], "description": "Specifies the vendor account associated with the manual override." }, "status": { "allOf": [ { "$ref": "#/components/schemas/OverrideStatus" } ], "description": "Indicates the current status of the manual override.", "example": "Active" }, "externalId": { "type": "string", "description": "Represents an external identifier for the manual override, if applicable.", "nullable": true, "example": "EXT-12345" }, "notes": { "type": "string", "description": "Contains additional notes or comments related to the manual override.", "nullable": true, "example": "Adjustment for Q1 billing" } }, "additionalProperties": false, "description": "Represents a manual override in the billing system, allowing specific adjustments to billing processing." }, "OverrideDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/Override" } ], "description": "Represents a manual override in the billing system, allowing specific adjustments to billing processing.", "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "OverrideListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Override" } } }, "additionalProperties": false }, "OverrideStatus": { "enum": [ "Active", "Disabled" ], "type": "string", "description": "Represents the status of a manual override in the billing system." }, "ParameterBag": { "type": "object", "properties": { "ordering": { "type": "array", "items": { "$ref": "#/components/schemas/CommerceParameter" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "fulfillment": { "type": "array", "items": { "$ref": "#/components/schemas/CommerceParameter" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ParameterConstraints": { "type": "object", "properties": { "required": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "hidden": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "readonly": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "capacity": { "allOf": [ { "$ref": "#/components/schemas/CapacitySettings" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ParameterPhase": { "enum": [ "Configuration", "Order", "Fulfillment" ], "type": "string" }, "ParameterScope": { "enum": [ "Agreement", "Item", "Subscription", "Order", "Asset" ], "type": "string" }, "ParameterType": { "enum": [ "SingleLineText", "MultiLineText", "Address", "Contact", "Checkbox", "Choice", "Subdomain", "Heading", "DropDown", "Email", "DataObject", "Date" ], "type": "string" }, "ParameterValue": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "multiple": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "value": { "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayValue": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ParametrisedMessage": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "parameters": { "nullable": true } }, "additionalProperties": false }, "PricingPolicyAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "activated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "deactivated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "PlatformObjectAuditPlatformExtension": { "type": "object", "properties": { "id": { "type": "string" }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "nullable": true }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string" }, "icon": { "type": "string", "nullable": true }, "revision": { "type": "integer", "format": "int32" }, "status": { "enum": [ "Draft", "Private", "Public", "Deleted" ], "type": "string" } }, "additionalProperties": false }, "PreValidation": { "type": "object", "properties": { "enrollmentDraft": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "enrollmentQuerying": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "reEnrollment": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "reEnrollmentDraft": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "reEnrollmentQuerying": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "PreValidationSettings": { "type": "object", "properties": { "purchaseOrderDraft": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "purchaseOrderQuerying": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "changeOrderDraft": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "configurationOrderDraft": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "terminationOrder": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "PriceCurrency": { "type": "object", "properties": { "purchase": { "type": "string", "description": "Indicates the purchase price currency visible to vendors or operations.", "example": "USD", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "sale": { "type": "string", "description": "Indicates the sale price currency visible to clients or operations.", "example": "EUR", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "rate": { "type": "number", "description": "Exchange rate between the purchase and sale currencies.", "format": "double", "example": 1, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } } }, "additionalProperties": false, "description": "Represents the currency details for pricing, including purchase and sale values." }, "PriceInfo": { "type": "object", "properties": { "visible": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "PriceList": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "currency": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "precision": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "defaultMarkup": { "type": "number", "format": "double", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "defaultMargin": { "type": "number", "format": "double", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "notes": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/PriceListExternalIdBag" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "statistics": { "allOf": [ { "$ref": "#/components/schemas/PriceListStatistics" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "product": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "vendor": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "PriceListExternalIdBag": { "type": "object", "properties": { "vendor": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "PriceListStatistics": { "type": "object", "properties": { "sellers": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "listings": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "priceListItems": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "purchasePriceItems": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "purchasePriceCompleteness": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "salesPriceItems": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Operations" ] } }, "salesPriceCompleteness": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Operations" ] } }, "averageMarkup": { "type": "number", "format": "double", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "averageMargin": { "type": "number", "format": "double", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } } }, "additionalProperties": false }, "PricingPolicy": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PricingPolicyAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/PricingPolicyExternalIdBag" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "client": { "allOf": [ { "$ref": "#/components/schemas/Account" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "eligibility": { "allOf": [ { "$ref": "#/components/schemas/PricingPolicyEligibility" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "markup": { "type": "number", "format": "double", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "margin": { "type": "number", "format": "double", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "notes": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/Product" }, "nullable": true, "x-rql": { "core": true, "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/PricingPolicyStatus" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "statistics": { "allOf": [ { "$ref": "#/components/schemas/PricingPolicyStatistics" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } } }, "additionalProperties": false }, "PricingPolicyEligibility": { "type": "object", "properties": { "client": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "partner": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "PricingPolicyExternalIdBag": { "type": "object", "properties": { "operations": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProductItem": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/ProductItemAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/ProductItemExternalIdBag" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "group": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ItemGroupRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "unit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/UnitOfMeasureRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "terms": { "allOf": [ { "$ref": "#/components/schemas/TermsEntity" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "quantityNotApplicable": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "product": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/ParameterValue" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "PricingPolicyStatistics": { "type": "object", "properties": { "orders": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "attachments": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "PricingPolicyStatus": { "enum": [ "None", "Active", "Inactive", "Deleted" ], "type": "string" }, "ProcessingSummary": { "type": "object", "properties": { "total": { "type": "integer", "description": "Indicates the total number of items involved in the processing.", "format": "int32", "example": 100, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "ready": { "type": "integer", "description": "Indicates the number of items that are ready for further processing.", "format": "int32", "example": 80, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "error": { "type": "integer", "description": "Indicates the number of items that encountered errors during processing.", "format": "int32", "example": 5, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "split": { "type": "integer", "description": "Indicates the number of items that were split into multiple parts during processing.", "format": "int32", "example": 10, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "skipped": { "type": "integer", "description": "Indicates the number of items that were skipped during processing.", "format": "int32", "example": 5, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "ignored": { "type": "integer", "description": "Indicates the number of items that were manually ignored.", "format": "int32", "example": 2, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a summary of the processing status for various billing operations." }, "ProductExternalIdBag": { "type": "object", "properties": { "operations": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "defaultErpItem": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProductItemAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "pending": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "published": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unpublished": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProductItemExternalIdBag": { "type": "object", "properties": { "vendor": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "operations": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProductProfile": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/ProductProfileAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "shortDescription": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "longDescription": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "featured": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "website": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "linkedIn": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "facebook": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "youTube": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "xProfile": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryEntityRef" }, "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "industries": { "type": "array", "items": { "$ref": "#/components/schemas/IndustryRef" }, "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentRef" }, "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "vendorProfile": { "allOf": [ { "$ref": "#/components/schemas/VendorProfile" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/ProductRef" }, "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "enum": [ "Draft", "Published", "Unpublished", "Deleted" ], "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProductProfileAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true }, "published": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true }, "unpublished": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true } }, "additionalProperties": false }, "Product": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/ProductAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "shortDescription": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "longDescription": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/ProductExternalIdBag" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "website": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "vendor": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "settings": { "allOf": [ { "$ref": "#/components/schemas/ProductSettings" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "statistics": { "allOf": [ { "$ref": "#/components/schemas/ProductStatistics" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProductAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "published": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "pending": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unpublished": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProductRequestsSetting": { "type": "object", "properties": { "enabled": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "label": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProductSplitBillingRequestsSetting": { "type": "object", "properties": { "enabled": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProductSettings": { "type": "object", "properties": { "productOrdering": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "productRequests": { "allOf": [ { "$ref": "#/components/schemas/ProductRequestsSetting" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "itemSelection": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "orderQueueChanges": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "preValidation": { "allOf": [ { "$ref": "#/components/schemas/PreValidationSettings" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "splitBilling": { "allOf": [ { "$ref": "#/components/schemas/ProductSplitBillingRequestsSetting" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "sendCostToErp": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "subscriptionCessation": { "allOf": [ { "$ref": "#/components/schemas/SubscriptionCessationSetting" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Program": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/ProgramAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "shortDescription": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "longDescription": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "website": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/ProgramStatus" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "eligibility": { "allOf": [ { "$ref": "#/components/schemas/ProgramEligibility" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "applicableTo": { "allOf": [ { "$ref": "#/components/schemas/ProgramApplicableTo" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/Product" }, "nullable": true, "x-rql": { "core": true, "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "vendor": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "settings": { "allOf": [ { "$ref": "#/components/schemas/ProgramSettings" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "statistics": { "allOf": [ { "$ref": "#/components/schemas/ProgramStatistics" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProductStatistics": { "type": "object", "properties": { "itemCount": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "ordersPlacedCount": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "agreementCount": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "subscriptionCount": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProgramApplicableTo": { "enum": [ "Buyer", "Licensee" ], "type": "string" }, "ProgramEligibility": { "type": "object", "properties": { "client": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "partner": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProgramAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "published": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unpublished": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProgramParameter": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "allOf": [ { "$ref": "#/components/schemas/ParameterType" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "phase": { "allOf": [ { "$ref": "#/components/schemas/ProgramParameterPhase" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "multiple": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "error": { "allOf": [ { "$ref": "#/components/schemas/ParametrisedMessage" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "constraints": { "allOf": [ { "$ref": "#/components/schemas/Constraints" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayValue": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "value": { "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProgramParameterBag": { "type": "object", "properties": { "ordering": { "type": "array", "items": { "$ref": "#/components/schemas/ProgramParameter" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "fulfillment": { "type": "array", "items": { "$ref": "#/components/schemas/ProgramParameter" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProgramTemplate": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "content": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "default": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/ProgramTemplateExternalIdBag" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "allOf": [ { "$ref": "#/components/schemas/ProgramTemplateType" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/TemplateStatus" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "program": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProgramRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProgramParameterPhase": { "enum": [ "Order", "Fulfillment" ], "type": "string" }, "ProgramSettings": { "type": "object", "properties": { "newCertificateAutoapprove": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "programEnrollment": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "programLink": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "terminateOnExpiration": { "allOf": [ { "$ref": "#/components/schemas/TerminateOnExpiration" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "preValidation": { "allOf": [ { "$ref": "#/components/schemas/PreValidation" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProgramStatistics": { "type": "object", "properties": { "certificates": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProgramStatus": { "enum": [ "None", "Draft", "Published", "Unpublished", "Deleted" ], "type": "string" }, "ProgramTermsAndConditionsAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "published": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unpublished": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProgramTemplateExternalIdBag": { "type": "object", "properties": { "vendor": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProgramTemplateType": { "enum": [ "EnrollmentProcessing", "EnrollmentQuerying", "EnrollmentCompleted" ], "type": "string" }, "Segment": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/SegmentAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "enum": [ "Draft", "Published", "Unpublished", "Deleted" ], "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Reconciliation": { "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/ReconciliationType" } ], "description": "Type of action — either Mpt.Models.Billing.ReconciliationType.Match (linking the charge to a source object),\nMpt.Models.Billing.ReconciliationType.Ignore (excludes the charge from billing),\nor Mpt.Models.Billing.ReconciliationType.Reset (resets the charge to its original state).", "example": "Match", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "source": { "allOf": [ { "$ref": "#/components/schemas/JournalChargeSource" } ], "description": "Identifies which object was used to reconcile the charge when Mpt.Models.Billing.Charges.Reconciliation.Type is Mpt.Models.Billing.ReconciliationType.Match.\nPossible values: Mpt.Models.Billing.Charges.JournalChargeSource.Agreement, Mpt.Models.Billing.Charges.JournalChargeSource.Subscription, Mpt.Models.Billing.Charges.JournalChargeSource.Asset.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "reason": { "type": "string", "description": "Reason provided for the action. Required when Mpt.Models.Billing.Charges.Reconciliation.Type is Mpt.Models.Billing.ReconciliationType.Ignore.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "original": { "allOf": [ { "$ref": "#/components/schemas/OriginalValues" } ], "description": "Values assigned during initial journal calculation — used for audit and to support charge reset.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents reconciliation info for a journal charge." }, "ReconciliationType": { "enum": [ "Match", "Ignore", "Reset" ], "type": "string" }, "SegmentAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "published": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unpublished": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "SellerCurrency": { "type": "object", "properties": { "value": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "billingEnabled": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "isDefault": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Seller": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/SellerStatus" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "currencies": { "type": "array", "items": { "$ref": "#/components/schemas/SellerCurrency" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "erpLink": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ErpLinkRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "SubscriptionAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "active": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "terminated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "terminating": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updating": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "expired": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "renewed": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "SellerStatus": { "enum": [ "Active", "Disabled", "Offline", "Deleted" ], "type": "string" }, "SplitBillingAgreement": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "allocations": { "type": "array", "items": { "$ref": "#/components/schemas/SplitBillingAgreementAllocation" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "SplitBillingAgreementAllocation": { "type": "object", "properties": { "buyer": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BuyerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "percentage": { "type": "number", "format": "double", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "price": { "allOf": [ { "$ref": "#/components/schemas/SplitBillingAllocationPrice" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "statistics": { "allOf": [ { "$ref": "#/components/schemas/SplitBillingAllocationStatistics" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/ExternalIds" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "SplitBillingAllocationPrice": { "type": "object", "properties": { "currency": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "SPxY": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "SPxM": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "PPxY": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "PPxM": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } } }, "additionalProperties": false }, "SplitBillingAllocationStatistics": { "type": "object", "properties": { "subscriptions": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "SplitBillingSubscription": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "subscription": { "allOf": [ { "$ref": "#/components/schemas/Subscription" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "allocations": { "type": "array", "items": { "$ref": "#/components/schemas/SplitBillingSubscriptionAllocation" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "SplitBillingSubscriptionAllocation": { "type": "object", "properties": { "buyer": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BuyerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "percentage": { "type": "number", "format": "double", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "price": { "allOf": [ { "$ref": "#/components/schemas/SplitBillingAllocationPrice" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "SplitStatus": { "enum": [ "Disabled", "Active", "Review" ], "type": "string" }, "Statement": { "type": "object", "properties": { "audit": { "allOf": [ { "$ref": "#/components/schemas/StatementAuditBag" } ], "description": "Represents a container for audit-related events for a statement", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "id": { "type": "string", "description": "The unique identifier of the statement.", "example": "SOM-1234-1234-1234-1234-1234", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/StatementExternalIds" } ], "description": "Contains external identifiers associated with the statement.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "ledger": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/LedgerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "customLedger": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/CustomLedgerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "allOf": [ { "$ref": "#/components/schemas/StatementType" } ], "description": "Specifies the type of the statement.", "example": "Debit", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "billingType": { "allOf": [ { "$ref": "#/components/schemas/BillingType" } ], "description": "Specifies the billing type of the statement.", "example": "Automated", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/StatementStatus" } ], "description": "Indicates the current status of the statement.", "example": "Generated", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "client": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "buyer": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BuyerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "vendor": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "seller": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SellerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "product": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "agreement": { "allOf": [ { "$ref": "#/components/schemas/Agreement" } ], "description": "Represents the agreement associated with the statement, if applicable.", "nullable": true, "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "licensee": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/LicenseeRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "price": { "allOf": [ { "$ref": "#/components/schemas/StatementPriceSummary" } ], "description": "Contains the pricing summary for the statement.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "processing": { "allOf": [ { "$ref": "#/components/schemas/ProcessingSummary" } ], "description": "Contains the processing summary for the statement, visible to operations.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "statusNotes": { "allOf": [ { "$ref": "#/components/schemas/BillingParametrisedMessage" } ], "description": "Contains additional notes or messages about the status of the statement, if applicable.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "error": { "allOf": [ { "$ref": "#/components/schemas/BillingError" } ], "description": "Represents any error associated with the statement, visible to clients or operations.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "creditMemo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/CreditMemoRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "invoice": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/InvoiceRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "backup": { "allOf": [ { "$ref": "#/components/schemas/BackupDetails" } ], "description": "Backup details for the statement.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "parent": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/StatementRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "statistics": { "allOf": [ { "$ref": "#/components/schemas/StatementStatistics" } ], "description": "Statistics to summarize the composition of a statement.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a billing statement in the system, containing details about transactions, pricing, and associated entities." }, "StatementAttachment": { "type": "object", "properties": { "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "description": "Name of the attachment.", "example": "raw records data", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "allOf": [ { "$ref": "#/components/schemas/BillingAttachmentType" } ], "description": "Specifies the type of the attachment, such as input, output, or general attachment.", "example": "Input", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "filename": { "type": "string", "description": "Represents the name of the file associated with the attachment.", "example": "invoice.pdf", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "size": { "type": "integer", "description": "Indicates the size of the file in bytes.", "format": "int64", "nullable": true, "example": 102400, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contentType": { "type": "string", "description": "Represents the MIME type of the file content.", "example": "application/pdf", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "description": "Provides a description of the attachment.", "example": "Invoice for March 2025", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "isDeleted": { "type": "boolean", "description": "Indicates whether the attachment has been marked as deleted.", "example": false, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "id": { "type": "string", "description": "The unique identifier of the attachment.", "example": "STA-1234-1234", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "statement": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/StatementRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an attachment associated with a billing statement in the system." }, "StatementAttachmentDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/StatementAttachment" } ], "description": "Represents an attachment associated with a billing statement in the system.", "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "StatementAttachmentListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/StatementAttachment" } } }, "additionalProperties": false }, "StatementAuditBag": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "generated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the statement reached the \"Generated\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "queued": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the statement reached the \"Queued\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "error": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the statement reached the \"Error\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "cancelled": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the statement reached the \"Cancelled\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "pending": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the statement reached the \"Pending\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "issued": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the statement reached the \"Issued\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "generating": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the statement reached the \"Generating\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "consolidating": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the statement reached the \"Consolidating\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "consolidated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Contains details about the most recent event when the statement reached the \"Consolidated\" status.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a container for audit-related events for a statement" }, "StatementDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/Statement" } ], "description": "Represents a billing statement in the system, containing details about transactions, pricing, and associated entities.", "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "StatementExternalIds": { "type": "object", "properties": { "operations": { "type": "string", "description": "Represents the identifier used for operations in the billing system.", "nullable": true, "example": "OPS-12345", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "vendor": { "type": "string", "description": "Represents the identifier used for vendors in the billing system.", "nullable": true, "example": "VND-67890", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "erpId": { "type": "string", "description": "Represents the identifier used in the ERP system for the statement, if applicable.", "nullable": true, "example": "ERP-12345", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "client": { "type": "string", "description": "Represents the identifier used for clients in the billing system.", "nullable": true, "example": "CLI-12345", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents external identifiers associated with a billing statement." }, "StatementListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Statement" } } }, "additionalProperties": false }, "StatementPriceSummary": { "type": "object", "properties": { "markup": { "type": "number", "description": "Represents the markup value applied to the pricing.", "format": "double", "example": 15.5, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "margin": { "type": "number", "description": "Represents the margin value calculated for the pricing.", "format": "double", "example": 20, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "totalPP": { "type": "number", "description": "Represents the total purchase price.", "format": "double", "example": 1000, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "totalBSP": { "type": "number", "description": "Represents the total sale price in buyer currency.", "format": "double", "example": 1200, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "currency": { "allOf": [ { "$ref": "#/components/schemas/PriceCurrency" } ], "description": "Specifies the currency details for the pricing, including purchase and sale values.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "totalSP": { "type": "number", "description": "Represents the total sale price.", "format": "double", "example": 1200, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a detailed summary of pricing for a billing statement, including currency and totals." }, "StatementStatistics": { "type": "object", "properties": { "statements": { "type": "integer", "description": "Gets or sets the count of child statements.", "format": "int32", "example": 3, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "products": { "type": "integer", "description": "Gets or sets the count of distinct products across child statements.", "format": "int32", "example": 3, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "agreements": { "type": "integer", "description": "Gets or sets the count of distinct agreements across child statements.", "format": "int32", "example": 3, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "licensees": { "type": "integer", "description": "Gets or sets the count of distinct licensees across child statements.", "format": "int32", "example": 2, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Counts of key dimensions derived from child statements, recalculated on consolidation changes." }, "StatementStatus": { "enum": [ "Generated", "Queued", "Error", "Cancelled", "Pending", "Issued", "Generating", "Consolidating", "Consolidated" ], "type": "string", "description": "Represents the various statuses a statement can have in the billing system." }, "StatementType": { "enum": [ "Debit", "Credit" ], "type": "string", "description": "Represents the type of a statement in the billing system." }, "Subscription": { "type": "object", "properties": { "id": { "type": "string" }, "audit": { "allOf": [ { "$ref": "#/components/schemas/SubscriptionAudit" } ] }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string" }, "revision": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "terminationDate": { "type": "string", "format": "date-time", "nullable": true }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/ExternalIds" } ] }, "terms": { "allOf": [ { "$ref": "#/components/schemas/TermsEntity" } ] }, "product": { "allOf": [ { "$ref": "#/components/schemas/Product" } ] }, "autoRenew": { "type": "boolean" }, "status": { "allOf": [ { "$ref": "#/components/schemas/SubscriptionStatus" } ] }, "commitmentDate": { "type": "string", "format": "date-time" }, "price": { "allOf": [ { "$ref": "#/components/schemas/SubscriptionSummaryPrice" } ] }, "parameters": { "allOf": [ { "$ref": "#/components/schemas/SubscriptionParameterBag" } ] }, "agreement": { "allOf": [ { "$ref": "#/components/schemas/Agreement" } ] }, "buyer": { "allOf": [ { "$ref": "#/components/schemas/Buyer" } ] }, "licensee": { "allOf": [ { "$ref": "#/components/schemas/Licensee" } ] }, "seller": { "allOf": [ { "$ref": "#/components/schemas/Seller" } ] }, "split": { "allOf": [ { "$ref": "#/components/schemas/SplitBillingSubscription" } ], "nullable": true }, "splitStatus": { "allOf": [ { "$ref": "#/components/schemas/SplitStatus" } ] }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementLine" }, "nullable": true }, "template": { "allOf": [ { "$ref": "#/components/schemas/Template" } ], "nullable": true } }, "additionalProperties": false }, "SubscriptionCessationSetting": { "type": "object", "properties": { "enabled": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "mode": { "enum": [ "Termination", "Auto-renewal", "Termination or auto-renewal" ], "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Template": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "content": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "enum": [ "OrderProcessing", "OrderQuerying", "OrderCompleted", "Subscription", "Asset" ], "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "default": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/TemplateExternalIdBag" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "product": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "SubscriptionParameterBag": { "type": "object", "properties": { "fulfillment": { "type": "array", "items": { "$ref": "#/components/schemas/CommerceParameter" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "SubscriptionStatus": { "enum": [ "Active", "Updating", "Terminating", "Terminated", "Expired" ], "type": "string" }, "SubscriptionSummaryPrice": { "type": "object", "properties": { "currency": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "markup": { "type": "number", "format": "double", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "margin": { "type": "number", "format": "double", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "defaultMarkupSource": { "allOf": [ { "$ref": "#/components/schemas/MarkupSourcePrice" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "markupSource": { "allOf": [ { "$ref": "#/components/schemas/MarkupSourcePrice" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "SPxY": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "SPxM": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "PPxY": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "PPxM": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "defaultMarkup": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "defaultMargin": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } } }, "additionalProperties": false }, "TermsAndConditionsAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "published": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "pending": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unpublished": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "TemplateExternalIdBag": { "type": "object", "properties": { "vendor": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "TemplateStatus": { "enum": [ "Active", "Deleted" ], "type": "string" }, "TerminateOnExpiration": { "type": "object", "properties": { "enabled": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "duration": { "type": "integer", "format": "int32", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UserGroup": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "modules": { "type": "array", "items": { "$ref": "#/components/schemas/ModuleRef" }, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "logo": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "isDefault": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserRef" }, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "extensions": { "type": "array", "items": { "$ref": "#/components/schemas/PlatformObjectAuditPlatformExtension" }, "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "buyers": { "type": "array", "items": { "$ref": "#/components/schemas/BuyerRef" }, "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "TermsEntity": { "type": "object", "properties": { "model": { "enum": [ "one-time", "usage", "quantity" ], "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "period": { "enum": [ "1m", "1y", "one-time" ], "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "commitment": { "enum": [ "1m", "1y", "3y" ], "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UnitOfMeasure": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "statistics": { "allOf": [ { "$ref": "#/components/schemas/UnitOfMeasureStatistics" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UnitOfMeasureStatistics": { "type": "object", "properties": { "itemCount": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UserAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "invitationAcceptedAt": { "type": "string", "format": "date-time", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "User": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/UserAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "email": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "phone": { "allOf": [ { "$ref": "#/components/schemas/PhoneNumber" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "firstName": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "lastName": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "lastLoginAt": { "type": "string", "format": "date-time", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "settings": { "allOf": [ { "$ref": "#/components/schemas/UserSettings" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "accounts": { "type": "array", "items": { "$ref": "#/components/schemas/AccountRef" }, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Operations" ] } }, "currentAccount": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UserSettings": { "type": "object", "properties": { "cultureCode": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "dateFormat": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "languageCode": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "numberFormat": { "allOf": [ { "$ref": "#/components/schemas/NumberFormat" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "timeFormat": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "timeZone": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "VendorProfile": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/VendorProfileAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "featured": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "website": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "linkedIn": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "facebook": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "youTube": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "xProfile": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryEntityRef" }, "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "productProfiles": { "type": "array", "items": { "$ref": "#/components/schemas/ProductProfileRef" }, "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "vendor": { "allOf": [ { "$ref": "#/components/schemas/Account" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "enum": [ "Draft", "Published", "Unpublished", "Deleted" ], "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "VendorProfileAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true }, "published": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true }, "unpublished": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true } }, "additionalProperties": false }, "Channel": { "type": "object", "properties": { "identity": { "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "DocumentDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/DocumentEntity" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "CreateCategoryRequest": { "type": "object", "properties": { "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CreateDocumentRequest": { "type": "object", "properties": { "document": { "type": "object", "properties": { "Name": { "type": "string" }, "Description": { "type": "string" }, "Language": { "type": "string" }, "DocumentType": { "allOf": [ { "$ref": "#/components/schemas/DocumentType" } ] }, "Url": { "type": "string" } }, "description": "Json representation of the document" }, "file": { "type": "string", "format": "binary", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } } }, "CreateExtensionWithIconRequest": { "type": "object", "properties": { "Extension": { "type": "object", "properties": { "Name": { "type": "string" }, "ShortDescription": { "type": "string" }, "LongDescription": { "type": "string" }, "Website": { "type": "string" }, "Categories": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" } } }, "description": "Json representation of the Extension" }, "icon": { "type": "string", "format": "binary", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } } }, "CreateInstallationRequest": { "type": "object", "properties": { "extension": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "invitation": { "allOf": [ { "$ref": "#/components/schemas/InvitationEntity" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "modules": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CreateInstanceRequest": { "type": "object", "properties": { "meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ExtensionMetaRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "version": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "channel": { "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CreateMediaRequest": { "type": "object", "properties": { "media": { "type": "object", "properties": { "Name": { "type": "string" }, "Description": { "type": "string" }, "MediaType": { "allOf": [ { "$ref": "#/components/schemas/MediaType" } ] }, "Url": { "type": "string" }, "DisplayOrder": { "type": "integer", "format": "int32" } }, "description": "Json representation of the media" }, "file": { "type": "string", "format": "binary", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } } }, "CreateTermRequest": { "type": "object", "properties": { "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayOrder": { "type": "integer", "format": "int32", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CreateTermVariantRequest": { "type": "object", "properties": { "variant": { "type": "object", "properties": { "Type": { "enum": [ "Online", "File" ], "type": "string" }, "AssetUrl": { "type": "string" }, "LanguageCode": { "type": "string" }, "Name": { "type": "string" }, "Description": { "type": "string" } }, "description": "Json representation of the variant" }, "file": { "type": "string", "format": "binary", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } } }, "DocumentAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "published": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unpublished": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "DocumentEntity": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/DocumentAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "enum": [ "Draft", "Published", "Unpublished", "Deleted" ], "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "filename": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "size": { "type": "integer", "format": "int32", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contentType": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "url": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "language": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "extension": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ExtensionRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "DocumentListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentEntity" } } }, "additionalProperties": false }, "ExtensionCategory": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/ExtensionCategoryAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "enum": [ "Active", "Disabled" ], "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "DocumentType": { "enum": [ "Online", "File" ], "type": "string" }, "EventTimeout": { "type": "object", "properties": { "maxTaskProcessing": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "maxTaskLifespan": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ExtensionAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "public": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "private": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ExtensionCategoryAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "activated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "deactivated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ExtensionCategoryListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionCategory" } } }, "additionalProperties": false }, "ExtensionDeferrable": { "type": "object", "properties": { "path": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "method": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "timeouts": { "allOf": [ { "$ref": "#/components/schemas/EventTimeout" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Extension": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/ExtensionAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "vendor": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "shortDescription": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "longDescription": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "website": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "enum": [ "Draft", "Private", "Public", "Deleted" ], "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionCategoryRef" }, "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "modules": { "type": "array", "items": { "$ref": "#/components/schemas/ModuleRef" }, "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "statistics": { "allOf": [ { "$ref": "#/components/schemas/ExtensionStatistics" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "configuration": { "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ExtensionMetaRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "service": { "allOf": [ { "$ref": "#/components/schemas/ExtensionServiceDetails" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ExtensionListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Extension" } } }, "additionalProperties": false }, "ExtensionEvent": { "type": "object", "properties": { "event": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "condition": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "path": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "task": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "timeouts": { "allOf": [ { "$ref": "#/components/schemas/EventTimeout" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ExtensionMeta": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "version": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "plugs": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationPoint" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "openapi": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionEvent" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "schedules": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionSchedule" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "webhooks": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionWebhook" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "deferrables": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionDeferrable" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ExtensionSchedule": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "path": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "cron": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ExtensionServiceDetails": { "type": "object", "properties": { "secret": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ExtensionUpdateWithIcon": { "type": "object", "properties": { "extension": { "type": "object", "properties": { "Extension.Node.Name": { "type": "string" }, "Extension.Node.Children": { "type": "array", "items": { "$ref": "#/components/schemas/DeltaNode" } }, "Extension.Path": { "type": "string" }, "Extension.Data.Name": { "type": "string" }, "Extension.Data.ShortDescription": { "type": "string" }, "Extension.Data.LongDescription": { "type": "string" }, "Extension.Data.Website": { "type": "string" }, "Extension.Data.Categories": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" } }, "Extension.Data.Configuration.RootElement.ValueKind": { "allOf": [ { "$ref": "#/components/schemas/JsonValueKind" } ] }, "Extension.IsDefined": { "type": "boolean" } }, "description": "Json representation of the extension", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "format": "binary", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } } }, "ExtensionStatistics": { "type": "object", "properties": { "installations": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ExtensionWebhook": { "type": "object", "properties": { "type": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "path": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "criteria": { "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Installation": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/InstallationAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "extension": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ExtensionRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "enum": [ "Invited", "Installed", "Uninstalled", "Expired" ], "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "configuration": { "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "invitation": { "allOf": [ { "$ref": "#/components/schemas/InvitationEntity" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "modules": { "type": "array", "items": { "$ref": "#/components/schemas/ModuleRef" }, "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "terms": { "type": "array", "items": { "$ref": "#/components/schemas/InstallationTermRef" }, "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "InstallationAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "invited": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "installed": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "expired": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "uninstalled": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "InstallationDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/Installation" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "InstallationListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Installation" } } }, "additionalProperties": false }, "InstallationTerm": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/InstallationTermAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayOrder": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "extension": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ExtensionRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "accepted": { "type": "string", "format": "date-time", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "acceptedBy": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "InstallationTermAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "published": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unpublished": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Instance": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/InstanceAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "extension": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ExtensionRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ExtensionMetaRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "enum": [ "Connecting", "Disconnected", "Running", "Deleted" ], "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "channel": { "allOf": [ { "$ref": "#/components/schemas/Channel" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "InstanceAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "connecting": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "running": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "disconnected": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "InstanceListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Instance" } } }, "additionalProperties": false }, "IntegrationPoint": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "condition": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "socket": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "href": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Media": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/MediaAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "enum": [ "Draft", "Published", "Unpublished", "Deleted" ], "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "filename": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "size": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contentType": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayOrder": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "url": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "extension": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ExtensionRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "InvitationEntity": { "type": "object", "properties": { "url": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "message": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "validity": { "enum": [ "7d", "14d", "1m", "3m", "6m", "1y" ], "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "JsonValueKind": { "enum": [ "Undefined", "Object", "Array", "String", "Number", "True", "False", "Null" ], "type": "string" }, "MediaAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "published": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unpublished": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "MediaDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/Media" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "MediaListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Media" } } }, "additionalProperties": false }, "Term": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/TermAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayOrder": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "enum": [ "Draft", "Published", "Unpublished", "Deleted" ], "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "extension": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ExtensionRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "MediaType": { "enum": [ "Video", "Image" ], "type": "string" }, "RedeemInstallationRequest": { "type": "object", "properties": { "code": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "modules": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "RequestObjectLink": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "TermAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "published": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unpublished": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "TermDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/Term" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "TermListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Term" } } }, "additionalProperties": false }, "TermVariant": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/TermVariantAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "enum": [ "Online", "File" ], "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "assetUrl": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "languageCode": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "enum": [ "Draft", "Published", "Unpublished", "Deleted" ], "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "filename": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "size": { "type": "integer", "format": "int32", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contentType": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "term": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/TermRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "fileId": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "TermVariantAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "published": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unpublished": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "TermVariantListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/TermVariant" } } }, "additionalProperties": false }, "UpdateCategory": { "type": "object", "properties": { "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "TokenResponse": { "type": "object", "properties": { "token": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UpdateCategoryDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/UpdateCategory" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "UpdateTermVariant": { "type": "object", "properties": { "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UpdateTermVariantDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/UpdateTermVariant" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "IndustryListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Industry" } } }, "additionalProperties": false }, "CategoryEntityListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryEntity" } } }, "additionalProperties": false }, "CreateAttachmentRequest": { "type": "object", "properties": { "attachment": { "type": "object", "properties": { "Name": { "type": "string", "description": "Attachment name" }, "Description": { "type": "string", "description": "Attachment description" } }, "description": "Json representation of the attachment" }, "file": { "type": "string", "description": "Attachment File", "format": "binary" } } }, "CreateIndustryRequest": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "productProfiles": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" }, "nullable": true } }, "additionalProperties": false, "description": "Represents a request to create a new industry in the public catalog.\nContains the necessary properties for specifying industry details." }, "CreateProductProfileRequest": { "type": "object", "properties": { "productProfile": { "type": "object", "properties": { "Name": { "type": "string" }, "ShortDescription": { "type": "string" }, "LongDescription": { "type": "string" }, "Featured": { "type": "boolean" }, "Website": { "type": "string" }, "LinkedIn": { "type": "string" }, "YouTube": { "type": "string" }, "XProfile": { "type": "string" }, "Categories": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" } }, "Industries": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" } }, "Segments": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" } }, "VendorProfile.Id": { "type": "string" } }, "description": "Json representation of the productProfile" }, "icon": { "type": "string", "format": "binary" } } }, "CreateSegmentRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "" }, "description": { "type": "string", "description": "", "nullable": true }, "productProfiles": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" }, "description": "", "nullable": true } }, "additionalProperties": false, "description": "Represents a request to create a new segment in the public catalog." }, "CreateVendorProfileRequest": { "type": "object", "properties": { "vendorProfile": { "type": "object", "properties": { "Name": { "type": "string" }, "Description": { "type": "string" }, "Featured": { "type": "boolean" }, "Website": { "type": "string" }, "LinkedIn": { "type": "string" }, "Facebook": { "type": "string" }, "YouTube": { "type": "string" }, "XProfile": { "type": "string" }, "Categories": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" } }, "ProductProfiles": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" } } }, "description": "Json representation of the vendorProfile" }, "icon": { "type": "string", "format": "binary" } } }, "ProductProfileAttachment": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/ProductProfileAttachmentAudit" } ], "description": "Represents ProductProfileAttachmentAudit.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "description": "Represents Description of file.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "filename": { "type": "string", "description": "Represents filename.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "size": { "type": "integer", "description": "Represents size of file.", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contentType": { "type": "string", "description": "Represents Content type.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "description": "Represents attachment status.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "productProfile": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductProfileRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a product profile attachment entity." }, "ProductProfileAttachmentAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "published": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Represents published event.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unpublished": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Represents unpublished event.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents ProductProfileAttachmentAudit." }, "ProductProfileAttachmentDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/ProductProfileAttachment" } ], "description": "Represents a product profile attachment entity.", "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ProductProfileAttachmentListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductProfileAttachment" } } }, "additionalProperties": false }, "ProductProfileListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductProfile" } } }, "additionalProperties": false }, "ProductProfileMedia": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/ProductProfileMediaAudit" } ], "description": "", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "type": "string", "description": "Represents media type.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "description": "Represents media description.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "description": "Represents media status.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "filename": { "type": "string", "description": "Represents media filename.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "size": { "type": "integer", "description": "Represents media size.", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contentType": { "type": "string", "description": "Represents content type.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayOrder": { "type": "integer", "description": "Represents display order.", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "url": { "type": "string", "description": "Represents media url.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "productProfile": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductProfileRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a product profile media entity." }, "ProductProfileMediaAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "published": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unpublished": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "" }, "ProductProfileMediaDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/ProductProfileMedia" } ], "description": "Represents a product profile media entity.", "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ProductProfileMediaListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductProfileMedia" } } }, "additionalProperties": false }, "ProductProfileUpdateWithIcon": { "type": "object", "properties": { "productProfile": { "type": "object", "properties": { "ProductProfile.Node.Name": { "type": "string" }, "ProductProfile.Node.Children": { "type": "array", "items": { "$ref": "#/components/schemas/DeltaNode" } }, "ProductProfile.Path": { "type": "string" }, "ProductProfile.Data.Name": { "type": "string" }, "ProductProfile.Data.ShortDescription": { "type": "string" }, "ProductProfile.Data.LongDescription": { "type": "string" }, "ProductProfile.Data.Featured": { "type": "boolean" }, "ProductProfile.Data.Website": { "type": "string" }, "ProductProfile.Data.LinkedIn": { "type": "string" }, "ProductProfile.Data.YouTube": { "type": "string" }, "ProductProfile.Data.XProfile": { "type": "string" }, "ProductProfile.Data.Categories": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" } }, "ProductProfile.Data.Industries": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" } }, "ProductProfile.Data.Segments": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" } }, "ProductProfile.Data.VendorProfile.Id": { "type": "string" }, "ProductProfile.Data.Products": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" } }, "ProductProfile.IsDefined": { "type": "boolean" } }, "description": "Json representation of the productProfile" }, "icon": { "type": "string", "description": "Icon file associated with the Product Profile.", "format": "binary" } } }, "SegmentListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Segment" } } }, "additionalProperties": false }, "UpdateIndustry": { "type": "object", "properties": { "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "productProfiles": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UpdateIndustryDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/UpdateIndustry" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "UpdateProductProfile": { "type": "object", "properties": { "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "shortDescription": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "longDescription": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "featured": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "website": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "linkedIn": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "youTube": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "xProfile": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "industries": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "vendorProfile": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UpdateSegment": { "type": "object", "properties": { "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "productProfiles": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UpdateSegmentDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/UpdateSegment" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "UpdateVendorProfile": { "type": "object", "properties": { "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "featured": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "website": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "linkedIn": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "facebook": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "youTube": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "xProfile": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "productProfiles": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "vendor": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "VendorProfileListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/VendorProfile" } } }, "additionalProperties": false }, "VendorProfileUpdateWithIcon": { "type": "object", "properties": { "vendorProfile": { "type": "object", "properties": { "VendorProfile.Node.Name": { "type": "string" }, "VendorProfile.Node.Children": { "type": "array", "items": { "$ref": "#/components/schemas/DeltaNode" } }, "VendorProfile.Path": { "type": "string" }, "VendorProfile.Data.Name": { "type": "string" }, "VendorProfile.Data.Description": { "type": "string" }, "VendorProfile.Data.Featured": { "type": "boolean" }, "VendorProfile.Data.Website": { "type": "string" }, "VendorProfile.Data.LinkedIn": { "type": "string" }, "VendorProfile.Data.Facebook": { "type": "string" }, "VendorProfile.Data.YouTube": { "type": "string" }, "VendorProfile.Data.XProfile": { "type": "string" }, "VendorProfile.Data.Categories": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" } }, "VendorProfile.Data.ProductProfiles": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" } }, "VendorProfile.Data.Vendor.Id": { "type": "string" }, "VendorProfile.IsDefined": { "type": "boolean" } }, "description": "Json representation of the vendorProfile" }, "icon": { "type": "string", "description": "Icon file associated with the Vendor Profile.", "format": "binary" } } }, "CurrencyWithIcon": { "type": "object", "properties": { "currency": { "type": "object", "properties": { "Currency.Node.Name": { "type": "string" }, "Currency.Node.Children": { "type": "array", "items": { "$ref": "#/components/schemas/DeltaNode" } }, "Currency.Path": { "type": "string" }, "Currency.Data.Id": { "type": "string", "description": "The unique identifier of the currency." }, "Currency.Data.Name": { "type": "string", "description": "The name of the currency." }, "Currency.Data.Code": { "type": "string", "description": "The ISO code of currency" }, "Currency.Data.Precision": { "type": "integer", "description": "Precision of the currency", "format": "int32" }, "Currency.Data.Statistics.SellerCount": { "type": "integer", "description": "Number of sellers using currency", "format": "int32" }, "Currency.Data.Statistics.PairCount": { "type": "integer", "description": "Number of pairs", "format": "int32" }, "Currency.Data.Status": { "allOf": [ { "$ref": "#/components/schemas/CurrencyStatus" } ], "description": "The current status of the currency." }, "Currency.Data.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Currency.Data.Icon": { "type": "string" }, "Currency.Data.Revision": { "type": "integer", "format": "int32" }, "Currency.Data.Audit.Deleted.At": { "type": "string", "format": "date-time" }, "Currency.Data.Audit.Deleted.ById": { "type": "string" }, "Currency.Data.Audit.Deleted.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Currency.Data.Audit.Deleted.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Currency.Data.Audit.Deleted.By.Name": { "type": "string" }, "Currency.Data.Audit.Deleted.By.Icon": { "type": "string" }, "Currency.Data.Audit.Deleted.By.Revision": { "type": "integer", "format": "int32" }, "Currency.Data.Audit.Deleted.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Currency.Data.Audit.Deleted.By.Audit.Created.ById": { "type": "string" }, "Currency.Data.Audit.Deleted.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Currency.Data.Audit.Deleted.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Currency.Data.Audit.Deleted.By.Audit.Updated.ById": { "type": "string" }, "Currency.Data.Audit.Deleted.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Currency.Data.Audit.Deleted.By.Id": { "type": "string" }, "Currency.Data.Audit.Created.At": { "type": "string", "format": "date-time" }, "Currency.Data.Audit.Created.ById": { "type": "string" }, "Currency.Data.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Currency.Data.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Currency.Data.Audit.Created.By.Name": { "type": "string" }, "Currency.Data.Audit.Created.By.Icon": { "type": "string" }, "Currency.Data.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Currency.Data.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Currency.Data.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Currency.Data.Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Currency.Data.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Currency.Data.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Currency.Data.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Currency.Data.Audit.Created.By.Id": { "type": "string" }, "Currency.Data.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Currency.Data.Audit.Updated.ById": { "type": "string" }, "Currency.Data.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Currency.Data.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Currency.Data.Audit.Updated.By.Name": { "type": "string" }, "Currency.Data.Audit.Updated.By.Icon": { "type": "string" }, "Currency.Data.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Currency.Data.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Currency.Data.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Currency.Data.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Currency.Data.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Currency.Data.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Currency.Data.Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Currency.Data.Audit.Updated.By.Id": { "type": "string" }, "Currency.IsDefined": { "type": "boolean" } }, "description": "Json representation of the currency" }, "icon": { "type": "string", "description": "Icon for the new currency", "format": "binary" } } }, "Currency": { "type": "object", "properties": { "audit": { "allOf": [ { "$ref": "#/components/schemas/ExchangeAudit" } ], "description": "Exchange Entity Audit properties bag" }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "icon": { "type": "string", "nullable": true }, "revision": { "type": "integer", "format": "int32" }, "id": { "type": "string", "description": "The unique identifier of the currency." }, "name": { "type": "string", "description": "The name of the currency." }, "code": { "type": "string", "description": "The ISO code of currency" }, "precision": { "type": "integer", "description": "Precision of the currency", "format": "int32" }, "statistics": { "allOf": [ { "$ref": "#/components/schemas/CurrencyStatistics" } ], "description": "Currency statistics" }, "status": { "allOf": [ { "$ref": "#/components/schemas/CurrencyStatus" } ], "description": "The current status of the currency." } }, "additionalProperties": false, "description": "Represents currency in exchange module." }, "CurrencyDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/Currency" } ], "description": "Represents currency in exchange module.", "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "CurrencyListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Currency" } } }, "additionalProperties": false }, "CurrencyStatistics": { "type": "object", "properties": { "sellerCount": { "type": "integer", "description": "Number of sellers using currency", "format": "int32" }, "pairCount": { "type": "integer", "description": "Number of pairs", "format": "int32" } }, "additionalProperties": false, "description": "Currency usage statistics" }, "CurrencyStatus": { "enum": [ "Active", "Deleted" ], "type": "string", "description": "Currency status enumeration" }, "NoteDto": { "type": "object", "properties": { "note": { "type": "string", "description": "", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Entity Note Dto" }, "ExchangeAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "deleted": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Delete event details", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Exchange Entity Audit properties bag" }, "IdentityType": { "enum": [ "User", "ApiToken", "Service", "Extension" ], "type": "string" }, "Pair": { "type": "object", "properties": { "audit": { "allOf": [ { "$ref": "#/components/schemas/ExchangeAudit" } ], "description": "Exchange Entity Audit properties bag", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "id": { "type": "string", "description": "The unique identifier of the pair.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "description": "The name of the pair.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "description": "The external id of the pair", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "notes": { "type": "string", "description": "Notes for the pair", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "primary": { "type": "boolean", "description": "If the pair is primary", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "reverse": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PairRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "sourceCurrency": { "allOf": [ { "$ref": "#/components/schemas/Currency" } ], "description": "Source Currency of the pair", "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "destinationCurrency": { "allOf": [ { "$ref": "#/components/schemas/Currency" } ], "description": "Destination currency of the pair", "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "latestRate": { "allOf": [ { "$ref": "#/components/schemas/Rate" } ], "description": "Latest pair rate", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "agreements": { "type": "integer", "description": "Number of agreements", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "rates": { "type": "integer", "description": "Number of rates", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/PairStatus" } ], "description": "The current status of the pair.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a pair of currencies in exchange module." }, "PairBulkData": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Pair" }, "description": "Array of data models" } }, "additionalProperties": false, "description": "Bulk operation data model" }, "PairBulkDataDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/PairBulkData" } ], "description": "Bulk operation data model", "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PairListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Pair" } } }, "additionalProperties": false }, "PairStatus": { "enum": [ "Active", "Deleted" ], "type": "string", "description": "Rate status enumeration" }, "Rate": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/ExchangeAudit" } ], "description": "Exchange Entity Audit properties bag", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "pair": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PairRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "recordDate": { "type": "string", "description": "Date and time of rate", "format": "date-time", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "value": { "type": "number", "description": "Rate from source to destination currency", "format": "double", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "description": "External id of rate", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/RateStatus" } ], "description": "Record status", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "reverseRate": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RateRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Record of rate for specific day" }, "RateBulkData": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Rate" }, "description": "Array of data models" } }, "additionalProperties": false, "description": "Bulk operation data model" }, "RateBulkDataDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/RateBulkData" } ], "description": "Bulk operation data model", "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "RateListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Rate" } } }, "additionalProperties": false }, "RateStatus": { "enum": [ "Active", "Deleted" ], "type": "string", "description": "Record status enumeration" }, "ErpItemDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/ErpItem" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ErpItemListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ErpItem" } } }, "additionalProperties": false }, "SalesDocumentExternalIds": { "type": "object", "properties": { "operations": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SalesDocumentLinePrice": { "type": "object", "properties": { "currency": { "type": "string", "nullable": true }, "markup": { "type": "number", "format": "double", "nullable": true }, "margin": { "type": "number", "format": "double", "nullable": true }, "PPx1": { "type": "number", "format": "double", "nullable": true }, "SPx1": { "type": "number", "format": "double", "nullable": true }, "unitSP": { "type": "number", "format": "double", "nullable": true }, "unitPP": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "SalesDocumentPrice": { "type": "object", "properties": { "currency": { "type": "string", "nullable": true }, "markup": { "type": "number", "format": "double", "nullable": true }, "margin": { "type": "number", "format": "double", "nullable": true }, "PPx1": { "type": "number", "format": "double", "nullable": true }, "SPx1": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "SalesOrder": { "type": "object", "properties": { "id": { "type": "string" }, "audit": { "allOf": [ { "$ref": "#/components/schemas/ErpAuditBag" } ] }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32" }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/ErpAttributes" } ], "nullable": true }, "source": { "type": "string", "nullable": true }, "price": { "allOf": [ { "$ref": "#/components/schemas/SalesDocumentPrice" } ], "nullable": true }, "error": { "allOf": [ { "$ref": "#/components/schemas/ParametrisedMessage" } ], "nullable": true }, "buyer": { "allOf": [ { "$ref": "#/components/schemas/Buyer" } ], "nullable": true }, "client": { "allOf": [ { "$ref": "#/components/schemas/Account" } ], "nullable": true }, "seller": { "allOf": [ { "$ref": "#/components/schemas/Seller" } ], "nullable": true }, "vendors": { "type": "array", "items": { "$ref": "#/components/schemas/VendorProfile" }, "nullable": true }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/ProductProfile" }, "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/SalesOrderStatus" } ], "nullable": true }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/SalesDocumentExternalIds" } ], "nullable": true }, "salesQuote": { "allOf": [ { "$ref": "#/components/schemas/SalesQuote" } ], "nullable": true }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderLine" }, "nullable": true } }, "additionalProperties": false }, "SalesOrderAttachment": { "type": "object", "properties": { "id": { "type": "string" }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ] }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string" }, "revision": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "status": { "type": "string" }, "contentType": { "type": "string" }, "salesOrder": { "allOf": [ { "$ref": "#/components/schemas/SalesOrder" } ] } }, "additionalProperties": false }, "SalesOrderAttachmentListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderAttachment" } } }, "additionalProperties": false }, "SalesOrderDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/SalesOrder" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "SalesOrderLine": { "type": "object", "properties": { "id": { "type": "string" }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/ErpAttributes" } ], "nullable": true }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/SalesDocumentExternalIds" } ], "nullable": true }, "description": { "type": "string", "nullable": true }, "lineNo": { "type": "integer", "format": "int32", "nullable": true }, "quantity": { "type": "integer", "format": "int32", "nullable": true }, "period": { "allOf": [ { "$ref": "#/components/schemas/DatePeriod" } ], "nullable": true }, "price": { "allOf": [ { "$ref": "#/components/schemas/SalesDocumentLinePrice" } ], "nullable": true }, "erpItem": { "allOf": [ { "$ref": "#/components/schemas/ErpItem" } ], "nullable": true }, "salesOrder": { "allOf": [ { "$ref": "#/components/schemas/SalesOrder" } ], "nullable": true } }, "additionalProperties": false }, "SalesOrderListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrder" } } }, "additionalProperties": false }, "SalesOrderStatus": { "enum": [ "Draft", "Finalizing", "Pending", "Ready", "Completed", "Deleted", "Error" ], "type": "string" }, "SalesQuote": { "type": "object", "properties": { "id": { "type": "string" }, "audit": { "allOf": [ { "$ref": "#/components/schemas/ErpAuditBag" } ] }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32" }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/ErpAttributes" } ], "nullable": true }, "source": { "type": "string", "nullable": true }, "price": { "allOf": [ { "$ref": "#/components/schemas/SalesDocumentPrice" } ], "nullable": true }, "error": { "allOf": [ { "$ref": "#/components/schemas/ParametrisedMessage" } ], "nullable": true }, "buyer": { "allOf": [ { "$ref": "#/components/schemas/Buyer" } ], "nullable": true }, "client": { "allOf": [ { "$ref": "#/components/schemas/Account" } ], "nullable": true }, "seller": { "allOf": [ { "$ref": "#/components/schemas/Seller" } ], "nullable": true }, "vendors": { "type": "array", "items": { "$ref": "#/components/schemas/VendorProfile" }, "nullable": true }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/ProductProfile" }, "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/SalesQuoteStatus" } ], "nullable": true }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/SalesDocumentExternalIds" } ], "nullable": true }, "expiryDate": { "type": "string", "format": "date-time", "nullable": true }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/SalesQuoteLine" }, "nullable": true }, "salesOrders": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrder" }, "nullable": true } }, "additionalProperties": false }, "SalesQuoteAttachment": { "type": "object", "properties": { "id": { "type": "string" }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ] }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string" }, "revision": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "status": { "type": "string" }, "contentType": { "type": "string" }, "salesQuote": { "allOf": [ { "$ref": "#/components/schemas/SalesQuote" } ] } }, "additionalProperties": false }, "SalesQuoteAttachmentListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesQuoteAttachment" } } }, "additionalProperties": false }, "SalesQuoteDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/SalesQuote" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "SalesQuoteLine": { "type": "object", "properties": { "id": { "type": "string" }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/ErpAttributes" } ], "nullable": true }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/SalesDocumentExternalIds" } ], "nullable": true }, "description": { "type": "string", "nullable": true }, "lineNo": { "type": "integer", "format": "int32", "nullable": true }, "quantity": { "type": "integer", "format": "int32", "nullable": true }, "period": { "allOf": [ { "$ref": "#/components/schemas/DatePeriod" } ], "nullable": true }, "price": { "allOf": [ { "$ref": "#/components/schemas/SalesDocumentLinePrice" } ], "nullable": true }, "erpItem": { "allOf": [ { "$ref": "#/components/schemas/ErpItem" } ], "nullable": true }, "salesQuote": { "allOf": [ { "$ref": "#/components/schemas/SalesQuote" } ], "nullable": true } }, "additionalProperties": false }, "SalesQuoteListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesQuote" } } }, "additionalProperties": false }, "SalesQuoteStatus": { "enum": [ "Draft", "Finalizing", "Pending", "Accepting", "Accepted", "Rejected", "Expired", "Deleted", "Error", "AwaitingAcceptance" ], "type": "string" }, "AccountSettings": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "footer": { "type": "string", "description": "Gets or sets the custom footer text to be included in notifications sent on behalf of this account.", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "sender": { "allOf": [ { "$ref": "#/components/schemas/AccountSettingsSender" } ], "description": "Gets or sets the custom sender information to be used for notifications sent on behalf of this account.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents account-specific notification settings." }, "AccountSettingsDto": { "type": "object", "properties": { "footer": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "sender": { "allOf": [ { "$ref": "#/components/schemas/AccountSettingsSenderDto" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AccountSettingsDtoDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/AccountSettingsDto" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "AccountSettingsSender": { "type": "object", "properties": { "name": { "type": "string", "description": "Gets or sets the display name to be used as the sender for notifications.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents the sender information for account-specific notification settings." }, "AccountSettingsSenderDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Attachment": { "type": "object", "properties": { "id": { "type": "string", "description": "Gets or sets the unique identifier for the attachment." }, "href": { "type": "string", "description": "Gets the URL to download the attachment.", "nullable": true, "readOnly": true }, "name": { "type": "string", "description": "Gets or sets the display name for the attachment." }, "fileName": { "type": "string", "description": "Gets or sets the file name of the attachment." }, "fileSize": { "type": "integer", "description": "Gets or sets the size of the attachment in bytes.", "format": "int32" }, "contentType": { "type": "string", "description": "Gets or sets the content type of the attachment." } }, "additionalProperties": false, "description": "Represents a file attachment associated with a notification message or batch." }, "Batch": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/BatchAudit" } ], "description": "Represents audit information for a Mpt.Notifications.Models.Messages.Batch.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "allOf": [ { "$ref": "#/components/schemas/Account" } ], "description": "Gets or sets the account associated with this batch, if applicable.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" }, "description": "Gets or sets the list of file attachments included with messages in this batch.", "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "body": { "type": "string", "description": "Gets or sets the body content for messages in this batch.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "category": { "allOf": [ { "$ref": "#/components/schemas/Category" } ], "description": "Gets or sets the category to which this batch belongs.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "template": { "allOf": [ { "$ref": "#/components/schemas/NotificationTemplate" } ], "description": "Gets or sets the template used to create this batch, if applicable.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "statistics": { "allOf": [ { "$ref": "#/components/schemas/BatchStatistics" } ], "description": "Gets or sets the statistics for messages in this batch.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "subject": { "type": "string", "description": "Gets or sets the subject for messages in this batch.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "description": "Gets or sets the current status of the batch.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "type": "string", "description": "Gets or sets the type of batch.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "payload": { "type": "string", "description": "Gets or sets the payload data used for template-based batches.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "sendContext": { "type": "string", "description": "Gets or sets the send context of the batch.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "sourceAccount": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a batch of notification messages that share common properties." }, "BatchAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "completed": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Gets or sets the event information for when the batch was completed.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "processed": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Gets or sets the event information for when the batch was processed.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents audit information for a Mpt.Notifications.Models.Messages.Batch." }, "BatchListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Batch" } } }, "additionalProperties": false }, "BatchRequest": { "type": "object", "properties": { "category": { "allOf": [ { "$ref": "#/components/schemas/ReferenceDto" } ], "nullable": true, "deprecated": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "subject": { "type": "string", "nullable": true, "deprecated": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "body": { "type": "string", "nullable": true, "deprecated": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/ContactReferenceDto" }, "nullable": true, "deprecated": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "allOf": [ { "$ref": "#/components/schemas/ReferenceDto" } ], "nullable": true, "deprecated": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "buyer": { "allOf": [ { "$ref": "#/components/schemas/BuyerReferenceDto" } ], "nullable": true, "deprecated": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "content": { "allOf": [ { "$ref": "#/components/schemas/ContentDto" } ], "description": "Represents the content of a notification batch request, which can include either templated or raw content.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "recipients": { "allOf": [ { "$ref": "#/components/schemas/RecipientsDto" } ], "description": "Represents the recipients of a notification message, including account, buyer, user, and contact details.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a batch request for sending notifications, supporting both raw and templated content." }, "BatchStatistics": { "type": "object", "properties": { "bounced": { "type": "integer", "description": "Gets or sets the number of messages that bounced.", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "complained": { "type": "integer", "description": "Gets or sets the number of messages that received complaints.", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "discarded": { "type": "integer", "description": "Gets or sets the number of messages that were discarded before sending.", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "failed": { "type": "integer", "description": "Gets or sets the number of messages that failed to send.", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "queued": { "type": "integer", "description": "Gets or sets the number of messages currently queued for sending.", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "sent": { "type": "integer", "description": "Gets or sets the number of messages that were successfully sent.", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "total": { "type": "integer", "description": "Gets or sets the total number of messages in the batch.", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents statistics for a notification batch, tracking the count of messages in various states." }, "BuyerExternalIdsDto": { "type": "object", "properties": { "erpCustomerId": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "BuyerReferenceDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/BuyerExternalIdsDto" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Category": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/NotificationCategoryAudit" } ], "description": "Represents audit information for a Mpt.Notifications.Models.Categories.Category.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "description": "Gets or sets the description of the category.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "optOutAllowed": { "type": "boolean", "description": "Gets or sets a value indicating whether recipients can opt out of notifications in this category.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "description": "Gets or sets the current status of the category.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "note": { "type": "string", "description": "Gets or sets an optional note about the category.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Operations" ] } }, "deleteAllowed": { "type": "boolean", "description": "Gets or sets a value indicating whether this category can be deleted.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Operations" ] } }, "statistics": { "allOf": [ { "$ref": "#/components/schemas/MessageStatistics" } ], "description": "Gets or sets the message statistics for this category.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "lastUsed": { "type": "string", "description": "Gets or sets the timestamp of when this category was last used to send a notification.", "format": "date-time", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "enabledByDefault": { "type": "boolean", "description": "Gets or sets a value indicating whether this category is enabled by default for new recipients.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Operations" ] } } }, "additionalProperties": false, "description": "Represents a notification category that can be used to organize and filter notifications." }, "CategoryListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } } }, "additionalProperties": false }, "Contact": { "type": "object", "properties": { "id": { "type": "string" }, "audit": { "allOf": [ { "$ref": "#/components/schemas/ContactAudit" } ], "description": "Represents audit information for a Mpt.Notifications.Models.Contacts.Contact." }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "blockedReason": { "type": "string", "nullable": true }, "email": { "type": "string" }, "status": { "type": "string" }, "identity": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ], "nullable": true }, "directories": { "type": "array", "items": { "$ref": "#/components/schemas/Directory" }, "nullable": true }, "chat": { "type": "boolean" }, "optOuts": { "type": "array", "items": { "$ref": "#/components/schemas/Category" }, "description": "Gets or sets the list of categories for which this contact has opted out of receiving notifications.", "nullable": true }, "user": { "allOf": [ { "$ref": "#/components/schemas/User" } ], "description": "Gets or sets the associated user information, if this contact is linked to a platform user.", "nullable": true } }, "additionalProperties": false, "description": "Represents a notification contact who can receive email notifications." }, "ContactAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "activated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Gets or sets the event information for when the contact was activated.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "blocked": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Gets or sets the event information for when the contact was blocked.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "deleted": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Gets or sets the event information for when the contact was deleted.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents audit information for a Mpt.Notifications.Models.Contacts.Contact." }, "ContactDto": { "type": "object", "properties": { "email": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "optOuts": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceDto" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "directories": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceDto" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "chat": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ContactDtoDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/ContactDto" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ContactListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } } }, "additionalProperties": false }, "ContactReferenceDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "email": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ContentDto": { "type": "object", "properties": { "templated": { "allOf": [ { "$ref": "#/components/schemas/TemplatedContentDto" } ], "description": "Represents the content of a templated message, including the template reference, associated data and test flag.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "raw": { "allOf": [ { "$ref": "#/components/schemas/RawContentDto" } ], "description": "Represents the raw content of a message, including its category, subject, and body.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents the content of a notification batch request, which can include either templated or raw content." }, "CreateCategoryDto": { "type": "object", "properties": { "name": { "type": "string", "description": "", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "description": "", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "optOutAllowed": { "type": "boolean", "description": "", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "note": { "type": "string", "description": "", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "deleteAllowed": { "type": "boolean", "description": "", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "enabledByDefault": { "type": "boolean", "description": "", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "CreateCategoryDto" }, "Directory": { "type": "object", "properties": { "id": { "type": "string" }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ] }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32" }, "account": { "allOf": [ { "$ref": "#/components/schemas/Account" } ] }, "origin": { "allOf": [ { "$ref": "#/components/schemas/Account" } ], "nullable": true }, "type": { "type": "string" }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } } }, "additionalProperties": false, "description": "Represents a contact directory associated with an account." }, "DirectoryListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Directory" } } }, "additionalProperties": false }, "UpdateNoteSubscriber": { "type": "object", "properties": { "note": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Footer": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/FooterAudit" } ], "description": "Represents audit information for a Mpt.Notifications.Models.Footers.Footer.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "languageCode": { "type": "string", "description": "Gets or sets the language code for this footer.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "content": { "type": "string", "description": "Gets or sets the content of the footer.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "isDefault": { "type": "boolean", "description": "Gets or sets a value indicating whether this is the default footer.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "description": "Gets or sets the current status of the footer.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a localized footer template that can be appended to notification messages." }, "FooterAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "activated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Gets or sets the event information for when the footer was activated.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "deleted": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Gets or sets the event information for when the footer was deleted.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents audit information for a Mpt.Notifications.Models.Footers.Footer." }, "FooterDto": { "type": "object", "properties": { "languageCode": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "content": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "FooterListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Footer" } } }, "additionalProperties": false }, "Message": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/MessageAudit" } ], "description": "Represents audit information for a Mpt.Notifications.Models.Messages.Message.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "allOf": [ { "$ref": "#/components/schemas/Account" } ], "description": "Gets or sets the account associated with this message, if applicable.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" }, "description": "Gets or sets the list of file attachments included with this message.", "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "batch": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BatchRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "body": { "type": "string", "description": "Gets or sets the body content of the message.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "category": { "allOf": [ { "$ref": "#/components/schemas/Category" } ], "description": "Gets or sets the category to which this message belongs.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contact": { "allOf": [ { "$ref": "#/components/schemas/Contact" } ], "description": "Gets or sets the recipient contact for this message.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "discardReason": { "type": "string", "description": "Gets or sets the reason the message was discarded, if applicable.", "nullable": true, "deprecated": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "template": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/NotificationTemplateRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "description": "Gets or sets the current status of the message.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "statusReason": { "type": "string", "description": "Gets or sets the reason for the current status.", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "subject": { "type": "string", "description": "Gets or sets the subject of the message.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an individual notification message sent to a specific contact." }, "MessageAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "queued": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Gets or sets the event information for when the message was queued for sending.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "discarded": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Gets or sets the event information for when the message was discarded.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "sent": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Gets or sets the event information for when the message was successfully sent.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "bounced": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Gets or sets the event information for when the message bounced.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "complained": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Gets or sets the event information for when a complaint was received about the message.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "failed": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Gets or sets the event information for when the message failed to send.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents audit information for a Mpt.Notifications.Models.Messages.Message." }, "MessageListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Message" } } }, "additionalProperties": false }, "MessageStatistics": { "type": "object", "properties": { "month": { "type": "integer", "description": "Gets or sets the number of messages sent in the current month.", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "today": { "type": "integer", "description": "Gets or sets the number of messages sent today.", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "week": { "type": "integer", "description": "Gets or sets the number of messages sent in the current week.", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } } }, "additionalProperties": false, "description": "Represents message statistics aggregated over different time periods." }, "NotificationCategoryAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "published": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Gets or sets the event information for when the category was published.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unpublished": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Gets or sets the event information for when the category was unpublished.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "deleted": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Gets or sets the event information for when the category was deleted.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents audit information for a Mpt.Notifications.Models.Categories.Category." }, "NotificationEventObjectType": { "enum": [ "Account", "AccountUser", "AccountUserBuyerVisibility", "Agreement", "AgreementAttachment", "AgreementLine", "ApiToken", "Asset", "Authorization", "Buyer", "BuyerSeller", "Category", "Certificate", "Chat", "ChatMessage", "ChatParticipant", "ChatAttachment", "CloudTenant", "Contact", "CreditMemo", "CreditMemoAttachment", "Currency", "CustomLedger", "CustomLedgerAttachment", "Document", "Enrollment", "ErpItem", "ErpLink", "ErpLinkTest", "Extension", "ExtensionCategory", "ExtensionDocument", "ExtensionInstallation", "ExtensionInstance", "ExtensionMedia", "ExtensionMeta", "ExtensionTerm", "ExtensionTermVariant", "Feedback", "File", "Footer", "Form", "Installation", "Invoice", "InvoiceAttachment", "ItemGroup", "Journal", "JournalAttachment", "Ledger", "LedgerAttachment", "Licensee", "Listing", "Media", "MessageTemplate", "Module", "NotificationTemplate", "Order", "OrderLine", "Override", "Pair", "Parameter", "ParameterDefinition", "ParameterGroup", "PriceList", "PriceListItem", "PricingPolicy", "PricingPolicyAttachment", "Product", "ProductDocument", "ProductItem", "ProductMedia", "Program", "ProgramDocument", "ProgramMedia", "ProgramParameterDefinition", "ProgramParameterGroup", "ProgramTemplate", "ProgramTerms", "ProgramTermsVariant", "PublicCatalogCategory", "PublicCatalogIndustry", "PublicCatalogProductProfile", "PublicCatalogSegment", "PublicCatalogVendorProfile", "Queue", "Quote", "Rate", "Request", "RequestAttachment", "RequestMessage", "SalesOrder", "SalesQuote", "Seller", "Service", "SplitBillingAgreement", "SplitBillingSubscription", "Statement", "StatementAttachment", "Subscriber", "Subscription", "SupportCase", "Task", "TaskLog", "TaskResult", "Template", "TemplateVariant", "Term", "Terms", "TermsVariant", "TermVariant", "UnitOfMeasure", "User", "UserGroup", "Webhook" ], "type": "string" }, "NotificationTemplate": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/NotificationTemplateAudit" } ], "description": "Represents audit information for a Mpt.Notifications.Models.NotificationTemplates.NotificationTemplate.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "category": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/CategoryRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "criteria": { "allOf": [ { "$ref": "#/components/schemas/NotificationTemplateCriteria" } ], "description": "Gets or sets the criteria for automatic triggering of this template based on events.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "defaultVariant": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/TemplateVariantRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "description": "Gets or sets the description of this template.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "lastUsed": { "type": "string", "description": "Gets or sets the timestamp of when this template was last used to send a notification.", "format": "date-time", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "owner": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "statistics": { "allOf": [ { "$ref": "#/components/schemas/MessageStatistics" } ], "description": "Gets or sets the usage statistics for this template.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "status": { "type": "string", "description": "Gets or sets the current status of the template.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "variants": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateVariantRef" }, "description": "Gets or sets the list of language-specific variants for this template.", "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "description": "Gets or sets an external identifier for integration with external systems.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a reusable template that can be used to generate messages." }, "NotificationTemplateAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "activated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Gets or sets the event information for when the template was activated.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "deleted": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Gets or sets the event information for when the template was deleted.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "disabled": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Gets or sets the event information for when the template was disabled.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents audit information for a Mpt.Notifications.Models.NotificationTemplates.NotificationTemplate." }, "NotificationTemplateCriteria": { "type": "object", "properties": { "accountTypes": { "type": "array", "items": { "type": "string" }, "description": "Gets or sets the list of account types for which this template should trigger.", "x-rql": { "core": true, "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "filterCondition": { "type": "string", "description": "Gets or sets the RQL filter condition that must be satisfied for the template to trigger.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "objectType": { "type": "string", "description": "Gets or sets the platform object type this template monitors.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "recipients": { "allOf": [ { "$ref": "#/components/schemas/NotificationTemplateCriteriaRecipients" } ], "description": "Gets or sets the custom Recipients condition. If specified, this RQL condition determines the recipients of the notification.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents the criteria for automatically triggering a template based on platform events." }, "NotificationTemplateCriteriaDto": { "type": "object", "properties": { "accountTypes": { "type": "array", "items": { "$ref": "#/components/schemas/AccountType" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "objectType": { "allOf": [ { "$ref": "#/components/schemas/NotificationEventObjectType" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "filterCondition": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "recipients": { "allOf": [ { "$ref": "#/components/schemas/NotificationTemplateCriteriaRecipientDto" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "NotificationTemplateCriteriaRecipientDto": { "type": "object", "properties": { "selector": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "NotificationTemplateCriteriaRecipients": { "type": "object", "properties": { "selector": { "type": "string", "description": "Gets or sets the RQL filter condition that must be satisfied for the template to trigger.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents the recipients criteria for automatically triggering a template based on platform events." }, "NotificationTemplateDto": { "type": "object", "properties": { "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "category": { "allOf": [ { "$ref": "#/components/schemas/ReferenceDto" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "criteria": { "allOf": [ { "$ref": "#/components/schemas/NotificationTemplateCriteriaDto" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "defaultVariant": { "allOf": [ { "$ref": "#/components/schemas/ReferenceDto" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "NotificationTemplateDtoDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/NotificationTemplateDto" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "NotificationTemplateListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationTemplate" } } }, "additionalProperties": false }, "NotificationTemplateReferenceDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "languageCode": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "RawContentDto": { "type": "object", "properties": { "category": { "allOf": [ { "$ref": "#/components/schemas/ReferenceDto" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "subject": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "body": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents the raw content of a message, including its category, subject, and body." }, "Recipients": { "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/User" }, "description": "Gets or initializes the list of individual users who will receive notifications.", "nullable": true, "x-rql": { "core": true, "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "userGroups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" }, "description": "Gets or initializes the list of user groups whose members will receive notifications.", "nullable": true, "x-rql": { "core": true, "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents the recipients of a subscriber." }, "RecipientsDto": { "type": "object", "properties": { "account": { "allOf": [ { "$ref": "#/components/schemas/ReferenceDto" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "buyer": { "allOf": [ { "$ref": "#/components/schemas/BuyerReferenceDto" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "user": { "allOf": [ { "$ref": "#/components/schemas/ReferenceDto" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/ContactReferenceDto" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents the recipients of a notification message, including account, buyer, user, and contact details." }, "ReferenceDto": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "StringStringValuesKeyValuePair": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "value": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "Subscriber": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/SubscriberAudit" } ], "description": "Represents audit information for a Mpt.Notifications.Models.Subscribers.Subscriber.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "description": "Gets or initializes the current status of the subscriber.", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "note": { "type": "string", "description": "Gets or initializes an optional note about this subscriber.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "recipients": { "allOf": [ { "$ref": "#/components/schemas/Recipients" } ], "description": "Gets or initializes the list of recipients who will receive notifications.", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "allOf": [ { "$ref": "#/components/schemas/Account" } ], "description": "Gets or initializes the account to which this subscriber is associated.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "category": { "allOf": [ { "$ref": "#/components/schemas/Category" } ], "description": "Gets or initializes the category this subscriber monitors for automatic notifications.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a subscription that defines which users or user groups should automatically receive notifications for a specific category." }, "SubscriberAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "activated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Gets or sets the event information for when the subscriber was activated.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "disabled": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Gets or sets the event information for when the subscriber was disabled.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "deleted": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Gets or sets the event information for when the subscriber was deleted.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents audit information for a Mpt.Notifications.Models.Subscribers.Subscriber." }, "SubscriberListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Subscriber" } } }, "additionalProperties": false }, "TemplateVariant": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/TemplateVariantAudit" } ], "description": "Represents audit information for a Mpt.Notifications.Models.NotificationTemplates.TemplateVariant.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "body": { "type": "string", "description": "Gets or sets the body content for this variant.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "default": { "type": "boolean", "description": "Gets or sets a value indicating whether this is the default variant for the parent template.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "languageCode": { "type": "string", "description": "Gets or sets the language code for this variant.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "template": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/NotificationTemplateRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "description": "Gets or sets the current status of the variant.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "subject": { "type": "string", "description": "Gets or sets the subject for messages created from this variant.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a language-specific variant of a template." }, "TemplateVariantAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "deleted": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "Gets or sets the event information for when the variant was deleted.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents audit information for a Mpt.Notifications.Models.NotificationTemplates.TemplateVariant." }, "TemplateVariantDto": { "type": "object", "properties": { "languageCode": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "subject": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "body": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "TemplateVariantDtoDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/TemplateVariantDto" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "TemplateVariantListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateVariant" } } }, "additionalProperties": false }, "TemplatedContentDto": { "type": "object", "properties": { "template": { "allOf": [ { "$ref": "#/components/schemas/NotificationTemplateReferenceDto" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "data": { "type": "object", "additionalProperties": {}, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "test": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents the content of a templated message, including the template reference, associated data and test flag." }, "UpdateFooterDto": { "type": "object", "properties": { "content": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "isDefault": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UpdateFooterDtoDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/UpdateFooterDto" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "UpdateNoteSubscriberDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/UpdateNoteSubscriber" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "UpdateRecipients": { "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserRef" }, "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "userGroups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupRef" }, "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UpdateSubscriber": { "type": "object", "properties": { "recipients": { "allOf": [ { "$ref": "#/components/schemas/UpdateRecipients" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "note": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UpdateSubscriberDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/UpdateSubscriber" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "UpdateSpotlight": { "type": "object", "properties": { "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "template": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "rqlFilter": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "scope": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "moduleId": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "moduleCode": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Invalidation": { "type": "object", "properties": { "interval": { "type": "string", "format": "date-span", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Scope": { "enum": [ "None", "Client", "Vendor", "Operations", "All" ], "type": "string" }, "SpotlightObject": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "total": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "top": { "type": "array", "items": {}, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "query": { "allOf": [ { "$ref": "#/components/schemas/SpotlightQueryDto" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "SpotlightObjectListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpotlightObject" } } }, "additionalProperties": false }, "SpotlightQuery": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "template": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "invalidationInterval": { "type": "string", "format": "date-span", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "invalidateOnDateChange": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "filter": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "scope": { "allOf": [ { "$ref": "#/components/schemas/Scope" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "SpotlightQueryDto": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "template": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "invalidation": { "allOf": [ { "$ref": "#/components/schemas/Invalidation" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "filter": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "scope": { "allOf": [ { "$ref": "#/components/schemas/Scope" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "SpotlightQueryListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpotlightQuery" } } }, "additionalProperties": false }, "UpdateSpotlightDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/UpdateSpotlight" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "AccountActivate": { "required": [ "externalId", "name" ], "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "maxLength": 500, "minLength": 1, "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/AccountExternalIds" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "maxLength": 250, "minLength": 1, "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalName": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "technicalSupportEmail": { "maxLength": 320, "type": "string", "format": "email", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "website": { "maxLength": 2000, "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "maxLength": 2000, "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupRef" }, "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "eligibility": { "allOf": [ { "$ref": "#/components/schemas/Eligibility" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "defaultLanguageCode": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AccountCreateFromForm": { "type": "object", "properties": { "account": { "type": "object", "properties": { "ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "ExternalId": { "type": "string" }, "ExternalName": { "type": "string" }, "Address.AddressLine1": { "type": "string" }, "Address.AddressLine2": { "type": "string" }, "Address.PostCode": { "type": "string" }, "Address.City": { "type": "string" }, "Address.State": { "type": "string" }, "Address.Country": { "type": "string" }, "TechnicalSupportEmail": { "type": "string" }, "Website": { "type": "string" }, "Description": { "type": "string" }, "Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Eligibility.Client": { "type": "boolean" }, "Eligibility.Partner": { "type": "boolean" }, "DefaultLanguageCode": { "type": "string" }, "Type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ] }, "Status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ] }, "Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Name": { "type": "string" }, "Icon": { "type": "string" }, "Revision": { "type": "integer", "format": "int32" }, "Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Created.ById": { "type": "string" }, "Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Created.By.Name": { "type": "string" }, "Audit.Created.By.Icon": { "type": "string" }, "Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Created.By.Id": { "type": "string" }, "Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Updated.ById": { "type": "string" }, "Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Updated.By.Name": { "type": "string" }, "Audit.Updated.By.Icon": { "type": "string" }, "Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Audit.Updated.By.Id": { "type": "string" }, "Id": { "type": "string" } }, "description": "Json representation of the account" }, "logo": { "type": "string", "format": "binary", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } } }, "AccountCreate": { "required": [ "name", "type" ], "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "maxLength": 500, "minLength": 1, "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/AccountExternalIds" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "maxLength": 250, "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalName": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "technicalSupportEmail": { "maxLength": 320, "type": "string", "format": "email", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "website": { "maxLength": 2000, "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "maxLength": 2000, "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupRef" }, "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "eligibility": { "allOf": [ { "$ref": "#/components/schemas/Eligibility" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "defaultLanguageCode": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AccountListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } } }, "additionalProperties": false }, "AccountDto": { "type": "object", "properties": { "id": { "type": "string", "allOf": [ { "pattern": "^ACC-\\d\\d\\d\\d-\\d\\d\\d\\d$" }, { "pattern": "^ACC-\\d\\d\\d\\d-\\d\\d\\d\\d$" }, { "pattern": "^ACC-\\d\\d\\d\\d-\\d\\d\\d\\d$" }, { "pattern": "^ACC-\\d\\d\\d\\d-\\d\\d\\d\\d$" }, { "pattern": "^ACC-\\d\\d\\d\\d-\\d\\d\\d\\d$" } ], "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AccountUpdateFromForm": { "type": "object", "properties": { "account": { "type": "object", "properties": { "ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "ExternalId": { "type": "string" }, "ExternalName": { "type": "string" }, "Address.AddressLine1": { "type": "string" }, "Address.AddressLine2": { "type": "string" }, "Address.PostCode": { "type": "string" }, "Address.City": { "type": "string" }, "Address.State": { "type": "string" }, "Address.Country": { "type": "string" }, "TechnicalSupportEmail": { "type": "string" }, "Website": { "type": "string" }, "Description": { "type": "string" }, "Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Eligibility.Client": { "type": "boolean" }, "Eligibility.Partner": { "type": "boolean" }, "DefaultLanguageCode": { "type": "string" }, "Type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ] }, "Status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ] }, "Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Name": { "type": "string" }, "Icon": { "type": "string" }, "Revision": { "type": "integer", "format": "int32" }, "Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Created.ById": { "type": "string" }, "Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Created.By.Name": { "type": "string" }, "Audit.Created.By.Icon": { "type": "string" }, "Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Created.By.Id": { "type": "string" }, "Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Updated.ById": { "type": "string" }, "Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Updated.By.Name": { "type": "string" }, "Audit.Updated.By.Icon": { "type": "string" }, "Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Audit.Updated.By.Id": { "type": "string" }, "Id": { "type": "string" } }, "description": "Json representation of the account" }, "logo": { "type": "string", "format": "binary", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } } }, "AccountUpdate": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "maxLength": 500, "minLength": 1, "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/AccountExternalIds" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "maxLength": 250, "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalName": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "technicalSupportEmail": { "maxLength": 320, "type": "string", "format": "email", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "website": { "maxLength": 2000, "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "maxLength": 2000, "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupRef" }, "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "eligibility": { "allOf": [ { "$ref": "#/components/schemas/Eligibility" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "defaultLanguageCode": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AccountUserQueryLegacy": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/AccountUserLegacyAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "user": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/UserRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupRef" }, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "buyers": { "type": "array", "items": { "$ref": "#/components/schemas/BuyerRef" }, "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "modules": { "type": "array", "items": { "$ref": "#/components/schemas/ModuleRef" }, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "invitation": { "allOf": [ { "$ref": "#/components/schemas/InvitationQueryModel" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "lastLoginAt": { "type": "string", "format": "date-time", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AccountUserAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "invited": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "joined": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "access": { "allOf": [ { "$ref": "#/components/schemas/DateEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AccountUserLegacyAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "invitationAcceptedAt": { "type": "string", "format": "date-time", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "access": { "allOf": [ { "$ref": "#/components/schemas/DateEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "joined": { "allOf": [ { "$ref": "#/components/schemas/DateEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AccountUserQueryLegacyListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AccountUserQueryLegacy" } } }, "additionalProperties": false }, "AccountUser": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/AccountUserAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "user": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/UserRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "email": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "phone": { "allOf": [ { "$ref": "#/components/schemas/PhoneNumber" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "firstName": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "lastName": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "settings": { "allOf": [ { "$ref": "#/components/schemas/UserSettings" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupRef" }, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "buyers": { "type": "array", "items": { "$ref": "#/components/schemas/BuyerRef" }, "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "modules": { "type": "array", "items": { "$ref": "#/components/schemas/ModuleRef" }, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "invitation": { "allOf": [ { "$ref": "#/components/schemas/InvitationQueryModel" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AccountUserDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/AccountUser" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "AccountUserListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AccountUser" } } }, "additionalProperties": false }, "AccountValidate": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/AccountExternalIds" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalName": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "technicalSupportEmail": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "website": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupRef" }, "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "eligibility": { "allOf": [ { "$ref": "#/components/schemas/Eligibility" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "defaultLanguageCode": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AgreementAttachmentDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/AgreementAttachmentEntity" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "AddressOptions": { "type": "object", "properties": { "hintText": { "type": "string" }, "defaultValue": { "allOf": [ { "$ref": "#/components/schemas/DefaultParameterAddress" } ] } }, "additionalProperties": false }, "AgreementAttachment": { "type": "object", "properties": { "attachment": { "type": "object", "properties": { "Name": { "type": "string" }, "Description": { "type": "string" }, "OrderId": { "type": "string" }, "Type": { "allOf": [ { "$ref": "#/components/schemas/AttachmentType" } ] }, "LicenseKey": { "type": "string" } }, "description": "Json representation of the attachment" }, "file": { "type": "string", "format": "binary", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } } }, "AgreementAttachmentEntity": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "filename": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "size": { "type": "integer", "format": "int32", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contentType": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "orderId": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "licenseKey": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "agreement": { "allOf": [ { "$ref": "#/components/schemas/Agreement" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AgreementAttachmentListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementAttachmentEntity" } } }, "additionalProperties": false }, "ApiToken": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "lastAccessAt": { "type": "string", "format": "date-time", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "token": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "modules": { "type": "array", "items": { "$ref": "#/components/schemas/ModuleRef" }, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "extensions": { "type": "array", "items": { "$ref": "#/components/schemas/PlatformObjectAuditPlatformExtension" }, "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AgreementDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/Agreement" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "AgreementLineListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementLine" } } }, "additionalProperties": false }, "AgreementListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Agreement" } } }, "additionalProperties": false }, "ApiTokenDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/ApiToken" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ApiTokenListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApiToken" } } }, "additionalProperties": false }, "AuthorizationUpdate": { "type": "object", "properties": { "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/AuthorizationExternalIdBag" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "currency": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "notes": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "journal": { "allOf": [ { "$ref": "#/components/schemas/JournalInput" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "eligibility": { "allOf": [ { "$ref": "#/components/schemas/AuthorizationEligibility" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "settings": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AssetDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/Asset" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "AssetListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Asset" } } }, "additionalProperties": false }, "AttachmentType": { "enum": [ "File", "LicenseKey" ], "type": "string" }, "AuthorizationExternalIdInput": { "type": "object", "properties": { "operations": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AuthorizationListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Authorization" } } }, "additionalProperties": false }, "AuthorizationUpdateDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/AuthorizationUpdate" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BuyerActivate": { "required": [ "account", "externalIds" ], "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/BuyerAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/BuyerExternalIds" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/BuyerStatus" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "taxId": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ParametrisedMessage" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Operations" ] } }, "sellers": { "type": "array", "items": { "$ref": "#/components/schemas/SellerRef" }, "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "BasicSelectionOption": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": false }, "BuyerCreateFromForm": { "type": "object", "properties": { "buyer": { "type": "object", "properties": { "ExternalIds.ErpCompanyContact": { "type": "string" }, "ExternalIds.ErpCustomer": { "type": "string" }, "ExternalIds.AccountExternalId": { "type": "string" }, "Status": { "allOf": [ { "$ref": "#/components/schemas/BuyerStatus" } ] }, "Address.AddressLine1": { "type": "string" }, "Address.AddressLine2": { "type": "string" }, "Address.PostCode": { "type": "string" }, "Address.City": { "type": "string" }, "Address.State": { "type": "string" }, "Address.Country": { "type": "string" }, "TaxId": { "type": "string" }, "Account.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Account.ExternalId": { "type": "string" }, "Account.ExternalName": { "type": "string" }, "Account.Address.AddressLine1": { "type": "string" }, "Account.Address.AddressLine2": { "type": "string" }, "Account.Address.PostCode": { "type": "string" }, "Account.Address.City": { "type": "string" }, "Account.Address.State": { "type": "string" }, "Account.Address.Country": { "type": "string" }, "Account.TechnicalSupportEmail": { "type": "string" }, "Account.Website": { "type": "string" }, "Account.Description": { "type": "string" }, "Account.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Account.Eligibility.Client": { "type": "boolean" }, "Account.Eligibility.Partner": { "type": "boolean" }, "Account.DefaultLanguageCode": { "type": "string" }, "Account.Type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ] }, "Account.Status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ] }, "Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Name": { "type": "string" }, "Account.Icon": { "type": "string" }, "Account.Revision": { "type": "integer", "format": "int32" }, "Account.Audit.Created.At": { "type": "string", "format": "date-time" }, "Account.Audit.Created.ById": { "type": "string" }, "Account.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Account.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Audit.Created.By.Name": { "type": "string" }, "Account.Audit.Created.By.Icon": { "type": "string" }, "Account.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Account.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Account.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Account.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Account.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Account.Audit.Created.By.Id": { "type": "string" }, "Account.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Account.Audit.Updated.ById": { "type": "string" }, "Account.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Account.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Audit.Updated.By.Name": { "type": "string" }, "Account.Audit.Updated.By.Icon": { "type": "string" }, "Account.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Account.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Account.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Account.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Account.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Account.Audit.Updated.By.Id": { "type": "string" }, "Account.Id": { "type": "string" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ParametrisedMessage" } }, "Sellers": { "type": "array", "items": { "$ref": "#/components/schemas/Seller" } }, "ErpLinks": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLink" } }, "Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Name": { "type": "string" }, "Icon": { "type": "string" }, "Revision": { "type": "integer", "format": "int32" }, "Audit.Activated.At": { "type": "string", "format": "date-time" }, "Audit.Activated.ById": { "type": "string" }, "Audit.Activated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Activated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Activated.By.Name": { "type": "string" }, "Audit.Activated.By.Icon": { "type": "string" }, "Audit.Activated.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Activated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Activated.By.Audit.Created.ById": { "type": "string" }, "Audit.Activated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Activated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Activated.By.Audit.Updated.ById": { "type": "string" }, "Audit.Activated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Activated.By.Id": { "type": "string" }, "Audit.Unassigned.At": { "type": "string", "format": "date-time" }, "Audit.Unassigned.ById": { "type": "string" }, "Audit.Unassigned.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Unassigned.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Unassigned.By.Name": { "type": "string" }, "Audit.Unassigned.By.Icon": { "type": "string" }, "Audit.Unassigned.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Unassigned.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Unassigned.By.Audit.Created.ById": { "type": "string" }, "Audit.Unassigned.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Unassigned.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Unassigned.By.Audit.Updated.ById": { "type": "string" }, "Audit.Unassigned.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Unassigned.By.Id": { "type": "string" }, "Audit.Disabled.At": { "type": "string", "format": "date-time" }, "Audit.Disabled.ById": { "type": "string" }, "Audit.Disabled.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Disabled.By.Name": { "type": "string" }, "Audit.Disabled.By.Icon": { "type": "string" }, "Audit.Disabled.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Disabled.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Disabled.By.Audit.Created.ById": { "type": "string" }, "Audit.Disabled.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Disabled.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Disabled.By.Audit.Updated.ById": { "type": "string" }, "Audit.Disabled.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Disabled.By.Id": { "type": "string" }, "Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Created.ById": { "type": "string" }, "Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Created.By.Name": { "type": "string" }, "Audit.Created.By.Icon": { "type": "string" }, "Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Created.By.Id": { "type": "string" }, "Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Updated.ById": { "type": "string" }, "Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Updated.By.Name": { "type": "string" }, "Audit.Updated.By.Icon": { "type": "string" }, "Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Updated.By.Id": { "type": "string" }, "Id": { "type": "string" } }, "description": "Json representation of the buyer" }, "logo": { "type": "string", "format": "binary", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } } }, "BuyerCreate": { "required": [ "address", "name" ], "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/BuyerAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "maxLength": 500, "minLength": 1, "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/BuyerExternalIds" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/BuyerStatus" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "taxId": { "maxLength": 18, "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ParametrisedMessage" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Operations" ] } }, "sellers": { "type": "array", "items": { "$ref": "#/components/schemas/SellerRef" }, "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "BuyerListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Buyer" } } }, "additionalProperties": false }, "BuyerDto": { "type": "object", "properties": { "id": { "pattern": "^BUY-\\d\\d\\d\\d-\\d\\d\\d\\d$", "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "BuyerTransferDetails": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/BuyerAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/BuyerExternalIds" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/BuyerStatus" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "taxId": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ParametrisedMessage" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Operations" ] } }, "sellers": { "type": "array", "items": { "$ref": "#/components/schemas/SellerRef" }, "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "stats": { "allOf": [ { "$ref": "#/components/schemas/BuyerTransferStats" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/AccountUserQueryLegacy" }, "x-rql": { "core": true, "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "BuyerTransfer": { "required": [ "account" ], "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/BuyerAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/BuyerExternalIds" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/BuyerStatus" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "taxId": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ParametrisedMessage" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Operations" ] } }, "sellers": { "type": "array", "items": { "$ref": "#/components/schemas/SellerRef" }, "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "BuyerTransferStats": { "type": "object", "properties": { "licenseeCount": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "orderCount": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "subscriptionCount": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "userCount": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "userGroupCount": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "agreementCount": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "BuyerUpdateFromForm": { "type": "object", "properties": { "buyer": { "type": "object", "properties": { "ExternalIds.ErpCompanyContact": { "type": "string" }, "ExternalIds.ErpCustomer": { "type": "string" }, "ExternalIds.AccountExternalId": { "type": "string" }, "Status": { "allOf": [ { "$ref": "#/components/schemas/BuyerStatus" } ] }, "Address.AddressLine1": { "type": "string" }, "Address.AddressLine2": { "type": "string" }, "Address.PostCode": { "type": "string" }, "Address.City": { "type": "string" }, "Address.State": { "type": "string" }, "Address.Country": { "type": "string" }, "TaxId": { "type": "string" }, "Account.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Account.ExternalId": { "type": "string" }, "Account.ExternalName": { "type": "string" }, "Account.Address.AddressLine1": { "type": "string" }, "Account.Address.AddressLine2": { "type": "string" }, "Account.Address.PostCode": { "type": "string" }, "Account.Address.City": { "type": "string" }, "Account.Address.State": { "type": "string" }, "Account.Address.Country": { "type": "string" }, "Account.TechnicalSupportEmail": { "type": "string" }, "Account.Website": { "type": "string" }, "Account.Description": { "type": "string" }, "Account.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Account.Eligibility.Client": { "type": "boolean" }, "Account.Eligibility.Partner": { "type": "boolean" }, "Account.DefaultLanguageCode": { "type": "string" }, "Account.Type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ] }, "Account.Status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ] }, "Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Name": { "type": "string" }, "Account.Icon": { "type": "string" }, "Account.Revision": { "type": "integer", "format": "int32" }, "Account.Audit.Created.At": { "type": "string", "format": "date-time" }, "Account.Audit.Created.ById": { "type": "string" }, "Account.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Account.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Audit.Created.By.Name": { "type": "string" }, "Account.Audit.Created.By.Icon": { "type": "string" }, "Account.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Account.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Account.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Account.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Account.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Account.Audit.Created.By.Id": { "type": "string" }, "Account.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Account.Audit.Updated.ById": { "type": "string" }, "Account.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Account.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Audit.Updated.By.Name": { "type": "string" }, "Account.Audit.Updated.By.Icon": { "type": "string" }, "Account.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Account.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Account.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Account.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Account.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Account.Audit.Updated.By.Id": { "type": "string" }, "Account.Id": { "type": "string" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ParametrisedMessage" } }, "Sellers": { "type": "array", "items": { "$ref": "#/components/schemas/Seller" } }, "ErpLinks": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLink" } }, "Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Name": { "type": "string" }, "Icon": { "type": "string" }, "Revision": { "type": "integer", "format": "int32" }, "Audit.Activated.At": { "type": "string", "format": "date-time" }, "Audit.Activated.ById": { "type": "string" }, "Audit.Activated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Activated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Activated.By.Name": { "type": "string" }, "Audit.Activated.By.Icon": { "type": "string" }, "Audit.Activated.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Activated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Activated.By.Audit.Created.ById": { "type": "string" }, "Audit.Activated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Activated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Activated.By.Audit.Updated.ById": { "type": "string" }, "Audit.Activated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Activated.By.Id": { "type": "string" }, "Audit.Unassigned.At": { "type": "string", "format": "date-time" }, "Audit.Unassigned.ById": { "type": "string" }, "Audit.Unassigned.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Unassigned.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Unassigned.By.Name": { "type": "string" }, "Audit.Unassigned.By.Icon": { "type": "string" }, "Audit.Unassigned.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Unassigned.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Unassigned.By.Audit.Created.ById": { "type": "string" }, "Audit.Unassigned.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Unassigned.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Unassigned.By.Audit.Updated.ById": { "type": "string" }, "Audit.Unassigned.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Unassigned.By.Id": { "type": "string" }, "Audit.Disabled.At": { "type": "string", "format": "date-time" }, "Audit.Disabled.ById": { "type": "string" }, "Audit.Disabled.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Disabled.By.Name": { "type": "string" }, "Audit.Disabled.By.Icon": { "type": "string" }, "Audit.Disabled.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Disabled.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Disabled.By.Audit.Created.ById": { "type": "string" }, "Audit.Disabled.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Disabled.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Disabled.By.Audit.Updated.ById": { "type": "string" }, "Audit.Disabled.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Disabled.By.Id": { "type": "string" }, "Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Created.ById": { "type": "string" }, "Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Created.By.Name": { "type": "string" }, "Audit.Created.By.Icon": { "type": "string" }, "Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Created.By.Id": { "type": "string" }, "Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Updated.ById": { "type": "string" }, "Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Updated.By.Name": { "type": "string" }, "Audit.Updated.By.Icon": { "type": "string" }, "Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Updated.By.Id": { "type": "string" }, "Id": { "type": "string" } }, "description": "Json representation of the buyer" }, "logo": { "type": "string", "format": "binary", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } } }, "BuyerUpdate": { "required": [ "address", "name" ], "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/BuyerAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "maxLength": 500, "minLength": 1, "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/BuyerExternalIds" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/BuyerStatus" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "taxId": { "maxLength": 18, "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ParametrisedMessage" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Operations" ] } }, "sellers": { "type": "array", "items": { "$ref": "#/components/schemas/SellerRef" }, "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "BuyerValidate": { "required": [ "account" ], "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/BuyerAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/BuyerExternalIds" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/BuyerStatus" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "taxId": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ParametrisedMessage" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Operations" ] } }, "sellers": { "type": "array", "items": { "$ref": "#/components/schemas/SellerRef" }, "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CertificateListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Certificate" } } }, "additionalProperties": false }, "CertificateUpdate": { "type": "object", "properties": { "parameters": { "allOf": [ { "$ref": "#/components/schemas/UpdateCertificateParameterBag" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "template": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "expirationDate": { "type": "string", "format": "date", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/CertificateExternalIds" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CertificateUpdateDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/CertificateUpdate" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "CloudTenantExternalIds": { "type": "object", "properties": { "cloudConsumptionId": { "type": "string", "format": "uuid", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "providerId": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "pyraTenantId": { "type": "string", "format": "uuid", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CheckboxOptions": { "type": "object", "properties": { "hintText": { "type": "string" }, "optionsList": { "type": "array", "items": { "$ref": "#/components/schemas/SelectionOption" } }, "defaultValue": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ChoiceOptions": { "type": "object", "properties": { "hintText": { "type": "string" }, "optionsList": { "type": "array", "items": { "$ref": "#/components/schemas/SelectionOption" } }, "defaultValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CloudTenantExternalIdsDto": { "required": [ "cloudConsumptionId", "pyraTenantId" ], "type": "object", "properties": { "pyraTenantId": { "minLength": 1, "type": "string", "format": "uuid", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "cloudConsumptionId": { "minLength": 1, "type": "string", "format": "uuid", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "providerId": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CloudTenant": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/CloudTenantExternalIds" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CloudTenantDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/CloudTenant" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "CloudTenantListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CloudTenant" } } }, "additionalProperties": false }, "CompleteEnrollment": { "type": "object", "properties": { "template": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/CertificateExternalIds" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CloudTenantStatus": { "enum": [ "Active", "Disabled", "Deleted" ], "type": "string" }, "CloudTenantType": { "enum": [ "AwsDirect", "AwsService", "Csp365", "CspAzure", "Ea365", "EaAzure", "Slm", "Virtual" ], "type": "string" }, "CompleteEnrollmentDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/CompleteEnrollment" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "DateParameter": { "type": "object", "additionalProperties": false }, "ConfigureProgramSettingsRequest": { "type": "object", "properties": { "newCertificateAutoapprove": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "programEnrollment": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "programLink": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "terminateOnExpiration": { "allOf": [ { "$ref": "#/components/schemas/TerminateOnExpiration" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "preValidation": { "allOf": [ { "$ref": "#/components/schemas/ProgramPreValidationInput" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ConfigureSettingsRequest": { "type": "object", "properties": { "productOrdering": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "productRequests": { "allOf": [ { "$ref": "#/components/schemas/ProductRequestsInput" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "itemSelection": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "orderQueueChanges": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "preValidation": { "allOf": [ { "$ref": "#/components/schemas/PreValidationInput" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "splitBilling": { "allOf": [ { "$ref": "#/components/schemas/ProductSplitBillingRequestsInput" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "sendCostToErp": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "subscriptionCessation": { "allOf": [ { "$ref": "#/components/schemas/SubscriptionCessationInput" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ConstraintsDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/Constraints" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ContactOptions": { "type": "object", "properties": { "hintText": { "type": "string" }, "defaultValue": { "allOf": [ { "$ref": "#/components/schemas/DefaultParameterContact" } ] }, "phoneMandatory": { "type": "boolean" } }, "additionalProperties": false }, "CreateAccountUserDto": { "required": [ "groups" ], "type": "object", "properties": { "id": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "email": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/EmailDto" } ], "format": "email", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "firstName": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "lastName": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "phone": { "allOf": [ { "$ref": "#/components/schemas/SetPhoneNumberDto" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "settings": { "allOf": [ { "$ref": "#/components/schemas/SetUserSettingsDto" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "notes": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "user": { "allOf": [ { "$ref": "#/components/schemas/UserProfileDto" } ], "nullable": true, "deprecated": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "allOf": [ { "$ref": "#/components/schemas/AccountDto" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "groups": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/UserGroupDto" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "invitation": { "allOf": [ { "$ref": "#/components/schemas/InvitationDto" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CreateApiTokenDto": { "type": "object", "properties": { "account": { "allOf": [ { "$ref": "#/components/schemas/AccountDto" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "modules": { "type": "array", "items": { "$ref": "#/components/schemas/ModuleDto" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "extensions": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionDto" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CreateAuthorizationRequest": { "required": [ "eligibility", "journal", "owner", "product" ], "type": "object", "properties": { "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/AuthorizationExternalIdInput" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "currency": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "notes": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "product": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "owner": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "journal": { "allOf": [ { "$ref": "#/components/schemas/JournalInput" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "eligibility": { "allOf": [ { "$ref": "#/components/schemas/AuthorizationEligibility" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "settings": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CreateCertificateRequest": { "required": [ "client", "program" ], "type": "object", "properties": { "program": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "buyer": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "licensee": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "client": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "parameters": { "allOf": [ { "$ref": "#/components/schemas/ProgramParameterValueBagInput" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CreateCloudTenantDto": { "required": [ "externalIds", "name" ], "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/CloudTenantType" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "maxLength": 100, "minLength": 1, "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/CloudTenantStatus" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/CloudTenantExternalIdsDto" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "allOf": [ { "$ref": "#/components/schemas/AccountDto" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CreateEnrollmentAttachmentRequest": { "type": "object", "properties": { "attachment": { "type": "object", "properties": { "Name": { "type": "string" }, "Description": { "type": "string" } }, "description": "Json representation of the attachment" }, "file": { "type": "string", "format": "binary", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } } }, "CreateEnrollmentRequest": { "type": "object", "properties": { "certificate": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "program": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "buyer": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "licensee": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "client": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "parameters": { "allOf": [ { "$ref": "#/components/schemas/ProgramParameterValueBagInput" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CreateItemGroupRequest": { "type": "object", "properties": { "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "label": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayOrder": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "multiple": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "required": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "default": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CreateListingRequest": { "required": [ "authorization", "eligibility", "priceList", "product", "seller" ], "type": "object", "properties": { "primary": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "notes": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "product": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "authorization": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "seller": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "priceList": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "eligibility": { "allOf": [ { "$ref": "#/components/schemas/ListingEligibility" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CreateParameterDefinitionRequest": { "required": [ "constraints", "description", "displayOrder", "name", "phase", "scope", "type" ], "type": "object", "properties": { "scope": { "minLength": 1, "enum": [ "Agreement", "Item", "Subscription", "Order", "Asset" ], "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "phase": { "minLength": 1, "enum": [ "Configuration", "Order", "Fulfillment" ], "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "context": { "enum": [ "None", "Purchase", "Change", "Configuration", "Termination" ], "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "minLength": 1, "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "minLength": 1, "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "multiple": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayOrder": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "constraints": { "allOf": [ { "$ref": "#/components/schemas/Constraints" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "minLength": 1, "enum": [ "SingleLineText", "MultiLineText", "Address", "Contact", "Checkbox", "Choice", "Subdomain", "Heading", "DropDown", "Email", "DataObject", "Date" ], "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "options": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AddressOptions" }, { "$ref": "#/components/schemas/CheckboxOptions" }, { "$ref": "#/components/schemas/ChoiceOptions" }, { "$ref": "#/components/schemas/DataObjectOptions" }, { "$ref": "#/components/schemas/ContactOptions" }, { "$ref": "#/components/schemas/DateOptions" }, { "$ref": "#/components/schemas/DropDownOptions" }, { "$ref": "#/components/schemas/EmailOptions" }, { "$ref": "#/components/schemas/HeadingOptions" }, { "$ref": "#/components/schemas/MultiLineTextOptions" }, { "$ref": "#/components/schemas/SingleLineTextOptions" }, { "$ref": "#/components/schemas/SubdomainOptions" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "group": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CreateParameterGroupRequest": { "type": "object", "properties": { "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "label": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayOrder": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "default": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CreatePriceListRequest": { "required": [ "precision", "product" ], "type": "object", "properties": { "currency": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "precision": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "defaultMarkup": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "defaultMargin": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "notes": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/PriceListExternalIdInput" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "product": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CreatePricingPolicyAttachmentRequest": { "type": "object", "properties": { "attachment": { "type": "object", "properties": { "Name": { "type": "string" }, "Description": { "type": "string" } }, "description": "Json representation of the attachment" }, "file": { "type": "string", "format": "binary", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } } }, "CreatePricingPolicyRequest": { "required": [ "eligibility" ], "type": "object", "properties": { "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/PricingPolicyExternalIdInput" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "client": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "eligibility": { "allOf": [ { "$ref": "#/components/schemas/PricingPolicyEligibility" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "markup": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "margin": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "notes": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CreateProductDocumentRequest": { "type": "object", "properties": { "document": { "type": "object", "properties": { "Name": { "type": "string" }, "Description": { "type": "string" }, "Language": { "type": "string" }, "DocumentType": { "allOf": [ { "$ref": "#/components/schemas/DocumentType" } ] }, "Url": { "type": "string" }, "DisplayOrder": { "type": "integer", "format": "int32" } }, "description": "Json representation of the document" }, "file": { "type": "string", "format": "binary", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } } }, "CreateProductItemRequest": { "required": [ "externalIds", "group", "product", "terms", "unit" ], "type": "object", "properties": { "product": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/ProductItemExternalIdInput" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "group": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unit": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "terms": { "allOf": [ { "$ref": "#/components/schemas/Terms" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "quantityNotApplicable": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/ParameterValueInput" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CreateProductMediaRequest": { "type": "object", "properties": { "media": { "type": "object", "properties": { "Name": { "type": "string" }, "Description": { "type": "string" }, "MediaType": { "allOf": [ { "$ref": "#/components/schemas/MediaType" } ] }, "Url": { "type": "string" }, "DisplayOrder": { "type": "integer", "format": "int32" } }, "description": "Json representation of the media" }, "file": { "type": "string", "format": "binary", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } } }, "CreateProductRequest": { "type": "object", "properties": { "product": { "type": "object", "properties": { "Name": { "type": "string" }, "ShortDescription": { "type": "string" }, "LongDescription": { "type": "string" }, "Website": { "type": "string" } }, "description": "Json representation of the product" }, "icon": { "type": "string", "format": "binary", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } } }, "CreateProgramDocumentRequest": { "type": "object", "properties": { "document": { "type": "object", "properties": { "Name": { "type": "string" }, "Description": { "type": "string" }, "Language": { "type": "string" }, "DocumentType": { "allOf": [ { "$ref": "#/components/schemas/DocumentType" } ] }, "Url": { "type": "string" }, "DisplayOrder": { "type": "integer", "format": "int32" } }, "description": "Json representation of the document" }, "file": { "type": "string", "format": "binary", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } } }, "CreateProgramMediaRequest": { "type": "object", "properties": { "media": { "type": "object", "properties": { "Name": { "type": "string" }, "Description": { "type": "string" }, "MediaType": { "allOf": [ { "$ref": "#/components/schemas/MediaType" } ] }, "Url": { "type": "string" }, "DisplayOrder": { "type": "integer", "format": "int32" } }, "description": "Json representation of the media" }, "file": { "type": "string", "format": "binary", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } } }, "CreateProgramParameterDefinitionRequest": { "required": [ "constraints", "description", "displayOrder", "name", "phase", "scope", "type" ], "type": "object", "properties": { "scope": { "minLength": 1, "enum": [ "Enrollment" ], "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "phase": { "minLength": 1, "enum": [ "Order", "Fulfillment" ], "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "minLength": 1, "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "minLength": 1, "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "multiple": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayOrder": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "constraints": { "allOf": [ { "$ref": "#/components/schemas/Constraints" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "minLength": 1, "enum": [ "SingleLineText", "MultiLineText", "Address", "Contact", "Checkbox", "Choice", "Subdomain", "Heading", "DropDown", "Email", "DataObject", "Date" ], "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "options": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AddressOptions" }, { "$ref": "#/components/schemas/CheckboxOptions" }, { "$ref": "#/components/schemas/ChoiceOptions" }, { "$ref": "#/components/schemas/DataObjectOptions" }, { "$ref": "#/components/schemas/ContactOptions" }, { "$ref": "#/components/schemas/DateOptions" }, { "$ref": "#/components/schemas/DropDownOptions" }, { "$ref": "#/components/schemas/EmailOptions" }, { "$ref": "#/components/schemas/HeadingOptions" }, { "$ref": "#/components/schemas/MultiLineTextOptions" }, { "$ref": "#/components/schemas/SingleLineTextOptions" }, { "$ref": "#/components/schemas/SubdomainOptions" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "group": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CreateProgramParameterGroupRequest": { "type": "object", "properties": { "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "label": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayOrder": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "default": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CreateProgramRequest": { "type": "object", "properties": { "Program": { "type": "object", "properties": { "Name": { "type": "string" }, "ShortDescription": { "type": "string" }, "LongDescription": { "type": "string" }, "Website": { "type": "string" }, "ApplicableTo": { "enum": [ "Buyer", "Licensee" ], "type": "string" }, "Eligibility.Client": { "type": "boolean" }, "Eligibility.Partner": { "type": "boolean" } }, "description": "Json representation of the Program" }, "icon": { "type": "string", "format": "binary", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } } }, "CreateProgramTemplateRequest": { "required": [ "content", "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "enum": [ "EnrollmentProcessing", "EnrollmentQuerying", "EnrollmentCompleted" ], "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "default": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "content": { "minLength": 1, "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/ProgramTemplateExternalIdInput" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CreateProgramTermsAndConditionsRequest": { "type": "object", "properties": { "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayOrder": { "type": "integer", "format": "int32", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CreateProgramTermsAndConditionsVariantRequest": { "type": "object", "properties": { "variant": { "type": "object", "properties": { "Type": { "enum": [ "Online", "File" ], "type": "string" }, "AssetUrl": { "type": "string" }, "LanguageCode": { "type": "string" }, "Name": { "type": "string" }, "Description": { "type": "string" } }, "description": "Json representation of the variant" }, "file": { "type": "string", "format": "binary", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } } }, "CreateTemplateRequest": { "required": [ "content", "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "enum": [ "OrderProcessing", "OrderQuerying", "OrderCompleted", "Subscription", "Asset" ], "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "default": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "content": { "minLength": 1, "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/TemplateExternalIdInput" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CreateTermsAndConditionsRequest": { "type": "object", "properties": { "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayOrder": { "type": "integer", "format": "int32", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CreateTermsAndConditionsVariantRequest": { "type": "object", "properties": { "variant": { "type": "object", "properties": { "Type": { "enum": [ "Online", "File" ], "type": "string" }, "AssetUrl": { "type": "string" }, "LanguageCode": { "type": "string" }, "Name": { "type": "string" }, "Description": { "type": "string" } }, "description": "Json representation of the variant" }, "file": { "type": "string", "format": "binary", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } } }, "CreateUnitOfMeasureRequest": { "type": "object", "properties": { "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CreateUserGroupDto": { "type": "object", "properties": { "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "logo": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "allOf": [ { "$ref": "#/components/schemas/AccountDto" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "modules": { "type": "array", "items": { "$ref": "#/components/schemas/ModuleDto" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "buyers": { "type": "array", "items": { "$ref": "#/components/schemas/BuyerDto" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "extensions": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionDto" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CreateWebhookRequest": { "required": [ "url" ], "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/WebhookType" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "url": { "type": "string", "format": "uri", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "criteria": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "secret": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "DataObjectOptions": { "type": "object", "properties": { "hintText": { "type": "string" }, "defaultValue": { "type": "string", "nullable": true }, "objectType": { "allOf": [ { "$ref": "#/components/schemas/DataObjectType" } ] } }, "additionalProperties": false }, "DataObjectType": { "enum": [ "Json", "Xml" ], "type": "string" }, "DateOptions": { "type": "object", "properties": { "hintText": { "type": "string" }, "dateRange": { "type": "boolean" }, "minAvailableDate": { "type": "string", "format": "date", "nullable": true }, "maxAvailableDate": { "type": "string", "format": "date", "nullable": true }, "defaultValue": { "oneOf": [ { "$ref": "#/components/schemas/RangeDateParameter" }, { "type": "string" } ], "nullable": true } }, "additionalProperties": false }, "EnrollmentAttachment": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "filename": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "size": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contentType": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "enrollment": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/EnrollmentRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "DecimalDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "type": "number", "format": "double", "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "DecimalNullableDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "DefaultParameterAddress": { "enum": [ "None", "Buyer", "Seller", "Licensee" ], "type": "string" }, "DefaultParameterContact": { "enum": [ "None", "CurrentlySignedInUser" ], "type": "string" }, "DefaultParameterEmail": { "enum": [ "None", "CurrentlySignedInUser" ], "type": "string" }, "Document": { "type": "object", "properties": { "domainEvents": { "type": "array", "items": { "$ref": "#/components/schemas/DomainEvent" }, "readOnly": true }, "markedForDelete": { "type": "boolean", "readOnly": true }, "markedForUpdate": { "type": "boolean", "readOnly": true }, "documentId": { "allOf": [ { "$ref": "#/components/schemas/DocumentId" } ], "readOnly": true }, "fileId": { "allOf": [ { "$ref": "#/components/schemas/FileId" } ], "readOnly": true }, "url": { "type": "string", "nullable": true, "readOnly": true }, "id": { "allOf": [ { "$ref": "#/components/schemas/IBusinessIdentifier" } ], "readOnly": true }, "language": { "type": "string", "nullable": true, "readOnly": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/DocumentStatus" } ], "readOnly": true }, "isDeleted": { "type": "boolean" }, "revision": { "type": "integer", "format": "int32", "readOnly": true }, "useDeleteStatus": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "DocumentId": { "type": "object", "properties": { "value": { "type": "string", "readOnly": true }, "postfixNumber": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "DocumentStatus": { "enum": [ "Draft", "Pending", "Published", "Unpublished", "Deleted" ], "type": "string" }, "DomainEvent": { "type": "object", "properties": { "timeStamp": { "type": "string", "format": "date-time", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "DropDownOptions": { "type": "object", "properties": { "hintText": { "type": "string" }, "placeholderText": { "type": "string", "nullable": true }, "optionsList": { "type": "array", "items": { "$ref": "#/components/schemas/BasicSelectionOption" } }, "description": { "type": "string", "nullable": true }, "defaultValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EmailDto": { "type": "string", "additionalProperties": false, "format": "email" }, "EmailOptions": { "type": "object", "properties": { "placeholderText": { "type": "string" }, "hintText": { "type": "string" }, "defaultValue": { "allOf": [ { "$ref": "#/components/schemas/DefaultParameterEmail" } ] } }, "additionalProperties": false }, "EnrollmentAttachmentDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/EnrollmentAttachment" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EnrollmentAttachmentListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/EnrollmentAttachment" } } }, "additionalProperties": false }, "Enrollment": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/EnrollmentAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "certificate": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/CertificateRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "program": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProgramRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "vendor": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "applicableTo": { "allOf": [ { "$ref": "#/components/schemas/ProgramApplicableTo" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "allOf": [ { "$ref": "#/components/schemas/EnrollmentType" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "buyer": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BuyerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Operations" ] } }, "licensee": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/LicenseeRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Operations" ] } }, "eligibility": { "allOf": [ { "$ref": "#/components/schemas/ProgramEligibility" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/EnrollmentStatus" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "notes": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "statusNotes": { "allOf": [ { "$ref": "#/components/schemas/ParametrisedMessage" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "assignee": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/UserRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Operations" ] } }, "parameters": { "allOf": [ { "$ref": "#/components/schemas/ProgramParameterBag" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "error": { "allOf": [ { "$ref": "#/components/schemas/ParametrisedMessage" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "template": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProgramTemplateRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Operations" ] } } }, "additionalProperties": false }, "EnrollmentAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "processing": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "querying": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "completed": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "failed": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "EnrollmentListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Enrollment" } } }, "additionalProperties": false }, "EnrollmentUpdate": { "type": "object", "properties": { "program": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "statusNotes": { "allOf": [ { "$ref": "#/components/schemas/ParametrisedMessage" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "notes": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "assignee": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "error": { "allOf": [ { "$ref": "#/components/schemas/ParametrisedMessage" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "parameters": { "allOf": [ { "$ref": "#/components/schemas/UpdateEnrollmentParameterBag" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "template": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "EnrollmentStatus": { "enum": [ "Draft", "Processing", "Querying", "Completed", "Failed", "Deleted" ], "type": "string" }, "EnrollmentType": { "enum": [ "Change", "New" ], "type": "string" }, "EnrollmentUpdateDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/EnrollmentUpdate" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ErpLinkAddress": { "required": [ "addressLine1", "city", "country", "postCode", "state" ], "type": "object", "properties": { "addressLine1": { "maxLength": 250, "minLength": 1, "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "addressLine2": { "maxLength": 250, "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "postCode": { "maxLength": 20, "minLength": 1, "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "city": { "maxLength": 200, "minLength": 1, "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "state": { "maxLength": 200, "minLength": 1, "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "country": { "maxLength": 2, "minLength": 1, "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ErpLinkDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/ErpLink" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ErpLinkListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLink" } } }, "additionalProperties": false }, "ErpLinkUpdateWithIcon": { "type": "object", "properties": { "erpLink": { "type": "object", "properties": { "ErpLink.Node.Name": { "type": "string" }, "ErpLink.Node.Children": { "type": "array", "items": { "$ref": "#/components/schemas/DeltaNode" } }, "ErpLink.Path": { "type": "string" }, "ErpLink.Data.Buyer.ExternalIds.ErpCompanyContact": { "type": "string" }, "ErpLink.Data.Buyer.ExternalIds.ErpCustomer": { "type": "string" }, "ErpLink.Data.Buyer.ExternalIds.AccountExternalId": { "type": "string" }, "ErpLink.Data.Buyer.Status": { "allOf": [ { "$ref": "#/components/schemas/BuyerStatus" } ] }, "ErpLink.Data.Buyer.Address.AddressLine1": { "type": "string" }, "ErpLink.Data.Buyer.Address.AddressLine2": { "type": "string" }, "ErpLink.Data.Buyer.Address.PostCode": { "type": "string" }, "ErpLink.Data.Buyer.Address.City": { "type": "string" }, "ErpLink.Data.Buyer.Address.State": { "type": "string" }, "ErpLink.Data.Buyer.Address.Country": { "type": "string" }, "ErpLink.Data.Buyer.TaxId": { "type": "string" }, "ErpLink.Data.Buyer.Account.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "ErpLink.Data.Buyer.Account.ExternalId": { "type": "string" }, "ErpLink.Data.Buyer.Account.ExternalName": { "type": "string" }, "ErpLink.Data.Buyer.Account.Address.AddressLine1": { "type": "string" }, "ErpLink.Data.Buyer.Account.Address.AddressLine2": { "type": "string" }, "ErpLink.Data.Buyer.Account.Address.PostCode": { "type": "string" }, "ErpLink.Data.Buyer.Account.Address.City": { "type": "string" }, "ErpLink.Data.Buyer.Account.Address.State": { "type": "string" }, "ErpLink.Data.Buyer.Account.Address.Country": { "type": "string" }, "ErpLink.Data.Buyer.Account.TechnicalSupportEmail": { "type": "string" }, "ErpLink.Data.Buyer.Account.Website": { "type": "string" }, "ErpLink.Data.Buyer.Account.Description": { "type": "string" }, "ErpLink.Data.Buyer.Account.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "ErpLink.Data.Buyer.Account.Eligibility.Client": { "type": "boolean" }, "ErpLink.Data.Buyer.Account.Eligibility.Partner": { "type": "boolean" }, "ErpLink.Data.Buyer.Account.DefaultLanguageCode": { "type": "string" }, "ErpLink.Data.Buyer.Account.Type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ] }, "ErpLink.Data.Buyer.Account.Status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ] }, "ErpLink.Data.Buyer.Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Buyer.Account.Name": { "type": "string" }, "ErpLink.Data.Buyer.Account.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Account.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Account.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Account.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Buyer.Account.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Buyer.Account.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Buyer.Account.Audit.Created.By.Name": { "type": "string" }, "ErpLink.Data.Buyer.Account.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Account.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Account.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "ErpLink.Data.Buyer.Account.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Account.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Buyer.Account.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Buyer.Account.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Account.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Account.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Buyer.Account.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Buyer.Account.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Buyer.Account.Audit.Updated.By.Name": { "type": "string" }, "ErpLink.Data.Buyer.Account.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Account.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Account.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Account.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Buyer.Account.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Buyer.Account.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "ErpLink.Data.Buyer.Account.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Account.Id": { "type": "string" }, "ErpLink.Data.Buyer.Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ParametrisedMessage" } }, "ErpLink.Data.Buyer.Sellers": { "type": "array", "items": { "$ref": "#/components/schemas/Seller" } }, "ErpLink.Data.Buyer.ErpLinks": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLink" } }, "ErpLink.Data.Buyer.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Buyer.Name": { "type": "string" }, "ErpLink.Data.Buyer.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Audit.Activated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Audit.Activated.ById": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Activated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Buyer.Audit.Activated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Buyer.Audit.Activated.By.Name": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Activated.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Activated.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Audit.Activated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Audit.Activated.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Activated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Buyer.Audit.Activated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Audit.Activated.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Activated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Buyer.Audit.Activated.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Unassigned.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Audit.Unassigned.ById": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Unassigned.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Buyer.Audit.Unassigned.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Buyer.Audit.Unassigned.By.Name": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Unassigned.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Unassigned.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Audit.Unassigned.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Audit.Unassigned.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Unassigned.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Buyer.Audit.Unassigned.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Audit.Unassigned.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Unassigned.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Buyer.Audit.Unassigned.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Disabled.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Audit.Disabled.ById": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Disabled.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Buyer.Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Buyer.Audit.Disabled.By.Name": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Disabled.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Disabled.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Audit.Disabled.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Audit.Disabled.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Disabled.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Buyer.Audit.Disabled.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Audit.Disabled.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Disabled.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Buyer.Audit.Disabled.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Buyer.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Buyer.Audit.Created.By.Name": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Buyer.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Buyer.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Buyer.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Buyer.Audit.Updated.By.Name": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Buyer.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Buyer.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Id": { "type": "string" }, "ErpLink.Data.Seller.ExternalId": { "type": "string" }, "ErpLink.Data.Seller.Status": { "allOf": [ { "$ref": "#/components/schemas/SellerStatus" } ] }, "ErpLink.Data.Seller.Currencies": { "type": "array", "items": { "$ref": "#/components/schemas/SellerCurrency" } }, "ErpLink.Data.Seller.Address.AddressLine1": { "type": "string" }, "ErpLink.Data.Seller.Address.AddressLine2": { "type": "string" }, "ErpLink.Data.Seller.Address.PostCode": { "type": "string" }, "ErpLink.Data.Seller.Address.City": { "type": "string" }, "ErpLink.Data.Seller.Address.State": { "type": "string" }, "ErpLink.Data.Seller.Address.Country": { "type": "string" }, "ErpLink.Data.Seller.Buyers": { "type": "array", "items": { "$ref": "#/components/schemas/Buyer" } }, "ErpLink.Data.Seller.ErpLink.Buyer.ExternalIds.ErpCompanyContact": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.ExternalIds.ErpCustomer": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.ExternalIds.AccountExternalId": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Status": { "allOf": [ { "$ref": "#/components/schemas/BuyerStatus" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Address.AddressLine1": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Address.AddressLine2": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Address.PostCode": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Address.City": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Address.State": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Address.Country": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.TaxId": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.ExternalId": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.ExternalName": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Address.AddressLine1": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Address.AddressLine2": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Address.PostCode": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Address.City": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Address.State": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Address.Country": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.TechnicalSupportEmail": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Website": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Description": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Eligibility.Client": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Eligibility.Partner": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.DefaultLanguageCode": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Created.By.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.By.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ParametrisedMessage" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Sellers": { "type": "array", "items": { "$ref": "#/components/schemas/Seller" } }, "ErpLink.Data.Seller.ErpLink.Buyer.ErpLinks": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLink" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.By.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.By.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.By.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.By.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.By.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Seller": { "allOf": [ { "$ref": "#/components/schemas/Seller" } ] }, "ErpLink.Data.Seller.ErpLink.BuyerId": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.SellerId": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.CompanyName": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Status": { "allOf": [ { "$ref": "#/components/schemas/ErpLinkStatus" } ] }, "ErpLink.Data.Seller.ErpLink.Note": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.ExternalIds.ErpCompanyContact": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.ExternalIds.ErpCustomer": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.ExternalIds.AccountExternalId": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Address.AddressLine1": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Address.AddressLine2": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Address.PostCode": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Address.City": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Address.State": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Address.Country": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.ShipTo": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLinkAddress" } }, "ErpLink.Data.Seller.ErpLink.BillTo": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLinkAddress" } }, "ErpLink.Data.Seller.ErpLink.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.By.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.By.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Seller.ErpLink.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Audit.Created.By.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.By.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Id": { "type": "string" }, "ErpLink.Data.Seller.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.Name": { "type": "string" }, "ErpLink.Data.Seller.Icon": { "type": "string" }, "ErpLink.Data.Seller.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Seller.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.Audit.Created.By.Name": { "type": "string" }, "ErpLink.Data.Seller.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "ErpLink.Data.Seller.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Seller.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Seller.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.Audit.Updated.By.Name": { "type": "string" }, "ErpLink.Data.Seller.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Seller.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "ErpLink.Data.Seller.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Seller.Id": { "type": "string" }, "ErpLink.Data.BuyerId": { "type": "string" }, "ErpLink.Data.SellerId": { "type": "string" }, "ErpLink.Data.CompanyName": { "type": "string" }, "ErpLink.Data.Status": { "allOf": [ { "$ref": "#/components/schemas/ErpLinkStatus" } ] }, "ErpLink.Data.Note": { "type": "string" }, "ErpLink.Data.ExternalIds.ErpCompanyContact": { "type": "string" }, "ErpLink.Data.ExternalIds.ErpCustomer": { "type": "string" }, "ErpLink.Data.ExternalIds.AccountExternalId": { "type": "string" }, "ErpLink.Data.Address.AddressLine1": { "type": "string" }, "ErpLink.Data.Address.AddressLine2": { "type": "string" }, "ErpLink.Data.Address.PostCode": { "type": "string" }, "ErpLink.Data.Address.City": { "type": "string" }, "ErpLink.Data.Address.State": { "type": "string" }, "ErpLink.Data.Address.Country": { "type": "string" }, "ErpLink.Data.ShipTo": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLinkAddress" } }, "ErpLink.Data.BillTo": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLinkAddress" } }, "ErpLink.Data.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Name": { "type": "string" }, "ErpLink.Data.Icon": { "type": "string" }, "ErpLink.Data.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Audit.Blocked.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Audit.Blocked.ById": { "type": "string" }, "ErpLink.Data.Audit.Blocked.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Audit.Blocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Audit.Blocked.By.Name": { "type": "string" }, "ErpLink.Data.Audit.Blocked.By.Icon": { "type": "string" }, "ErpLink.Data.Audit.Blocked.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Audit.Blocked.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Audit.Blocked.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Audit.Blocked.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Audit.Blocked.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Audit.Blocked.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Audit.Blocked.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Audit.Blocked.By.Id": { "type": "string" }, "ErpLink.Data.Audit.Unblocked.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Audit.Unblocked.ById": { "type": "string" }, "ErpLink.Data.Audit.Unblocked.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Audit.Unblocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Audit.Unblocked.By.Name": { "type": "string" }, "ErpLink.Data.Audit.Unblocked.By.Icon": { "type": "string" }, "ErpLink.Data.Audit.Unblocked.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Audit.Unblocked.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Audit.Unblocked.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Audit.Unblocked.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Audit.Unblocked.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Audit.Unblocked.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Audit.Unblocked.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Audit.Unblocked.By.Id": { "type": "string" }, "ErpLink.Data.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Audit.Created.By.Name": { "type": "string" }, "ErpLink.Data.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "ErpLink.Data.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Audit.Updated.By.Name": { "type": "string" }, "ErpLink.Data.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "ErpLink.Data.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "ErpLink.Data.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Id": { "type": "string" }, "ErpLink.IsDefined": { "type": "boolean" } }, "description": "Json representation of the erpLink", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "logo": { "type": "string", "format": "binary", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } } }, "ExtendedParameterValue": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "value": { "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "error": { "allOf": [ { "$ref": "#/components/schemas/ParametrisedMessage" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "constraints": { "allOf": [ { "$ref": "#/components/schemas/Constraints" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ExtendedParameterValueDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/ExtendedParameterValue" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ExtendedParameterValueListDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ExtendedParameterValue" }, "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ItemGroupListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ItemGroup" } } }, "additionalProperties": false }, "ExtensionDto": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "FailEnrollmentRequest": { "required": [ "statusNotes" ], "type": "object", "properties": { "statusNotes": { "allOf": [ { "$ref": "#/components/schemas/ParametrisedMessage" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "FileId": { "type": "object", "properties": { "value": { "type": "string", "readOnly": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "HeadingOptions": { "type": "object", "additionalProperties": false }, "HttpStatusCode": { "enum": [ "Continue", "SwitchingProtocols", "Processing", "EarlyHints", "OK", "Created", "Accepted", "NonAuthoritativeInformation", "NoContent", "ResetContent", "PartialContent", "MultiStatus", "AlreadyReported", "IMUsed", "MultipleChoices", "MovedPermanently", "Found", "SeeOther", "NotModified", "UseProxy", "Unused", "TemporaryRedirect", "PermanentRedirect", "BadRequest", "Unauthorized", "PaymentRequired", "Forbidden", "NotFound", "MethodNotAllowed", "NotAcceptable", "ProxyAuthenticationRequired", "RequestTimeout", "Conflict", "Gone", "LengthRequired", "PreconditionFailed", "RequestEntityTooLarge", "RequestUriTooLong", "UnsupportedMediaType", "RequestedRangeNotSatisfiable", "ExpectationFailed", "MisdirectedRequest", "UnprocessableEntity", "Locked", "FailedDependency", "UpgradeRequired", "PreconditionRequired", "TooManyRequests", "RequestHeaderFieldsTooLarge", "UnavailableForLegalReasons", "InternalServerError", "NotImplemented", "BadGateway", "ServiceUnavailable", "GatewayTimeout", "HttpVersionNotSupported", "VariantAlsoNegotiates", "InsufficientStorage", "LoopDetected", "NotExtended", "NetworkAuthenticationRequired" ], "type": "string" }, "IBusinessIdentifier": { "type": "object", "properties": { "value": { "type": "string", "readOnly": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Int32Delta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "type": "integer", "format": "int32", "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "InvitationDto": { "type": "object", "properties": { "status": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "InvitationQueryModel": { "type": "object", "properties": { "url": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "LicenseeCreateFromForm": { "type": "object", "properties": { "licensee": { "type": "object", "properties": { "ExternalId": { "type": "string" }, "Status": { "allOf": [ { "$ref": "#/components/schemas/LicenseeStatus" } ] }, "Address.AddressLine1": { "type": "string" }, "Address.AddressLine2": { "type": "string" }, "Address.PostCode": { "type": "string" }, "Address.City": { "type": "string" }, "Address.State": { "type": "string" }, "Address.Country": { "type": "string" }, "UseBuyerAddress": { "type": "boolean" }, "Description": { "type": "string" }, "Account.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Account.ExternalId": { "type": "string" }, "Account.ExternalName": { "type": "string" }, "Account.Address.AddressLine1": { "type": "string" }, "Account.Address.AddressLine2": { "type": "string" }, "Account.Address.PostCode": { "type": "string" }, "Account.Address.City": { "type": "string" }, "Account.Address.State": { "type": "string" }, "Account.Address.Country": { "type": "string" }, "Account.TechnicalSupportEmail": { "type": "string" }, "Account.Website": { "type": "string" }, "Account.Description": { "type": "string" }, "Account.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Account.Eligibility.Client": { "type": "boolean" }, "Account.Eligibility.Partner": { "type": "boolean" }, "Account.DefaultLanguageCode": { "type": "string" }, "Account.Type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ] }, "Account.Status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ] }, "Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Name": { "type": "string" }, "Account.Icon": { "type": "string" }, "Account.Revision": { "type": "integer", "format": "int32" }, "Account.Audit.Created.At": { "type": "string", "format": "date-time" }, "Account.Audit.Created.ById": { "type": "string" }, "Account.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Account.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Audit.Created.By.Name": { "type": "string" }, "Account.Audit.Created.By.Icon": { "type": "string" }, "Account.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Account.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Account.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Account.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Account.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Account.Audit.Created.By.Id": { "type": "string" }, "Account.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Account.Audit.Updated.ById": { "type": "string" }, "Account.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Account.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Audit.Updated.By.Name": { "type": "string" }, "Account.Audit.Updated.By.Icon": { "type": "string" }, "Account.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Account.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Account.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Account.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Account.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Account.Audit.Updated.By.Id": { "type": "string" }, "Account.Id": { "type": "string" }, "Buyer.ExternalIds.ErpCompanyContact": { "type": "string" }, "Buyer.ExternalIds.ErpCustomer": { "type": "string" }, "Buyer.ExternalIds.AccountExternalId": { "type": "string" }, "Buyer.Status": { "allOf": [ { "$ref": "#/components/schemas/BuyerStatus" } ] }, "Buyer.Address.AddressLine1": { "type": "string" }, "Buyer.Address.AddressLine2": { "type": "string" }, "Buyer.Address.PostCode": { "type": "string" }, "Buyer.Address.City": { "type": "string" }, "Buyer.Address.State": { "type": "string" }, "Buyer.Address.Country": { "type": "string" }, "Buyer.TaxId": { "type": "string" }, "Buyer.Account.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Buyer.Account.ExternalId": { "type": "string" }, "Buyer.Account.ExternalName": { "type": "string" }, "Buyer.Account.Address.AddressLine1": { "type": "string" }, "Buyer.Account.Address.AddressLine2": { "type": "string" }, "Buyer.Account.Address.PostCode": { "type": "string" }, "Buyer.Account.Address.City": { "type": "string" }, "Buyer.Account.Address.State": { "type": "string" }, "Buyer.Account.Address.Country": { "type": "string" }, "Buyer.Account.TechnicalSupportEmail": { "type": "string" }, "Buyer.Account.Website": { "type": "string" }, "Buyer.Account.Description": { "type": "string" }, "Buyer.Account.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Buyer.Account.Eligibility.Client": { "type": "boolean" }, "Buyer.Account.Eligibility.Partner": { "type": "boolean" }, "Buyer.Account.DefaultLanguageCode": { "type": "string" }, "Buyer.Account.Type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ] }, "Buyer.Account.Status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ] }, "Buyer.Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Account.Name": { "type": "string" }, "Buyer.Account.Icon": { "type": "string" }, "Buyer.Account.Revision": { "type": "integer", "format": "int32" }, "Buyer.Account.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Account.Audit.Created.ById": { "type": "string" }, "Buyer.Account.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Buyer.Account.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Account.Audit.Created.By.Name": { "type": "string" }, "Buyer.Account.Audit.Created.By.Icon": { "type": "string" }, "Buyer.Account.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Buyer.Account.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Buyer.Account.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Account.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Account.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Account.Audit.Created.By.Id": { "type": "string" }, "Buyer.Account.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Account.Audit.Updated.ById": { "type": "string" }, "Buyer.Account.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Buyer.Account.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Account.Audit.Updated.By.Name": { "type": "string" }, "Buyer.Account.Audit.Updated.By.Icon": { "type": "string" }, "Buyer.Account.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Buyer.Account.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Account.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Buyer.Account.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Account.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Buyer.Account.Audit.Updated.By.Id": { "type": "string" }, "Buyer.Account.Id": { "type": "string" }, "Buyer.Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ParametrisedMessage" } }, "Buyer.Sellers": { "type": "array", "items": { "$ref": "#/components/schemas/Seller" } }, "Buyer.ErpLinks": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLink" } }, "Buyer.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Name": { "type": "string" }, "Buyer.Icon": { "type": "string" }, "Buyer.Revision": { "type": "integer", "format": "int32" }, "Buyer.Audit.Activated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Activated.ById": { "type": "string" }, "Buyer.Audit.Activated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Buyer.Audit.Activated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Audit.Activated.By.Name": { "type": "string" }, "Buyer.Audit.Activated.By.Icon": { "type": "string" }, "Buyer.Audit.Activated.By.Revision": { "type": "integer", "format": "int32" }, "Buyer.Audit.Activated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Activated.By.Audit.Created.ById": { "type": "string" }, "Buyer.Audit.Activated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Activated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Activated.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Audit.Activated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Activated.By.Id": { "type": "string" }, "Buyer.Audit.Unassigned.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Unassigned.ById": { "type": "string" }, "Buyer.Audit.Unassigned.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Buyer.Audit.Unassigned.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Audit.Unassigned.By.Name": { "type": "string" }, "Buyer.Audit.Unassigned.By.Icon": { "type": "string" }, "Buyer.Audit.Unassigned.By.Revision": { "type": "integer", "format": "int32" }, "Buyer.Audit.Unassigned.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Unassigned.By.Audit.Created.ById": { "type": "string" }, "Buyer.Audit.Unassigned.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Unassigned.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Unassigned.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Audit.Unassigned.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Unassigned.By.Id": { "type": "string" }, "Buyer.Audit.Disabled.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Disabled.ById": { "type": "string" }, "Buyer.Audit.Disabled.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Buyer.Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Audit.Disabled.By.Name": { "type": "string" }, "Buyer.Audit.Disabled.By.Icon": { "type": "string" }, "Buyer.Audit.Disabled.By.Revision": { "type": "integer", "format": "int32" }, "Buyer.Audit.Disabled.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Disabled.By.Audit.Created.ById": { "type": "string" }, "Buyer.Audit.Disabled.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Disabled.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Disabled.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Audit.Disabled.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Disabled.By.Id": { "type": "string" }, "Buyer.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Created.ById": { "type": "string" }, "Buyer.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Buyer.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Audit.Created.By.Name": { "type": "string" }, "Buyer.Audit.Created.By.Icon": { "type": "string" }, "Buyer.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Buyer.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Buyer.Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Created.By.Id": { "type": "string" }, "Buyer.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Updated.ById": { "type": "string" }, "Buyer.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Buyer.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Audit.Updated.By.Name": { "type": "string" }, "Buyer.Audit.Updated.By.Icon": { "type": "string" }, "Buyer.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Buyer.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Buyer.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Updated.By.Id": { "type": "string" }, "Buyer.Id": { "type": "string" }, "Seller.ExternalId": { "type": "string" }, "Seller.Status": { "allOf": [ { "$ref": "#/components/schemas/SellerStatus" } ] }, "Seller.Currencies": { "type": "array", "items": { "$ref": "#/components/schemas/SellerCurrency" } }, "Seller.Address.AddressLine1": { "type": "string" }, "Seller.Address.AddressLine2": { "type": "string" }, "Seller.Address.PostCode": { "type": "string" }, "Seller.Address.City": { "type": "string" }, "Seller.Address.State": { "type": "string" }, "Seller.Address.Country": { "type": "string" }, "Seller.Buyers": { "type": "array", "items": { "$ref": "#/components/schemas/Buyer" } }, "Seller.ErpLink.Buyer.ExternalIds.ErpCompanyContact": { "type": "string" }, "Seller.ErpLink.Buyer.ExternalIds.ErpCustomer": { "type": "string" }, "Seller.ErpLink.Buyer.ExternalIds.AccountExternalId": { "type": "string" }, "Seller.ErpLink.Buyer.Status": { "allOf": [ { "$ref": "#/components/schemas/BuyerStatus" } ] }, "Seller.ErpLink.Buyer.Address.AddressLine1": { "type": "string" }, "Seller.ErpLink.Buyer.Address.AddressLine2": { "type": "string" }, "Seller.ErpLink.Buyer.Address.PostCode": { "type": "string" }, "Seller.ErpLink.Buyer.Address.City": { "type": "string" }, "Seller.ErpLink.Buyer.Address.State": { "type": "string" }, "Seller.ErpLink.Buyer.Address.Country": { "type": "string" }, "Seller.ErpLink.Buyer.TaxId": { "type": "string" }, "Seller.ErpLink.Buyer.Account.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Seller.ErpLink.Buyer.Account.ExternalId": { "type": "string" }, "Seller.ErpLink.Buyer.Account.ExternalName": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Address.AddressLine1": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Address.AddressLine2": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Address.PostCode": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Address.City": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Address.State": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Address.Country": { "type": "string" }, "Seller.ErpLink.Buyer.Account.TechnicalSupportEmail": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Website": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Description": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Seller.ErpLink.Buyer.Account.Eligibility.Client": { "type": "boolean" }, "Seller.ErpLink.Buyer.Account.Eligibility.Partner": { "type": "boolean" }, "Seller.ErpLink.Buyer.Account.DefaultLanguageCode": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ] }, "Seller.ErpLink.Buyer.Account.Status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ] }, "Seller.ErpLink.Buyer.Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Account.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Account.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Account.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ParametrisedMessage" } }, "Seller.ErpLink.Buyer.Sellers": { "type": "array", "items": { "$ref": "#/components/schemas/Seller" } }, "Seller.ErpLink.Buyer.ErpLinks": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLink" } }, "Seller.ErpLink.Buyer.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Audit.Activated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Activated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Buyer.Audit.Activated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Audit.Activated.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Activated.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Unassigned.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Disabled.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Buyer.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Audit.Created.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Buyer.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Audit.Updated.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Id": { "type": "string" }, "Seller.ErpLink.Seller.ExternalId": { "type": "string" }, "Seller.ErpLink.Seller.Status": { "allOf": [ { "$ref": "#/components/schemas/SellerStatus" } ] }, "Seller.ErpLink.Seller.Currencies": { "type": "array", "items": { "$ref": "#/components/schemas/SellerCurrency" } }, "Seller.ErpLink.Seller.Address.AddressLine1": { "type": "string" }, "Seller.ErpLink.Seller.Address.AddressLine2": { "type": "string" }, "Seller.ErpLink.Seller.Address.PostCode": { "type": "string" }, "Seller.ErpLink.Seller.Address.City": { "type": "string" }, "Seller.ErpLink.Seller.Address.State": { "type": "string" }, "Seller.ErpLink.Seller.Address.Country": { "type": "string" }, "Seller.ErpLink.Seller.Buyers": { "type": "array", "items": { "$ref": "#/components/schemas/Buyer" } }, "Seller.ErpLink.Seller.ErpLink": { "allOf": [ { "$ref": "#/components/schemas/ErpLink" } ] }, "Seller.ErpLink.Seller.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Seller.Name": { "type": "string" }, "Seller.ErpLink.Seller.Icon": { "type": "string" }, "Seller.ErpLink.Seller.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Seller.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Seller.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Seller.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Seller.Audit.Created.By.Name": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Seller.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.ErpLink.Seller.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Seller.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Seller.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Seller.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Seller.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Seller.Audit.Updated.By.Name": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Seller.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Seller.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Seller.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.ErpLink.Seller.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Seller.Id": { "type": "string" }, "Seller.ErpLink.BuyerId": { "type": "string" }, "Seller.ErpLink.SellerId": { "type": "string" }, "Seller.ErpLink.CompanyName": { "type": "string" }, "Seller.ErpLink.Status": { "allOf": [ { "$ref": "#/components/schemas/ErpLinkStatus" } ] }, "Seller.ErpLink.Note": { "type": "string" }, "Seller.ErpLink.ExternalIds.ErpCompanyContact": { "type": "string" }, "Seller.ErpLink.ExternalIds.ErpCustomer": { "type": "string" }, "Seller.ErpLink.ExternalIds.AccountExternalId": { "type": "string" }, "Seller.ErpLink.Address.AddressLine1": { "type": "string" }, "Seller.ErpLink.Address.AddressLine2": { "type": "string" }, "Seller.ErpLink.Address.PostCode": { "type": "string" }, "Seller.ErpLink.Address.City": { "type": "string" }, "Seller.ErpLink.Address.State": { "type": "string" }, "Seller.ErpLink.Address.Country": { "type": "string" }, "Seller.ErpLink.ShipTo": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLinkAddress" } }, "Seller.ErpLink.BillTo": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLinkAddress" } }, "Seller.ErpLink.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Name": { "type": "string" }, "Seller.ErpLink.Icon": { "type": "string" }, "Seller.ErpLink.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Audit.Blocked.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Blocked.ById": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Audit.Blocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Audit.Blocked.By.Name": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.Icon": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Audit.Blocked.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Blocked.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Audit.Blocked.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Blocked.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Audit.Blocked.By.Id": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Unblocked.ById": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Audit.Unblocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Audit.Unblocked.By.Name": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.Icon": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Audit.Unblocked.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Unblocked.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Audit.Unblocked.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Unblocked.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Audit.Unblocked.By.Id": { "type": "string" }, "Seller.ErpLink.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Audit.Created.By.Name": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Audit.Updated.By.Name": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Id": { "type": "string" }, "Seller.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Name": { "type": "string" }, "Seller.Icon": { "type": "string" }, "Seller.Revision": { "type": "integer", "format": "int32" }, "Seller.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Audit.Created.ById": { "type": "string" }, "Seller.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Audit.Created.By.Name": { "type": "string" }, "Seller.Audit.Created.By.Icon": { "type": "string" }, "Seller.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Audit.Created.By.Id": { "type": "string" }, "Seller.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Audit.Updated.ById": { "type": "string" }, "Seller.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Audit.Updated.By.Name": { "type": "string" }, "Seller.Audit.Updated.By.Icon": { "type": "string" }, "Seller.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.Audit.Updated.By.Id": { "type": "string" }, "Seller.Id": { "type": "string" }, "Eligibility.Client": { "type": "boolean" }, "Eligibility.Partner": { "type": "boolean" }, "Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Name": { "type": "string" }, "Icon": { "type": "string" }, "Revision": { "type": "integer", "format": "int32" }, "Audit.Disabled.At": { "type": "string", "format": "date-time" }, "Audit.Disabled.ById": { "type": "string" }, "Audit.Disabled.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Disabled.By.Name": { "type": "string" }, "Audit.Disabled.By.Icon": { "type": "string" }, "Audit.Disabled.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Disabled.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Disabled.By.Audit.Created.ById": { "type": "string" }, "Audit.Disabled.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Disabled.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Disabled.By.Audit.Updated.ById": { "type": "string" }, "Audit.Disabled.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Disabled.By.Id": { "type": "string" }, "Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Created.ById": { "type": "string" }, "Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Created.By.Name": { "type": "string" }, "Audit.Created.By.Icon": { "type": "string" }, "Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Created.By.Id": { "type": "string" }, "Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Updated.ById": { "type": "string" }, "Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Updated.By.Name": { "type": "string" }, "Audit.Updated.By.Icon": { "type": "string" }, "Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Updated.By.Id": { "type": "string" }, "Id": { "type": "string" } }, "description": "Json representation of the licensee" }, "logo": { "type": "string", "format": "binary", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } } }, "ItemPriceInfo": { "type": "object", "properties": { "visible": { "type": "boolean" }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "JournalInput": { "type": "object", "properties": { "firstInvoiceDate": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "frequency": { "enum": [ "1m", "6m", "1y", "3m", "3y", "one-time" ], "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "LastWebhookCallDetails": { "type": "object", "properties": { "callTime": { "type": "string", "format": "date-time", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "responseTime": { "type": "string", "format": "date-time", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "httpStatusCode": { "allOf": [ { "$ref": "#/components/schemas/HttpStatusCode" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "reasonPhrase": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "success": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "response": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "error": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "headers": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "LastWebhookCallDetailsJsonOptional": { "type": "object", "properties": { "hasValue": { "type": "boolean", "readOnly": true }, "value": { "allOf": [ { "$ref": "#/components/schemas/LastWebhookCallDetails" } ], "nullable": true } }, "additionalProperties": false }, "LicenseeCreate": { "required": [ "buyer", "seller", "useBuyerAddress" ], "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/LicenseeAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "maxLength": 500, "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "maxLength": 2000, "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "maxLength": 250, "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/LicenseeStatus" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "useBuyerAddress": { "type": "boolean", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "maxLength": 2000, "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "buyer": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BuyerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "seller": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SellerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "eligibility": { "allOf": [ { "$ref": "#/components/schemas/Eligibility" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "LicenseeListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Licensee" } } }, "additionalProperties": false }, "LicenseeUpdateFromForm": { "type": "object", "properties": { "licensee": { "type": "object", "properties": { "ExternalId": { "type": "string" }, "Status": { "allOf": [ { "$ref": "#/components/schemas/LicenseeStatus" } ] }, "Address.AddressLine1": { "type": "string" }, "Address.AddressLine2": { "type": "string" }, "Address.PostCode": { "type": "string" }, "Address.City": { "type": "string" }, "Address.State": { "type": "string" }, "Address.Country": { "type": "string" }, "UseBuyerAddress": { "type": "boolean" }, "Description": { "type": "string" }, "Account.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Account.ExternalId": { "type": "string" }, "Account.ExternalName": { "type": "string" }, "Account.Address.AddressLine1": { "type": "string" }, "Account.Address.AddressLine2": { "type": "string" }, "Account.Address.PostCode": { "type": "string" }, "Account.Address.City": { "type": "string" }, "Account.Address.State": { "type": "string" }, "Account.Address.Country": { "type": "string" }, "Account.TechnicalSupportEmail": { "type": "string" }, "Account.Website": { "type": "string" }, "Account.Description": { "type": "string" }, "Account.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Account.Eligibility.Client": { "type": "boolean" }, "Account.Eligibility.Partner": { "type": "boolean" }, "Account.DefaultLanguageCode": { "type": "string" }, "Account.Type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ] }, "Account.Status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ] }, "Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Name": { "type": "string" }, "Account.Icon": { "type": "string" }, "Account.Revision": { "type": "integer", "format": "int32" }, "Account.Audit.Created.At": { "type": "string", "format": "date-time" }, "Account.Audit.Created.ById": { "type": "string" }, "Account.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Account.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Audit.Created.By.Name": { "type": "string" }, "Account.Audit.Created.By.Icon": { "type": "string" }, "Account.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Account.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Account.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Account.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Account.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Account.Audit.Created.By.Id": { "type": "string" }, "Account.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Account.Audit.Updated.ById": { "type": "string" }, "Account.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Account.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Audit.Updated.By.Name": { "type": "string" }, "Account.Audit.Updated.By.Icon": { "type": "string" }, "Account.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Account.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Account.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Account.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Account.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Account.Audit.Updated.By.Id": { "type": "string" }, "Account.Id": { "type": "string" }, "Buyer.ExternalIds.ErpCompanyContact": { "type": "string" }, "Buyer.ExternalIds.ErpCustomer": { "type": "string" }, "Buyer.ExternalIds.AccountExternalId": { "type": "string" }, "Buyer.Status": { "allOf": [ { "$ref": "#/components/schemas/BuyerStatus" } ] }, "Buyer.Address.AddressLine1": { "type": "string" }, "Buyer.Address.AddressLine2": { "type": "string" }, "Buyer.Address.PostCode": { "type": "string" }, "Buyer.Address.City": { "type": "string" }, "Buyer.Address.State": { "type": "string" }, "Buyer.Address.Country": { "type": "string" }, "Buyer.TaxId": { "type": "string" }, "Buyer.Account.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Buyer.Account.ExternalId": { "type": "string" }, "Buyer.Account.ExternalName": { "type": "string" }, "Buyer.Account.Address.AddressLine1": { "type": "string" }, "Buyer.Account.Address.AddressLine2": { "type": "string" }, "Buyer.Account.Address.PostCode": { "type": "string" }, "Buyer.Account.Address.City": { "type": "string" }, "Buyer.Account.Address.State": { "type": "string" }, "Buyer.Account.Address.Country": { "type": "string" }, "Buyer.Account.TechnicalSupportEmail": { "type": "string" }, "Buyer.Account.Website": { "type": "string" }, "Buyer.Account.Description": { "type": "string" }, "Buyer.Account.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Buyer.Account.Eligibility.Client": { "type": "boolean" }, "Buyer.Account.Eligibility.Partner": { "type": "boolean" }, "Buyer.Account.DefaultLanguageCode": { "type": "string" }, "Buyer.Account.Type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ] }, "Buyer.Account.Status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ] }, "Buyer.Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Account.Name": { "type": "string" }, "Buyer.Account.Icon": { "type": "string" }, "Buyer.Account.Revision": { "type": "integer", "format": "int32" }, "Buyer.Account.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Account.Audit.Created.ById": { "type": "string" }, "Buyer.Account.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Buyer.Account.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Account.Audit.Created.By.Name": { "type": "string" }, "Buyer.Account.Audit.Created.By.Icon": { "type": "string" }, "Buyer.Account.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Buyer.Account.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Buyer.Account.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Account.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Account.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Account.Audit.Created.By.Id": { "type": "string" }, "Buyer.Account.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Account.Audit.Updated.ById": { "type": "string" }, "Buyer.Account.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Buyer.Account.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Account.Audit.Updated.By.Name": { "type": "string" }, "Buyer.Account.Audit.Updated.By.Icon": { "type": "string" }, "Buyer.Account.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Buyer.Account.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Account.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Buyer.Account.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Account.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Buyer.Account.Audit.Updated.By.Id": { "type": "string" }, "Buyer.Account.Id": { "type": "string" }, "Buyer.Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ParametrisedMessage" } }, "Buyer.Sellers": { "type": "array", "items": { "$ref": "#/components/schemas/Seller" } }, "Buyer.ErpLinks": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLink" } }, "Buyer.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Name": { "type": "string" }, "Buyer.Icon": { "type": "string" }, "Buyer.Revision": { "type": "integer", "format": "int32" }, "Buyer.Audit.Activated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Activated.ById": { "type": "string" }, "Buyer.Audit.Activated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Buyer.Audit.Activated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Audit.Activated.By.Name": { "type": "string" }, "Buyer.Audit.Activated.By.Icon": { "type": "string" }, "Buyer.Audit.Activated.By.Revision": { "type": "integer", "format": "int32" }, "Buyer.Audit.Activated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Activated.By.Audit.Created.ById": { "type": "string" }, "Buyer.Audit.Activated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Activated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Activated.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Audit.Activated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Activated.By.Id": { "type": "string" }, "Buyer.Audit.Unassigned.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Unassigned.ById": { "type": "string" }, "Buyer.Audit.Unassigned.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Buyer.Audit.Unassigned.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Audit.Unassigned.By.Name": { "type": "string" }, "Buyer.Audit.Unassigned.By.Icon": { "type": "string" }, "Buyer.Audit.Unassigned.By.Revision": { "type": "integer", "format": "int32" }, "Buyer.Audit.Unassigned.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Unassigned.By.Audit.Created.ById": { "type": "string" }, "Buyer.Audit.Unassigned.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Unassigned.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Unassigned.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Audit.Unassigned.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Unassigned.By.Id": { "type": "string" }, "Buyer.Audit.Disabled.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Disabled.ById": { "type": "string" }, "Buyer.Audit.Disabled.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Buyer.Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Audit.Disabled.By.Name": { "type": "string" }, "Buyer.Audit.Disabled.By.Icon": { "type": "string" }, "Buyer.Audit.Disabled.By.Revision": { "type": "integer", "format": "int32" }, "Buyer.Audit.Disabled.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Disabled.By.Audit.Created.ById": { "type": "string" }, "Buyer.Audit.Disabled.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Disabled.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Disabled.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Audit.Disabled.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Disabled.By.Id": { "type": "string" }, "Buyer.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Created.ById": { "type": "string" }, "Buyer.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Buyer.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Audit.Created.By.Name": { "type": "string" }, "Buyer.Audit.Created.By.Icon": { "type": "string" }, "Buyer.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Buyer.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Buyer.Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Created.By.Id": { "type": "string" }, "Buyer.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Updated.ById": { "type": "string" }, "Buyer.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Buyer.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Audit.Updated.By.Name": { "type": "string" }, "Buyer.Audit.Updated.By.Icon": { "type": "string" }, "Buyer.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Buyer.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Buyer.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Buyer.Audit.Updated.By.Id": { "type": "string" }, "Buyer.Id": { "type": "string" }, "Seller.ExternalId": { "type": "string" }, "Seller.Status": { "allOf": [ { "$ref": "#/components/schemas/SellerStatus" } ] }, "Seller.Currencies": { "type": "array", "items": { "$ref": "#/components/schemas/SellerCurrency" } }, "Seller.Address.AddressLine1": { "type": "string" }, "Seller.Address.AddressLine2": { "type": "string" }, "Seller.Address.PostCode": { "type": "string" }, "Seller.Address.City": { "type": "string" }, "Seller.Address.State": { "type": "string" }, "Seller.Address.Country": { "type": "string" }, "Seller.Buyers": { "type": "array", "items": { "$ref": "#/components/schemas/Buyer" } }, "Seller.ErpLink.Buyer.ExternalIds.ErpCompanyContact": { "type": "string" }, "Seller.ErpLink.Buyer.ExternalIds.ErpCustomer": { "type": "string" }, "Seller.ErpLink.Buyer.ExternalIds.AccountExternalId": { "type": "string" }, "Seller.ErpLink.Buyer.Status": { "allOf": [ { "$ref": "#/components/schemas/BuyerStatus" } ] }, "Seller.ErpLink.Buyer.Address.AddressLine1": { "type": "string" }, "Seller.ErpLink.Buyer.Address.AddressLine2": { "type": "string" }, "Seller.ErpLink.Buyer.Address.PostCode": { "type": "string" }, "Seller.ErpLink.Buyer.Address.City": { "type": "string" }, "Seller.ErpLink.Buyer.Address.State": { "type": "string" }, "Seller.ErpLink.Buyer.Address.Country": { "type": "string" }, "Seller.ErpLink.Buyer.TaxId": { "type": "string" }, "Seller.ErpLink.Buyer.Account.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Seller.ErpLink.Buyer.Account.ExternalId": { "type": "string" }, "Seller.ErpLink.Buyer.Account.ExternalName": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Address.AddressLine1": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Address.AddressLine2": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Address.PostCode": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Address.City": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Address.State": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Address.Country": { "type": "string" }, "Seller.ErpLink.Buyer.Account.TechnicalSupportEmail": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Website": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Description": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Seller.ErpLink.Buyer.Account.Eligibility.Client": { "type": "boolean" }, "Seller.ErpLink.Buyer.Account.Eligibility.Partner": { "type": "boolean" }, "Seller.ErpLink.Buyer.Account.DefaultLanguageCode": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ] }, "Seller.ErpLink.Buyer.Account.Status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ] }, "Seller.ErpLink.Buyer.Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Account.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Account.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Account.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ParametrisedMessage" } }, "Seller.ErpLink.Buyer.Sellers": { "type": "array", "items": { "$ref": "#/components/schemas/Seller" } }, "Seller.ErpLink.Buyer.ErpLinks": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLink" } }, "Seller.ErpLink.Buyer.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Audit.Activated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Activated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Buyer.Audit.Activated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Audit.Activated.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Activated.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Unassigned.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Disabled.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Buyer.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Audit.Created.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Buyer.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Audit.Updated.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Buyer.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Id": { "type": "string" }, "Seller.ErpLink.Seller.ExternalId": { "type": "string" }, "Seller.ErpLink.Seller.Status": { "allOf": [ { "$ref": "#/components/schemas/SellerStatus" } ] }, "Seller.ErpLink.Seller.Currencies": { "type": "array", "items": { "$ref": "#/components/schemas/SellerCurrency" } }, "Seller.ErpLink.Seller.Address.AddressLine1": { "type": "string" }, "Seller.ErpLink.Seller.Address.AddressLine2": { "type": "string" }, "Seller.ErpLink.Seller.Address.PostCode": { "type": "string" }, "Seller.ErpLink.Seller.Address.City": { "type": "string" }, "Seller.ErpLink.Seller.Address.State": { "type": "string" }, "Seller.ErpLink.Seller.Address.Country": { "type": "string" }, "Seller.ErpLink.Seller.Buyers": { "type": "array", "items": { "$ref": "#/components/schemas/Buyer" } }, "Seller.ErpLink.Seller.ErpLink": { "allOf": [ { "$ref": "#/components/schemas/ErpLink" } ] }, "Seller.ErpLink.Seller.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Seller.Name": { "type": "string" }, "Seller.ErpLink.Seller.Icon": { "type": "string" }, "Seller.ErpLink.Seller.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Seller.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Seller.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Seller.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Seller.Audit.Created.By.Name": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Seller.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.ErpLink.Seller.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Seller.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Seller.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Seller.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Seller.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Seller.Audit.Updated.By.Name": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Seller.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Seller.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Seller.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.ErpLink.Seller.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Seller.Id": { "type": "string" }, "Seller.ErpLink.BuyerId": { "type": "string" }, "Seller.ErpLink.SellerId": { "type": "string" }, "Seller.ErpLink.CompanyName": { "type": "string" }, "Seller.ErpLink.Status": { "allOf": [ { "$ref": "#/components/schemas/ErpLinkStatus" } ] }, "Seller.ErpLink.Note": { "type": "string" }, "Seller.ErpLink.ExternalIds.ErpCompanyContact": { "type": "string" }, "Seller.ErpLink.ExternalIds.ErpCustomer": { "type": "string" }, "Seller.ErpLink.ExternalIds.AccountExternalId": { "type": "string" }, "Seller.ErpLink.Address.AddressLine1": { "type": "string" }, "Seller.ErpLink.Address.AddressLine2": { "type": "string" }, "Seller.ErpLink.Address.PostCode": { "type": "string" }, "Seller.ErpLink.Address.City": { "type": "string" }, "Seller.ErpLink.Address.State": { "type": "string" }, "Seller.ErpLink.Address.Country": { "type": "string" }, "Seller.ErpLink.ShipTo": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLinkAddress" } }, "Seller.ErpLink.BillTo": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLinkAddress" } }, "Seller.ErpLink.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Name": { "type": "string" }, "Seller.ErpLink.Icon": { "type": "string" }, "Seller.ErpLink.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Audit.Blocked.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Blocked.ById": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Audit.Blocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Audit.Blocked.By.Name": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.Icon": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Audit.Blocked.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Blocked.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Audit.Blocked.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Blocked.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Audit.Blocked.By.Id": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Unblocked.ById": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Audit.Unblocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Audit.Unblocked.By.Name": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.Icon": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Audit.Unblocked.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Unblocked.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Audit.Unblocked.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Unblocked.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Audit.Unblocked.By.Id": { "type": "string" }, "Seller.ErpLink.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Audit.Created.By.Name": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.ErpLink.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Audit.Updated.By.Name": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.ErpLink.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Id": { "type": "string" }, "Seller.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Name": { "type": "string" }, "Seller.Icon": { "type": "string" }, "Seller.Revision": { "type": "integer", "format": "int32" }, "Seller.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Audit.Created.ById": { "type": "string" }, "Seller.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Audit.Created.By.Name": { "type": "string" }, "Seller.Audit.Created.By.Icon": { "type": "string" }, "Seller.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Audit.Created.By.Id": { "type": "string" }, "Seller.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Audit.Updated.ById": { "type": "string" }, "Seller.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Audit.Updated.By.Name": { "type": "string" }, "Seller.Audit.Updated.By.Icon": { "type": "string" }, "Seller.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.Audit.Updated.By.Id": { "type": "string" }, "Seller.Id": { "type": "string" }, "Eligibility.Client": { "type": "boolean" }, "Eligibility.Partner": { "type": "boolean" }, "Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Name": { "type": "string" }, "Icon": { "type": "string" }, "Revision": { "type": "integer", "format": "int32" }, "Audit.Disabled.At": { "type": "string", "format": "date-time" }, "Audit.Disabled.ById": { "type": "string" }, "Audit.Disabled.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Disabled.By.Name": { "type": "string" }, "Audit.Disabled.By.Icon": { "type": "string" }, "Audit.Disabled.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Disabled.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Disabled.By.Audit.Created.ById": { "type": "string" }, "Audit.Disabled.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Disabled.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Disabled.By.Audit.Updated.ById": { "type": "string" }, "Audit.Disabled.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Disabled.By.Id": { "type": "string" }, "Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Created.ById": { "type": "string" }, "Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Created.By.Name": { "type": "string" }, "Audit.Created.By.Icon": { "type": "string" }, "Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Created.By.Id": { "type": "string" }, "Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Updated.ById": { "type": "string" }, "Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Updated.By.Name": { "type": "string" }, "Audit.Updated.By.Icon": { "type": "string" }, "Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Audit.Updated.By.Id": { "type": "string" }, "Id": { "type": "string" } }, "description": "Json representation of the licensee" }, "logo": { "type": "string", "format": "binary", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } } }, "LicenseeUpdate": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/LicenseeAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "maxLength": 500, "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "maxLength": 2000, "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "maxLength": 250, "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/LicenseeStatus" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "useBuyerAddress": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "maxLength": 2000, "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "buyer": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BuyerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "seller": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SellerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "eligibility": { "allOf": [ { "$ref": "#/components/schemas/Eligibility" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ListingListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Listing" } } }, "additionalProperties": false }, "ListingUpdate": { "type": "object", "properties": { "primary": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "notes": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "eligibility": { "allOf": [ { "$ref": "#/components/schemas/ListingEligibility" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ListingUpdateDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/ListingUpdate" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ModuleListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Module" } } }, "additionalProperties": false }, "ModuleDto": { "type": "object", "properties": { "id": { "type": "string", "allOf": [ { "pattern": "^MOD-\\d\\d\\d\\d$" }, { "pattern": "^MOD-\\d\\d\\d\\d$" } ], "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ParameterDefinition": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "multiple": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayOrder": { "type": "integer", "format": "int32", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "constraints": { "allOf": [ { "$ref": "#/components/schemas/Constraints" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "options": { "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "enum": [ "SingleLineText", "MultiLineText", "Address", "Contact", "Checkbox", "Choice", "Subdomain", "Heading", "DropDown", "Email", "DataObject", "Date" ], "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "enum": [ "Active", "Deleted" ], "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "group": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ParameterGroupRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "scope": { "enum": [ "Agreement", "Item", "Subscription", "Order", "Asset" ], "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "phase": { "enum": [ "Configuration", "Order", "Fulfillment" ], "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "context": { "enum": [ "None", "Purchase", "Change", "Configuration", "Termination" ], "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "product": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "MultiLineTextOptions": { "type": "object", "properties": { "placeholderText": { "type": "string" }, "hintText": { "type": "string" }, "minChar": { "type": "integer", "format": "int32", "nullable": true }, "maxChar": { "type": "integer", "format": "int32", "nullable": true }, "defaultValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrderAssetDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/OrderAsset" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "OrderAssetListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderAsset" } } }, "additionalProperties": false }, "OrderDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/Order" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "OrderLineListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLine" } } }, "additionalProperties": false }, "OrderListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } } }, "additionalProperties": false }, "OrderNotificationRequest": { "required": [ "userId" ], "type": "object", "properties": { "userId": { "minLength": 1, "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "notifyMe": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "OrderSubscriptionDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/OrderSubscription" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "OrderSubscriptionListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderSubscription" } } }, "additionalProperties": false }, "ParameterDefinitionListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ParameterDefinition" } } }, "additionalProperties": false }, "ParameterGroup": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "label": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayOrder": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "default": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "parameterCount": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "product": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ParameterGroupListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ParameterGroup" } } }, "additionalProperties": false }, "ParameterValueDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/ParameterValueModel" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ParameterValueInput": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "value": { "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ParameterValueModel": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "value": { "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ParameterValueIReadOnlyCollectionDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ParameterValueModel" }, "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ParameterValueUpdate": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "value": { "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ParameterValueUpdateDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/ParameterValueUpdate" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ParameterValueUpdateListDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ParameterValueUpdate" }, "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PriceListItem": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PriceListItemAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "enum": [ "Draft", "Private", "ForSale" ], "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "info": { "allOf": [ { "$ref": "#/components/schemas/PriceInfo" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "reasonForChange": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Operations" ] } }, "unitLP": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unitPP": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "markup": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "margin": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "unitSP": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "PPx1": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "PPxM": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "PPxY": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "SPx1": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "SPxM": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "SPxY": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "LPx1": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "LPxM": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "LPxY": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "priceList": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PriceListRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "item": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductItemRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ParametrisedMessageDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/ParametrisedMessage" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PreValidationInput": { "type": "object", "properties": { "purchaseOrderDraft": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "purchaseOrderQuerying": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "changeOrderDraft": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "configurationOrderDraft": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "terminationOrder": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "PriceListExternalIdInput": { "type": "object", "properties": { "vendor": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "PriceListItemListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PriceListItem" } } }, "additionalProperties": false }, "PriceListItemAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "published": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unpublished": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "PriceListItemUpdate": { "type": "object", "properties": { "status": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "reasonForChange": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unitPP": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unitLP": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unitSP": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "markup": { "type": "number", "format": "double", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "info": { "allOf": [ { "$ref": "#/components/schemas/ItemPriceInfo" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "PriceListItemUpdateDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/PriceListItemUpdate" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PriceListUpdate": { "type": "object", "properties": { "externalIds": { "allOf": [ { "$ref": "#/components/schemas/UpdatePriceListExternalId" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "defaultMarkup": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "defaultMargin": { "type": "number", "format": "double", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "notes": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "PriceListListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PriceList" } } }, "additionalProperties": false }, "PriceListUpdateDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/PriceListUpdate" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ProductDocument": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "filename": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "size": { "type": "integer", "format": "int32", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contentType": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "url": { "type": "string", "readOnly": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "language": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "product": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "PricingPolicyAttachment": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "size": { "type": "integer", "format": "int32", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "fileName": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contentType": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "pricingPolicy": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PricingPolicyRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "PricingPolicyAttachmentDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/PricingPolicyAttachment" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PricingPolicyAttachmentListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PricingPolicyAttachment" } } }, "additionalProperties": false }, "PricingPolicyDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/PricingPolicy" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PricingPolicyEligibilityDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/PricingPolicyEligibility" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PricingPolicyExternalIdInput": { "type": "object", "properties": { "operations": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "PricingPolicyListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PricingPolicy" } } }, "additionalProperties": false }, "ProcessEnrollmentRequest": { "type": "object", "properties": { "template": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProductDocumentDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/ProductDocument" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ProductDocumentListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductDocument" } } }, "additionalProperties": false }, "ProductItemListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductItem" } } }, "additionalProperties": false }, "ProductMedia": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "filename": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "size": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contentType": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayOrder": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "url": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "product": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProductItemExternalIdInput": { "type": "object", "properties": { "vendor": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "operations": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProductMediaDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/ProductMedia" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ProductMediaListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductMedia" } } }, "additionalProperties": false }, "ProductListDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Product" }, "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ProductListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } } }, "additionalProperties": false }, "ProductUpdate": { "type": "object", "properties": { "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "shortDescription": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "longDescription": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/ProductExternalIdBag" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "website": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProductRequestsInput": { "type": "object", "properties": { "enabled": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "label": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProductSplitBillingRequestsInput": { "type": "object", "properties": { "enabled": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "enum": [ "OrderBased", "PercentageBased" ], "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProductUpdateWithIcon": { "type": "object", "properties": { "product": { "type": "object", "properties": { "Product.Node.Name": { "type": "string" }, "Product.Node.Children": { "type": "array", "items": { "$ref": "#/components/schemas/DeltaNode" } }, "Product.Path": { "type": "string" }, "Product.Data.Name": { "type": "string" }, "Product.Data.ShortDescription": { "type": "string" }, "Product.Data.LongDescription": { "type": "string" }, "Product.Data.ExternalIds.Operations": { "type": "string" }, "Product.Data.ExternalIds.DefaultErpItem": { "type": "string" }, "Product.Data.Website": { "type": "string" }, "Product.IsDefined": { "type": "boolean" } }, "description": "Json representation of the product", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "format": "binary", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } } }, "ProgramDocument": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/ProgramDocumentStatus" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "filename": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "size": { "type": "integer", "format": "int32", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contentType": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "url": { "type": "string", "readOnly": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "language": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "program": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProgramRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProgramDocumentDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/ProgramDocument" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ProgramDocumentListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProgramDocument" } } }, "additionalProperties": false }, "ProgramListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Program" } } }, "additionalProperties": false }, "ProgramDocumentStatus": { "enum": [ "Draft", "Published", "Unpublished" ], "type": "string" }, "ProgramEligibilityDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/ProgramEligibility" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ProgramMedia": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/ProgramMediaStatus" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "filename": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "size": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contentType": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayOrder": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "url": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "program": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProgramRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProgramMediaDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/ProgramMedia" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ProgramMediaListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProgramMedia" } } }, "additionalProperties": false }, "ProgramParameterDefinition": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "multiple": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayOrder": { "type": "integer", "format": "int32", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "constraints": { "allOf": [ { "$ref": "#/components/schemas/Constraints" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "options": { "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "enum": [ "SingleLineText", "MultiLineText", "Address", "Contact", "Checkbox", "Choice", "Subdomain", "Heading", "DropDown", "Email", "DataObject", "Date" ], "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "enum": [ "Active", "Deleted" ], "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "group": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProgramParameterGroupRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "scope": { "enum": [ "Enrollment" ], "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "phase": { "enum": [ "Order", "Fulfillment" ], "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "program": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProgramRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProgramMediaStatus": { "enum": [ "Draft", "Published", "Unpublished" ], "type": "string" }, "ProgramParameterDefinitionListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProgramParameterDefinition" } } }, "additionalProperties": false }, "ProgramParameterGroup": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "label": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayOrder": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "default": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "parameterCount": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "program": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProgramRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProgramParameterGroupDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/ProgramParameterGroup" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ProgramParameterGroupListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProgramParameterGroup" } } }, "additionalProperties": false }, "ProgramTemplateListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProgramTemplate" } } }, "additionalProperties": false }, "ProgramParameterValueBagInput": { "type": "object", "properties": { "ordering": { "type": "array", "items": { "$ref": "#/components/schemas/ProgramParameterValueInput" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "fulfillment": { "type": "array", "items": { "$ref": "#/components/schemas/ProgramParameterValueInput" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProgramParameterValueInput": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "value": { "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProgramPreValidationInput": { "type": "object", "properties": { "enrollmentDraft": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "enrollmentQuerying": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "reEnrollment": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "reEnrollmentQuerying": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "reEnrollmentDraft": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProgramTemplateUpdate": { "type": "object", "properties": { "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "default": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "content": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/ProgramTemplateExternalIdBag" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProgramTemplateExternalIdInput": { "type": "object", "properties": { "vendor": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProgramTemplateUpdateDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/ProgramTemplateUpdate" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ProgramTermsAndConditions": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/ProgramTermsAndConditionsAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayOrder": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/ProgramTermsAndConditionsStatus" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "program": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProgramRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProgramTermsAndConditionsListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProgramTermsAndConditions" } } }, "additionalProperties": false }, "ProgramTermsAndConditionsVariant": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "assetUrl": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "languageCode": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/ProgramTermsAndConditionsVariantStatus" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "filename": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "size": { "type": "integer", "format": "int32", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contentType": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "programTermsAndConditions": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProgramTermsAndConditionsRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "fileId": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProgramTermsAndConditionsStatus": { "enum": [ "Draft", "Published", "Unpublished", "Deleted" ], "type": "string" }, "ProgramTermsAndConditionsVariantListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProgramTermsAndConditionsVariant" } } }, "additionalProperties": false }, "ProgramTermsVariantUpdate": { "type": "object", "properties": { "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProgramTermsAndConditionsVariantStatus": { "enum": [ "Draft", "Published", "Unpublished", "Deleted" ], "type": "string" }, "ProgramTermsVariantUpdateDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/ProgramTermsVariantUpdate" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ProgramUpdate": { "type": "object", "properties": { "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "shortDescription": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "longDescription": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "website": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "eligibility": { "allOf": [ { "$ref": "#/components/schemas/ProgramEligibility" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "applicableTo": { "enum": [ "Buyer", "Licensee" ], "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProgramUpdateDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/ProgramUpdate" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ProgramUpdateWithIcon": { "type": "object", "properties": { "program": { "type": "object", "properties": { "Program.Node.Name": { "type": "string" }, "Program.Node.Children": { "type": "array", "items": { "$ref": "#/components/schemas/DeltaNode" } }, "Program.Path": { "type": "string" }, "Program.Data.Name": { "type": "string" }, "Program.Data.ShortDescription": { "type": "string" }, "Program.Data.LongDescription": { "type": "string" }, "Program.Data.Website": { "type": "string" }, "Program.Data.Eligibility.Client": { "type": "boolean" }, "Program.Data.Eligibility.Partner": { "type": "boolean" }, "Program.Data.ApplicableTo": { "enum": [ "Buyer", "Licensee" ], "type": "string" }, "Program.Data.Products": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" } }, "Program.IsDefined": { "type": "boolean" } }, "description": "Json representation of the program", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "format": "binary", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } } }, "DateEvent": { "type": "object", "properties": { "at": { "type": "string", "format": "date-time", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "QueryEnrollmentRequest": { "required": [ "template" ], "type": "object", "properties": { "template": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "SellerCreate": { "required": [ "currencies", "name" ], "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "maxLength": 500, "minLength": 1, "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/SellerStatus" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "currencies": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/SellerCurrency" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "erpLink": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ErpLinkRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "RangeDateParameter": { "allOf": [ { "$ref": "#/components/schemas/DateParameter" }, { "type": "object", "properties": { "start": { "type": "string", "format": "date" }, "end": { "type": "string", "format": "date" } }, "additionalProperties": false } ] }, "RequestObjectLinkDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "RequestObjectLinkListDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" }, "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "SelectionOption": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SellerListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Seller" } } }, "additionalProperties": false }, "SellerUpdateWithIcon": { "type": "object", "properties": { "seller": { "type": "object", "properties": { "Seller.Node.Name": { "type": "string" }, "Seller.Node.Children": { "type": "array", "items": { "$ref": "#/components/schemas/DeltaNode" } }, "Seller.Path": { "type": "string" }, "Seller.Data.ExternalId": { "type": "string" }, "Seller.Data.Status": { "allOf": [ { "$ref": "#/components/schemas/SellerStatus" } ] }, "Seller.Data.Currencies": { "type": "array", "items": { "$ref": "#/components/schemas/SellerCurrency" } }, "Seller.Data.Address.AddressLine1": { "type": "string" }, "Seller.Data.Address.AddressLine2": { "type": "string" }, "Seller.Data.Address.PostCode": { "type": "string" }, "Seller.Data.Address.City": { "type": "string" }, "Seller.Data.Address.State": { "type": "string" }, "Seller.Data.Address.Country": { "type": "string" }, "Seller.Data.Buyers": { "type": "array", "items": { "$ref": "#/components/schemas/Buyer" } }, "Seller.Data.ErpLink.Buyer.ExternalIds.ErpCompanyContact": { "type": "string" }, "Seller.Data.ErpLink.Buyer.ExternalIds.ErpCustomer": { "type": "string" }, "Seller.Data.ErpLink.Buyer.ExternalIds.AccountExternalId": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Status": { "allOf": [ { "$ref": "#/components/schemas/BuyerStatus" } ] }, "Seller.Data.ErpLink.Buyer.Address.AddressLine1": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Address.AddressLine2": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Address.PostCode": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Address.City": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Address.State": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Address.Country": { "type": "string" }, "Seller.Data.ErpLink.Buyer.TaxId": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Seller.Data.ErpLink.Buyer.Account.ExternalId": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.ExternalName": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Address.AddressLine1": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Address.AddressLine2": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Address.PostCode": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Address.City": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Address.State": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Address.Country": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.TechnicalSupportEmail": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Website": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Description": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Seller.Data.ErpLink.Buyer.Account.Eligibility.Client": { "type": "boolean" }, "Seller.Data.ErpLink.Buyer.Account.Eligibility.Partner": { "type": "boolean" }, "Seller.Data.ErpLink.Buyer.Account.DefaultLanguageCode": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ] }, "Seller.Data.ErpLink.Buyer.Account.Status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ] }, "Seller.Data.ErpLink.Buyer.Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Buyer.Account.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Data.ErpLink.Buyer.Account.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Buyer.Account.Audit.Created.By.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Created.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.Data.ErpLink.Buyer.Account.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Buyer.Account.Audit.Created.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.By.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ParametrisedMessage" } }, "Seller.Data.ErpLink.Buyer.Sellers": { "type": "array", "items": { "$ref": "#/components/schemas/Seller" } }, "Seller.Data.ErpLink.Buyer.ErpLinks": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLink" } }, "Seller.Data.ErpLink.Buyer.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Buyer.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Audit.Activated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Audit.Activated.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Activated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Data.ErpLink.Buyer.Audit.Activated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Buyer.Audit.Activated.By.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Activated.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Activated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Audit.Activated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Audit.Activated.By.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Activated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Buyer.Audit.Activated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Audit.Activated.By.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Activated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Buyer.Audit.Activated.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.By.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.By.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.By.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.By.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.By.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.By.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Data.ErpLink.Buyer.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Buyer.Audit.Created.By.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Created.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Buyer.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Buyer.Audit.Created.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Data.ErpLink.Buyer.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Buyer.Audit.Updated.By.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Updated.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Buyer.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Buyer.Audit.Updated.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Id": { "type": "string" }, "Seller.Data.ErpLink.Seller.ExternalId": { "type": "string" }, "Seller.Data.ErpLink.Seller.Status": { "allOf": [ { "$ref": "#/components/schemas/SellerStatus" } ] }, "Seller.Data.ErpLink.Seller.Currencies": { "type": "array", "items": { "$ref": "#/components/schemas/SellerCurrency" } }, "Seller.Data.ErpLink.Seller.Address.AddressLine1": { "type": "string" }, "Seller.Data.ErpLink.Seller.Address.AddressLine2": { "type": "string" }, "Seller.Data.ErpLink.Seller.Address.PostCode": { "type": "string" }, "Seller.Data.ErpLink.Seller.Address.City": { "type": "string" }, "Seller.Data.ErpLink.Seller.Address.State": { "type": "string" }, "Seller.Data.ErpLink.Seller.Address.Country": { "type": "string" }, "Seller.Data.ErpLink.Seller.Buyers": { "type": "array", "items": { "$ref": "#/components/schemas/Buyer" } }, "Seller.Data.ErpLink.Seller.ErpLink": { "allOf": [ { "$ref": "#/components/schemas/ErpLink" } ] }, "Seller.Data.ErpLink.Seller.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Seller.Name": { "type": "string" }, "Seller.Data.ErpLink.Seller.Icon": { "type": "string" }, "Seller.Data.ErpLink.Seller.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Seller.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Seller.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Seller.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Data.ErpLink.Seller.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Seller.Audit.Created.By.Name": { "type": "string" }, "Seller.Data.ErpLink.Seller.Audit.Created.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Seller.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Seller.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.Data.ErpLink.Seller.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Seller.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Seller.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Seller.Audit.Created.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Seller.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Seller.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Seller.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Data.ErpLink.Seller.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Seller.Audit.Updated.By.Name": { "type": "string" }, "Seller.Data.ErpLink.Seller.Audit.Updated.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Seller.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Seller.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Seller.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Seller.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Seller.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.Data.ErpLink.Seller.Audit.Updated.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Seller.Id": { "type": "string" }, "Seller.Data.ErpLink.BuyerId": { "type": "string" }, "Seller.Data.ErpLink.SellerId": { "type": "string" }, "Seller.Data.ErpLink.CompanyName": { "type": "string" }, "Seller.Data.ErpLink.Status": { "allOf": [ { "$ref": "#/components/schemas/ErpLinkStatus" } ] }, "Seller.Data.ErpLink.Note": { "type": "string" }, "Seller.Data.ErpLink.ExternalIds.ErpCompanyContact": { "type": "string" }, "Seller.Data.ErpLink.ExternalIds.ErpCustomer": { "type": "string" }, "Seller.Data.ErpLink.ExternalIds.AccountExternalId": { "type": "string" }, "Seller.Data.ErpLink.Address.AddressLine1": { "type": "string" }, "Seller.Data.ErpLink.Address.AddressLine2": { "type": "string" }, "Seller.Data.ErpLink.Address.PostCode": { "type": "string" }, "Seller.Data.ErpLink.Address.City": { "type": "string" }, "Seller.Data.ErpLink.Address.State": { "type": "string" }, "Seller.Data.ErpLink.Address.Country": { "type": "string" }, "Seller.Data.ErpLink.ShipTo": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLinkAddress" } }, "Seller.Data.ErpLink.BillTo": { "type": "array", "items": { "$ref": "#/components/schemas/ErpLinkAddress" } }, "Seller.Data.ErpLink.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Name": { "type": "string" }, "Seller.Data.ErpLink.Icon": { "type": "string" }, "Seller.Data.ErpLink.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Audit.Blocked.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Audit.Blocked.ById": { "type": "string" }, "Seller.Data.ErpLink.Audit.Blocked.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Data.ErpLink.Audit.Blocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Audit.Blocked.By.Name": { "type": "string" }, "Seller.Data.ErpLink.Audit.Blocked.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Audit.Blocked.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Audit.Blocked.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Audit.Blocked.By.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Audit.Blocked.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Audit.Blocked.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Audit.Blocked.By.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Audit.Blocked.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Audit.Blocked.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Audit.Unblocked.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Audit.Unblocked.ById": { "type": "string" }, "Seller.Data.ErpLink.Audit.Unblocked.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Data.ErpLink.Audit.Unblocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Audit.Unblocked.By.Name": { "type": "string" }, "Seller.Data.ErpLink.Audit.Unblocked.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Audit.Unblocked.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Audit.Unblocked.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Audit.Unblocked.By.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Audit.Unblocked.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Audit.Unblocked.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Audit.Unblocked.By.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Audit.Unblocked.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Audit.Unblocked.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Data.ErpLink.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Audit.Created.By.Name": { "type": "string" }, "Seller.Data.ErpLink.Audit.Created.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Audit.Created.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Data.ErpLink.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Audit.Updated.By.Name": { "type": "string" }, "Seller.Data.ErpLink.Audit.Updated.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.ErpLink.Audit.Updated.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Id": { "type": "string" }, "Seller.Data.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.Name": { "type": "string" }, "Seller.Data.Icon": { "type": "string" }, "Seller.Data.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.Audit.Created.ById": { "type": "string" }, "Seller.Data.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Data.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.Audit.Created.By.Name": { "type": "string" }, "Seller.Data.Audit.Created.By.Icon": { "type": "string" }, "Seller.Data.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.Data.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.Data.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.Audit.Created.By.Id": { "type": "string" }, "Seller.Data.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.Audit.Updated.ById": { "type": "string" }, "Seller.Data.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "Seller.Data.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.Audit.Updated.By.Name": { "type": "string" }, "Seller.Data.Audit.Updated.By.Icon": { "type": "string" }, "Seller.Data.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "Seller.Data.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.Data.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "Seller.Data.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "Seller.Data.Audit.Updated.By.Id": { "type": "string" }, "Seller.Data.Id": { "type": "string" }, "Seller.IsDefined": { "type": "boolean" } }, "description": "Json representation of the seller", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "logo": { "type": "string", "format": "binary", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } } }, "Service": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ServiceListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Service" } } }, "additionalProperties": false }, "TemplateListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Template" } } }, "additionalProperties": false }, "SetNumberFormatDto": { "type": "object", "properties": { "decimalSeparator": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "groupSeparator": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "SetPasswordDto": { "required": [ "password" ], "type": "object", "properties": { "password": { "minLength": 1, "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "currentPassword": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "SetPhoneNumberDto": { "type": "object", "properties": { "prefix": { "maxLength": 10, "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "number": { "maxLength": 15, "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "SetUserSettingsDto": { "type": "object", "properties": { "cultureCode": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "dateFormat": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "languageCode": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "numberFormat": { "allOf": [ { "$ref": "#/components/schemas/SetNumberFormatDto" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "timeFormat": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "timeZone": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "SingleLineTextOptions": { "type": "object", "properties": { "placeholderText": { "type": "string" }, "hintText": { "type": "string" }, "pattern": { "type": "string", "nullable": true }, "minChar": { "type": "integer", "format": "int32", "nullable": true }, "maxChar": { "type": "integer", "format": "int32", "nullable": true }, "defaultValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SplitBillingAgreementDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/SplitBillingAgreement" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "SplitBillingSubscriptionDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/SplitBillingSubscription" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "StringJsonOptional": { "type": "object", "properties": { "hasValue": { "type": "boolean", "readOnly": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StringStringDictionaryJsonOptional": { "type": "object", "properties": { "hasValue": { "type": "boolean", "readOnly": true }, "value": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "SubdomainOptions": { "type": "object", "properties": { "placeholderText": { "type": "string" }, "hintText": { "type": "string" }, "domainSuffix": { "type": "string" } }, "additionalProperties": false }, "SubscriptionCessationInput": { "type": "object", "properties": { "enabled": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "mode": { "enum": [ "Termination", "Auto-renewal", "Termination or auto-renewal" ], "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "SubscriptionDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/Subscription" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "SubscriptionListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription" } } }, "additionalProperties": false }, "TemplateUpdate": { "type": "object", "properties": { "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "default": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "content": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/TemplateExternalIdBag" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "TemplateExternalIdInput": { "type": "object", "properties": { "vendor": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "TemplateUpdateDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/TemplateUpdate" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "TermsAndConditions": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/TermsAndConditionsAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayOrder": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "product": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "TerminateCertificateRequest": { "required": [ "statusNotes" ], "type": "object", "properties": { "statusNotes": { "allOf": [ { "$ref": "#/components/schemas/ParametrisedMessage" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Terms": { "type": "object", "properties": { "model": { "enum": [ "one-time", "usage", "quantity" ], "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "period": { "enum": [ "1m", "1y", "one-time" ], "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "commitment": { "enum": [ "1m", "1y", "3y" ], "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "TermsAndConditionsListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/TermsAndConditions" } } }, "additionalProperties": false }, "TermsAndConditionsVariant": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "assetUrl": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "languageCode": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "filename": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "size": { "type": "integer", "format": "int32", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contentType": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "termsAndConditions": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/TermsAndConditionsRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "fileId": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "TermsAndConditionsVariantListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/TermsAndConditionsVariant" } } }, "additionalProperties": false }, "TermsVariantUpdate": { "type": "object", "properties": { "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "TermsVariantUpdateDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/TermsVariantUpdate" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "UpdateParameter": { "type": "object", "properties": { "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayOrder": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "constraints": { "allOf": [ { "$ref": "#/components/schemas/Constraints" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "options": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AddressOptions" }, { "$ref": "#/components/schemas/CheckboxOptions" }, { "$ref": "#/components/schemas/ChoiceOptions" }, { "$ref": "#/components/schemas/DataObjectOptions" }, { "$ref": "#/components/schemas/ContactOptions" }, { "$ref": "#/components/schemas/DateOptions" }, { "$ref": "#/components/schemas/DropDownOptions" }, { "$ref": "#/components/schemas/EmailOptions" }, { "$ref": "#/components/schemas/HeadingOptions" }, { "$ref": "#/components/schemas/MultiLineTextOptions" }, { "$ref": "#/components/schemas/SingleLineTextOptions" }, { "$ref": "#/components/schemas/SubdomainOptions" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "group": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UnitOfMeasureListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/UnitOfMeasure" } } }, "additionalProperties": false }, "UpdateCertificateParameterBag": { "type": "object", "properties": { "ordering": { "type": "array", "items": { "$ref": "#/components/schemas/ParameterValueUpdate" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "fulfillment": { "type": "array", "items": { "$ref": "#/components/schemas/ParameterValueUpdate" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UpdateEnrollmentParameterBag": { "type": "object", "properties": { "ordering": { "type": "array", "items": { "$ref": "#/components/schemas/ExtendedParameterValue" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "fulfillment": { "type": "array", "items": { "$ref": "#/components/schemas/ExtendedParameterValue" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UpdateItemGroupRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "label": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayOrder": { "type": "integer", "format": "int32", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "multiple": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "required": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "default": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UpdateParameterGroupRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "label": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayOrder": { "type": "integer", "format": "int32", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "default": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UpdateParameterDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/UpdateParameter" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "UpdatePriceListExternalId": { "type": "object", "properties": { "vendor": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UpdateProductItem": { "type": "object", "properties": { "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/ProductItemExternalIdBag" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "group": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unit": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/ParameterValueModel" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UpdateProductItemDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/UpdateProductItem" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "UpdateProgramParameter": { "type": "object", "properties": { "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayOrder": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "constraints": { "allOf": [ { "$ref": "#/components/schemas/Constraints" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "options": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AddressOptions" }, { "$ref": "#/components/schemas/CheckboxOptions" }, { "$ref": "#/components/schemas/ChoiceOptions" }, { "$ref": "#/components/schemas/DataObjectOptions" }, { "$ref": "#/components/schemas/ContactOptions" }, { "$ref": "#/components/schemas/DateOptions" }, { "$ref": "#/components/schemas/DropDownOptions" }, { "$ref": "#/components/schemas/EmailOptions" }, { "$ref": "#/components/schemas/HeadingOptions" }, { "$ref": "#/components/schemas/MultiLineTextOptions" }, { "$ref": "#/components/schemas/SingleLineTextOptions" }, { "$ref": "#/components/schemas/SubdomainOptions" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "group": { "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UpdateProgramParameterDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/UpdateProgramParameter" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "UserExtendedAccount": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/AccountExternalIds" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalName": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "technicalSupportEmail": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "website": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupRef" }, "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "eligibility": { "allOf": [ { "$ref": "#/components/schemas/Eligibility" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "defaultLanguageCode": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "invitation": { "allOf": [ { "$ref": "#/components/schemas/InvitationQueryModel" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "favorite": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/UserExtendedAccountAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UpdateProgramTermsAndConditionsRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayOrder": { "type": "integer", "format": "int32", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UpdateTermsAndConditionsRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayOrder": { "type": "integer", "format": "int32", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UpdateUnitOfMeasureRequest": { "type": "object", "properties": { "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UpdateUserWithIconDto": { "type": "object", "properties": { "user": { "type": "object", "properties": { "User.Node.Name": { "type": "string" }, "User.Node.Children": { "type": "array", "items": { "$ref": "#/components/schemas/DeltaNode" } }, "User.Path": { "type": "string" }, "User.Data.Email": { "type": "string" }, "User.Data.Status": { "type": "string" }, "User.Data.Phone.Prefix": { "type": "string" }, "User.Data.Phone.Number": { "type": "string" }, "User.Data.FirstName": { "type": "string" }, "User.Data.LastName": { "type": "string" }, "User.Data.LastLoginAt": { "type": "string", "format": "date-time" }, "User.Data.Settings.CultureCode": { "type": "string" }, "User.Data.Settings.DateFormat": { "type": "string" }, "User.Data.Settings.LanguageCode": { "type": "string" }, "User.Data.Settings.NumberFormat.DecimalSeparator": { "type": "string" }, "User.Data.Settings.NumberFormat.GroupSeparator": { "type": "string" }, "User.Data.Settings.TimeFormat": { "type": "string" }, "User.Data.Settings.TimeZone": { "type": "string" }, "User.Data.Accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } }, "User.Data.CurrentAccount.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "User.Data.CurrentAccount.ExternalId": { "type": "string" }, "User.Data.CurrentAccount.ExternalName": { "type": "string" }, "User.Data.CurrentAccount.Address.AddressLine1": { "type": "string" }, "User.Data.CurrentAccount.Address.AddressLine2": { "type": "string" }, "User.Data.CurrentAccount.Address.PostCode": { "type": "string" }, "User.Data.CurrentAccount.Address.City": { "type": "string" }, "User.Data.CurrentAccount.Address.State": { "type": "string" }, "User.Data.CurrentAccount.Address.Country": { "type": "string" }, "User.Data.CurrentAccount.TechnicalSupportEmail": { "type": "string" }, "User.Data.CurrentAccount.Website": { "type": "string" }, "User.Data.CurrentAccount.Description": { "type": "string" }, "User.Data.CurrentAccount.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "User.Data.CurrentAccount.Eligibility.Client": { "type": "boolean" }, "User.Data.CurrentAccount.Eligibility.Partner": { "type": "boolean" }, "User.Data.CurrentAccount.DefaultLanguageCode": { "type": "string" }, "User.Data.CurrentAccount.Type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ] }, "User.Data.CurrentAccount.Status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ] }, "User.Data.CurrentAccount.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "User.Data.CurrentAccount.Name": { "type": "string" }, "User.Data.CurrentAccount.Icon": { "type": "string" }, "User.Data.CurrentAccount.Revision": { "type": "integer", "format": "int32" }, "User.Data.CurrentAccount.Audit.Created.At": { "type": "string", "format": "date-time" }, "User.Data.CurrentAccount.Audit.Created.ById": { "type": "string" }, "User.Data.CurrentAccount.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "User.Data.CurrentAccount.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "User.Data.CurrentAccount.Audit.Created.By.Name": { "type": "string" }, "User.Data.CurrentAccount.Audit.Created.By.Icon": { "type": "string" }, "User.Data.CurrentAccount.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "User.Data.CurrentAccount.Audit.Created.By.Audit.Created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "User.Data.CurrentAccount.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "User.Data.CurrentAccount.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "User.Data.CurrentAccount.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "User.Data.CurrentAccount.Audit.Created.By.Id": { "type": "string" }, "User.Data.CurrentAccount.Audit.Updated.At": { "type": "string", "format": "date-time" }, "User.Data.CurrentAccount.Audit.Updated.ById": { "type": "string" }, "User.Data.CurrentAccount.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "User.Data.CurrentAccount.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "User.Data.CurrentAccount.Audit.Updated.By.Name": { "type": "string" }, "User.Data.CurrentAccount.Audit.Updated.By.Icon": { "type": "string" }, "User.Data.CurrentAccount.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "User.Data.CurrentAccount.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "User.Data.CurrentAccount.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "User.Data.CurrentAccount.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "User.Data.CurrentAccount.Audit.Updated.By.Audit.Updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ] }, "User.Data.CurrentAccount.Audit.Updated.By.Id": { "type": "string" }, "User.Data.CurrentAccount.Id": { "type": "string" }, "User.Data.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "User.Data.Name": { "type": "string" }, "User.Data.Icon": { "type": "string" }, "User.Data.Revision": { "type": "integer", "format": "int32" }, "User.Data.Audit.InvitationAcceptedAt": { "type": "string", "format": "date-time" }, "User.Data.Audit.Created.At": { "type": "string", "format": "date-time" }, "User.Data.Audit.Created.ById": { "type": "string" }, "User.Data.Audit.Created.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "User.Data.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "User.Data.Audit.Created.By.Name": { "type": "string" }, "User.Data.Audit.Created.By.Icon": { "type": "string" }, "User.Data.Audit.Created.By.Revision": { "type": "integer", "format": "int32" }, "User.Data.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "User.Data.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "User.Data.Audit.Created.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "User.Data.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "User.Data.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "User.Data.Audit.Created.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "User.Data.Audit.Created.By.Id": { "type": "string" }, "User.Data.Audit.Updated.At": { "type": "string", "format": "date-time" }, "User.Data.Audit.Updated.ById": { "type": "string" }, "User.Data.Audit.Updated.By.Type": { "allOf": [ { "$ref": "#/components/schemas/IdentityType" } ] }, "User.Data.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "User.Data.Audit.Updated.By.Name": { "type": "string" }, "User.Data.Audit.Updated.By.Icon": { "type": "string" }, "User.Data.Audit.Updated.By.Revision": { "type": "integer", "format": "int32" }, "User.Data.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "User.Data.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "User.Data.Audit.Updated.By.Audit.Created.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "User.Data.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "User.Data.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "User.Data.Audit.Updated.By.Audit.Updated.By": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ] }, "User.Data.Audit.Updated.By.Id": { "type": "string" }, "User.Data.Id": { "type": "string" }, "User.IsDefined": { "type": "boolean" } }, "description": "Json representation of the user", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "format": "binary", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } } }, "UpdateWebhookRequest": { "type": "object", "properties": { "webhookId": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "allOf": [ { "$ref": "#/components/schemas/StringJsonOptional" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "url": { "allOf": [ { "$ref": "#/components/schemas/UriJsonOptional" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "criteria": { "allOf": [ { "$ref": "#/components/schemas/StringStringDictionaryJsonOptional" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "secret": { "allOf": [ { "$ref": "#/components/schemas/StringJsonOptional" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "lastCall": { "allOf": [ { "$ref": "#/components/schemas/LastWebhookCallDetailsJsonOptional" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UriJsonOptional": { "type": "object", "properties": { "hasValue": { "type": "boolean", "readOnly": true }, "value": { "type": "string", "format": "uri", "nullable": true } }, "additionalProperties": false }, "UserExtendedAccountAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "invited": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "joined": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "access": { "allOf": [ { "$ref": "#/components/schemas/DateEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UserExtendedAccountDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/UserExtendedAccount" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "UserExtendedAccountListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserExtendedAccount" } } }, "additionalProperties": false }, "UserGroupDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/UserGroup" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "UserGroupDto": { "type": "object", "properties": { "id": { "type": "string", "allOf": [ { "pattern": "^UGR-\\d\\d\\d\\d-\\d\\d\\d\\d$" }, { "pattern": "^UGR-\\d\\d\\d\\d-\\d\\d\\d\\d$" } ], "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UserGroupListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } } }, "additionalProperties": false }, "UserDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/User" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "UserProfileDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "email": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/EmailDto" } ], "format": "email", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "firstName": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "lastName": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "phone": { "allOf": [ { "$ref": "#/components/schemas/SetPhoneNumberDto" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "settings": { "allOf": [ { "$ref": "#/components/schemas/SetUserSettingsDto" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "notes": { "maxLength": 2000, "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UserListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } }, "additionalProperties": false }, "TaskRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/TaskStatus" } ], "description": "Task status: a new task is created in the Queued (default) or Blocked status.", "nullable": true, "example": "Queued", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "code": { "type": "string", "description": "Task code for the workflow, prefixed with the service namespace.", "example": "platform.accounts.buyers.transfer", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "The Task represents the state of an asynchronous, usually long running operation." }, "Webhook": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "url": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/WebhookStatus" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "allOf": [ { "$ref": "#/components/schemas/WebhookType" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "secret": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "statistics": { "allOf": [ { "$ref": "#/components/schemas/WebhookStatistics" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "objectType": { "allOf": [ { "$ref": "#/components/schemas/WebhookObjectType" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "object": { "allOf": [ { "$ref": "#/components/schemas/WebhookObjectRef" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "criteria": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookCriteria" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "lastSuccess": { "allOf": [ { "$ref": "#/components/schemas/WebhookCall" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "lastFailure": { "allOf": [ { "$ref": "#/components/schemas/WebhookCall" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "lastCall": { "allOf": [ { "$ref": "#/components/schemas/WebhookCall" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "WebhookCall": { "type": "object", "properties": { "success": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "callTime": { "type": "string", "format": "date-time", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "responseTime": { "type": "string", "format": "date-time", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "headers": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "error": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "response": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "reasonPhrase": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "httpStatusCode": { "allOf": [ { "$ref": "#/components/schemas/HttpStatusCode" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "WebhookCriteria": { "type": "object", "properties": { "key": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "value": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "WebhookListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook" } } }, "additionalProperties": false }, "WebhookObjectRef": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "WebhookObjectType": { "enum": [ "Order", "Request", "Account", "Enrollment", "Answer" ], "type": "string" }, "WebhookStatistics": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "successes": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "failures": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "failuresSinceLastSuccess": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "WebhookStatus": { "enum": [ "Enabled", "Disabled" ], "type": "string" }, "WebhookType": { "enum": [ "ValidatePurchaseOrderDraft", "ValidatePurchaseOrderQuerying", "ValidateChangeOrderDraft", "ValidateTerminateOrder", "SelectOrderLines", "ValidateEnrollmentDraft", "ValidateEnrollmentQuerying", "ValidateReEnrollment", "ValidateReEnrollmentQuerying", "ValidateConfigurationOrderDraft", "ValidateAnswer" ], "type": "string" }, "Answer": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/AnswerAudit" } ], "description": "Audit information for answer lifecycle events", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "form": { "allOf": [ { "$ref": "#/components/schemas/Form" } ], "description": "The parent form that defines the structure of this answer", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "chat": { "allOf": [ { "$ref": "#/components/schemas/Chat" } ], "description": "The chat this answer belongs to", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/AnswerStatus" } ], "description": "The current lifecycle status of the answer", "example": "Draft", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/AnswerParameter" }, "description": "Flat list of parameter values for this answer, each referencing a ParameterDefinition and optionally belonging to one or more groups", "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "isDeleted": { "type": "boolean", "description": "Indicates whether the answer has been soft-deleted", "example": false, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "A form submission within a chat, containing parameter values filled by participants" }, "AnswerAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "deleted": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "The soft-deletion event details", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "submitted": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "The submission event details", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "queried": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "The query (change request) event details", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "accepted": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "The acceptance event details", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Audit information for answer lifecycle events" }, "AnswerDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/Answer" } ], "description": "A form submission within a chat, containing parameter values filled by participants", "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "AnswerListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Answer" } } }, "additionalProperties": false }, "AnswerParameter": { "type": "object", "properties": { "id": { "type": "string", "description": "Reference to the original ParameterDefinition ID", "example": "PDE-1234-5678-9012", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "description": "Snapshot of the parameter name from the ParameterDefinition at creation time", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "description": "The external identifier from the ParameterDefinition, used as alternate lookup key", "nullable": true, "example": "customer-name", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "allOf": [ { "$ref": "#/components/schemas/ParameterType" } ], "description": "Gets or sets the type of the parameter.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "value": { "allOf": [ { "$ref": "#/components/schemas/JsonNode" } ], "description": "The user-provided value, null when unfilled", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayValue": { "type": "string", "description": "Gets or sets the human-readable display representation of Mpt.Helpdesk.Models.Answers.AnswerParameter.Value.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "constraints": { "allOf": [ { "$ref": "#/components/schemas/HelpdeskConstraints" } ], "description": "Constraints for this parameter instance, initially copied from definition and overridable by the assignee", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "error": { "allOf": [ { "$ref": "#/components/schemas/ErrorDetails" } ], "description": "Structured error on this parameter, set by the assignee (manual) or by automated validation (system errors E000001/E000002)", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/OrderedParameterGroupRef" }, "description": "The parameter groups this parameter belongs to, stored as IDs in the database and resolved to full objects at query time", "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "A parameter value within an answer, identified by its ParameterDefinition ID" }, "AnswerStatus": { "enum": [ "Draft", "Submitted", "Querying", "Accepted" ], "type": "string", "description": "Defines the lifecycle status of an answer in the helpdesk system" }, "CancellationToken": { "type": "object", "properties": { "isCancellationRequested": { "type": "boolean", "readOnly": true }, "canBeCanceled": { "type": "boolean", "readOnly": true }, "waitHandle": { "allOf": [ { "$ref": "#/components/schemas/WaitHandle" } ], "readOnly": true } }, "additionalProperties": false }, "Chat": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "description": "Gets or sets the description associated with the chat.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "allOf": [ { "$ref": "#/components/schemas/ChatType" } ], "description": "Represents the type of chat, indicating whether it is a direct message, group chat, channel, or support case.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "participants": { "type": "array", "items": { "$ref": "#/components/schemas/ChatParticipantRef" }, "description": "Represents the participants in the chat.", "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "lastMessage": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ChatMessageRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/ChatAttachmentRef" }, "description": "Represents the attachments associated with the chat.", "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ChatAttachment": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/ChatAttachmentAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "chat": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ChatRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/FileStatus" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "file": { "allOf": [ { "$ref": "#/components/schemas/File" } ], "description": "Represents the file this attachment belongs to.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ChatAttachmentAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "deleted": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ChatAttachmentDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/ChatAttachment" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ChatAttachmentListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ChatAttachment" } } }, "additionalProperties": false }, "ChatDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/Chat" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ChatLink": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/ChatLinkAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "message": { "allOf": [ { "$ref": "#/components/schemas/ChatMessage" } ], "description": "Represents the message this link belongs to.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "chat": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ChatRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "uri": { "type": "string", "description": "Represents the URI for link.", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "objectId": { "type": "string", "description": "Represents the ObjectId for link.", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ChatLinkAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "deleted": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ChatLinkDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/ChatLink" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ChatLinkListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ChatLink" } } }, "additionalProperties": false }, "ChatListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Chat" } } }, "additionalProperties": false }, "ChatMessage": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/ChatMessageAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "chat": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ChatRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "sender": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ChatParticipantRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "content": { "type": "string", "description": "Content of the chat message.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "visibility": { "allOf": [ { "$ref": "#/components/schemas/MessageVisibility" } ], "description": "Visibility of the chat message, indicating whether it is public or private.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "isDeleted": { "type": "boolean", "description": "Set to true when the message should be considered deleted", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/ChatLinkRef" }, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "identity": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PlatformIdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ChatMessageAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "deleted": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "madePublic": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "madePrivate": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ChatMessageDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/ChatMessage" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ChatMessageListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ChatMessage" } } }, "additionalProperties": false }, "ChatParticipant": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/ChatParticipantAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "chat": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ChatRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "contact": { "allOf": [ { "$ref": "#/components/schemas/Contact" } ], "description": "Represents the contact information of the participant", "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "identity": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PlatformIdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "muted": { "type": "boolean", "description": "Flag indicates whether participant should be notified of new messages in the chat.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/ParticipantStatus" } ], "description": "Represents the status of the chat participant, indicating whether they are active, suspended, or exited.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "lastReadMessage": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ChatMessageRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "unreadMessageCount": { "type": "integer", "description": "The count of messages in the chat not read by this participant.", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ChatParticipantAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "exited": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "reactivated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ChatParticipantDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/ChatParticipant" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ChatParticipantListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ChatParticipant" } } }, "additionalProperties": false }, "ChatType": { "enum": [ "Direct", "Group", "Channel", "Case" ], "type": "string" }, "ErrorDetails": { "type": "object", "properties": { "id": { "type": "string", "description": "The error code identifying system-generated errors, null for manual errors set by the assignee", "nullable": true, "example": "E000001", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "message": { "type": "string", "description": "Human-readable error description", "nullable": true, "example": "Required field is empty", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Structured error details for an answer parameter" }, "Feedback": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "description": "Gets or sets the description associated with the feedback.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "requester": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PlatformIdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/FeedbackStatus" } ], "description": "Gets or sets the status associated with the feedback.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "rating": { "type": "integer", "description": "Gets or sets the rating associated with the feedback.", "format": "int32", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "notes": { "type": "string", "description": "Gets or sets the notes associated with the feedback.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "internalNotes": { "type": "string", "description": "Gets or sets the internal notes associated with the feedback.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Operations" ] } }, "externalId": { "type": "string", "description": "Gets or sets the externalId associated with the feedback.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Operations" ] } }, "metaData": { "description": "Gets the metadata as a JSON document (read-only).", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/FeedbackAttachmentRef" }, "description": "Represents the attachments associated with the feedback.", "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "FeedbackAttachment": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/FeedbackAttachmentAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "feedback": { "allOf": [ { "$ref": "#/components/schemas/Feedback" } ], "description": "Represents the feedback this attachment belongs to.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/FileStatus" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "file": { "allOf": [ { "$ref": "#/components/schemas/File" } ], "description": "Represents the file this attachment belongs to.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "description": "Represents the name this attachment.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "description": "Represents the description this attachment.", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "FeedbackAttachmentAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "deleted": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "FeedbackAttachmentDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/FeedbackAttachment" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "FeedbackAttachmentListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FeedbackAttachment" } } }, "additionalProperties": false }, "FeedbackDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/Feedback" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "FeedbackListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Feedback" } } }, "additionalProperties": false }, "FeedbackStatus": { "enum": [ "Submitted", "Reviewed", "Deleted" ], "type": "string" }, "File": { "type": "object", "properties": { "id": { "type": "string" }, "audit": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectAudit" } ] }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string" }, "icon": { "type": "string", "nullable": true }, "revision": { "type": "integer", "format": "int32" }, "type": { "allOf": [ { "$ref": "#/components/schemas/FileType" } ], "description": "Specifies the type of the file, such as attachment or icon", "example": "Icon" }, "filename": { "type": "string", "description": "Represents the name of the file associated with the attachment.", "example": "report.pdf" }, "size": { "type": "integer", "description": "Indicates the size of the file in bytes.", "format": "int64", "nullable": true, "example": 102400 }, "contentType": { "type": "string", "description": "Represents the MIME type of the file content.", "example": "application/pdf" } }, "additionalProperties": false, "description": "Represents a file in the helpdesk module" }, "FileStatus": { "enum": [ "Active", "Deleted" ], "type": "string" }, "FileType": { "enum": [ "Attachment", "Icon", "Image", "Video" ], "type": "string" }, "Form": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/FormAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "description": "Gets or sets the description associated with the form.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/FormStatus" } ], "description": "Gets or sets the status of the Form.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "statistics": { "allOf": [ { "$ref": "#/components/schemas/FormStatistics" } ], "description": "Gets or sets usage statistics for this form.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "isDeleted": { "type": "boolean", "description": "Indicates whether the queue has been marked as deleted.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "FormAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "deleted": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "published": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unpublished": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "FormDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/Form" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "FormListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Form" } } }, "additionalProperties": false }, "FormStatistics": { "type": "object", "properties": { "groups": { "type": "integer", "description": "The number of parameter groups assigned to this form.", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "parameters": { "type": "integer", "description": "The total number of parameter definitions across all groups in this form.", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents usage statistics for a form." }, "FormStatus": { "enum": [ "Unpublished", "Published" ], "type": "string" }, "HelpdeskConstraints": { "type": "object", "properties": { "hidden": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "readonly": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "required": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "capacity": { "allOf": [ { "$ref": "#/components/schemas/CapacitySettings" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "visibility": { "allOf": [ { "$ref": "#/components/schemas/VisibilityMode" } ], "description": "The visibility mode controlling who can see the parameter", "nullable": true, "example": "All", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Constraints specific to helpdesk parameters" }, "HelpdeskParameterDefinition": { "type": "object", "properties": { "id": { "type": "string" }, "audit": { "allOf": [ { "$ref": "#/components/schemas/ParameterDefinitionAudit" } ], "description": "Audit information for a parameter definition" }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string" }, "icon": { "type": "string", "nullable": true }, "revision": { "type": "integer", "format": "int32" }, "scope": { "allOf": [ { "$ref": "#/components/schemas/HelpdeskParameterScope" } ], "description": "The scope that defines the applicability and context of the helpdesk parameter within the system", "example": "Form" }, "phase": { "allOf": [ { "$ref": "#/components/schemas/HelpdeskParameterPhase" } ], "description": "The phase of the parameter in the helpdesk workflow", "example": "Request" }, "description": { "type": "string", "description": "The description of the parameter", "example": "Customer contact email address" }, "multiple": { "type": "boolean", "description": "Indicates whether the parameter can accept multiple values", "example": false }, "externalId": { "type": "string", "description": "The optional external identifier of the parameter for integration purposes", "nullable": true, "example": "EXT-PARAM-123" }, "displayOrder": { "type": "integer", "description": "The display order of the parameter where a lower value indicates higher priority in the display sequence", "format": "int32", "nullable": true, "example": 1 }, "constraints": { "allOf": [ { "$ref": "#/components/schemas/HelpdeskConstraints" } ], "description": "The constraints associated with the parameter including required, readonly, and visibility settings" }, "options": { "description": "The type-specific options for the parameter which vary based on the parameter type", "nullable": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/ParameterType" } ], "description": "The parameter type defining the data format and validation rules", "example": "String" }, "statistics": { "allOf": [ { "$ref": "#/components/schemas/ParameterUsageStatistics" } ], "description": "Statistics about parameter usage across cases and groups" }, "account": { "allOf": [ { "$ref": "#/components/schemas/Account" } ], "description": "The platform account that owns this parameter definition" }, "isDeleted": { "type": "boolean", "description": "Indicates whether the parameter definition has been marked as deleted." } }, "additionalProperties": false, "description": "Parameter definition in the helpdesk system" }, "HelpdeskParameterDefinitionDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/HelpdeskParameterDefinition" } ], "description": "Parameter definition in the helpdesk system", "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "HelpdeskParameterDefinitionListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/HelpdeskParameterDefinition" } } }, "additionalProperties": false }, "HelpdeskParameterGroup": { "type": "object", "properties": { "id": { "type": "string" }, "audit": { "allOf": [ { "$ref": "#/components/schemas/ParameterGroupAudit" } ] }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string" }, "icon": { "type": "string", "nullable": true }, "revision": { "type": "integer", "format": "int32" }, "label": { "type": "string", "description": "The translatable label for the parameter group", "example": "Customer Information" }, "description": { "type": "string", "description": "The optional description providing additional context for the parameter group", "nullable": true, "example": "Basic customer details and contact information" }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/OrderedParameterDefinition" }, "description": "The collection of ordered parameter definitions that belong to this parameter group" }, "account": { "allOf": [ { "$ref": "#/components/schemas/Account" } ], "description": "The platform account that owns this parameter group" }, "statistics": { "allOf": [ { "$ref": "#/components/schemas/ParameterGroupStatistics" } ], "description": "Statistics about parameter count and form usage for this parameter group" }, "isDeleted": { "type": "boolean", "description": "Indicates whether the parameter group has been marked as deleted", "example": false } }, "additionalProperties": false }, "HelpdeskParameterGroupDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/HelpdeskParameterGroup" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "HelpdeskParameterGroupListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/HelpdeskParameterGroup" } } }, "additionalProperties": false }, "HelpdeskParameterPhase": { "enum": [ "Request", "Response" ], "type": "string", "description": "Defines the phase that determines when a parameter is used in the helpdesk workflow." }, "HelpdeskParameterScope": { "enum": [ "Case", "Form" ], "type": "string", "description": "Defines the scope that determines where a parameter is applicable in the helpdesk system." }, "IntPtr": { "type": "object", "additionalProperties": false }, "MessageVisibility": { "enum": [ "Public", "Private" ], "type": "string" }, "OrderedParameterDefinition": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/ParameterDefinitionAudit" } ], "description": "Audit information for a parameter definition", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "scope": { "allOf": [ { "$ref": "#/components/schemas/HelpdeskParameterScope" } ], "description": "The scope that defines the applicability and context of the helpdesk parameter within the system", "example": "Form", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "phase": { "allOf": [ { "$ref": "#/components/schemas/HelpdeskParameterPhase" } ], "description": "The phase of the parameter in the helpdesk workflow", "example": "Request", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "description": "The description of the parameter", "example": "Customer contact email address", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "multiple": { "type": "boolean", "description": "Indicates whether the parameter can accept multiple values", "example": false, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "description": "The optional external identifier of the parameter for integration purposes", "nullable": true, "example": "EXT-PARAM-123", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayOrder": { "type": "integer", "description": "The display order of the parameter where a lower value indicates higher priority in the display sequence", "format": "int32", "nullable": true, "example": 1, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "constraints": { "allOf": [ { "$ref": "#/components/schemas/HelpdeskConstraints" } ], "description": "The constraints associated with the parameter including required, readonly, and visibility settings", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "options": { "description": "The type-specific options for the parameter which vary based on the parameter type", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "allOf": [ { "$ref": "#/components/schemas/ParameterType" } ], "description": "The parameter type defining the data format and validation rules", "example": "String", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "statistics": { "allOf": [ { "$ref": "#/components/schemas/ParameterUsageStatistics" } ], "description": "Statistics about parameter usage across cases and groups", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "isDeleted": { "type": "boolean", "description": "Indicates whether the parameter definition has been marked as deleted.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "group": { "allOf": [ { "$ref": "#/components/schemas/HelpdeskParameterGroup" } ], "description": "The parameter group that contains this parameter definition", "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Ordered parameter definition within a parameter group" }, "OrderedParameterDefinitionDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/OrderedParameterDefinition" } ], "description": "Ordered parameter definition within a parameter group", "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "OrderedParameterDefinitionListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderedParameterDefinition" } } }, "additionalProperties": false }, "OrderedParameterGroup": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/ParameterGroupAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "label": { "type": "string", "description": "The translatable label for the parameter group", "example": "Customer Information", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "description": "The optional description providing additional context for the parameter group", "nullable": true, "example": "Basic customer details and contact information", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/OrderedParameterDefinitionRef" }, "description": "The collection of ordered parameter definitions that belong to this parameter group", "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "statistics": { "allOf": [ { "$ref": "#/components/schemas/ParameterGroupStatistics" } ], "description": "Statistics about parameter count and form usage for this parameter group", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "isDeleted": { "type": "boolean", "description": "Indicates whether the parameter group has been marked as deleted", "example": false, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayOrder": { "type": "integer", "description": "The display order of this parameter group within the form", "format": "int32", "nullable": true, "example": 1, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Ordered parameter group within a form" }, "OrderedParameterGroupDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/OrderedParameterGroup" } ], "description": "Ordered parameter group within a form", "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "OrderedParameterGroupListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderedParameterGroup" } } }, "additionalProperties": false }, "ParameterDefinitionAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "deleted": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "description": "The deletion event details", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Audit information for a parameter definition" }, "ParameterGroupAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "deleted": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ParameterGroupForm": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/FormAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "description": "Gets or sets the description associated with the form.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/FormStatus" } ], "description": "Gets or sets the status of the Form.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "statistics": { "allOf": [ { "$ref": "#/components/schemas/FormStatistics" } ], "description": "Gets or sets usage statistics for this form.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "isDeleted": { "type": "boolean", "description": "Indicates whether the queue has been marked as deleted.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "A form associated with a parameter group" }, "ParameterGroupFormListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ParameterGroupForm" } } }, "additionalProperties": false }, "ParameterGroupStatistics": { "type": "object", "properties": { "parameters": { "type": "integer", "description": "The number of parameter definitions in this group", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "forms": { "type": "integer", "description": "The number of non-deleted forms this group is assigned to", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Usage statistics for a parameter group" }, "ParameterUsageStatistics": { "type": "object", "properties": { "cases": { "type": "integer", "description": "The number of cases using this parameter", "format": "int32", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "groups": { "type": "integer", "description": "The number of groups using this parameter", "format": "int32", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "forms": { "type": "integer", "description": "The number of forms using this parameter", "format": "int32", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Usage statistics for a parameter definition" }, "ParticipantStatus": { "enum": [ "Active", "Exited", "Deactivated" ], "type": "string" }, "Queue": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/QueueAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "description": "Gets or sets the description associated with the queue.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "description": "Gets or sets the optional external identifier associated with the queue.", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/QueueStatus" } ], "description": "Gets or sets the status of the queue.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "default": { "type": "boolean", "description": "Indicates whether this queue is the default queue.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "internal": { "type": "boolean", "description": "Indicates whether this queue is internal.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "allOf": [ { "$ref": "#/components/schemas/Account" } ], "description": "Gets or sets the account associated with the queue.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "statistics": { "allOf": [ { "$ref": "#/components/schemas/QueueStatistics" } ], "description": "Gets or sets helpful statistics about the use of the queue.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "isDeleted": { "type": "boolean", "description": "Indicates whether the queue has been marked as deleted.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "QueueAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "deleted": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "activated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "disabled": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "QueueDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/Queue" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "QueueListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Queue" } } }, "additionalProperties": false }, "QueueStatistics": { "type": "object", "properties": { "totalCases": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "openCases": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "awaitingCases": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "QueueStatus": { "enum": [ "Disabled", "Active" ], "type": "string" }, "SafeWaitHandle": { "type": "object", "properties": { "isClosed": { "type": "boolean", "readOnly": true }, "isInvalid": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "SupportCase": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/SupportCaseAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/PlatformMetadata" } ], "nullable": true }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "chat": { "allOf": [ { "$ref": "#/components/schemas/Chat" } ], "description": "Represents the chat this support case is coupled with.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "reporter": { "allOf": [ { "$ref": "#/components/schemas/Contact" } ], "description": "Represents the Mpt.Helpdesk.Models.Notifications.Contact who is reporting this issue.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "assignee": { "allOf": [ { "$ref": "#/components/schemas/Contact" } ], "description": "Represents the Mpt.Helpdesk.Models.Notifications.Contact to whom this case is currently assigned. It can be null if the case is unassigned.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "allOf": [ { "$ref": "#/components/schemas/Account" } ], "description": "Represents the account context of the Mpt.Helpdesk.Models.Cases.SupportCase.Reporter.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "queue": { "allOf": [ { "$ref": "#/components/schemas/Queue" } ], "description": "Queue to which this case is currently assigned.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/SupportCaseStatus" } ], "description": "The status of the support case.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "queryPrompt": { "type": "string", "description": "The prompt that is set along with setting the Mpt.Helpdesk.Models.Cases.SupportCase.Status to Mpt.Helpdesk.Models.Cases.SupportCaseStatus.Querying", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "awaiting": { "type": "boolean", "description": "Can be set by users of the account that manages the case", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/SupportCaseParameter" }, "description": "Represents the parameter values in the case.", "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "SupportCaseAudit": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "processed": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "queried": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "transferred": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "completed": { "allOf": [ { "$ref": "#/components/schemas/PlatformObjectEvent" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "SupportCaseDelta": { "type": "object", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ], "nullable": true }, "path": { "type": "string" }, "data": { "allOf": [ { "$ref": "#/components/schemas/SupportCase" } ], "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "SupportCaseListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SupportCase" } } }, "additionalProperties": false }, "SupportCaseParameter": { "type": "object", "properties": { "id": { "type": "string", "description": "Gets or sets the unique identifier for the parameter.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "description": "Gets or sets the name of the parameter.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "description": "Gets or sets the external identifier for the parameter, if applicable.", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "allOf": [ { "$ref": "#/components/schemas/ParameterType" } ], "description": "Gets or sets the type of the parameter.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "multiple": { "type": "boolean", "description": "Indicates whether this parameter accepts multiple values.\nWhen true, Mpt.Helpdesk.Models.Cases.SupportCaseParameter.Value is a JSON array.", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "constraints": { "allOf": [ { "$ref": "#/components/schemas/HelpdeskConstraints" } ], "description": "Gets or sets the helpdesk-specific constraints for the parameter.\nTreated as a primitive type for RQL queries.", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayOrder": { "type": "integer", "description": "Gets or sets the formatted display order of the parameter for UI presentation.", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "value": { "allOf": [ { "$ref": "#/components/schemas/JsonNode" } ], "description": "Gets or sets the actual value of the parameter as a JSON element.\nThis is a core property for RQL queries.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayValue": { "type": "string", "description": "Gets or sets the human-readable display representation of Mpt.Helpdesk.Models.Cases.SupportCaseParameter.Value.", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a parameter associated with a support case in the helpdesk system." }, "SupportCaseStatus": { "enum": [ "Processing", "Querying", "Completed" ], "type": "string" }, "VisibilityMode": { "enum": [ "All", "OnlyMyAccount" ], "type": "string", "description": "Defines who can see the parameter in the helpdesk system." }, "WaitHandle": { "type": "object", "properties": { "handle": { "allOf": [ { "$ref": "#/components/schemas/IntPtr" } ], "deprecated": true }, "safeWaitHandle": { "allOf": [ { "$ref": "#/components/schemas/SafeWaitHandle" } ] } }, "additionalProperties": false }, "PlatformIdentityRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UserGroupRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "logo": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "isDefault": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "PlatformAccountRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UserRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AccountRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "allOf": [ { "$ref": "#/components/schemas/AccountType" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "BuyerRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "SellerRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProgramRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/ProgramStatus" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "applicableTo": { "allOf": [ { "$ref": "#/components/schemas/ProgramApplicableTo" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/Product" }, "nullable": true, "x-rql": { "core": true, "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CategoryEntityRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "enum": [ "Draft", "Published", "Unpublished", "Deleted" ], "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "LicenseeRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProgramTemplateRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "allOf": [ { "$ref": "#/components/schemas/ProgramTemplateType" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CertificateTermsRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "accepted": { "type": "string", "format": "date-time", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "acceptedBy": { "allOf": [ { "$ref": "#/components/schemas/ExtendedIdentity" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProductItemRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/ProductItemExternalIdBag" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "JournalRef": { "type": "object", "properties": { "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "id": { "type": "string", "description": "The unique identifier of the journal entry.", "example": "BJO-1234-1234", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "description": "Name of the journal.", "example": "29 Nov 2024 #1", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "dueDate": { "type": "string", "description": "The due date for the journal entry.", "format": "date-time", "example": "2025-05-15T23:59:59+00:00", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a journal entry in the billing system." }, "LedgerRef": { "type": "object", "properties": { "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "id": { "type": "string", "description": "The unique identifier of the ledger.", "example": "BLE-1234-1234-1234-1234", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a ledger in the billing system." }, "CustomLedgerRef": { "type": "object", "properties": { "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "id": { "type": "string", "description": "The unique identifier of the custom ledger.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "description": "Name of the custom ledger.", "example": "Quarterly Revenue Ledger", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a custom ledger in the billing system." }, "ChargeRef": { "type": "object", "properties": { "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "id": { "type": "string", "description": "The unique identifier of the charge.", "example": "CHG-1234-1234-1234-1234-1234", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/ChargeExternalIds" } ], "description": "Contains external identifiers associated with the charge.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a charge in the billing system." }, "ProductRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "allOf": [ { "$ref": "#/components/schemas/ProductExternalIdBag" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "StatementRef": { "type": "object", "properties": { "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "id": { "type": "string", "description": "The unique identifier of the statement.", "example": "SOM-1234-1234-1234-1234-1234", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a billing statement in the system, containing details about transactions, pricing, and associated entities." }, "TemplateRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CreditMemoRef": { "type": "object", "properties": { "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "id": { "type": "string", "description": "The unique identifier of the credit memo.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a credit memo in the billing system." }, "InvoiceRef": { "type": "object", "properties": { "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "id": { "type": "string", "description": "The unique identifier of the invoice.", "example": "INV-123-456-789", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an invoice entity in the billing system." }, "PriceListRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "currency": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ItemGroupRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "IndustryRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "enum": [ "Draft", "Published", "Unpublished", "Deleted" ], "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UnitOfMeasureRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "SegmentRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "enum": [ "Draft", "Published", "Unpublished", "Deleted" ], "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ErpLinkRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "companyName": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/ErpLinkStatus" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ModuleRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "filters": { "allOf": [ { "$ref": "#/components/schemas/Filters" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "settings": { "allOf": [ { "$ref": "#/components/schemas/ModuleSettings" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProductProfileRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "vendorProfile": { "allOf": [ { "$ref": "#/components/schemas/VendorProfile" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "enum": [ "Draft", "Published", "Unpublished", "Deleted" ], "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ExtensionMetaRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "version": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ExtensionRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ExtensionCategoryRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "enum": [ "Active", "Disabled" ], "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "InstallationTermRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "accepted": { "type": "string", "format": "date-time", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "acceptedBy": { "allOf": [ { "$ref": "#/components/schemas/PlatformIdentity" } ], "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "TermRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "enum": [ "Draft", "Published", "Unpublished", "Deleted" ], "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "EnrollmentRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "applicableTo": { "allOf": [ { "$ref": "#/components/schemas/ProgramApplicableTo" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "allOf": [ { "$ref": "#/components/schemas/EnrollmentType" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "eligibility": { "allOf": [ { "$ref": "#/components/schemas/ProgramEligibility" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/EnrollmentStatus" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "PairRef": { "type": "object", "properties": { "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "id": { "type": "string", "description": "The unique identifier of the pair.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "description": "The name of the pair.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "description": "The external id of the pair", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "notes": { "type": "string", "description": "Notes for the pair", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "primary": { "type": "boolean", "description": "If the pair is primary", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "latestRate": { "allOf": [ { "$ref": "#/components/schemas/Rate" } ], "description": "Latest pair rate", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a pair of currencies in exchange module." }, "RateRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "value": { "type": "number", "description": "Rate from source to destination currency", "format": "double", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "description": "External id of rate", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Record of rate for specific day" }, "BatchRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "allOf": [ { "$ref": "#/components/schemas/Account" } ], "description": "Gets or sets the account associated with this batch, if applicable.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "category": { "allOf": [ { "$ref": "#/components/schemas/Category" } ], "description": "Gets or sets the category to which this batch belongs.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "template": { "allOf": [ { "$ref": "#/components/schemas/NotificationTemplate" } ], "description": "Gets or sets the template used to create this batch, if applicable.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "description": "Gets or sets the current status of the batch.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "type": "string", "description": "Gets or sets the type of batch.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a batch of notification messages that share common properties." }, "NotificationTemplateRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "lastUsed": { "type": "string", "description": "Gets or sets the timestamp of when this template was last used to send a notification.", "format": "date-time", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "description": "Gets or sets the current status of the template.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a reusable template that can be used to generate messages." }, "CategoryRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "description": "Gets or sets the description of the category.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "lastUsed": { "type": "string", "description": "Gets or sets the timestamp of when this category was last used to send a notification.", "format": "date-time", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a notification category that can be used to organize and filter notifications." }, "TemplateVariantRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "default": { "type": "boolean", "description": "Gets or sets a value indicating whether this is the default variant for the parent template.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "languageCode": { "type": "string", "description": "Gets or sets the language code for this variant.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "description": "Gets or sets the current status of the variant.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a language-specific variant of a template." }, "CertificateRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ParameterGroupRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProgramParameterGroupRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "PricingPolicyRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "client": { "allOf": [ { "$ref": "#/components/schemas/Account" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "eligibility": { "allOf": [ { "$ref": "#/components/schemas/PricingPolicyEligibility" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/Product" }, "nullable": true, "x-rql": { "core": true, "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProgramTermsAndConditionsRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "TermsAndConditionsRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "OrderedParameterGroupRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayOrder": { "type": "integer", "description": "The display order of this parameter group within the form", "format": "int32", "nullable": true, "example": 1, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Ordered parameter group within a form" }, "ChatParticipantRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "muted": { "type": "boolean", "description": "Flag indicates whether participant should be notified of new messages in the chat.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "allOf": [ { "$ref": "#/components/schemas/ParticipantStatus" } ], "description": "Represents the status of the chat participant, indicating whether they are active, suspended, or exited.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ChatMessageRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "content": { "type": "string", "description": "Content of the chat message.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "visibility": { "allOf": [ { "$ref": "#/components/schemas/MessageVisibility" } ], "description": "Visibility of the chat message, indicating whether it is public or private.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "isDeleted": { "type": "boolean", "description": "Set to true when the message should be considered deleted", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ChatAttachmentRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "file": { "allOf": [ { "$ref": "#/components/schemas/File" } ], "description": "Represents the file this attachment belongs to.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ChatRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "allOf": [ { "$ref": "#/components/schemas/ChatType" } ], "description": "Represents the type of chat, indicating whether it is a direct message, group chat, channel, or support case.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ChatLinkRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "message": { "allOf": [ { "$ref": "#/components/schemas/ChatMessage" } ], "description": "Represents the message this link belongs to.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "uri": { "type": "string", "description": "Represents the URI for link.", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "objectId": { "type": "string", "description": "Represents the ObjectId for link.", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "FeedbackAttachmentRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "feedback": { "allOf": [ { "$ref": "#/components/schemas/Feedback" } ], "description": "Represents the feedback this attachment belongs to.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "file": { "allOf": [ { "$ref": "#/components/schemas/File" } ], "description": "Represents the file this attachment belongs to.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "description": "Represents the name this attachment.", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "description": { "type": "string", "description": "Represents the description this attachment.", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "OrderedParameterDefinitionRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "revision": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "description": "The optional external identifier of the parameter for integration purposes", "nullable": true, "example": "EXT-PARAM-123", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Ordered parameter definition within a parameter group" }, "PlatformMetadata": { "type": "object", "properties": { "omitted": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } } }, "servers": [ { "url": "https://api.s1.show" } ] }