{ "openapi": "3.0.1", "info": { "title": "Marketplace API", "version": "prod-4.0.226-g8fd8e5e6" }, "paths": { "/public/v1/accounts/accounts": { "post": { "tags": [ "Accounts" ], "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" }, "Type": { "$ref": "#/components/schemas/AccountType" }, "Status": { "$ref": "#/components/schemas/AccountStatus" }, "ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "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" }, "Name": { "type": "string" }, "Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Eligibility.Client": { "type": "boolean" }, "Eligibility.Partner": { "type": "boolean" }, "Icon": { "type": "string" }, "Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Created.ById": { "type": "string" }, "Audit.Created.By.Name": { "type": "string" }, "Audit.Created.By.Icon": { "type": "string" }, "Audit.Created.By.HasIcon": { "type": "boolean" }, "Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Created.By.Id": { "type": "string" }, "Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Updated.ById": { "type": "string" }, "Audit.Updated.By.Name": { "type": "string" }, "Audit.Updated.By.Icon": { "type": "string" }, "Audit.Updated.By.HasIcon": { "type": "boolean" }, "Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Audit.Updated.By.Id": { "type": "string" }, "Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Id": { "type": "string" }, "SystemId": { "type": "integer", "format": "int32" } }, "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" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Accounts" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountListResponse" } } } } } } }, "/public/v1/accounts/accounts/{id}/enable": { "post": { "tags": [ "Accounts" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } } }, "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" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } } }, "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" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountActivate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountActivate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AccountActivate" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } } }, "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" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } } }, "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}": { "put": { "tags": [ "Accounts" ], "parameters": [ { "name": "id", "in": "path", "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" }, "Type": { "$ref": "#/components/schemas/AccountType" }, "Status": { "$ref": "#/components/schemas/AccountStatus" }, "ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "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" }, "Name": { "type": "string" }, "Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Eligibility.Client": { "type": "boolean" }, "Eligibility.Partner": { "type": "boolean" }, "Icon": { "type": "string" }, "Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Created.ById": { "type": "string" }, "Audit.Created.By.Name": { "type": "string" }, "Audit.Created.By.Icon": { "type": "string" }, "Audit.Created.By.HasIcon": { "type": "boolean" }, "Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Created.By.Id": { "type": "string" }, "Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Updated.ById": { "type": "string" }, "Audit.Updated.By.Name": { "type": "string" }, "Audit.Updated.By.Icon": { "type": "string" }, "Audit.Updated.By.HasIcon": { "type": "boolean" }, "Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Audit.Updated.By.Id": { "type": "string" }, "Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Id": { "type": "string" }, "SystemId": { "type": "integer", "format": "int32" } }, "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" } } } }, "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": [ "Accounts" ], "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/Account" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/accounts/{id}/validate": { "post": { "tags": [ "Accounts" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountValidate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountValidate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AccountValidate" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/accounts/{id}/icon": { "get": { "tags": [ "Accounts" ], "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/accounts/{accountId}/users": { "post": { "tags": [ "AccountsUsersLegacy" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAccountUserDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAccountUserDto" } }, "application/*+json": { "schema": { "$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}": { "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": { "$ref": "#/components/schemas/UserGroupDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserGroupDto" } }, "application/*+json": { "schema": { "$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" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUserListResponse" } } } } } }, "post": { "tags": [ "AccountUsers" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAccountUserDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAccountUserDto" } }, "application/*+json": { "schema": { "$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" } } } } } } }, "/public/v1/accounts/accounts/{accountId}/users/{userId}": { "get": { "tags": [ "AccountUsers" ], "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" } } } } } }, "delete": { "tags": [ "AccountUsers" ], "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" } } } } } } }, "/public/v1/accounts/accounts/{accountId}/users/{userId}/groups": { "post": { "tags": [ "AccountUsers" ], "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/UserGroupDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserGroupDto" } }, "application/*+json": { "schema": { "$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" } } } } } }, "put": { "tags": [ "AccountUsers" ], "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" } } } } } } }, "/public/v1/accounts/accounts/{accountId}/users/{userId}/groups/{userGroupId}": { "delete": { "tags": [ "AccountUsers" ], "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" } } } } } } }, "/public/v1/accounts/accounts/{accountId}/users/{userId}/resend-invite": { "post": { "tags": [ "AccountUsers" ], "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" } } } } } } }, "/public/v1/accounts/accounts/{accountId}/users/{userId}/send-new-invite": { "post": { "tags": [ "AccountUsers" ], "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" } } } } } } }, "/public/v1/accounts/accounts/{accountId}/users/{userId}/accept-invite": { "post": { "tags": [ "AccountUsers" ], "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" } } } } } } }, "/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": { "$ref": "#/components/schemas/CreateAccountUserDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAccountUserDto" } }, "application/*+json": { "schema": { "$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": { "$ref": "#/components/schemas/UserGroupDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserGroupDto" } }, "application/*+json": { "schema": { "$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": "Details of the agreement to create", "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": "Id of existing agreement to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Update 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 agreement template", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "language", "in": "query", "schema": { "type": "string" } }, { "name": "template.id", "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/commerce/agreements/{id}/render": { "get": { "tags": [ "Agreements" ], "summary": "Renders agreement template", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "language", "in": "query", "schema": { "type": "string" } }, { "name": "template.id", "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/commerce/agreements/{agreementId}/attachments": { "get": { "tags": [ "AgreementsAttachments" ], "parameters": [ { "name": "agreementId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementAttachmentListResponse" } } } } } }, "post": { "tags": [ "AgreementsAttachments" ], "parameters": [ { "name": "agreementId", "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" }, "OrderId": { "type": "string" }, "Type": { "$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" ], "parameters": [ { "name": "agreementId", "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/AgreementAttachmentEntity" } } } }, "301": { "description": "Moved Permanently" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "AgreementsAttachments" ], "parameters": [ { "name": "agreementId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "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 individual agreement attachment, specified by attachmentId.", "parameters": [ { "name": "agreementId", "in": "path", "description": "Request attachment id", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Request 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": { "post": { "tags": [ "ApiTokens" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApiTokenDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateApiTokenDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateApiTokenDto" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiToken" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "ApiTokens" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTokenListResponse" } } } } } } }, "/public/v1/accounts/api-tokens/{id}": { "put": { "tags": [ "ApiTokens" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateApiTokenDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateApiTokenDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateApiTokenDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiToken" } } } }, "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" ], "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" } } } } } }, "get": { "tags": [ "ApiTokens" ], "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/ApiToken" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/api-tokens/{id}/enable": { "post": { "tags": [ "ApiTokens" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiToken" } } } }, "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" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiToken" } } } }, "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": "Details of the asset to create", "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 existing asset", "parameters": [ { "name": "id", "in": "path", "description": "Id of existing asset to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Update 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 existing asset", "parameters": [ { "name": "id", "in": "path", "description": "Id of existing asset to terminate", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Update 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 asset template", "parameters": [ { "name": "id", "in": "path", "description": "Id of the asset to render template for", "required": true, "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "Language code for the template", "schema": { "type": "string" } }, { "name": "template.id", "in": "query", "description": "Id of the template to render", "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": "pricingPolicyId", "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/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": { "$ref": "#/components/schemas/CreateAuthorizationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAuthorizationRequest" } }, "application/*+json": { "schema": { "$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": { "$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.Type": { "$ref": "#/components/schemas/AccountType" }, "Account.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Account.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "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.Name": { "type": "string" }, "Account.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Account.Eligibility.Client": { "type": "boolean" }, "Account.Eligibility.Partner": { "type": "boolean" }, "Account.Icon": { "type": "string" }, "Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Audit.Created.At": { "type": "string", "format": "date-time" }, "Account.Audit.Created.ById": { "type": "string" }, "Account.Audit.Created.By.Name": { "type": "string" }, "Account.Audit.Created.By.Icon": { "type": "string" }, "Account.Audit.Created.By.HasIcon": { "type": "boolean" }, "Account.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Account.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "Account.Audit.Created.By.Id": { "type": "string" }, "Account.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Account.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Account.Audit.Updated.ById": { "type": "string" }, "Account.Audit.Updated.By.Name": { "type": "string" }, "Account.Audit.Updated.By.Icon": { "type": "string" }, "Account.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Account.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Account.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "Account.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Account.Audit.Updated.By.Id": { "type": "string" }, "Account.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Account.Id": { "type": "string" }, "Account.SystemId": { "type": "integer", "format": "int32" }, "Name": { "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" } }, "Contact.Name": { "type": "string" }, "Contact.FirstName": { "type": "string" }, "Contact.LastName": { "type": "string" }, "Contact.Email": { "type": "string" }, "Contact.Phone.Prefix": { "type": "string" }, "Contact.Phone.Number": { "type": "string" }, "Contact.User.Email": { "type": "string" }, "Contact.User.Status": { "type": "string" }, "Contact.User.Phone.Prefix": { "type": "string" }, "Contact.User.Phone.Number": { "type": "string" }, "Contact.User.FirstName": { "type": "string" }, "Contact.User.LastName": { "type": "string" }, "Contact.User.Icon": { "type": "string" }, "Contact.User.LastLoginAt": { "type": "string", "format": "date-time" }, "Contact.User.Settings.CultureCode": { "type": "string" }, "Contact.User.Settings.LanguageCode": { "type": "string" }, "Contact.User.Name": { "type": "string" }, "Contact.User.Accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } }, "Contact.User.CurrentAccount.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Contact.User.CurrentAccount.ExternalId": { "type": "string" }, "Contact.User.CurrentAccount.ExternalName": { "type": "string" }, "Contact.User.CurrentAccount.Type": { "$ref": "#/components/schemas/AccountType" }, "Contact.User.CurrentAccount.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Contact.User.CurrentAccount.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "Contact.User.CurrentAccount.Address.AddressLine1": { "type": "string" }, "Contact.User.CurrentAccount.Address.AddressLine2": { "type": "string" }, "Contact.User.CurrentAccount.Address.PostCode": { "type": "string" }, "Contact.User.CurrentAccount.Address.City": { "type": "string" }, "Contact.User.CurrentAccount.Address.State": { "type": "string" }, "Contact.User.CurrentAccount.Address.Country": { "type": "string" }, "Contact.User.CurrentAccount.TechnicalSupportEmail": { "type": "string" }, "Contact.User.CurrentAccount.Website": { "type": "string" }, "Contact.User.CurrentAccount.Description": { "type": "string" }, "Contact.User.CurrentAccount.Name": { "type": "string" }, "Contact.User.CurrentAccount.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Contact.User.CurrentAccount.Eligibility.Client": { "type": "boolean" }, "Contact.User.CurrentAccount.Eligibility.Partner": { "type": "boolean" }, "Contact.User.CurrentAccount.Icon": { "type": "string" }, "Contact.User.CurrentAccount.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.CurrentAccount.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.CurrentAccount.Audit.Created.ById": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.Name": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.Icon": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.HasIcon": { "type": "boolean" }, "Contact.User.CurrentAccount.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Contact.User.CurrentAccount.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.CurrentAccount.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.CurrentAccount.Audit.Created.By.Id": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.CurrentAccount.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.CurrentAccount.Audit.Updated.ById": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.Name": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.Icon": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Contact.User.CurrentAccount.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Contact.User.CurrentAccount.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.CurrentAccount.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Contact.User.CurrentAccount.Audit.Updated.By.Id": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.CurrentAccount.Id": { "type": "string" }, "Contact.User.CurrentAccount.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.Audit.InvitationAcceptedAt": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Created.ById": { "type": "string" }, "Contact.User.Audit.Created.By.Name": { "type": "string" }, "Contact.User.Audit.Created.By.Icon": { "type": "string" }, "Contact.User.Audit.Created.By.HasIcon": { "type": "boolean" }, "Contact.User.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Contact.User.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Contact.User.Audit.Created.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Contact.User.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.Audit.Created.By.Id": { "type": "string" }, "Contact.User.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Updated.ById": { "type": "string" }, "Contact.User.Audit.Updated.By.Name": { "type": "string" }, "Contact.User.Audit.Updated.By.Icon": { "type": "string" }, "Contact.User.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Contact.User.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Contact.User.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Contact.User.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Contact.User.Audit.Updated.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.Audit.Updated.By.Id": { "type": "string" }, "Contact.User.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.Id": { "type": "string" }, "Contact.User.SystemId": { "type": "integer", "format": "int32" }, "Contact.Type": { "type": "string" }, "Icon": { "type": "string" }, "Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Activated.At": { "type": "string", "format": "date-time" }, "Audit.Activated.ById": { "type": "string" }, "Audit.Activated.By.Name": { "type": "string" }, "Audit.Activated.By.Icon": { "type": "string" }, "Audit.Activated.By.HasIcon": { "type": "boolean" }, "Audit.Activated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Activated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Activated.By.Id": { "type": "string" }, "Audit.Activated.By.SystemId": { "type": "integer", "format": "int32" }, "Audit.Unassigned.At": { "type": "string", "format": "date-time" }, "Audit.Unassigned.ById": { "type": "string" }, "Audit.Unassigned.By.Name": { "type": "string" }, "Audit.Unassigned.By.Icon": { "type": "string" }, "Audit.Unassigned.By.HasIcon": { "type": "boolean" }, "Audit.Unassigned.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Unassigned.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Unassigned.By.Id": { "type": "string" }, "Audit.Unassigned.By.SystemId": { "type": "integer", "format": "int32" }, "Audit.Disabled.At": { "type": "string", "format": "date-time" }, "Audit.Disabled.ById": { "type": "string" }, "Audit.Disabled.By.Name": { "type": "string" }, "Audit.Disabled.By.Icon": { "type": "string" }, "Audit.Disabled.By.HasIcon": { "type": "boolean" }, "Audit.Disabled.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Disabled.By.Id": { "type": "string" }, "Audit.Disabled.By.SystemId": { "type": "integer", "format": "int32" }, "Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Created.ById": { "type": "string" }, "Audit.Created.By.Name": { "type": "string" }, "Audit.Created.By.Icon": { "type": "string" }, "Audit.Created.By.HasIcon": { "type": "boolean" }, "Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Created.By.Id": { "type": "string" }, "Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Updated.ById": { "type": "string" }, "Audit.Updated.By.Name": { "type": "string" }, "Audit.Updated.By.Icon": { "type": "string" }, "Audit.Updated.By.HasIcon": { "type": "boolean" }, "Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Updated.By.Id": { "type": "string" }, "Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Id": { "type": "string" }, "SystemId": { "type": "integer", "format": "int32" } }, "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": { "$ref": "#/components/schemas/BuyerActivate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuyerActivate" } }, "application/*+json": { "schema": { "$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": { "$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.Type": { "$ref": "#/components/schemas/AccountType" }, "Account.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Account.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "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.Name": { "type": "string" }, "Account.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Account.Eligibility.Client": { "type": "boolean" }, "Account.Eligibility.Partner": { "type": "boolean" }, "Account.Icon": { "type": "string" }, "Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Audit.Created.At": { "type": "string", "format": "date-time" }, "Account.Audit.Created.ById": { "type": "string" }, "Account.Audit.Created.By.Name": { "type": "string" }, "Account.Audit.Created.By.Icon": { "type": "string" }, "Account.Audit.Created.By.HasIcon": { "type": "boolean" }, "Account.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Account.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "Account.Audit.Created.By.Id": { "type": "string" }, "Account.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Account.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Account.Audit.Updated.ById": { "type": "string" }, "Account.Audit.Updated.By.Name": { "type": "string" }, "Account.Audit.Updated.By.Icon": { "type": "string" }, "Account.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Account.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Account.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "Account.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Account.Audit.Updated.By.Id": { "type": "string" }, "Account.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Account.Id": { "type": "string" }, "Account.SystemId": { "type": "integer", "format": "int32" }, "Name": { "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" } }, "Contact.Name": { "type": "string" }, "Contact.FirstName": { "type": "string" }, "Contact.LastName": { "type": "string" }, "Contact.Email": { "type": "string" }, "Contact.Phone.Prefix": { "type": "string" }, "Contact.Phone.Number": { "type": "string" }, "Contact.User.Email": { "type": "string" }, "Contact.User.Status": { "type": "string" }, "Contact.User.Phone.Prefix": { "type": "string" }, "Contact.User.Phone.Number": { "type": "string" }, "Contact.User.FirstName": { "type": "string" }, "Contact.User.LastName": { "type": "string" }, "Contact.User.Icon": { "type": "string" }, "Contact.User.LastLoginAt": { "type": "string", "format": "date-time" }, "Contact.User.Settings.CultureCode": { "type": "string" }, "Contact.User.Settings.LanguageCode": { "type": "string" }, "Contact.User.Name": { "type": "string" }, "Contact.User.Accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } }, "Contact.User.CurrentAccount.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Contact.User.CurrentAccount.ExternalId": { "type": "string" }, "Contact.User.CurrentAccount.ExternalName": { "type": "string" }, "Contact.User.CurrentAccount.Type": { "$ref": "#/components/schemas/AccountType" }, "Contact.User.CurrentAccount.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Contact.User.CurrentAccount.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "Contact.User.CurrentAccount.Address.AddressLine1": { "type": "string" }, "Contact.User.CurrentAccount.Address.AddressLine2": { "type": "string" }, "Contact.User.CurrentAccount.Address.PostCode": { "type": "string" }, "Contact.User.CurrentAccount.Address.City": { "type": "string" }, "Contact.User.CurrentAccount.Address.State": { "type": "string" }, "Contact.User.CurrentAccount.Address.Country": { "type": "string" }, "Contact.User.CurrentAccount.TechnicalSupportEmail": { "type": "string" }, "Contact.User.CurrentAccount.Website": { "type": "string" }, "Contact.User.CurrentAccount.Description": { "type": "string" }, "Contact.User.CurrentAccount.Name": { "type": "string" }, "Contact.User.CurrentAccount.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Contact.User.CurrentAccount.Eligibility.Client": { "type": "boolean" }, "Contact.User.CurrentAccount.Eligibility.Partner": { "type": "boolean" }, "Contact.User.CurrentAccount.Icon": { "type": "string" }, "Contact.User.CurrentAccount.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.CurrentAccount.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.CurrentAccount.Audit.Created.ById": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.Name": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.Icon": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.HasIcon": { "type": "boolean" }, "Contact.User.CurrentAccount.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Contact.User.CurrentAccount.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.CurrentAccount.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.CurrentAccount.Audit.Created.By.Id": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.CurrentAccount.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.CurrentAccount.Audit.Updated.ById": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.Name": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.Icon": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Contact.User.CurrentAccount.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Contact.User.CurrentAccount.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.CurrentAccount.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Contact.User.CurrentAccount.Audit.Updated.By.Id": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.CurrentAccount.Id": { "type": "string" }, "Contact.User.CurrentAccount.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.Audit.InvitationAcceptedAt": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Created.ById": { "type": "string" }, "Contact.User.Audit.Created.By.Name": { "type": "string" }, "Contact.User.Audit.Created.By.Icon": { "type": "string" }, "Contact.User.Audit.Created.By.HasIcon": { "type": "boolean" }, "Contact.User.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Contact.User.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Contact.User.Audit.Created.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Contact.User.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.Audit.Created.By.Id": { "type": "string" }, "Contact.User.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Updated.ById": { "type": "string" }, "Contact.User.Audit.Updated.By.Name": { "type": "string" }, "Contact.User.Audit.Updated.By.Icon": { "type": "string" }, "Contact.User.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Contact.User.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Contact.User.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Contact.User.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Contact.User.Audit.Updated.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.Audit.Updated.By.Id": { "type": "string" }, "Contact.User.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.Id": { "type": "string" }, "Contact.User.SystemId": { "type": "integer", "format": "int32" }, "Contact.Type": { "type": "string" }, "Icon": { "type": "string" }, "Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Activated.At": { "type": "string", "format": "date-time" }, "Audit.Activated.ById": { "type": "string" }, "Audit.Activated.By.Name": { "type": "string" }, "Audit.Activated.By.Icon": { "type": "string" }, "Audit.Activated.By.HasIcon": { "type": "boolean" }, "Audit.Activated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Activated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Activated.By.Id": { "type": "string" }, "Audit.Activated.By.SystemId": { "type": "integer", "format": "int32" }, "Audit.Unassigned.At": { "type": "string", "format": "date-time" }, "Audit.Unassigned.ById": { "type": "string" }, "Audit.Unassigned.By.Name": { "type": "string" }, "Audit.Unassigned.By.Icon": { "type": "string" }, "Audit.Unassigned.By.HasIcon": { "type": "boolean" }, "Audit.Unassigned.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Unassigned.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Unassigned.By.Id": { "type": "string" }, "Audit.Unassigned.By.SystemId": { "type": "integer", "format": "int32" }, "Audit.Disabled.At": { "type": "string", "format": "date-time" }, "Audit.Disabled.ById": { "type": "string" }, "Audit.Disabled.By.Name": { "type": "string" }, "Audit.Disabled.By.Icon": { "type": "string" }, "Audit.Disabled.By.HasIcon": { "type": "boolean" }, "Audit.Disabled.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Disabled.By.Id": { "type": "string" }, "Audit.Disabled.By.SystemId": { "type": "integer", "format": "int32" }, "Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Created.ById": { "type": "string" }, "Audit.Created.By.Name": { "type": "string" }, "Audit.Created.By.Icon": { "type": "string" }, "Audit.Created.By.HasIcon": { "type": "boolean" }, "Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Created.By.Id": { "type": "string" }, "Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Updated.ById": { "type": "string" }, "Audit.Updated.By.Name": { "type": "string" }, "Audit.Updated.By.Icon": { "type": "string" }, "Audit.Updated.By.HasIcon": { "type": "boolean" }, "Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Updated.By.Id": { "type": "string" }, "Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Id": { "type": "string" }, "SystemId": { "type": "integer", "format": "int32" } }, "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": { "post": { "tags": [ "Buyers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuyerTransfer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuyerTransfer" } }, "application/*+json": { "schema": { "$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" } } } } } }, "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" } } } } } } }, "/public/v1/accounts/buyers/{id}/validate": { "post": { "tags": [ "Buyers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuyerValidate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuyerValidate" } }, "application/*+json": { "schema": { "$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": { "$ref": "#/components/schemas/CreateCertificateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCertificateRequest" } }, "application/*+json": { "schema": { "$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": { "$ref": "#/components/schemas/TerminateCertificateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TerminateCertificateRequest" } }, "application/*+json": { "schema": { "$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": { "post": { "tags": [ "CloudTenants" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCloudTenantDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCloudTenantDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateCloudTenantDto" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudTenant" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "CloudTenants" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudTenantListResponse" } } } } } } }, "/public/v1/accounts/cloud-tenants/{id}": { "delete": { "tags": [ "CloudTenants" ], "parameters": [ { "name": "id", "in": "path", "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" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudTenant" } }, "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" } } } }, "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": [ "CloudTenants" ], "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/CloudTenant" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/catalog/products/{productId}/documents": { "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" } } } } } }, "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": { "$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" } } } } } } }, "/public/v1/catalog/products/{productId}/documents/{id}": { "get": { "tags": [ "Documents" ], "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/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/{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": { "$ref": "#/components/schemas/CreateEnrollmentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateEnrollmentRequest" } }, "application/*+json": { "schema": { "$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/validate": { "post": { "tags": [ "Enrollment" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Enrollment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Enrollment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Enrollment" } } } }, "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" } } }, "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": { "$ref": "#/components/schemas/QueryEnrollmentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QueryEnrollmentRequest" } }, "application/*+json": { "schema": { "$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": { "$ref": "#/components/schemas/ProcessEnrollmentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProcessEnrollmentRequest" } }, "application/*+json": { "schema": { "$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}/fail": { "post": { "tags": [ "Enrollment" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FailEnrollmentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FailEnrollmentRequest" } }, "application/*+json": { "schema": { "$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": { "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" } } } } } }, "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" } } } } } } }, "/public/v1/program/enrollments/{enrollmentId}/attachments/{id}": { "get": { "tags": [ "EnrollmentAttachments" ], "parameters": [ { "name": "enrollmentId", "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/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/accounts/erp-links/{id}": { "put": { "tags": [ "ErpLinks" ], "parameters": [ { "name": "id", "in": "path", "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": { "$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.Type": { "$ref": "#/components/schemas/AccountType" }, "ErpLink.Data.Buyer.Account.Status": { "$ref": "#/components/schemas/AccountStatus" }, "ErpLink.Data.Buyer.Account.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "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.Name": { "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.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "ErpLink.Data.Buyer.Account.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Account.Audit.Created.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Buyer.Account.Audit.Created.By.Type": { "$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.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Buyer.Account.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Account.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "ErpLink.Data.Buyer.Account.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Account.Audit.Updated.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Buyer.Account.Audit.Updated.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Buyer.Account.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "ErpLink.Data.Buyer.Account.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Account.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Account.Id": { "type": "string" }, "ErpLink.Data.Buyer.Account.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Name": { "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.Contact.Name": { "type": "string" }, "ErpLink.Data.Buyer.Contact.FirstName": { "type": "string" }, "ErpLink.Data.Buyer.Contact.LastName": { "type": "string" }, "ErpLink.Data.Buyer.Contact.Email": { "type": "string" }, "ErpLink.Data.Buyer.Contact.Phone.Prefix": { "type": "string" }, "ErpLink.Data.Buyer.Contact.Phone.Number": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Email": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Status": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Phone.Prefix": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Phone.Number": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.FirstName": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.LastName": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.LastLoginAt": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Contact.User.Settings.CultureCode": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Settings.LanguageCode": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Name": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.ExternalId": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.ExternalName": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Type": { "$ref": "#/components/schemas/AccountType" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Status": { "$ref": "#/components/schemas/AccountStatus" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Address.AddressLine1": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Address.AddressLine2": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Address.PostCode": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Address.City": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Address.State": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Address.Country": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.TechnicalSupportEmail": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Website": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Description": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Name": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Eligibility.Client": { "type": "boolean" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Eligibility.Partner": { "type": "boolean" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Name": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Created.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Name": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Id": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Contact.User.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Buyer.Contact.User.Audit.InvitationAcceptedAt": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Contact.User.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Contact.User.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Audit.Created.By.Name": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Audit.Created.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Buyer.Contact.User.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Buyer.Contact.User.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Buyer.Contact.User.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Contact.User.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Audit.Created.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Buyer.Contact.User.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Contact.User.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Buyer.Contact.User.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Contact.User.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Contact.User.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Audit.Updated.By.Name": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Audit.Updated.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Buyer.Contact.User.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Buyer.Contact.User.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Buyer.Contact.User.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Contact.User.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Buyer.Contact.User.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Contact.User.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Audit.Updated.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Buyer.Contact.User.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Contact.User.Id": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Contact.Type": { "type": "string" }, "ErpLink.Data.Buyer.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Activated.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Activated.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Buyer.Audit.Activated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Buyer.Audit.Activated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Buyer.Audit.Activated.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Activated.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Unassigned.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Unassigned.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Buyer.Audit.Unassigned.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Buyer.Audit.Unassigned.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Buyer.Audit.Unassigned.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Unassigned.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Disabled.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Disabled.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Buyer.Audit.Disabled.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Buyer.Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Buyer.Audit.Disabled.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Disabled.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Created.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Buyer.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Buyer.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Buyer.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Updated.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Buyer.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Buyer.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Buyer.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Id": { "type": "string" }, "ErpLink.Data.Buyer.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ExternalId": { "type": "string" }, "ErpLink.Data.Seller.Status": { "$ref": "#/components/schemas/SellerStatus" }, "ErpLink.Data.Seller.Currencies": { "type": "array", "items": { "type": "string" } }, "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.Name": { "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": { "$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.Type": { "$ref": "#/components/schemas/AccountType" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Status": { "$ref": "#/components/schemas/AccountStatus" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "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.Name": { "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.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Created.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Created.By.Type": { "$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.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Name": { "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.Contact.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.FirstName": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.LastName": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.Email": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.Phone.Prefix": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.Phone.Number": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Email": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Status": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Phone.Prefix": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Phone.Number": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.FirstName": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.LastName": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.LastLoginAt": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Settings.CultureCode": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Settings.LanguageCode": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.ExternalId": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.ExternalName": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Type": { "$ref": "#/components/schemas/AccountType" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Status": { "$ref": "#/components/schemas/AccountStatus" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.AddressLine1": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.AddressLine2": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.PostCode": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.City": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.State": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.Country": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.TechnicalSupportEmail": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Website": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Description": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Eligibility.Client": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Eligibility.Partner": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.InvitationAcceptedAt": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.Type": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Seller": { "$ref": "#/components/schemas/Seller" }, "ErpLink.Data.Seller.ErpLink.BuyerId": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.SellerId": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.CompanyName": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Status": { "$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.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Created.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Audit.Created.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.ErpLink.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.Icon": { "type": "string" }, "ErpLink.Data.Seller.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "ErpLink.Data.Seller.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.Audit.Created.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Seller.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Seller.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Seller.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "ErpLink.Data.Seller.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.Audit.Updated.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Seller.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Seller.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "ErpLink.Data.Seller.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Seller.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.Id": { "type": "string" }, "ErpLink.Data.Seller.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.BuyerId": { "type": "string" }, "ErpLink.Data.SellerId": { "type": "string" }, "ErpLink.Data.Name": { "type": "string" }, "ErpLink.Data.CompanyName": { "type": "string" }, "ErpLink.Data.Status": { "$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.Icon": { "type": "string" }, "ErpLink.Data.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Audit.Blocked.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Audit.Blocked.ById": { "type": "string" }, "ErpLink.Data.Audit.Blocked.By.Name": { "type": "string" }, "ErpLink.Data.Audit.Blocked.By.Icon": { "type": "string" }, "ErpLink.Data.Audit.Blocked.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Audit.Blocked.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Audit.Blocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Audit.Blocked.By.Id": { "type": "string" }, "ErpLink.Data.Audit.Blocked.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Audit.Unblocked.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Audit.Unblocked.ById": { "type": "string" }, "ErpLink.Data.Audit.Unblocked.By.Name": { "type": "string" }, "ErpLink.Data.Audit.Unblocked.By.Icon": { "type": "string" }, "ErpLink.Data.Audit.Unblocked.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Audit.Unblocked.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Audit.Unblocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Audit.Unblocked.By.Id": { "type": "string" }, "ErpLink.Data.Audit.Unblocked.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Audit.Created.By.Name": { "type": "string" }, "ErpLink.Data.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Audit.Created.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Audit.Updated.By.Name": { "type": "string" }, "ErpLink.Data.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Audit.Updated.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Id": { "type": "string" }, "ErpLink.Data.SystemId": { "type": "integer", "format": "int32" }, "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": { "$ref": "#/components/schemas/ErpLinkAudit" }, "$meta": { "$ref": "#/components/schemas/Metadata" }, "icon": { "type": "string", "nullable": true }, "buyer": { "$ref": "#/components/schemas/Buyer" }, "seller": { "$ref": "#/components/schemas/Seller" }, "name": { "type": "string" }, "companyName": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/ErpLinkStatus" }, "note": { "type": "string", "nullable": true }, "externalIds": { "$ref": "#/components/schemas/BuyerExternalIds" }, "address": { "$ref": "#/components/schemas/Address" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErpLink" } } } }, "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": [ "ErpLinks" ], "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/ErpLink" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/erp-links/{id}/block": { "post": { "tags": [ "ErpLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErpLink" } }, "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" } } } }, "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" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErpLink" } }, "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" } } } }, "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": { "get": { "tags": [ "ErpLinks" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErpLinkListResponse" } } } } } } }, "/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": { "$ref": "#/components/schemas/CreateItemGroupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateItemGroupRequest" } }, "application/*+json": { "schema": { "$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": { "$ref": "#/components/schemas/UpdateItemGroupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateItemGroupRequest" } }, "application/*+json": { "schema": { "$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": { "post": { "tags": [ "Licensees" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "licensee": { "type": "object", "properties": { "Name": { "type": "string" }, "ExternalId": { "type": "string" }, "Status": { "$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.Type": { "$ref": "#/components/schemas/AccountType" }, "Account.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Account.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "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.Name": { "type": "string" }, "Account.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Account.Eligibility.Client": { "type": "boolean" }, "Account.Eligibility.Partner": { "type": "boolean" }, "Account.Icon": { "type": "string" }, "Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Audit.Created.At": { "type": "string", "format": "date-time" }, "Account.Audit.Created.ById": { "type": "string" }, "Account.Audit.Created.By.Name": { "type": "string" }, "Account.Audit.Created.By.Icon": { "type": "string" }, "Account.Audit.Created.By.HasIcon": { "type": "boolean" }, "Account.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Account.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "Account.Audit.Created.By.Id": { "type": "string" }, "Account.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Account.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Account.Audit.Updated.ById": { "type": "string" }, "Account.Audit.Updated.By.Name": { "type": "string" }, "Account.Audit.Updated.By.Icon": { "type": "string" }, "Account.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Account.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Account.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "Account.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Account.Audit.Updated.By.Id": { "type": "string" }, "Account.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Account.Id": { "type": "string" }, "Account.SystemId": { "type": "integer", "format": "int32" }, "Buyer.ExternalIds.ErpCompanyContact": { "type": "string" }, "Buyer.ExternalIds.ErpCustomer": { "type": "string" }, "Buyer.ExternalIds.AccountExternalId": { "type": "string" }, "Buyer.Status": { "$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.Type": { "$ref": "#/components/schemas/AccountType" }, "Buyer.Account.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Buyer.Account.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "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.Name": { "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.Icon": { "type": "string" }, "Buyer.Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Account.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Account.Audit.Created.ById": { "type": "string" }, "Buyer.Account.Audit.Created.By.Name": { "type": "string" }, "Buyer.Account.Audit.Created.By.Icon": { "type": "string" }, "Buyer.Account.Audit.Created.By.HasIcon": { "type": "boolean" }, "Buyer.Account.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Account.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Account.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "Buyer.Account.Audit.Created.By.Id": { "type": "string" }, "Buyer.Account.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Account.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Account.Audit.Updated.ById": { "type": "string" }, "Buyer.Account.Audit.Updated.By.Name": { "type": "string" }, "Buyer.Account.Audit.Updated.By.Icon": { "type": "string" }, "Buyer.Account.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Buyer.Account.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Account.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "Buyer.Account.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Buyer.Account.Audit.Updated.By.Id": { "type": "string" }, "Buyer.Account.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Account.Id": { "type": "string" }, "Buyer.Account.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Name": { "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.Contact.Name": { "type": "string" }, "Buyer.Contact.FirstName": { "type": "string" }, "Buyer.Contact.LastName": { "type": "string" }, "Buyer.Contact.Email": { "type": "string" }, "Buyer.Contact.Phone.Prefix": { "type": "string" }, "Buyer.Contact.Phone.Number": { "type": "string" }, "Buyer.Contact.User.Email": { "type": "string" }, "Buyer.Contact.User.Status": { "type": "string" }, "Buyer.Contact.User.Phone.Prefix": { "type": "string" }, "Buyer.Contact.User.Phone.Number": { "type": "string" }, "Buyer.Contact.User.FirstName": { "type": "string" }, "Buyer.Contact.User.LastName": { "type": "string" }, "Buyer.Contact.User.Icon": { "type": "string" }, "Buyer.Contact.User.LastLoginAt": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.Settings.CultureCode": { "type": "string" }, "Buyer.Contact.User.Settings.LanguageCode": { "type": "string" }, "Buyer.Contact.User.Name": { "type": "string" }, "Buyer.Contact.User.Accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } }, "Buyer.Contact.User.CurrentAccount.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Buyer.Contact.User.CurrentAccount.ExternalId": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.ExternalName": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Type": { "$ref": "#/components/schemas/AccountType" }, "Buyer.Contact.User.CurrentAccount.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Buyer.Contact.User.CurrentAccount.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "Buyer.Contact.User.CurrentAccount.Address.AddressLine1": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Address.AddressLine2": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Address.PostCode": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Address.City": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Address.State": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Address.Country": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.TechnicalSupportEmail": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Website": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Description": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Name": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Buyer.Contact.User.CurrentAccount.Eligibility.Client": { "type": "boolean" }, "Buyer.Contact.User.CurrentAccount.Eligibility.Partner": { "type": "boolean" }, "Buyer.Contact.User.CurrentAccount.Icon": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Contact.User.CurrentAccount.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.ById": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Name": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Icon": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.HasIcon": { "type": "boolean" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Id": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.ById": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Name": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Icon": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Id": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Contact.User.CurrentAccount.Id": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Contact.User.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Contact.User.Audit.InvitationAcceptedAt": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.Audit.Created.ById": { "type": "string" }, "Buyer.Contact.User.Audit.Created.By.Name": { "type": "string" }, "Buyer.Contact.User.Audit.Created.By.Icon": { "type": "string" }, "Buyer.Contact.User.Audit.Created.By.HasIcon": { "type": "boolean" }, "Buyer.Contact.User.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Contact.User.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Contact.User.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Buyer.Contact.User.Audit.Created.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Buyer.Contact.User.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Contact.User.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Buyer.Contact.User.Audit.Created.By.Id": { "type": "string" }, "Buyer.Contact.User.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Contact.User.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.Audit.Updated.ById": { "type": "string" }, "Buyer.Contact.User.Audit.Updated.By.Name": { "type": "string" }, "Buyer.Contact.User.Audit.Updated.By.Icon": { "type": "string" }, "Buyer.Contact.User.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Buyer.Contact.User.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Contact.User.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Contact.User.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Buyer.Contact.User.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Buyer.Contact.User.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Contact.User.Audit.Updated.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Buyer.Contact.User.Audit.Updated.By.Id": { "type": "string" }, "Buyer.Contact.User.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Contact.User.Id": { "type": "string" }, "Buyer.Contact.User.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Contact.Type": { "type": "string" }, "Buyer.Icon": { "type": "string" }, "Buyer.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Audit.Activated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Activated.ById": { "type": "string" }, "Buyer.Audit.Activated.By.Name": { "type": "string" }, "Buyer.Audit.Activated.By.Icon": { "type": "string" }, "Buyer.Audit.Activated.By.HasIcon": { "type": "boolean" }, "Buyer.Audit.Activated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Audit.Activated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Buyer.Audit.Activated.By.Id": { "type": "string" }, "Buyer.Audit.Activated.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Audit.Unassigned.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Unassigned.ById": { "type": "string" }, "Buyer.Audit.Unassigned.By.Name": { "type": "string" }, "Buyer.Audit.Unassigned.By.Icon": { "type": "string" }, "Buyer.Audit.Unassigned.By.HasIcon": { "type": "boolean" }, "Buyer.Audit.Unassigned.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Audit.Unassigned.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Buyer.Audit.Unassigned.By.Id": { "type": "string" }, "Buyer.Audit.Unassigned.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Audit.Disabled.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Disabled.ById": { "type": "string" }, "Buyer.Audit.Disabled.By.Name": { "type": "string" }, "Buyer.Audit.Disabled.By.Icon": { "type": "string" }, "Buyer.Audit.Disabled.By.HasIcon": { "type": "boolean" }, "Buyer.Audit.Disabled.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Buyer.Audit.Disabled.By.Id": { "type": "string" }, "Buyer.Audit.Disabled.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Created.ById": { "type": "string" }, "Buyer.Audit.Created.By.Name": { "type": "string" }, "Buyer.Audit.Created.By.Icon": { "type": "string" }, "Buyer.Audit.Created.By.HasIcon": { "type": "boolean" }, "Buyer.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Buyer.Audit.Created.By.Id": { "type": "string" }, "Buyer.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Updated.ById": { "type": "string" }, "Buyer.Audit.Updated.By.Name": { "type": "string" }, "Buyer.Audit.Updated.By.Icon": { "type": "string" }, "Buyer.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Buyer.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Buyer.Audit.Updated.By.Id": { "type": "string" }, "Buyer.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Id": { "type": "string" }, "Buyer.SystemId": { "type": "integer", "format": "int32" }, "Seller.ExternalId": { "type": "string" }, "Seller.Status": { "$ref": "#/components/schemas/SellerStatus" }, "Seller.Currencies": { "type": "array", "items": { "type": "string" } }, "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.Name": { "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": { "$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.Type": { "$ref": "#/components/schemas/AccountType" }, "Seller.ErpLink.Buyer.Account.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Seller.ErpLink.Buyer.Account.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "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.Name": { "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.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Type": { "$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.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Account.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Account.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Name": { "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.Contact.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.FirstName": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.LastName": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.Email": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.Phone.Prefix": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.Phone.Number": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Email": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Status": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Phone.Prefix": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Phone.Number": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.FirstName": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.LastName": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.LastLoginAt": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.Settings.CultureCode": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Settings.LanguageCode": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.ExternalId": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.ExternalName": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Type": { "$ref": "#/components/schemas/AccountType" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.AddressLine1": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.AddressLine2": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.PostCode": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.City": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.State": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.Country": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.TechnicalSupportEmail": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Website": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Description": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Eligibility.Client": { "type": "boolean" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Eligibility.Partner": { "type": "boolean" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Contact.User.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Contact.User.Audit.InvitationAcceptedAt": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Contact.User.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Contact.Type": { "type": "string" }, "Seller.ErpLink.Buyer.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Activated.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Activated.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Id": { "type": "string" }, "Seller.ErpLink.Buyer.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Seller.ExternalId": { "type": "string" }, "Seller.ErpLink.Seller.Status": { "$ref": "#/components/schemas/SellerStatus" }, "Seller.ErpLink.Seller.Currencies": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "Seller.ErpLink.Seller.Buyers": { "type": "array", "items": { "$ref": "#/components/schemas/Buyer" } }, "Seller.ErpLink.Seller.ErpLink": { "$ref": "#/components/schemas/ErpLink" }, "Seller.ErpLink.Seller.Icon": { "type": "string" }, "Seller.ErpLink.Seller.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Seller.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Seller.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Seller.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Seller.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Seller.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Seller.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Seller.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Seller.ErpLink.Seller.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Seller.Id": { "type": "string" }, "Seller.ErpLink.Seller.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.BuyerId": { "type": "string" }, "Seller.ErpLink.SellerId": { "type": "string" }, "Seller.ErpLink.Name": { "type": "string" }, "Seller.ErpLink.CompanyName": { "type": "string" }, "Seller.ErpLink.Status": { "$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.Icon": { "type": "string" }, "Seller.ErpLink.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Audit.Blocked.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Blocked.ById": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.Name": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.Icon": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Audit.Blocked.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Audit.Blocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Audit.Blocked.By.Id": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Audit.Unblocked.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Unblocked.ById": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.Name": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.Icon": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Audit.Unblocked.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Audit.Unblocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Audit.Unblocked.By.Id": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.Name": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.Name": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Id": { "type": "string" }, "Seller.ErpLink.SystemId": { "type": "integer", "format": "int32" }, "Seller.Icon": { "type": "string" }, "Seller.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Audit.Created.ById": { "type": "string" }, "Seller.Audit.Created.By.Name": { "type": "string" }, "Seller.Audit.Created.By.Icon": { "type": "string" }, "Seller.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.Audit.Created.By.Id": { "type": "string" }, "Seller.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Audit.Updated.ById": { "type": "string" }, "Seller.Audit.Updated.By.Name": { "type": "string" }, "Seller.Audit.Updated.By.Icon": { "type": "string" }, "Seller.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Seller.Audit.Updated.By.Id": { "type": "string" }, "Seller.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.Id": { "type": "string" }, "Seller.SystemId": { "type": "integer", "format": "int32" }, "Eligibility.Client": { "type": "boolean" }, "Eligibility.Partner": { "type": "boolean" }, "Contact.Name": { "type": "string" }, "Contact.FirstName": { "type": "string" }, "Contact.LastName": { "type": "string" }, "Contact.Email": { "type": "string" }, "Contact.Phone.Prefix": { "type": "string" }, "Contact.Phone.Number": { "type": "string" }, "Contact.User.Email": { "type": "string" }, "Contact.User.Status": { "type": "string" }, "Contact.User.Phone.Prefix": { "type": "string" }, "Contact.User.Phone.Number": { "type": "string" }, "Contact.User.FirstName": { "type": "string" }, "Contact.User.LastName": { "type": "string" }, "Contact.User.Icon": { "type": "string" }, "Contact.User.LastLoginAt": { "type": "string", "format": "date-time" }, "Contact.User.Settings.CultureCode": { "type": "string" }, "Contact.User.Settings.LanguageCode": { "type": "string" }, "Contact.User.Name": { "type": "string" }, "Contact.User.Accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } }, "Contact.User.CurrentAccount.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Contact.User.CurrentAccount.ExternalId": { "type": "string" }, "Contact.User.CurrentAccount.ExternalName": { "type": "string" }, "Contact.User.CurrentAccount.Type": { "$ref": "#/components/schemas/AccountType" }, "Contact.User.CurrentAccount.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Contact.User.CurrentAccount.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "Contact.User.CurrentAccount.Address.AddressLine1": { "type": "string" }, "Contact.User.CurrentAccount.Address.AddressLine2": { "type": "string" }, "Contact.User.CurrentAccount.Address.PostCode": { "type": "string" }, "Contact.User.CurrentAccount.Address.City": { "type": "string" }, "Contact.User.CurrentAccount.Address.State": { "type": "string" }, "Contact.User.CurrentAccount.Address.Country": { "type": "string" }, "Contact.User.CurrentAccount.TechnicalSupportEmail": { "type": "string" }, "Contact.User.CurrentAccount.Website": { "type": "string" }, "Contact.User.CurrentAccount.Description": { "type": "string" }, "Contact.User.CurrentAccount.Name": { "type": "string" }, "Contact.User.CurrentAccount.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Contact.User.CurrentAccount.Eligibility.Client": { "type": "boolean" }, "Contact.User.CurrentAccount.Eligibility.Partner": { "type": "boolean" }, "Contact.User.CurrentAccount.Icon": { "type": "string" }, "Contact.User.CurrentAccount.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.CurrentAccount.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.CurrentAccount.Audit.Created.ById": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.Name": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.Icon": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.HasIcon": { "type": "boolean" }, "Contact.User.CurrentAccount.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Contact.User.CurrentAccount.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.CurrentAccount.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.CurrentAccount.Audit.Created.By.Id": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.CurrentAccount.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.CurrentAccount.Audit.Updated.ById": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.Name": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.Icon": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Contact.User.CurrentAccount.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Contact.User.CurrentAccount.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.CurrentAccount.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Contact.User.CurrentAccount.Audit.Updated.By.Id": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.CurrentAccount.Id": { "type": "string" }, "Contact.User.CurrentAccount.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.Audit.InvitationAcceptedAt": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Created.ById": { "type": "string" }, "Contact.User.Audit.Created.By.Name": { "type": "string" }, "Contact.User.Audit.Created.By.Icon": { "type": "string" }, "Contact.User.Audit.Created.By.HasIcon": { "type": "boolean" }, "Contact.User.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Contact.User.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Contact.User.Audit.Created.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Contact.User.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.Audit.Created.By.Id": { "type": "string" }, "Contact.User.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Updated.ById": { "type": "string" }, "Contact.User.Audit.Updated.By.Name": { "type": "string" }, "Contact.User.Audit.Updated.By.Icon": { "type": "string" }, "Contact.User.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Contact.User.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Contact.User.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Contact.User.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Contact.User.Audit.Updated.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.Audit.Updated.By.Id": { "type": "string" }, "Contact.User.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.Id": { "type": "string" }, "Contact.User.SystemId": { "type": "integer", "format": "int32" }, "Contact.Type": { "type": "string" }, "Icon": { "type": "string" }, "Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Disabled.At": { "type": "string", "format": "date-time" }, "Audit.Disabled.ById": { "type": "string" }, "Audit.Disabled.By.Name": { "type": "string" }, "Audit.Disabled.By.Icon": { "type": "string" }, "Audit.Disabled.By.HasIcon": { "type": "boolean" }, "Audit.Disabled.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Disabled.By.Id": { "type": "string" }, "Audit.Disabled.By.SystemId": { "type": "integer", "format": "int32" }, "Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Created.ById": { "type": "string" }, "Audit.Created.By.Name": { "type": "string" }, "Audit.Created.By.Icon": { "type": "string" }, "Audit.Created.By.HasIcon": { "type": "boolean" }, "Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Created.By.Id": { "type": "string" }, "Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Updated.ById": { "type": "string" }, "Audit.Updated.By.Name": { "type": "string" }, "Audit.Updated.By.Icon": { "type": "string" }, "Audit.Updated.By.HasIcon": { "type": "boolean" }, "Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Updated.By.Id": { "type": "string" }, "Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Id": { "type": "string" }, "SystemId": { "type": "integer", "format": "int32" } }, "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" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Licensees" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicenseeListResponse" } } } } } } }, "/public/v1/accounts/licensees/{id}": { "put": { "tags": [ "Licensees" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "licensee": { "type": "object", "properties": { "Name": { "type": "string" }, "ExternalId": { "type": "string" }, "Status": { "$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.Type": { "$ref": "#/components/schemas/AccountType" }, "Account.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Account.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "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.Name": { "type": "string" }, "Account.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Account.Eligibility.Client": { "type": "boolean" }, "Account.Eligibility.Partner": { "type": "boolean" }, "Account.Icon": { "type": "string" }, "Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Audit.Created.At": { "type": "string", "format": "date-time" }, "Account.Audit.Created.ById": { "type": "string" }, "Account.Audit.Created.By.Name": { "type": "string" }, "Account.Audit.Created.By.Icon": { "type": "string" }, "Account.Audit.Created.By.HasIcon": { "type": "boolean" }, "Account.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Account.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "Account.Audit.Created.By.Id": { "type": "string" }, "Account.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Account.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Account.Audit.Updated.ById": { "type": "string" }, "Account.Audit.Updated.By.Name": { "type": "string" }, "Account.Audit.Updated.By.Icon": { "type": "string" }, "Account.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Account.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Account.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "Account.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Account.Audit.Updated.By.Id": { "type": "string" }, "Account.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Account.Id": { "type": "string" }, "Account.SystemId": { "type": "integer", "format": "int32" }, "Buyer.ExternalIds.ErpCompanyContact": { "type": "string" }, "Buyer.ExternalIds.ErpCustomer": { "type": "string" }, "Buyer.ExternalIds.AccountExternalId": { "type": "string" }, "Buyer.Status": { "$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.Type": { "$ref": "#/components/schemas/AccountType" }, "Buyer.Account.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Buyer.Account.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "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.Name": { "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.Icon": { "type": "string" }, "Buyer.Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Account.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Account.Audit.Created.ById": { "type": "string" }, "Buyer.Account.Audit.Created.By.Name": { "type": "string" }, "Buyer.Account.Audit.Created.By.Icon": { "type": "string" }, "Buyer.Account.Audit.Created.By.HasIcon": { "type": "boolean" }, "Buyer.Account.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Account.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Account.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "Buyer.Account.Audit.Created.By.Id": { "type": "string" }, "Buyer.Account.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Account.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Account.Audit.Updated.ById": { "type": "string" }, "Buyer.Account.Audit.Updated.By.Name": { "type": "string" }, "Buyer.Account.Audit.Updated.By.Icon": { "type": "string" }, "Buyer.Account.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Buyer.Account.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Account.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "Buyer.Account.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Buyer.Account.Audit.Updated.By.Id": { "type": "string" }, "Buyer.Account.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Account.Id": { "type": "string" }, "Buyer.Account.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Name": { "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.Contact.Name": { "type": "string" }, "Buyer.Contact.FirstName": { "type": "string" }, "Buyer.Contact.LastName": { "type": "string" }, "Buyer.Contact.Email": { "type": "string" }, "Buyer.Contact.Phone.Prefix": { "type": "string" }, "Buyer.Contact.Phone.Number": { "type": "string" }, "Buyer.Contact.User.Email": { "type": "string" }, "Buyer.Contact.User.Status": { "type": "string" }, "Buyer.Contact.User.Phone.Prefix": { "type": "string" }, "Buyer.Contact.User.Phone.Number": { "type": "string" }, "Buyer.Contact.User.FirstName": { "type": "string" }, "Buyer.Contact.User.LastName": { "type": "string" }, "Buyer.Contact.User.Icon": { "type": "string" }, "Buyer.Contact.User.LastLoginAt": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.Settings.CultureCode": { "type": "string" }, "Buyer.Contact.User.Settings.LanguageCode": { "type": "string" }, "Buyer.Contact.User.Name": { "type": "string" }, "Buyer.Contact.User.Accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } }, "Buyer.Contact.User.CurrentAccount.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Buyer.Contact.User.CurrentAccount.ExternalId": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.ExternalName": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Type": { "$ref": "#/components/schemas/AccountType" }, "Buyer.Contact.User.CurrentAccount.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Buyer.Contact.User.CurrentAccount.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "Buyer.Contact.User.CurrentAccount.Address.AddressLine1": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Address.AddressLine2": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Address.PostCode": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Address.City": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Address.State": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Address.Country": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.TechnicalSupportEmail": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Website": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Description": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Name": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Buyer.Contact.User.CurrentAccount.Eligibility.Client": { "type": "boolean" }, "Buyer.Contact.User.CurrentAccount.Eligibility.Partner": { "type": "boolean" }, "Buyer.Contact.User.CurrentAccount.Icon": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Contact.User.CurrentAccount.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.ById": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Name": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Icon": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.HasIcon": { "type": "boolean" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Id": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.ById": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Name": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Icon": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Id": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Contact.User.CurrentAccount.Id": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Contact.User.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Contact.User.Audit.InvitationAcceptedAt": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.Audit.Created.ById": { "type": "string" }, "Buyer.Contact.User.Audit.Created.By.Name": { "type": "string" }, "Buyer.Contact.User.Audit.Created.By.Icon": { "type": "string" }, "Buyer.Contact.User.Audit.Created.By.HasIcon": { "type": "boolean" }, "Buyer.Contact.User.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Contact.User.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Contact.User.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Buyer.Contact.User.Audit.Created.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Buyer.Contact.User.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Contact.User.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Buyer.Contact.User.Audit.Created.By.Id": { "type": "string" }, "Buyer.Contact.User.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Contact.User.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.Audit.Updated.ById": { "type": "string" }, "Buyer.Contact.User.Audit.Updated.By.Name": { "type": "string" }, "Buyer.Contact.User.Audit.Updated.By.Icon": { "type": "string" }, "Buyer.Contact.User.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Buyer.Contact.User.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Contact.User.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Contact.User.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Buyer.Contact.User.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Buyer.Contact.User.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Contact.User.Audit.Updated.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Buyer.Contact.User.Audit.Updated.By.Id": { "type": "string" }, "Buyer.Contact.User.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Contact.User.Id": { "type": "string" }, "Buyer.Contact.User.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Contact.Type": { "type": "string" }, "Buyer.Icon": { "type": "string" }, "Buyer.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Audit.Activated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Activated.ById": { "type": "string" }, "Buyer.Audit.Activated.By.Name": { "type": "string" }, "Buyer.Audit.Activated.By.Icon": { "type": "string" }, "Buyer.Audit.Activated.By.HasIcon": { "type": "boolean" }, "Buyer.Audit.Activated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Audit.Activated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Buyer.Audit.Activated.By.Id": { "type": "string" }, "Buyer.Audit.Activated.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Audit.Unassigned.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Unassigned.ById": { "type": "string" }, "Buyer.Audit.Unassigned.By.Name": { "type": "string" }, "Buyer.Audit.Unassigned.By.Icon": { "type": "string" }, "Buyer.Audit.Unassigned.By.HasIcon": { "type": "boolean" }, "Buyer.Audit.Unassigned.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Audit.Unassigned.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Buyer.Audit.Unassigned.By.Id": { "type": "string" }, "Buyer.Audit.Unassigned.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Audit.Disabled.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Disabled.ById": { "type": "string" }, "Buyer.Audit.Disabled.By.Name": { "type": "string" }, "Buyer.Audit.Disabled.By.Icon": { "type": "string" }, "Buyer.Audit.Disabled.By.HasIcon": { "type": "boolean" }, "Buyer.Audit.Disabled.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Buyer.Audit.Disabled.By.Id": { "type": "string" }, "Buyer.Audit.Disabled.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Created.ById": { "type": "string" }, "Buyer.Audit.Created.By.Name": { "type": "string" }, "Buyer.Audit.Created.By.Icon": { "type": "string" }, "Buyer.Audit.Created.By.HasIcon": { "type": "boolean" }, "Buyer.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Buyer.Audit.Created.By.Id": { "type": "string" }, "Buyer.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Updated.ById": { "type": "string" }, "Buyer.Audit.Updated.By.Name": { "type": "string" }, "Buyer.Audit.Updated.By.Icon": { "type": "string" }, "Buyer.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Buyer.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Buyer.Audit.Updated.By.Id": { "type": "string" }, "Buyer.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Id": { "type": "string" }, "Buyer.SystemId": { "type": "integer", "format": "int32" }, "Seller.ExternalId": { "type": "string" }, "Seller.Status": { "$ref": "#/components/schemas/SellerStatus" }, "Seller.Currencies": { "type": "array", "items": { "type": "string" } }, "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.Name": { "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": { "$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.Type": { "$ref": "#/components/schemas/AccountType" }, "Seller.ErpLink.Buyer.Account.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Seller.ErpLink.Buyer.Account.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "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.Name": { "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.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Type": { "$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.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Account.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Account.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Name": { "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.Contact.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.FirstName": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.LastName": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.Email": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.Phone.Prefix": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.Phone.Number": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Email": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Status": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Phone.Prefix": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Phone.Number": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.FirstName": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.LastName": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.LastLoginAt": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.Settings.CultureCode": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Settings.LanguageCode": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.ExternalId": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.ExternalName": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Type": { "$ref": "#/components/schemas/AccountType" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.AddressLine1": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.AddressLine2": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.PostCode": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.City": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.State": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.Country": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.TechnicalSupportEmail": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Website": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Description": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Eligibility.Client": { "type": "boolean" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Eligibility.Partner": { "type": "boolean" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Contact.User.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Contact.User.Audit.InvitationAcceptedAt": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Contact.User.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Contact.Type": { "type": "string" }, "Seller.ErpLink.Buyer.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Activated.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Activated.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Id": { "type": "string" }, "Seller.ErpLink.Buyer.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Seller.ExternalId": { "type": "string" }, "Seller.ErpLink.Seller.Status": { "$ref": "#/components/schemas/SellerStatus" }, "Seller.ErpLink.Seller.Currencies": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "Seller.ErpLink.Seller.Buyers": { "type": "array", "items": { "$ref": "#/components/schemas/Buyer" } }, "Seller.ErpLink.Seller.ErpLink": { "$ref": "#/components/schemas/ErpLink" }, "Seller.ErpLink.Seller.Icon": { "type": "string" }, "Seller.ErpLink.Seller.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Seller.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Seller.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Seller.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Seller.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Seller.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Seller.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Seller.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Seller.ErpLink.Seller.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Seller.Id": { "type": "string" }, "Seller.ErpLink.Seller.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.BuyerId": { "type": "string" }, "Seller.ErpLink.SellerId": { "type": "string" }, "Seller.ErpLink.Name": { "type": "string" }, "Seller.ErpLink.CompanyName": { "type": "string" }, "Seller.ErpLink.Status": { "$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.Icon": { "type": "string" }, "Seller.ErpLink.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Audit.Blocked.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Blocked.ById": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.Name": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.Icon": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Audit.Blocked.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Audit.Blocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Audit.Blocked.By.Id": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Audit.Unblocked.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Unblocked.ById": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.Name": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.Icon": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Audit.Unblocked.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Audit.Unblocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Audit.Unblocked.By.Id": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.Name": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.Name": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Id": { "type": "string" }, "Seller.ErpLink.SystemId": { "type": "integer", "format": "int32" }, "Seller.Icon": { "type": "string" }, "Seller.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Audit.Created.ById": { "type": "string" }, "Seller.Audit.Created.By.Name": { "type": "string" }, "Seller.Audit.Created.By.Icon": { "type": "string" }, "Seller.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.Audit.Created.By.Id": { "type": "string" }, "Seller.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Audit.Updated.ById": { "type": "string" }, "Seller.Audit.Updated.By.Name": { "type": "string" }, "Seller.Audit.Updated.By.Icon": { "type": "string" }, "Seller.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Seller.Audit.Updated.By.Id": { "type": "string" }, "Seller.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.Id": { "type": "string" }, "Seller.SystemId": { "type": "integer", "format": "int32" }, "Eligibility.Client": { "type": "boolean" }, "Eligibility.Partner": { "type": "boolean" }, "Contact.Name": { "type": "string" }, "Contact.FirstName": { "type": "string" }, "Contact.LastName": { "type": "string" }, "Contact.Email": { "type": "string" }, "Contact.Phone.Prefix": { "type": "string" }, "Contact.Phone.Number": { "type": "string" }, "Contact.User.Email": { "type": "string" }, "Contact.User.Status": { "type": "string" }, "Contact.User.Phone.Prefix": { "type": "string" }, "Contact.User.Phone.Number": { "type": "string" }, "Contact.User.FirstName": { "type": "string" }, "Contact.User.LastName": { "type": "string" }, "Contact.User.Icon": { "type": "string" }, "Contact.User.LastLoginAt": { "type": "string", "format": "date-time" }, "Contact.User.Settings.CultureCode": { "type": "string" }, "Contact.User.Settings.LanguageCode": { "type": "string" }, "Contact.User.Name": { "type": "string" }, "Contact.User.Accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } }, "Contact.User.CurrentAccount.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Contact.User.CurrentAccount.ExternalId": { "type": "string" }, "Contact.User.CurrentAccount.ExternalName": { "type": "string" }, "Contact.User.CurrentAccount.Type": { "$ref": "#/components/schemas/AccountType" }, "Contact.User.CurrentAccount.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Contact.User.CurrentAccount.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "Contact.User.CurrentAccount.Address.AddressLine1": { "type": "string" }, "Contact.User.CurrentAccount.Address.AddressLine2": { "type": "string" }, "Contact.User.CurrentAccount.Address.PostCode": { "type": "string" }, "Contact.User.CurrentAccount.Address.City": { "type": "string" }, "Contact.User.CurrentAccount.Address.State": { "type": "string" }, "Contact.User.CurrentAccount.Address.Country": { "type": "string" }, "Contact.User.CurrentAccount.TechnicalSupportEmail": { "type": "string" }, "Contact.User.CurrentAccount.Website": { "type": "string" }, "Contact.User.CurrentAccount.Description": { "type": "string" }, "Contact.User.CurrentAccount.Name": { "type": "string" }, "Contact.User.CurrentAccount.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Contact.User.CurrentAccount.Eligibility.Client": { "type": "boolean" }, "Contact.User.CurrentAccount.Eligibility.Partner": { "type": "boolean" }, "Contact.User.CurrentAccount.Icon": { "type": "string" }, "Contact.User.CurrentAccount.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.CurrentAccount.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.CurrentAccount.Audit.Created.ById": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.Name": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.Icon": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.HasIcon": { "type": "boolean" }, "Contact.User.CurrentAccount.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Contact.User.CurrentAccount.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.CurrentAccount.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.CurrentAccount.Audit.Created.By.Id": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.CurrentAccount.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.CurrentAccount.Audit.Updated.ById": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.Name": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.Icon": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Contact.User.CurrentAccount.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Contact.User.CurrentAccount.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.CurrentAccount.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Contact.User.CurrentAccount.Audit.Updated.By.Id": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.CurrentAccount.Id": { "type": "string" }, "Contact.User.CurrentAccount.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.Audit.InvitationAcceptedAt": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Created.ById": { "type": "string" }, "Contact.User.Audit.Created.By.Name": { "type": "string" }, "Contact.User.Audit.Created.By.Icon": { "type": "string" }, "Contact.User.Audit.Created.By.HasIcon": { "type": "boolean" }, "Contact.User.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Contact.User.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Contact.User.Audit.Created.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Contact.User.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.Audit.Created.By.Id": { "type": "string" }, "Contact.User.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Updated.ById": { "type": "string" }, "Contact.User.Audit.Updated.By.Name": { "type": "string" }, "Contact.User.Audit.Updated.By.Icon": { "type": "string" }, "Contact.User.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Contact.User.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Contact.User.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Contact.User.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Contact.User.Audit.Updated.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.Audit.Updated.By.Id": { "type": "string" }, "Contact.User.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.Id": { "type": "string" }, "Contact.User.SystemId": { "type": "integer", "format": "int32" }, "Contact.Type": { "type": "string" }, "Icon": { "type": "string" }, "Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Disabled.At": { "type": "string", "format": "date-time" }, "Audit.Disabled.ById": { "type": "string" }, "Audit.Disabled.By.Name": { "type": "string" }, "Audit.Disabled.By.Icon": { "type": "string" }, "Audit.Disabled.By.HasIcon": { "type": "boolean" }, "Audit.Disabled.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Disabled.By.Id": { "type": "string" }, "Audit.Disabled.By.SystemId": { "type": "integer", "format": "int32" }, "Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Created.ById": { "type": "string" }, "Audit.Created.By.Name": { "type": "string" }, "Audit.Created.By.Icon": { "type": "string" }, "Audit.Created.By.HasIcon": { "type": "boolean" }, "Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Created.By.Id": { "type": "string" }, "Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Updated.ById": { "type": "string" }, "Audit.Updated.By.Name": { "type": "string" }, "Audit.Updated.By.Icon": { "type": "string" }, "Audit.Updated.By.HasIcon": { "type": "boolean" }, "Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Updated.By.Id": { "type": "string" }, "Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Id": { "type": "string" }, "SystemId": { "type": "integer", "format": "int32" } }, "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" } } } }, "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" ], "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" } } } } } }, "get": { "tags": [ "Licensees" ], "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/Licensee" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/licensees/{id}/enable": { "post": { "tags": [ "Licensees" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Licensee" } } } }, "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" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Licensee" } } } }, "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" ], "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/commerce/lines": { "get": { "tags": [ "Lines" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementLineListResponse" } } } } } } }, "/public/v1/commerce/agreements/{agreementId}/lines": { "get": { "tags": [ "Lines" ], "parameters": [ { "name": "agreementId", "in": "path", "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" ], "parameters": [ { "name": "subscriptionId", "in": "path", "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" ], "parameters": [ { "name": "orderId", "in": "path", "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" ], "parameters": [ { "name": "assetId", "in": "path", "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": { "$ref": "#/components/schemas/CreateListingRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateListingRequest" } }, "application/*+json": { "schema": { "$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" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModuleListResponse" } } } } } } }, "/public/v1/accounts/modules/{id}": { "get": { "tags": [ "Modules" ], "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/Module" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/commerce/orders/{orderId}/assets": { "get": { "tags": [ "OrderAssets" ], "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": "Details of the asset to create", "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" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "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": "Id of the asset to update", "required": true, "schema": { "type": "string" } }, { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Update details of asset", "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": "Id of the asset to delete", "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 order asset template", "parameters": [ { "name": "id", "in": "path", "description": "Id of the asset to render template for", "required": true, "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "Language code for the template", "schema": { "type": "string" } }, { "name": "template.id", "in": "query", "description": "Id of the template to render", "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 the agreement specified in order body, or simultaneously creates and agreement in case of purchase order.", "requestBody": { "description": "Details of the order to create", "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 order. Not every property can be updated. For example it's impossible to change state of the order, or assign it to another agreement.", "parameters": [ { "name": "id", "in": "path", "description": "Id of order to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Update details of order", "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 order. Only applicable to draft orders.", "parameters": [ { "name": "id", "in": "path", "description": "Id of order to be deleted", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Update details of order", "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 order, changing its status to processing.", "parameters": [ { "name": "id", "in": "path", "description": "Id of order to be processed", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Update details of order", "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": "Sets order status to querying, effectively returning it back to client for update.", "parameters": [ { "name": "id", "in": "path", "description": "Id of order to be queried", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Update details of order", "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 the order. As result order gets status completed and agreement gets updated with order information.", "parameters": [ { "name": "id", "in": "path", "description": "Id of order to be completed", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Update details of order", "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": "Quote the order.", "parameters": [ { "name": "id", "in": "path", "description": "Id of order to be quoted", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Update details of order", "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 the order. Status changes to failed. State of the agreement doesn't change except the status.", "parameters": [ { "name": "id", "in": "path", "description": "Id of order to be failed", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Update details of order", "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 order state. Internally calls validate endpoint of a connector.", "parameters": [ { "name": "id", "in": "path", "description": "Id of order to be completed", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Update details of order", "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 order 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/commerce/orders/{id}/render": { "get": { "tags": [ "Orders" ], "summary": "Renders order 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/commerce/orders/{id}/notify": { "post": { "tags": [ "Orders" ], "summary": "Notifies a user about an order.", "parameters": [ { "name": "id", "in": "path", "description": "Id of order to include in the notification", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The body of the request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderNotificationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderNotificationRequest" } }, "application/*+json": { "schema": { "$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" ], "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": "Details of the subscription to create", "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" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "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 and existing subscription", "parameters": [ { "name": "id", "in": "path", "description": "Id of the subscription to update", "required": true, "schema": { "type": "string" } }, { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Update details of subscription", "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 subscription.", "parameters": [ { "name": "id", "in": "path", "description": "Id of subscription to be deleted", "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 order subscription template", "parameters": [ { "name": "id", "in": "path", "description": "Id of the subscription to render template for", "required": true, "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "Language code for the template", "schema": { "type": "string" } }, { "name": "template.id", "in": "query", "description": "Id of the template to render", "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": { "$ref": "#/components/schemas/CreateParameterGroupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateParameterGroupRequest" } }, "application/*+json": { "schema": { "$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": { "$ref": "#/components/schemas/UpdateParameterGroupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateParameterGroupRequest" } }, "application/*+json": { "schema": { "$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": { "$ref": "#/components/schemas/CreateParameterDefinitionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateParameterDefinitionRequest" } }, "application/*+json": { "schema": { "$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": { "$ref": "#/components/schemas/CreatePriceListRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatePriceListRequest" } }, "application/*+json": { "schema": { "$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": { "$ref": "#/components/schemas/CreatePricingPolicyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatePricingPolicyRequest" } }, "application/*+json": { "schema": { "$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": { "$ref": "#/components/schemas/CreateProductItemRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateProductItemRequest" } }, "application/*+json": { "schema": { "$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": { "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" } } } } } }, "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": { "$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" } } } } } } }, "/public/v1/catalog/products/{productId}/media/{id}": { "get": { "tags": [ "ProductMedia" ], "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/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/{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": { "$ref": "#/components/schemas/ConfigureSettingsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConfigureSettingsRequest" } }, "application/*+json": { "schema": { "$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": { "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" } } } } } }, "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": { "$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" } } } } } } }, "/public/v1/program/programs/{programId}/documents/{id}": { "get": { "tags": [ "ProgramDocuments" ], "parameters": [ { "name": "programId", "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/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/{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": { "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" } } } } } }, "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": { "$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" } } } } } } }, "/public/v1/program/programs/{programId}/media/{id}": { "get": { "tags": [ "ProgramMedia" ], "parameters": [ { "name": "programId", "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/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/{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": { "$ref": "#/components/schemas/CreateProgramParameterGroupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateProgramParameterGroupRequest" } }, "application/*+json": { "schema": { "$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": { "$ref": "#/components/schemas/CreateProgramParameterDefinitionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateProgramParameterDefinitionRequest" } }, "application/*+json": { "schema": { "$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": { "$ref": "#/components/schemas/ConfigureProgramSettingsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConfigureProgramSettingsRequest" } }, "application/*+json": { "schema": { "$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": { "$ref": "#/components/schemas/CreateProgramTemplateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateProgramTemplateRequest" } }, "application/*+json": { "schema": { "$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": { "$ref": "#/components/schemas/CreateProgramTermsAndConditionsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateProgramTermsAndConditionsRequest" } }, "application/*+json": { "schema": { "$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": { "$ref": "#/components/schemas/UpdateProgramTermsAndConditionsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateProgramTermsAndConditionsRequest" } }, "application/*+json": { "schema": { "$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/commerce/requests/{requestId}/attachments": { "get": { "tags": [ "RequestAttachments" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachmentListResponse" } } } } } }, "post": { "tags": [ "RequestAttachments" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "language", "in": "query", "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/Attachment" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/commerce/requests/{requestId}/attachments/{id}": { "get": { "tags": [ "RequestAttachments" ], "parameters": [ { "name": "requestId", "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/Attachment" } } } }, "301": { "description": "Moved Permanently" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "RequestAttachments" ], "summary": "Deletes an individual request attachment, specified by attachmentId.", "parameters": [ { "name": "requestId", "in": "path", "description": "Request attachment id", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Request attachment id", "required": true, "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "RequestAttachments" ], "summary": "Updates an individual request attachment, specified by attachmentId.", "parameters": [ { "name": "requestId", "in": "path", "description": "Request attachment id", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Request attachment id", "required": true, "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "", "schema": { "type": "string" } } ], "requestBody": { "description": "Request attachment model", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Attachment" } } } }, "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/commerce/requests": { "post": { "tags": [ "Requests" ], "summary": "Creates a new request.", "parameters": [ { "name": "language", "in": "query", "description": "", "schema": { "type": "string" } } ], "requestBody": { "description": "Request data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Request" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Requests" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestListResponse" } } } } } } }, "/public/v1/commerce/requests/{id}": { "put": { "tags": [ "Requests" ], "summary": "Updates request. Not every property is updatable.", "parameters": [ { "name": "id", "in": "path", "description": "Request id", "required": true, "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "", "schema": { "type": "string" } } ], "requestBody": { "description": "Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Request" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Request" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Request" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Request" } } } }, "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": [ "Requests" ], "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/Request" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/commerce/requests/{id}/validate": { "post": { "tags": [ "Requests" ], "summary": "Validates the request, and returns any error information at both request parameter and request level.", "parameters": [ { "name": "id", "in": "path", "description": "Request id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Validate" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/commerce/requests/{id}/process": { "post": { "tags": [ "Requests" ], "summary": "Updates the status to processing.", "parameters": [ { "name": "id", "in": "path", "description": "Request id", "required": true, "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "", "schema": { "type": "string" } } ], "requestBody": { "description": "Process request data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Process" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Process" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Process" } } } }, "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/commerce/requests/{id}/query": { "post": { "tags": [ "Requests" ], "summary": "Updates the status to querying.", "parameters": [ { "name": "id", "in": "path", "description": "Request id", "required": true, "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "", "schema": { "type": "string" } } ], "requestBody": { "description": "Query request data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Query" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Query" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Query" } } } }, "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/commerce/requests/{id}/complete": { "post": { "tags": [ "Requests" ], "summary": "Updates the status to complete.", "parameters": [ { "name": "id", "in": "path", "description": "Request id", "required": true, "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "", "schema": { "type": "string" } } ], "requestBody": { "description": "Complete request data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Complete" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Complete" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Complete" } } } }, "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/commerce/requests/{id}/template": { "get": { "tags": [ "Requests" ], "summary": "Renders a request template", "parameters": [ { "name": "id", "in": "path", "description": "Request id", "required": true, "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "", "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/commerce/requests/{requestId}/messages": { "post": { "tags": [ "RequestsMessages" ], "summary": "Creates a new request message.", "parameters": [ { "name": "requestId", "in": "path", "description": "Request Id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Create message", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMessage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateMessage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateMessage" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestMessage" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "RequestsMessages" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestMessageListResponse" } } } } } } }, "/public/v1/commerce/requests/{requestId}/messages/{id}": { "get": { "tags": [ "RequestsMessages" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "select", "in": "query", "schema": { "type": "string" } }, { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestMessage" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/sellers": { "post": { "tags": [ "Sellers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SellerCreate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SellerCreate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SellerCreate" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Seller" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Sellers" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SellerListResponse" } } } } } } }, "/public/v1/accounts/sellers/{id}/activate": { "post": { "tags": [ "Sellers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Seller" } } } }, "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" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Seller" } } } }, "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" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Seller" } } } }, "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}": { "put": { "tags": [ "Sellers" ], "parameters": [ { "name": "id", "in": "path", "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": { "$ref": "#/components/schemas/SellerStatus" }, "Seller.Data.Currencies": { "type": "array", "items": { "type": "string" } }, "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.Name": { "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": { "$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.Type": { "$ref": "#/components/schemas/AccountType" }, "Seller.Data.ErpLink.Buyer.Account.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Seller.Data.ErpLink.Buyer.Account.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "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.Name": { "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.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Created.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Created.By.Type": { "$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.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Created.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Account.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.SystemId": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Name": { "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.Contact.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.FirstName": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.LastName": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.Email": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.Phone.Prefix": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.Phone.Number": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Email": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Status": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Phone.Prefix": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Phone.Number": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.FirstName": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.LastName": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.LastLoginAt": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Contact.User.Settings.CultureCode": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Settings.LanguageCode": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.ExternalId": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.ExternalName": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Type": { "$ref": "#/components/schemas/AccountType" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Address.AddressLine1": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Address.AddressLine2": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Address.PostCode": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Address.City": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Address.State": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Address.Country": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.TechnicalSupportEmail": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Website": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Description": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Eligibility.Client": { "type": "boolean" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Eligibility.Partner": { "type": "boolean" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.SystemId": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Contact.User.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.InvitationAcceptedAt": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Created.By.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Created.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Created.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Updated.By.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Updated.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Updated.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Contact.User.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.SystemId": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Contact.Type": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Activated.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Activated.By.HasIcon": { "type": "boolean" }, "Seller.Data.ErpLink.Buyer.Audit.Activated.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Buyer.Audit.Activated.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Activated.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.By.HasIcon": { "type": "boolean" }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.By.HasIcon": { "type": "boolean" }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Created.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.Data.ErpLink.Buyer.Audit.Created.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Buyer.Audit.Created.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Updated.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.Data.ErpLink.Buyer.Audit.Updated.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Buyer.Audit.Updated.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.SystemId": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Seller.ExternalId": { "type": "string" }, "Seller.Data.ErpLink.Seller.Status": { "$ref": "#/components/schemas/SellerStatus" }, "Seller.Data.ErpLink.Seller.Currencies": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "Seller.Data.ErpLink.Seller.Buyers": { "type": "array", "items": { "$ref": "#/components/schemas/Buyer" } }, "Seller.Data.ErpLink.Seller.ErpLink": { "$ref": "#/components/schemas/ErpLink" }, "Seller.Data.ErpLink.Seller.Icon": { "type": "string" }, "Seller.Data.ErpLink.Seller.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "Seller.Data.ErpLink.Seller.Audit.Created.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Seller.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.Data.ErpLink.Seller.Audit.Created.By.Type": { "$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.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Seller.Audit.Created.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Seller.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.Data.ErpLink.Seller.Audit.Updated.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Seller.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.Data.ErpLink.Seller.Audit.Updated.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Seller.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Seller.Data.ErpLink.Seller.Audit.Updated.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Seller.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Seller.Id": { "type": "string" }, "Seller.Data.ErpLink.Seller.SystemId": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.BuyerId": { "type": "string" }, "Seller.Data.ErpLink.SellerId": { "type": "string" }, "Seller.Data.ErpLink.Name": { "type": "string" }, "Seller.Data.ErpLink.CompanyName": { "type": "string" }, "Seller.Data.ErpLink.Status": { "$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.Icon": { "type": "string" }, "Seller.Data.ErpLink.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "Seller.Data.ErpLink.Audit.Blocked.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Audit.Blocked.By.HasIcon": { "type": "boolean" }, "Seller.Data.ErpLink.Audit.Blocked.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.Data.ErpLink.Audit.Blocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Audit.Blocked.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Audit.Blocked.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.Data.ErpLink.Audit.Unblocked.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Audit.Unblocked.By.HasIcon": { "type": "boolean" }, "Seller.Data.ErpLink.Audit.Unblocked.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.Data.ErpLink.Audit.Unblocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Audit.Unblocked.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Audit.Unblocked.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.Data.ErpLink.Audit.Created.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.Data.ErpLink.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.Data.ErpLink.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Audit.Created.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.Data.ErpLink.Audit.Updated.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.Data.ErpLink.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.Data.ErpLink.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Audit.Updated.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Id": { "type": "string" }, "Seller.Data.ErpLink.SystemId": { "type": "integer", "format": "int32" }, "Seller.Data.Icon": { "type": "string" }, "Seller.Data.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.Audit.Created.ById": { "type": "string" }, "Seller.Data.Audit.Created.By.Name": { "type": "string" }, "Seller.Data.Audit.Created.By.Icon": { "type": "string" }, "Seller.Data.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.Data.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.Data.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.Audit.Created.By.Id": { "type": "string" }, "Seller.Data.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.Data.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.Audit.Updated.ById": { "type": "string" }, "Seller.Data.Audit.Updated.By.Name": { "type": "string" }, "Seller.Data.Audit.Updated.By.Icon": { "type": "string" }, "Seller.Data.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.Data.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.Data.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Seller.Data.Audit.Updated.By.Id": { "type": "string" }, "Seller.Data.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.Data.Id": { "type": "string" }, "Seller.Data.SystemId": { "type": "integer", "format": "int32" }, "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": { "$ref": "#/components/schemas/Audit" }, "$meta": { "$ref": "#/components/schemas/Metadata" }, "icon": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/SellerStatus" }, "currencies": { "type": "array", "items": { "type": "string" }, "nullable": true }, "address": { "$ref": "#/components/schemas/Address" }, "name": { "type": "string" }, "erpLink": { "$ref": "#/components/schemas/ErpLink" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Seller" } } } }, "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" ], "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" } } } } } }, "get": { "tags": [ "Sellers" ], "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/Seller" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/sellers/{id}/icon": { "get": { "tags": [ "Sellers" ], "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/commerce/agreements/{agreementId}/split": { "get": { "tags": [ "SplitBillingAgreement" ], "parameters": [ { "name": "agreementId", "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/SplitBillingAgreement" } } } } } }, "post": { "tags": [ "SplitBillingAgreement" ], "parameters": [ { "name": "agreementId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "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" ], "parameters": [ { "name": "agreementId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "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" ], "parameters": [ { "name": "subscriptionId", "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/SplitBillingSubscription" } } } } } }, "put": { "tags": [ "SplitBillingSubscription" ], "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "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": "Details of the subscription to create", "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 existing subscription", "parameters": [ { "name": "id", "in": "path", "description": "Id of existing agreement to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Update 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 existing subscription", "parameters": [ { "name": "id", "in": "path", "description": "Id of existing agreement to terminate", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Update 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 subscription template", "parameters": [ { "name": "id", "in": "path", "description": "Id of the subscription to render template for", "required": true, "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "Language code for the template", "schema": { "type": "string" } }, { "name": "template.id", "in": "query", "description": "Id of the template to render", "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": { "$ref": "#/components/schemas/CreateTemplateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateTemplateRequest" } }, "application/*+json": { "schema": { "$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": { "$ref": "#/components/schemas/CreateTermsAndConditionsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateTermsAndConditionsRequest" } }, "application/*+json": { "schema": { "$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": { "$ref": "#/components/schemas/UpdateTermsAndConditionsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateTermsAndConditionsRequest" } }, "application/*+json": { "schema": { "$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": { "$ref": "#/components/schemas/CreateUnitOfMeasureRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateUnitOfMeasureRequest" } }, "application/*+json": { "schema": { "$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": { "$ref": "#/components/schemas/UpdateUnitOfMeasureRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateUnitOfMeasureRequest" } }, "application/*+json": { "schema": { "$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": { "post": { "tags": [ "UserGroups" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUserGroupDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateUserGroupDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateUserGroupDto" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroup" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "UserGroups" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupListResponse" } } } } } } }, "/public/v1/accounts/user-groups/{id}": { "put": { "tags": [ "UserGroups" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserGroupDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateUserGroupDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateUserGroupDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroup" } } } }, "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" ], "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" } } } } } }, "get": { "tags": [ "UserGroups" ], "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/UserGroup" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/users/{id}/set-password": { "post": { "tags": [ "Users" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetPasswordDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetPasswordDto" } }, "application/*+json": { "schema": { "$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" } } } } } } }, "/public/v1/accounts/users/{id}": { "put": { "tags": [ "Users" ], "parameters": [ { "name": "id", "in": "path", "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.Icon": { "type": "string" }, "User.Data.LastLoginAt": { "type": "string", "format": "date-time" }, "User.Data.Settings.CultureCode": { "type": "string" }, "User.Data.Settings.LanguageCode": { "type": "string" }, "User.Data.Name": { "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.Type": { "$ref": "#/components/schemas/AccountType" }, "User.Data.CurrentAccount.Status": { "$ref": "#/components/schemas/AccountStatus" }, "User.Data.CurrentAccount.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "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.Name": { "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.Icon": { "type": "string" }, "User.Data.CurrentAccount.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "User.Data.CurrentAccount.Audit.Created.By.Icon": { "type": "string" }, "User.Data.CurrentAccount.Audit.Created.By.HasIcon": { "type": "boolean" }, "User.Data.CurrentAccount.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "User.Data.CurrentAccount.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "User.Data.CurrentAccount.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "User.Data.CurrentAccount.Audit.Created.By.Id": { "type": "string" }, "User.Data.CurrentAccount.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "User.Data.CurrentAccount.Audit.Updated.By.Icon": { "type": "string" }, "User.Data.CurrentAccount.Audit.Updated.By.HasIcon": { "type": "boolean" }, "User.Data.CurrentAccount.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "User.Data.CurrentAccount.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "User.Data.CurrentAccount.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "User.Data.CurrentAccount.Audit.Updated.By.Id": { "type": "string" }, "User.Data.CurrentAccount.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "User.Data.CurrentAccount.Id": { "type": "string" }, "User.Data.CurrentAccount.SystemId": { "type": "integer", "format": "int32" }, "User.Data.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "User.Data.Audit.Created.By.Icon": { "type": "string" }, "User.Data.Audit.Created.By.HasIcon": { "type": "boolean" }, "User.Data.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "User.Data.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "User.Data.Audit.Created.By.Id": { "type": "string" }, "User.Data.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "User.Data.Audit.Updated.At": { "type": "string", "format": "date-time" }, "User.Data.Audit.Updated.ById": { "type": "string" }, "User.Data.Audit.Updated.By.Name": { "type": "string" }, "User.Data.Audit.Updated.By.Icon": { "type": "string" }, "User.Data.Audit.Updated.By.HasIcon": { "type": "boolean" }, "User.Data.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "User.Data.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "User.Data.Audit.Updated.By.Id": { "type": "string" }, "User.Data.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "User.Data.Id": { "type": "string" }, "User.Data.SystemId": { "type": "integer", "format": "int32" }, "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" ], "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" } } } } } }, "get": { "tags": [ "Users" ], "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/User" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/accounts/users/{id}/unblock": { "post": { "tags": [ "Users" ], "parameters": [ { "name": "id", "in": "path", "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/{id}/block": { "post": { "tags": [ "Users" ], "parameters": [ { "name": "id", "in": "path", "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/{id}/sso-check": { "get": { "tags": [ "Users" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "deprecated": true } }, "/public/v1/accounts/users/{id}/sso": { "get": { "tags": [ "Users" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/public/v1/accounts/users/{id}/icon": { "get": { "tags": [ "Users" ], "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/accounts/users/{id}/accounts": { "get": { "tags": [ "Users" ], "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/UserExtendedAccountListResponse" } } } } } } }, "/public/v1/accounts/users": { "get": { "tags": [ "Users" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserListResponse" } } } } } } }, "/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": { "$ref": "#/components/schemas/CreateWebhookRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateWebhookRequest" } }, "application/*+json": { "schema": { "$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": { "$ref": "#/components/schemas/UpdateWebhookRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateWebhookRequest" } }, "application/*+json": { "schema": { "$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/audit/event-types/{id}": { "put": { "tags": [ "AuditEventTypes" ], "summary": "Updates an existing event type.", "parameters": [ { "name": "id", "in": "path", "description": "Id of the event type to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Details of the event type to update", "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" } } }, "get": { "tags": [ "AuditEventTypes" ], "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/AuditEventType" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/audit/event-types": { "get": { "tags": [ "AuditEventTypes" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditEventTypeListResponse" } } } } } } }, "/public/v1/audit/records": { "post": { "tags": [ "AuditRecords" ], "summary": "Creates a new audit record for the object specified in body.", "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" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditRecordListResponse" } } } } } } }, "/public/v1/audit/records/{id}": { "get": { "tags": [ "AuditRecords" ], "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/AuditRecord" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/spotlight/objects/-/refresh": { "post": { "tags": [ "SpotlightObjects" ], "responses": { "204": { "description": "No Content" } } } }, "/public/v1/spotlight/objects/{id}/refresh": { "post": { "tags": [ "SpotlightObjects" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/public/v1/spotlight/objects": { "get": { "tags": [ "SpotlightObjects" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpotlightObjectListResponse" } } } } } } }, "/public/v1/spotlight/queries/{id}": { "put": { "tags": [ "SpotlightQueries" ], "summary": "Updates a query.", "parameters": [ { "name": "id", "in": "path", "description": "id of entity", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "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" } } } } } }, "get": { "tags": [ "SpotlightQueries" ], "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/SpotlightQuery" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/spotlight/queries": { "get": { "tags": [ "SpotlightQueries" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpotlightQueryListResponse" } } } } } } }, "/public/v1/billing/credit-memos/{creditMemoId}/attachments/{id}": { "get": { "tags": [ "CreditMemoAttachments" ], "summary": "Retrieves a specific credit memo attachment by its ID.\r\nDepending on the Accept header, this endpoint can either download the attachment or return only its metadata.", "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.", "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, specified by attachmentId.", "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.", "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.", "parameters": [ { "name": "creditMemoId", "in": "path", "description": "The ID of the credit memo to which the attachment belongs.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The name of the attachment.", "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 a new credit memo.", "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 customer ledger attachment by its ID.\r\nDepending on the Accept header, this endpoint can either download the attachment or return only its metadata.", "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.", "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 an individual custom ledger attachment, specified by attachmentId.", "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.", "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.", "parameters": [ { "name": "customLedgerId", "in": "path", "description": "The ID of the custom ledger to which the attachment belongs.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The name of the attachment.", "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.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the CustomCharge item.", "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.", "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.", "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.", "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.", "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.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the custom ledger.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The file to upload.", "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "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.", "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.", "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.\r\nDepending on the Accept header, this endpoint can either download the attachment or return only its metadata.", "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.", "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 individual invoice attachment, specified by attachmentId.", "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.", "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.", "parameters": [ { "name": "invoiceId", "in": "path", "description": "The ID of the invoice to which the attachment belongs.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The name of the attachment.", "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.", "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.\r\nDepending on the Accept header, this endpoint can either download the attachment or return only its metadata.", "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.", "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 an individual journal attachment, specified by attachmentId.", "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.", "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.", "parameters": [ { "name": "journalId", "in": "path", "description": "The ID of the journal to which the attachment belongs.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The name of the attachment.", "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.", "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.", "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": "Update the source of the charge.", "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": "Ignore the charge to exclude it from client billing.", "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 by undoing all reconcile actions.", "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.", "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.", "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.", "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.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the journal.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Journal file that contains the charges data.", "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "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.", "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.", "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": "Enquiry the journal.", "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.", "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.", "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.", "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.", "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.\r\nDepending on the Accept header, this endpoint can either download the attachment or return only its metadata.", "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.", "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 an individual ledger attachment, specified by attachmentId.", "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.", "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.", "parameters": [ { "name": "ledgerId", "in": "path", "description": "The ID of the ledger to which the attachment belongs.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The name of the attachment.", "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.", "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.", "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 the ledger with the specified ID.", "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 the ledger with the specified ID.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the ledger to regenerate.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The journal 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 the ledger with the specified ID.", "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.", "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.", "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.", "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.\r\nDepending on the Accept header, this endpoint can either download the attachment or return only its metadata.", "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.", "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 an individual statement attachment, specified by attachmentId.", "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.", "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.", "parameters": [ { "name": "statementId", "in": "path", "description": "The ID of the statement to which the attachment belongs.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The name of the attachment.", "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.", "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.", "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/{id}": { "put": { "tags": [ "Statements" ], "summary": "Updates an existing statement.", "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": "Set the statement status to Mpt.Models.Billing.StatementStatus.Cancelled.", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "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": "Set the statement status to Mpt.Models.Billing.StatementStatus.Error.", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "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": "Set the statement status to Mpt.Models.Billing.StatementStatus.Issued.", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "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": "Set the statement status to Mpt.Models.Billing.StatementStatus.Pending.", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "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": "Queue the statement.", "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": "Retry failed statement by setting its status to Mpt.Models.Billing.StatementStatus.Generated.", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "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": "Recalculate the statement.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the statement.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The ledger 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": { "get": { "tags": [ "Statements" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatementListResponse" } } } } } } }, "/public/v1/notifications/batches": { "post": { "tags": [ "Batches" ], "summary": "Creates a new message batch. Effectively queues the messages to be sent.", "requestBody": { "description": "Message batch request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageBatchDto" } } } }, "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" ], "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": "Get attachment. If the accept header lists 'application/json' first this endpoint returns the attachments\r\nmetadata. Otherwise, a redirect to download", "parameters": [ { "name": "batchId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "attachmentId", "in": "path", "description": "", "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" ], "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/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.", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCategoryDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCategoryDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/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.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "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" ], "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" } } } } } }, "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": "Unpublish a category", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NoteDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NoteDto" } } } }, "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": "Publish a category", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NoteDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NoteDto" } } } }, "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.", "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.", "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": { "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" ], "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.", "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.", "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.", "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" ], "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/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": "Returns contacts, which are configured to receive notifications for provided category and account.", "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/Contact" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/public/v1/notifications/messages": { "get": { "tags": [ "Messages" ], "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" ], "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/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/subscribers/{id}": { "put": { "tags": [ "Subscribers" ], "summary": "Updates Subscriber recipients.", "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" ], "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/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 Subscriber recipients.", "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/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 Subscriber recipients.", "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/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" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriberListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } } }, "components": { "schemas": { "AccountCreateFromForm": { "type": "object", "properties": { "account": { "type": "object", "properties": { "ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "ExternalId": { "type": "string" }, "ExternalName": { "type": "string" }, "Type": { "$ref": "#/components/schemas/AccountType" }, "Status": { "$ref": "#/components/schemas/AccountStatus" }, "ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "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" }, "Name": { "type": "string" }, "Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Eligibility.Client": { "type": "boolean" }, "Eligibility.Partner": { "type": "boolean" }, "Icon": { "type": "string" }, "Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Created.ById": { "type": "string" }, "Audit.Created.By.Name": { "type": "string" }, "Audit.Created.By.Icon": { "type": "string" }, "Audit.Created.By.HasIcon": { "type": "boolean" }, "Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Created.By.Id": { "type": "string" }, "Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Updated.ById": { "type": "string" }, "Audit.Updated.By.Name": { "type": "string" }, "Audit.Updated.By.Icon": { "type": "string" }, "Audit.Updated.By.HasIcon": { "type": "boolean" }, "Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Audit.Updated.By.Id": { "type": "string" }, "Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Id": { "type": "string" }, "SystemId": { "type": "integer", "format": "int32" } }, "description": "Json representation of the account" }, "logo": { "type": "string", "format": "binary", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } } }, "AccountCreate": { "required": [ "name", "serviceLevel", "type" ], "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountExternalIds" } ], "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" ] } }, "type": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/AccountType" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "serviceLevel": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/AccountServiceLevel" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "type": "object", "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" ] } }, "name": { "maxLength": 500, "minLength": 1, "type": "string", "x-rql": { "core": true, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Eligibility" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "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 }, "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 }, "Account": { "required": [ "name", "status", "type" ], "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountExternalIds" } ], "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" ] } }, "type": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/AccountType" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "serviceLevel": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/AccountServiceLevel" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "type": "object", "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" ] } }, "name": { "maxLength": 500, "minLength": 1, "type": "string", "x-rql": { "core": true, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Eligibility" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AccountListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } } }, "additionalProperties": false }, "AccountUpdateFromForm": { "type": "object", "properties": { "account": { "type": "object", "properties": { "ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "ExternalId": { "type": "string" }, "ExternalName": { "type": "string" }, "Type": { "$ref": "#/components/schemas/AccountType" }, "Status": { "$ref": "#/components/schemas/AccountStatus" }, "ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "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" }, "Name": { "type": "string" }, "Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Eligibility.Client": { "type": "boolean" }, "Eligibility.Partner": { "type": "boolean" }, "Icon": { "type": "string" }, "Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Created.ById": { "type": "string" }, "Audit.Created.By.Name": { "type": "string" }, "Audit.Created.By.Icon": { "type": "string" }, "Audit.Created.By.HasIcon": { "type": "boolean" }, "Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Created.By.Id": { "type": "string" }, "Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Updated.ById": { "type": "string" }, "Audit.Updated.By.Name": { "type": "string" }, "Audit.Updated.By.Icon": { "type": "string" }, "Audit.Updated.By.HasIcon": { "type": "boolean" }, "Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Audit.Updated.By.Id": { "type": "string" }, "Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Id": { "type": "string" }, "SystemId": { "type": "integer", "format": "int32" } }, "description": "Json representation of the account" }, "logo": { "type": "string", "format": "binary", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } } }, "AccountServiceLevel": { "enum": [ "Express", "Elite", "Dsc", "Focus", "Runners", "Strategics", "NotApplicable" ], "type": "string" }, "AccountStatus": { "enum": [ "Active", "Enabled", "Disabled" ], "type": "string" }, "AccountType": { "enum": [ "Client", "Vendor", "Operations" ], "type": "string" }, "AccountUpdate": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountExternalIds" } ], "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" ] } }, "type": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/AccountType" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "serviceLevel": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/AccountServiceLevel" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "type": "object", "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" ] } }, "name": { "maxLength": 500, "minLength": 1, "type": "string", "x-rql": { "core": true, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Eligibility" } ], "x-rql": { "rqlType": "Reference", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountUserLegacyAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Invitation" } ], "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "invited": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "joined": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DateEvent" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "access": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DateEvent" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AccountUserLegacyAudit": { "type": "object", "properties": { "created": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DateEvent" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "joined": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DateEvent" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AccountUserQueryLegacyListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountUserAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PhoneNumber" } ], "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" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "settings": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/UserSettings" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Invitation" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AccountUserListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountExternalIds" } ], "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" ] } }, "type": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/AccountType" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "serviceLevel": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/AccountServiceLevel" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "type": "object", "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" ] } }, "name": { "type": "string", "nullable": true, "x-rql": { "core": true, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Eligibility" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Address": { "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" ] } } }, "additionalProperties": false }, "AddressOptions": { "type": "object", "properties": { "hintText": { "type": "string" }, "defaultValue": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/DefaultParameterAddress" } ] } }, "additionalProperties": false }, "AgreementAttachmentListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementAttachmentEntity" } } }, "additionalProperties": false }, "Agreement": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AgreementAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/AgreementStatus" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "listing": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListingRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "authorization": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AuthorizationRef" } ], "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" ] } }, "client": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "price": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AgreementSummaryPrice" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "startDate": { "type": "string", "format": "date-time", "nullable": true, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "endDate": { "type": "string", "format": "date-time", "nullable": true, "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" ] } }, "error": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ParametrisedMessage" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementLine" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "assets": { "type": "array", "items": { "$ref": "#/components/schemas/AssetRef" }, "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "subscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionRef" }, "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "parameters": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ParameterBag" } ], "x-rql": { "rqlType": "Reference", "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" ] } }, "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" ] } }, "product": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ExternalIds" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "split": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SplitBillingAgreement" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "termsAndConditions": { "type": "array", "items": { "$ref": "#/components/schemas/CommerceTermsAndConditions" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "certificates": { "type": "array", "items": { "$ref": "#/components/schemas/CertificateRef" }, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AgreementAttachment": { "type": "object", "properties": { "attachment": { "type": "object", "properties": { "Name": { "type": "string" }, "Description": { "type": "string" }, "OrderId": { "type": "string" }, "Type": { "$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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "name": { "type": "string", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AgreementRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AgreementAudit": { "type": "object", "properties": { "created": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "active": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "provisioning": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "terminated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AgreementLineAudit": { "type": "object", "properties": { "created": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "terminated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "deleted": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AgreementLine": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AgreementLineAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "quantity": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "item": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductItem" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "price": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AgreementLinePrice" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "order": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Order" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/AgreementLineStatus" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "subscription": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Subscription" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "asset": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Asset" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "agreement": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Agreement" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "client": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Account" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "vendor": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Account" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "buyer": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Buyer" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "seller": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Seller" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "product": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Product" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ApiToken": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "status": { "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", "nullable": true, "x-rql": { "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" ] } }, "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" ] } } }, "additionalProperties": false }, "AgreementLineListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementLine" } } }, "additionalProperties": false }, "AgreementLinePrice": { "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/MarkupSourcePrice" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "markupSource": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/MarkupSourcePrice" } ], "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 }, "AgreementLineStatus": { "enum": [ "Active", "Terminated", "Deleted", "Expired" ], "type": "string" }, "AgreementListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Agreement" } } }, "additionalProperties": false }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/MarkupSourcePrice" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "markupSource": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/MarkupSourcePrice" } ], "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 }, "ApiTokenListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApiToken" } } }, "additionalProperties": false }, "AssetAudit": { "type": "object", "properties": { "created": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "draft": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "active": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "terminated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Asset": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AssetAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ExternalIds" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/AssetStatus" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "price": { "type": "object", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AssetParameterBag" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "terms": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/TermsEntity" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "agreement": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AgreementRef" } ], "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" ] } }, "priceList": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PriceListRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "listing": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListingRef" } ], "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/AgreementLine" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "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 }, "AuthorizationUpdate": { "type": "object", "properties": { "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AuthorizationExternalIdBag" } ], "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/JournalInput" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "eligibility": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AuthorizationEligibility" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AssetListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Asset" } } }, "additionalProperties": false }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/MarkupSourcePrice" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "markupSource": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/MarkupSourcePrice" } ], "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 }, "Attachment": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "name": { "type": "string", "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" ] } }, "description": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "filename": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "size": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contentType": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "request": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Request" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AttachmentListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" } } }, "additionalProperties": false }, "AttachmentType": { "enum": [ "File", "LicenseKey" ], "type": "string" }, "Authorization": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AuthorizationExternalIdBag" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "currency": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "notes": { "type": "string", "nullable": true, "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" ] } }, "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" ] } }, "statistics": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AuthorizationStatistics" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "journal": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AuthorizationJournal" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "eligibility": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AuthorizationEligibility" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "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 }, "AuthorizationExternalIdInput": { "type": "object", "properties": { "operations": { "type": "string", "nullable": true, "x-rql": { "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 }, "AuthorizationListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Authorization" } } }, "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 }, "BuyerActivate": { "required": [ "account", "externalIds" ], "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BuyerAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contact": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ContactQueryModel" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BuyerExternalIds" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/BuyerStatus" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Address" } ], "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" ] } }, "name": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "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": { "$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.Type": { "$ref": "#/components/schemas/AccountType" }, "Account.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Account.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "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.Name": { "type": "string" }, "Account.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Account.Eligibility.Client": { "type": "boolean" }, "Account.Eligibility.Partner": { "type": "boolean" }, "Account.Icon": { "type": "string" }, "Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Audit.Created.At": { "type": "string", "format": "date-time" }, "Account.Audit.Created.ById": { "type": "string" }, "Account.Audit.Created.By.Name": { "type": "string" }, "Account.Audit.Created.By.Icon": { "type": "string" }, "Account.Audit.Created.By.HasIcon": { "type": "boolean" }, "Account.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Account.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "Account.Audit.Created.By.Id": { "type": "string" }, "Account.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Account.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Account.Audit.Updated.ById": { "type": "string" }, "Account.Audit.Updated.By.Name": { "type": "string" }, "Account.Audit.Updated.By.Icon": { "type": "string" }, "Account.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Account.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Account.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "Account.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Account.Audit.Updated.By.Id": { "type": "string" }, "Account.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Account.Id": { "type": "string" }, "Account.SystemId": { "type": "integer", "format": "int32" }, "Name": { "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" } }, "Contact.Name": { "type": "string" }, "Contact.FirstName": { "type": "string" }, "Contact.LastName": { "type": "string" }, "Contact.Email": { "type": "string" }, "Contact.Phone.Prefix": { "type": "string" }, "Contact.Phone.Number": { "type": "string" }, "Contact.User.Email": { "type": "string" }, "Contact.User.Status": { "type": "string" }, "Contact.User.Phone.Prefix": { "type": "string" }, "Contact.User.Phone.Number": { "type": "string" }, "Contact.User.FirstName": { "type": "string" }, "Contact.User.LastName": { "type": "string" }, "Contact.User.Icon": { "type": "string" }, "Contact.User.LastLoginAt": { "type": "string", "format": "date-time" }, "Contact.User.Settings.CultureCode": { "type": "string" }, "Contact.User.Settings.LanguageCode": { "type": "string" }, "Contact.User.Name": { "type": "string" }, "Contact.User.Accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } }, "Contact.User.CurrentAccount.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Contact.User.CurrentAccount.ExternalId": { "type": "string" }, "Contact.User.CurrentAccount.ExternalName": { "type": "string" }, "Contact.User.CurrentAccount.Type": { "$ref": "#/components/schemas/AccountType" }, "Contact.User.CurrentAccount.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Contact.User.CurrentAccount.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "Contact.User.CurrentAccount.Address.AddressLine1": { "type": "string" }, "Contact.User.CurrentAccount.Address.AddressLine2": { "type": "string" }, "Contact.User.CurrentAccount.Address.PostCode": { "type": "string" }, "Contact.User.CurrentAccount.Address.City": { "type": "string" }, "Contact.User.CurrentAccount.Address.State": { "type": "string" }, "Contact.User.CurrentAccount.Address.Country": { "type": "string" }, "Contact.User.CurrentAccount.TechnicalSupportEmail": { "type": "string" }, "Contact.User.CurrentAccount.Website": { "type": "string" }, "Contact.User.CurrentAccount.Description": { "type": "string" }, "Contact.User.CurrentAccount.Name": { "type": "string" }, "Contact.User.CurrentAccount.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Contact.User.CurrentAccount.Eligibility.Client": { "type": "boolean" }, "Contact.User.CurrentAccount.Eligibility.Partner": { "type": "boolean" }, "Contact.User.CurrentAccount.Icon": { "type": "string" }, "Contact.User.CurrentAccount.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.CurrentAccount.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.CurrentAccount.Audit.Created.ById": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.Name": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.Icon": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.HasIcon": { "type": "boolean" }, "Contact.User.CurrentAccount.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Contact.User.CurrentAccount.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.CurrentAccount.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.CurrentAccount.Audit.Created.By.Id": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.CurrentAccount.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.CurrentAccount.Audit.Updated.ById": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.Name": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.Icon": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Contact.User.CurrentAccount.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Contact.User.CurrentAccount.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.CurrentAccount.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Contact.User.CurrentAccount.Audit.Updated.By.Id": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.CurrentAccount.Id": { "type": "string" }, "Contact.User.CurrentAccount.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.Audit.InvitationAcceptedAt": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Created.ById": { "type": "string" }, "Contact.User.Audit.Created.By.Name": { "type": "string" }, "Contact.User.Audit.Created.By.Icon": { "type": "string" }, "Contact.User.Audit.Created.By.HasIcon": { "type": "boolean" }, "Contact.User.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Contact.User.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Contact.User.Audit.Created.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Contact.User.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.Audit.Created.By.Id": { "type": "string" }, "Contact.User.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Updated.ById": { "type": "string" }, "Contact.User.Audit.Updated.By.Name": { "type": "string" }, "Contact.User.Audit.Updated.By.Icon": { "type": "string" }, "Contact.User.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Contact.User.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Contact.User.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Contact.User.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Contact.User.Audit.Updated.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.Audit.Updated.By.Id": { "type": "string" }, "Contact.User.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.Id": { "type": "string" }, "Contact.User.SystemId": { "type": "integer", "format": "int32" }, "Contact.Type": { "type": "string" }, "Icon": { "type": "string" }, "Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Activated.At": { "type": "string", "format": "date-time" }, "Audit.Activated.ById": { "type": "string" }, "Audit.Activated.By.Name": { "type": "string" }, "Audit.Activated.By.Icon": { "type": "string" }, "Audit.Activated.By.HasIcon": { "type": "boolean" }, "Audit.Activated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Activated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Activated.By.Id": { "type": "string" }, "Audit.Activated.By.SystemId": { "type": "integer", "format": "int32" }, "Audit.Unassigned.At": { "type": "string", "format": "date-time" }, "Audit.Unassigned.ById": { "type": "string" }, "Audit.Unassigned.By.Name": { "type": "string" }, "Audit.Unassigned.By.Icon": { "type": "string" }, "Audit.Unassigned.By.HasIcon": { "type": "boolean" }, "Audit.Unassigned.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Unassigned.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Unassigned.By.Id": { "type": "string" }, "Audit.Unassigned.By.SystemId": { "type": "integer", "format": "int32" }, "Audit.Disabled.At": { "type": "string", "format": "date-time" }, "Audit.Disabled.ById": { "type": "string" }, "Audit.Disabled.By.Name": { "type": "string" }, "Audit.Disabled.By.Icon": { "type": "string" }, "Audit.Disabled.By.HasIcon": { "type": "boolean" }, "Audit.Disabled.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Disabled.By.Id": { "type": "string" }, "Audit.Disabled.By.SystemId": { "type": "integer", "format": "int32" }, "Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Created.ById": { "type": "string" }, "Audit.Created.By.Name": { "type": "string" }, "Audit.Created.By.Icon": { "type": "string" }, "Audit.Created.By.HasIcon": { "type": "boolean" }, "Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Created.By.Id": { "type": "string" }, "Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Updated.ById": { "type": "string" }, "Audit.Updated.By.Name": { "type": "string" }, "Audit.Updated.By.Icon": { "type": "string" }, "Audit.Updated.By.HasIcon": { "type": "boolean" }, "Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Updated.By.Id": { "type": "string" }, "Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Id": { "type": "string" }, "SystemId": { "type": "integer", "format": "int32" } }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BuyerAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contact": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ContactQueryModel" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BuyerExternalIds" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/BuyerStatus" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "type": "object", "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" ] } }, "name": { "maxLength": 500, "minLength": 1, "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "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 }, "BuyerExternalIds": { "type": "object", "properties": { "erpCompanyContact": { "maxLength": 250, "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "erpCustomer": { "maxLength": 250, "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "accountExternalId": { "maxLength": 250, "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "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 }, "Buyer": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BuyerAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contact": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ContactQueryModel" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BuyerExternalIds" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/BuyerStatus" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Address" } ], "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" ] } }, "name": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "activated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unassigned": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "disabled": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "BuyerListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Buyer" } } }, "additionalProperties": false }, "BuyerTransferDetails": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BuyerAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contact": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ContactQueryModel" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BuyerExternalIds" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/BuyerStatus" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Address" } ], "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" ] } }, "name": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "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": { "type": "object", "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 }, "BuyerStatus": { "enum": [ "Active", "Enabled", "Disabled", "Deleted", "Unassigned", "Conflict", "Mismatch" ], "type": "string" }, "BuyerTransfer": { "required": [ "account" ], "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BuyerAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contact": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ContactQueryModel" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BuyerExternalIds" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/BuyerStatus" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Address" } ], "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" ] } }, "name": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "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": { "$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.Type": { "$ref": "#/components/schemas/AccountType" }, "Account.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Account.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "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.Name": { "type": "string" }, "Account.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Account.Eligibility.Client": { "type": "boolean" }, "Account.Eligibility.Partner": { "type": "boolean" }, "Account.Icon": { "type": "string" }, "Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Audit.Created.At": { "type": "string", "format": "date-time" }, "Account.Audit.Created.ById": { "type": "string" }, "Account.Audit.Created.By.Name": { "type": "string" }, "Account.Audit.Created.By.Icon": { "type": "string" }, "Account.Audit.Created.By.HasIcon": { "type": "boolean" }, "Account.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Account.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "Account.Audit.Created.By.Id": { "type": "string" }, "Account.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Account.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Account.Audit.Updated.ById": { "type": "string" }, "Account.Audit.Updated.By.Name": { "type": "string" }, "Account.Audit.Updated.By.Icon": { "type": "string" }, "Account.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Account.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Account.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "Account.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Account.Audit.Updated.By.Id": { "type": "string" }, "Account.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Account.Id": { "type": "string" }, "Account.SystemId": { "type": "integer", "format": "int32" }, "Name": { "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" } }, "Contact.Name": { "type": "string" }, "Contact.FirstName": { "type": "string" }, "Contact.LastName": { "type": "string" }, "Contact.Email": { "type": "string" }, "Contact.Phone.Prefix": { "type": "string" }, "Contact.Phone.Number": { "type": "string" }, "Contact.User.Email": { "type": "string" }, "Contact.User.Status": { "type": "string" }, "Contact.User.Phone.Prefix": { "type": "string" }, "Contact.User.Phone.Number": { "type": "string" }, "Contact.User.FirstName": { "type": "string" }, "Contact.User.LastName": { "type": "string" }, "Contact.User.Icon": { "type": "string" }, "Contact.User.LastLoginAt": { "type": "string", "format": "date-time" }, "Contact.User.Settings.CultureCode": { "type": "string" }, "Contact.User.Settings.LanguageCode": { "type": "string" }, "Contact.User.Name": { "type": "string" }, "Contact.User.Accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } }, "Contact.User.CurrentAccount.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Contact.User.CurrentAccount.ExternalId": { "type": "string" }, "Contact.User.CurrentAccount.ExternalName": { "type": "string" }, "Contact.User.CurrentAccount.Type": { "$ref": "#/components/schemas/AccountType" }, "Contact.User.CurrentAccount.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Contact.User.CurrentAccount.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "Contact.User.CurrentAccount.Address.AddressLine1": { "type": "string" }, "Contact.User.CurrentAccount.Address.AddressLine2": { "type": "string" }, "Contact.User.CurrentAccount.Address.PostCode": { "type": "string" }, "Contact.User.CurrentAccount.Address.City": { "type": "string" }, "Contact.User.CurrentAccount.Address.State": { "type": "string" }, "Contact.User.CurrentAccount.Address.Country": { "type": "string" }, "Contact.User.CurrentAccount.TechnicalSupportEmail": { "type": "string" }, "Contact.User.CurrentAccount.Website": { "type": "string" }, "Contact.User.CurrentAccount.Description": { "type": "string" }, "Contact.User.CurrentAccount.Name": { "type": "string" }, "Contact.User.CurrentAccount.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Contact.User.CurrentAccount.Eligibility.Client": { "type": "boolean" }, "Contact.User.CurrentAccount.Eligibility.Partner": { "type": "boolean" }, "Contact.User.CurrentAccount.Icon": { "type": "string" }, "Contact.User.CurrentAccount.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.CurrentAccount.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.CurrentAccount.Audit.Created.ById": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.Name": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.Icon": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.HasIcon": { "type": "boolean" }, "Contact.User.CurrentAccount.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Contact.User.CurrentAccount.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.CurrentAccount.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.CurrentAccount.Audit.Created.By.Id": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.CurrentAccount.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.CurrentAccount.Audit.Updated.ById": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.Name": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.Icon": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Contact.User.CurrentAccount.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Contact.User.CurrentAccount.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.CurrentAccount.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Contact.User.CurrentAccount.Audit.Updated.By.Id": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.CurrentAccount.Id": { "type": "string" }, "Contact.User.CurrentAccount.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.Audit.InvitationAcceptedAt": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Created.ById": { "type": "string" }, "Contact.User.Audit.Created.By.Name": { "type": "string" }, "Contact.User.Audit.Created.By.Icon": { "type": "string" }, "Contact.User.Audit.Created.By.HasIcon": { "type": "boolean" }, "Contact.User.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Contact.User.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Contact.User.Audit.Created.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Contact.User.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.Audit.Created.By.Id": { "type": "string" }, "Contact.User.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Updated.ById": { "type": "string" }, "Contact.User.Audit.Updated.By.Name": { "type": "string" }, "Contact.User.Audit.Updated.By.Icon": { "type": "string" }, "Contact.User.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Contact.User.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Contact.User.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Contact.User.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Contact.User.Audit.Updated.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.Audit.Updated.By.Id": { "type": "string" }, "Contact.User.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.Id": { "type": "string" }, "Contact.User.SystemId": { "type": "integer", "format": "int32" }, "Contact.Type": { "type": "string" }, "Icon": { "type": "string" }, "Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Activated.At": { "type": "string", "format": "date-time" }, "Audit.Activated.ById": { "type": "string" }, "Audit.Activated.By.Name": { "type": "string" }, "Audit.Activated.By.Icon": { "type": "string" }, "Audit.Activated.By.HasIcon": { "type": "boolean" }, "Audit.Activated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Activated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Activated.By.Id": { "type": "string" }, "Audit.Activated.By.SystemId": { "type": "integer", "format": "int32" }, "Audit.Unassigned.At": { "type": "string", "format": "date-time" }, "Audit.Unassigned.ById": { "type": "string" }, "Audit.Unassigned.By.Name": { "type": "string" }, "Audit.Unassigned.By.Icon": { "type": "string" }, "Audit.Unassigned.By.HasIcon": { "type": "boolean" }, "Audit.Unassigned.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Unassigned.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Unassigned.By.Id": { "type": "string" }, "Audit.Unassigned.By.SystemId": { "type": "integer", "format": "int32" }, "Audit.Disabled.At": { "type": "string", "format": "date-time" }, "Audit.Disabled.ById": { "type": "string" }, "Audit.Disabled.By.Name": { "type": "string" }, "Audit.Disabled.By.Icon": { "type": "string" }, "Audit.Disabled.By.HasIcon": { "type": "boolean" }, "Audit.Disabled.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Disabled.By.Id": { "type": "string" }, "Audit.Disabled.By.SystemId": { "type": "integer", "format": "int32" }, "Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Created.ById": { "type": "string" }, "Audit.Created.By.Name": { "type": "string" }, "Audit.Created.By.Icon": { "type": "string" }, "Audit.Created.By.HasIcon": { "type": "boolean" }, "Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Created.By.Id": { "type": "string" }, "Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Updated.ById": { "type": "string" }, "Audit.Updated.By.Name": { "type": "string" }, "Audit.Updated.By.Icon": { "type": "string" }, "Audit.Updated.By.HasIcon": { "type": "boolean" }, "Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Updated.By.Id": { "type": "string" }, "Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Id": { "type": "string" }, "SystemId": { "type": "integer", "format": "int32" } }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BuyerAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contact": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ContactQueryModel" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BuyerExternalIds" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/BuyerStatus" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "type": "object", "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" ] } }, "name": { "maxLength": 500, "minLength": 1, "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BuyerAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contact": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ContactQueryModel" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BuyerExternalIds" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/BuyerStatus" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Address" } ], "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" ] } }, "name": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "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 }, "Certificate": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/CertificateAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "program": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProgramRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "type": "object", "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": { "type": "string", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProgramEligibility" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/CertificateStatus" } ], "x-rql": { "rqlType": "Reference", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProgramParameterBag" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "terms": { "type": "array", "items": { "$ref": "#/components/schemas/CertificateTerms" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CertificateAudit": { "type": "object", "properties": { "created": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "activated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "pending": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "terminated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "expired": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updating": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CertificateListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Certificate" } } }, "additionalProperties": false }, "CertificateTerms": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProgramTermsAndConditionsAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "name": { "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" ] } }, "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": { "type": "object", "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": [ "Pending", "Updating", "Active", "Terminated", "Expired" ], "type": "string" }, "CertificateUpdate": { "type": "object", "properties": { "parameters": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/UpdateCertificateParameterBag" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "template": { "type": "object", "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": { "type": "object", "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 }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "account": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudTenantExternalIds" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "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" ] } }, "type": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CloudTenantListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CloudTenant" } } }, "additionalProperties": false }, "CommerceTermsAndConditions": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/TermsAndConditionsAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "name": { "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" ] } }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ExtendedIdentity" } ], "x-rql": { "core": true, "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" }, "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": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/ParameterType" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "phase": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/ParameterPhase" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "error": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ParametrisedMessage" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "constraints": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ParameterConstraints" } ], "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 }, "CompleteEnrollment": { "type": "object", "properties": { "template": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/CertificateExternalIds" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Complete": { "type": "object", "properties": { "message": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/TerminateOnExpiration" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "preValidation": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProgramPreValidationInput" } ], "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductRequestsInput" } ], "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PreValidationInput" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "splitBilling": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductSplitBillingRequestsInput" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "subscriptionCessation": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SubscriptionCessationInput" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ConstraintTypeBooleanNullableDictionaryDelta": { "type": "object", "properties": { "node": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ] }, "path": { "type": "string" }, "data": { "type": "object", "properties": { "Required": { "type": "boolean" }, "Hidden": { "type": "boolean" }, "ReadOnly": { "type": "boolean" } }, "additionalProperties": false, "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "Constraints": { "type": "object", "properties": { "hidden": { "type": "boolean", "nullable": true }, "readonly": { "type": "boolean", "nullable": true }, "required": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ContactOptions": { "type": "object", "properties": { "hintText": { "type": "string" }, "defaultValue": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/DefaultParameterContact" } ] }, "phoneMandatory": { "type": "boolean" } }, "additionalProperties": false }, "ContactQueryModel": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "firstName": { "maxLength": 100, "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "lastName": { "maxLength": 100, "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "email": { "maxLength": 320, "type": "string", "format": "email", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "phone": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PhoneNumber" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "user": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/User" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CreateAccountUserDto": { "required": [ "groups" ], "type": "object", "properties": { "email": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/EmailDto" } ], "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" ] } }, "phone": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SetPhoneNumberDto" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "settings": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SetUserSettingsDto" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "user": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/UserProfileDto" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "type": "object", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/InvitationDto" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CreateApiTokenDto": { "type": "object", "properties": { "account": { "type": "object", "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" ] } } }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AuthorizationExternalIdInput" } ], "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "owner": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "journal": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/JournalInput" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "eligibility": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AuthorizationEligibility" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CreateCertificateRequest": { "required": [ "client", "program" ], "type": "object", "properties": { "program": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "buyer": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "licensee": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "client": { "type": "object", "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" ] } }, "parameters": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProgramParameterValueBagInput" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CreateCloudTenantDto": { "required": [ "externalIds", "name" ], "type": "object", "properties": { "type": { "type": "string", "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": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/CloudTenantStatus" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudTenantExternalIdsDto" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountDto" } ], "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "program": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "buyer": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "licensee": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "client": { "type": "object", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProgramParameterValueBagInput" } ], "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "authorization": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "seller": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "priceList": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "eligibility": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListingEligibility" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CreateMessage": { "required": [ "content", "visibility" ], "type": "object", "properties": { "visibility": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestMessageVisibility" } ], "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" ] } } }, "additionalProperties": false }, "CreateParameter": { "required": [ "parameterDefinitionId", "value" ], "type": "object", "properties": { "parameterDefinitionId": { "minLength": 1, "type": "string" }, "value": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "CreateParameterDefinitionRequest": { "required": [ "constraints", "description", "displayOrder", "name", "phase", "scope", "type" ], "type": "object", "properties": { "scope": { "minLength": 1, "enum": [ "Agreement", "Item", "Request", "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" ] } }, "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": { "type": "object", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PriceListExternalIdInput" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "product": { "type": "object", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PricingPolicyExternalIdInput" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "client": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "eligibility": { "type": "object", "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": { "$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": { "type": "object", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductItemExternalIdInput" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "group": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "terms": { "type": "object", "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": { "$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": { "$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": { "$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" ] } }, "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": { "type": "object", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "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" ] } } }, "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" ] } } } }, "CreateRequest": { "required": [ "from", "name", "status", "to" ], "type": "object", "properties": { "externalId": { "maxLength": 250, "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "maxLength": 1000, "minLength": 1, "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "minLength": 1, "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "from": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestFrom" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "requester": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestRequester" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "assignee": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestAssignee" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "to": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestTo" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "product": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestProduct" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/CreateParameter" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "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", "RequestProcessing", "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" ] } } }, "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": { "type": "object", "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" ] } } }, "additionalProperties": false }, "CreateWebhookRequest": { "required": [ "url" ], "type": "object", "properties": { "type": { "type": "string", "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": { "type": "string", "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 }, "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 }, "DecimalDelta": { "type": "object", "properties": { "node": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ] }, "path": { "type": "string" }, "data": { "type": "number", "format": "double", "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "DecimalNullableDelta": { "type": "object", "properties": { "node": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ] }, "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", "Buyer", "Licensee", "CurrentlySignedInUser" ], "type": "string" }, "DefaultParameterEmail": { "enum": [ "None", "CurrentlySignedInUser" ], "type": "string" }, "DeltaNode": { "type": "object", "properties": { "name": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/DeltaNode" }, "readOnly": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DocumentId" } ] }, "fileId": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/FileId" } ] }, "url": { "type": "string", "readOnly": true }, "language": { "type": "string", "readOnly": true }, "status": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/State" } ] }, "isDeleted": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "DocumentId": { "type": "object", "properties": { "value": { "type": "string", "readOnly": true }, "postfixNumber": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "DocumentType": { "enum": [ "Online", "File" ], "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 }, "EnrollmentAttachment": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "name": { "type": "string", "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 }, "EmailDto": { "type": "object", "properties": { "address": { "maxLength": 200, "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "EmailOptions": { "type": "object", "properties": { "placeholderText": { "type": "string" }, "hintText": { "type": "string" }, "defaultValue": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/DefaultParameterEmail" } ] } }, "additionalProperties": false }, "EnrollmentAttachmentListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/EnrollmentAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "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" ] } }, "applicableTo": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/ProgramApplicableTo" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "type": "string", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProgramEligibility" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ParametrisedMessage" } ], "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProgramParameterBag" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "error": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ParametrisedMessage" } ], "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "processing": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "querying": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "completed": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "failed": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "EnrollmentListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Enrollment" } } }, "additionalProperties": false }, "EnrollmentUpdate": { "type": "object", "properties": { "program": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "statusNotes": { "type": "object", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "error": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ParametrisedMessage" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "parameters": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/UpdateEnrollmentParameterBag" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "template": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "EnrollmentStatus": { "enum": [ "Processing", "Querying", "Completed", "Failed" ], "type": "string" }, "EnrollmentType": { "enum": [ "Change", "New" ], "type": "string" }, "ErpLink": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ErpLinkAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "icon": { "type": "string", "nullable": true, "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" ] } }, "name": { "type": "string", "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": { "type": "string", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BuyerExternalIds" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "address": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Address" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } } }, "additionalProperties": false }, "ErpLinkAudit": { "type": "object", "properties": { "created": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "blocked": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unblocked": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ErpLinkListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "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": { "$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.Type": { "$ref": "#/components/schemas/AccountType" }, "ErpLink.Data.Buyer.Account.Status": { "$ref": "#/components/schemas/AccountStatus" }, "ErpLink.Data.Buyer.Account.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "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.Name": { "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.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "ErpLink.Data.Buyer.Account.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Account.Audit.Created.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Buyer.Account.Audit.Created.By.Type": { "$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.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Buyer.Account.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Account.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "ErpLink.Data.Buyer.Account.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Account.Audit.Updated.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Buyer.Account.Audit.Updated.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Buyer.Account.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "ErpLink.Data.Buyer.Account.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Account.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Account.Id": { "type": "string" }, "ErpLink.Data.Buyer.Account.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Name": { "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.Contact.Name": { "type": "string" }, "ErpLink.Data.Buyer.Contact.FirstName": { "type": "string" }, "ErpLink.Data.Buyer.Contact.LastName": { "type": "string" }, "ErpLink.Data.Buyer.Contact.Email": { "type": "string" }, "ErpLink.Data.Buyer.Contact.Phone.Prefix": { "type": "string" }, "ErpLink.Data.Buyer.Contact.Phone.Number": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Email": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Status": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Phone.Prefix": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Phone.Number": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.FirstName": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.LastName": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.LastLoginAt": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Contact.User.Settings.CultureCode": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Settings.LanguageCode": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Name": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.ExternalId": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.ExternalName": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Type": { "$ref": "#/components/schemas/AccountType" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Status": { "$ref": "#/components/schemas/AccountStatus" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Address.AddressLine1": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Address.AddressLine2": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Address.PostCode": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Address.City": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Address.State": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Address.Country": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.TechnicalSupportEmail": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Website": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Description": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Name": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Eligibility.Client": { "type": "boolean" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Eligibility.Partner": { "type": "boolean" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Name": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Created.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Name": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.Id": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.CurrentAccount.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Contact.User.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Buyer.Contact.User.Audit.InvitationAcceptedAt": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Contact.User.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Contact.User.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Audit.Created.By.Name": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Audit.Created.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Buyer.Contact.User.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Buyer.Contact.User.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Buyer.Contact.User.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Contact.User.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Audit.Created.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Buyer.Contact.User.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Contact.User.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Buyer.Contact.User.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Contact.User.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Contact.User.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Audit.Updated.By.Name": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Audit.Updated.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Buyer.Contact.User.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Buyer.Contact.User.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Buyer.Contact.User.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Contact.User.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Buyer.Contact.User.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Buyer.Contact.User.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Audit.Updated.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Buyer.Contact.User.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Contact.User.Id": { "type": "string" }, "ErpLink.Data.Buyer.Contact.User.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Contact.Type": { "type": "string" }, "ErpLink.Data.Buyer.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Activated.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Activated.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Buyer.Audit.Activated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Buyer.Audit.Activated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Buyer.Audit.Activated.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Activated.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Unassigned.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Unassigned.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Buyer.Audit.Unassigned.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Buyer.Audit.Unassigned.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Buyer.Audit.Unassigned.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Unassigned.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Disabled.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Disabled.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Buyer.Audit.Disabled.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Buyer.Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Buyer.Audit.Disabled.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Disabled.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Created.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Buyer.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Buyer.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Buyer.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Updated.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Buyer.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Buyer.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Buyer.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Buyer.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Buyer.Id": { "type": "string" }, "ErpLink.Data.Buyer.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ExternalId": { "type": "string" }, "ErpLink.Data.Seller.Status": { "$ref": "#/components/schemas/SellerStatus" }, "ErpLink.Data.Seller.Currencies": { "type": "array", "items": { "type": "string" } }, "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.Name": { "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": { "$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.Type": { "$ref": "#/components/schemas/AccountType" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Status": { "$ref": "#/components/schemas/AccountStatus" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "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.Name": { "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.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Created.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Created.By.Type": { "$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.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Account.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Name": { "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.Contact.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.FirstName": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.LastName": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.Email": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.Phone.Prefix": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.Phone.Number": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Email": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Status": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Phone.Prefix": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Phone.Number": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.FirstName": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.LastName": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.LastLoginAt": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Settings.CultureCode": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Settings.LanguageCode": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.ExternalId": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.ExternalName": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Type": { "$ref": "#/components/schemas/AccountType" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Status": { "$ref": "#/components/schemas/AccountStatus" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.AddressLine1": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.AddressLine2": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.PostCode": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.City": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.State": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.Country": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.TechnicalSupportEmail": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Website": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Description": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Eligibility.Client": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Eligibility.Partner": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.CurrentAccount.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.InvitationAcceptedAt": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.User.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Contact.Type": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Activated.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Unassigned.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Disabled.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Buyer.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Buyer.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Seller": { "$ref": "#/components/schemas/Seller" }, "ErpLink.Data.Seller.ErpLink.BuyerId": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.SellerId": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.CompanyName": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Status": { "$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.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Blocked.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Unblocked.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Created.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Audit.Created.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.ErpLink.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.ErpLink.Id": { "type": "string" }, "ErpLink.Data.Seller.ErpLink.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.Icon": { "type": "string" }, "ErpLink.Data.Seller.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "ErpLink.Data.Seller.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.Audit.Created.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Seller.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Seller.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Seller.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Seller.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "ErpLink.Data.Seller.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Seller.Audit.Updated.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Seller.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Seller.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Seller.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "ErpLink.Data.Seller.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Seller.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Seller.Id": { "type": "string" }, "ErpLink.Data.Seller.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.BuyerId": { "type": "string" }, "ErpLink.Data.SellerId": { "type": "string" }, "ErpLink.Data.Name": { "type": "string" }, "ErpLink.Data.CompanyName": { "type": "string" }, "ErpLink.Data.Status": { "$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.Icon": { "type": "string" }, "ErpLink.Data.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "ErpLink.Data.Audit.Blocked.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Audit.Blocked.ById": { "type": "string" }, "ErpLink.Data.Audit.Blocked.By.Name": { "type": "string" }, "ErpLink.Data.Audit.Blocked.By.Icon": { "type": "string" }, "ErpLink.Data.Audit.Blocked.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Audit.Blocked.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Audit.Blocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Audit.Blocked.By.Id": { "type": "string" }, "ErpLink.Data.Audit.Blocked.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Audit.Unblocked.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Audit.Unblocked.ById": { "type": "string" }, "ErpLink.Data.Audit.Unblocked.By.Name": { "type": "string" }, "ErpLink.Data.Audit.Unblocked.By.Icon": { "type": "string" }, "ErpLink.Data.Audit.Unblocked.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Audit.Unblocked.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Audit.Unblocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Audit.Unblocked.By.Id": { "type": "string" }, "ErpLink.Data.Audit.Unblocked.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Audit.Created.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Audit.Created.ById": { "type": "string" }, "ErpLink.Data.Audit.Created.By.Name": { "type": "string" }, "ErpLink.Data.Audit.Created.By.Icon": { "type": "string" }, "ErpLink.Data.Audit.Created.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Audit.Created.By.Id": { "type": "string" }, "ErpLink.Data.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Audit.Updated.At": { "type": "string", "format": "date-time" }, "ErpLink.Data.Audit.Updated.ById": { "type": "string" }, "ErpLink.Data.Audit.Updated.By.Name": { "type": "string" }, "ErpLink.Data.Audit.Updated.By.Icon": { "type": "string" }, "ErpLink.Data.Audit.Updated.By.HasIcon": { "type": "boolean" }, "ErpLink.Data.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "ErpLink.Data.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "ErpLink.Data.Audit.Updated.By.Id": { "type": "string" }, "ErpLink.Data.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "ErpLink.Data.Id": { "type": "string" }, "ErpLink.Data.SystemId": { "type": "integer", "format": "int32" }, "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" ] } } } }, "ErpLinkStatus": { "enum": [ "Active", "Blocked" ], "type": "string" }, "ExtendedIdentity": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "name": { "type": "string", "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" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ParametrisedMessage" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "constraints": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Constraints" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ExtendedParameterValueDelta": { "type": "object", "properties": { "node": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ] }, "path": { "type": "string" }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ExtendedParameterValue" } ] }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ExtendedParameterValueListDelta": { "type": "object", "properties": { "node": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ] }, "path": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ExtendedParameterValue" }, "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "Identity": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "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 }, "ExternalIds": { "type": "object", "properties": { "client": { "type": "string", "nullable": true, "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" ] } }, "vendor": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "FailEnrollmentRequest": { "required": [ "statusNotes" ], "type": "object", "properties": { "statusNotes": { "type": "object", "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 }, "Filters": { "type": "object", "properties": { "group.buyers": { "type": "array", "items": { "type": "string" } } }, "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" }, "Invitation": { "type": "object", "properties": { "url": { "type": "string", "nullable": true }, "status": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "IdentityType": { "enum": [ "User", "ApiToken" ], "type": "string" }, "Int32Delta": { "type": "object", "properties": { "node": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ] }, "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 }, "ItemGroup": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "name": { "type": "string", "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 }, "ItemGroupListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ItemGroup" } } }, "additionalProperties": false }, "LicenseeCreateFromForm": { "type": "object", "properties": { "licensee": { "type": "object", "properties": { "Name": { "type": "string" }, "ExternalId": { "type": "string" }, "Status": { "$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.Type": { "$ref": "#/components/schemas/AccountType" }, "Account.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Account.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "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.Name": { "type": "string" }, "Account.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Account.Eligibility.Client": { "type": "boolean" }, "Account.Eligibility.Partner": { "type": "boolean" }, "Account.Icon": { "type": "string" }, "Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Audit.Created.At": { "type": "string", "format": "date-time" }, "Account.Audit.Created.ById": { "type": "string" }, "Account.Audit.Created.By.Name": { "type": "string" }, "Account.Audit.Created.By.Icon": { "type": "string" }, "Account.Audit.Created.By.HasIcon": { "type": "boolean" }, "Account.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Account.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "Account.Audit.Created.By.Id": { "type": "string" }, "Account.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Account.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Account.Audit.Updated.ById": { "type": "string" }, "Account.Audit.Updated.By.Name": { "type": "string" }, "Account.Audit.Updated.By.Icon": { "type": "string" }, "Account.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Account.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Account.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "Account.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Account.Audit.Updated.By.Id": { "type": "string" }, "Account.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Account.Id": { "type": "string" }, "Account.SystemId": { "type": "integer", "format": "int32" }, "Buyer.ExternalIds.ErpCompanyContact": { "type": "string" }, "Buyer.ExternalIds.ErpCustomer": { "type": "string" }, "Buyer.ExternalIds.AccountExternalId": { "type": "string" }, "Buyer.Status": { "$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.Type": { "$ref": "#/components/schemas/AccountType" }, "Buyer.Account.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Buyer.Account.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "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.Name": { "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.Icon": { "type": "string" }, "Buyer.Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Account.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Account.Audit.Created.ById": { "type": "string" }, "Buyer.Account.Audit.Created.By.Name": { "type": "string" }, "Buyer.Account.Audit.Created.By.Icon": { "type": "string" }, "Buyer.Account.Audit.Created.By.HasIcon": { "type": "boolean" }, "Buyer.Account.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Account.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Account.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "Buyer.Account.Audit.Created.By.Id": { "type": "string" }, "Buyer.Account.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Account.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Account.Audit.Updated.ById": { "type": "string" }, "Buyer.Account.Audit.Updated.By.Name": { "type": "string" }, "Buyer.Account.Audit.Updated.By.Icon": { "type": "string" }, "Buyer.Account.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Buyer.Account.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Account.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "Buyer.Account.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Buyer.Account.Audit.Updated.By.Id": { "type": "string" }, "Buyer.Account.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Account.Id": { "type": "string" }, "Buyer.Account.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Name": { "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.Contact.Name": { "type": "string" }, "Buyer.Contact.FirstName": { "type": "string" }, "Buyer.Contact.LastName": { "type": "string" }, "Buyer.Contact.Email": { "type": "string" }, "Buyer.Contact.Phone.Prefix": { "type": "string" }, "Buyer.Contact.Phone.Number": { "type": "string" }, "Buyer.Contact.User.Email": { "type": "string" }, "Buyer.Contact.User.Status": { "type": "string" }, "Buyer.Contact.User.Phone.Prefix": { "type": "string" }, "Buyer.Contact.User.Phone.Number": { "type": "string" }, "Buyer.Contact.User.FirstName": { "type": "string" }, "Buyer.Contact.User.LastName": { "type": "string" }, "Buyer.Contact.User.Icon": { "type": "string" }, "Buyer.Contact.User.LastLoginAt": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.Settings.CultureCode": { "type": "string" }, "Buyer.Contact.User.Settings.LanguageCode": { "type": "string" }, "Buyer.Contact.User.Name": { "type": "string" }, "Buyer.Contact.User.Accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } }, "Buyer.Contact.User.CurrentAccount.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Buyer.Contact.User.CurrentAccount.ExternalId": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.ExternalName": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Type": { "$ref": "#/components/schemas/AccountType" }, "Buyer.Contact.User.CurrentAccount.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Buyer.Contact.User.CurrentAccount.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "Buyer.Contact.User.CurrentAccount.Address.AddressLine1": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Address.AddressLine2": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Address.PostCode": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Address.City": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Address.State": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Address.Country": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.TechnicalSupportEmail": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Website": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Description": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Name": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Buyer.Contact.User.CurrentAccount.Eligibility.Client": { "type": "boolean" }, "Buyer.Contact.User.CurrentAccount.Eligibility.Partner": { "type": "boolean" }, "Buyer.Contact.User.CurrentAccount.Icon": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Contact.User.CurrentAccount.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.ById": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Name": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Icon": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.HasIcon": { "type": "boolean" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Id": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.ById": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Name": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Icon": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Id": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Contact.User.CurrentAccount.Id": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Contact.User.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Contact.User.Audit.InvitationAcceptedAt": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.Audit.Created.ById": { "type": "string" }, "Buyer.Contact.User.Audit.Created.By.Name": { "type": "string" }, "Buyer.Contact.User.Audit.Created.By.Icon": { "type": "string" }, "Buyer.Contact.User.Audit.Created.By.HasIcon": { "type": "boolean" }, "Buyer.Contact.User.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Contact.User.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Contact.User.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Buyer.Contact.User.Audit.Created.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Buyer.Contact.User.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Contact.User.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Buyer.Contact.User.Audit.Created.By.Id": { "type": "string" }, "Buyer.Contact.User.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Contact.User.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.Audit.Updated.ById": { "type": "string" }, "Buyer.Contact.User.Audit.Updated.By.Name": { "type": "string" }, "Buyer.Contact.User.Audit.Updated.By.Icon": { "type": "string" }, "Buyer.Contact.User.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Buyer.Contact.User.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Contact.User.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Contact.User.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Buyer.Contact.User.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Buyer.Contact.User.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Contact.User.Audit.Updated.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Buyer.Contact.User.Audit.Updated.By.Id": { "type": "string" }, "Buyer.Contact.User.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Contact.User.Id": { "type": "string" }, "Buyer.Contact.User.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Contact.Type": { "type": "string" }, "Buyer.Icon": { "type": "string" }, "Buyer.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Audit.Activated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Activated.ById": { "type": "string" }, "Buyer.Audit.Activated.By.Name": { "type": "string" }, "Buyer.Audit.Activated.By.Icon": { "type": "string" }, "Buyer.Audit.Activated.By.HasIcon": { "type": "boolean" }, "Buyer.Audit.Activated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Audit.Activated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Buyer.Audit.Activated.By.Id": { "type": "string" }, "Buyer.Audit.Activated.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Audit.Unassigned.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Unassigned.ById": { "type": "string" }, "Buyer.Audit.Unassigned.By.Name": { "type": "string" }, "Buyer.Audit.Unassigned.By.Icon": { "type": "string" }, "Buyer.Audit.Unassigned.By.HasIcon": { "type": "boolean" }, "Buyer.Audit.Unassigned.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Audit.Unassigned.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Buyer.Audit.Unassigned.By.Id": { "type": "string" }, "Buyer.Audit.Unassigned.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Audit.Disabled.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Disabled.ById": { "type": "string" }, "Buyer.Audit.Disabled.By.Name": { "type": "string" }, "Buyer.Audit.Disabled.By.Icon": { "type": "string" }, "Buyer.Audit.Disabled.By.HasIcon": { "type": "boolean" }, "Buyer.Audit.Disabled.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Buyer.Audit.Disabled.By.Id": { "type": "string" }, "Buyer.Audit.Disabled.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Created.ById": { "type": "string" }, "Buyer.Audit.Created.By.Name": { "type": "string" }, "Buyer.Audit.Created.By.Icon": { "type": "string" }, "Buyer.Audit.Created.By.HasIcon": { "type": "boolean" }, "Buyer.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Buyer.Audit.Created.By.Id": { "type": "string" }, "Buyer.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Updated.ById": { "type": "string" }, "Buyer.Audit.Updated.By.Name": { "type": "string" }, "Buyer.Audit.Updated.By.Icon": { "type": "string" }, "Buyer.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Buyer.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Buyer.Audit.Updated.By.Id": { "type": "string" }, "Buyer.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Id": { "type": "string" }, "Buyer.SystemId": { "type": "integer", "format": "int32" }, "Seller.ExternalId": { "type": "string" }, "Seller.Status": { "$ref": "#/components/schemas/SellerStatus" }, "Seller.Currencies": { "type": "array", "items": { "type": "string" } }, "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.Name": { "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": { "$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.Type": { "$ref": "#/components/schemas/AccountType" }, "Seller.ErpLink.Buyer.Account.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Seller.ErpLink.Buyer.Account.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "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.Name": { "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.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Type": { "$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.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Account.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Account.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Name": { "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.Contact.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.FirstName": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.LastName": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.Email": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.Phone.Prefix": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.Phone.Number": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Email": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Status": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Phone.Prefix": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Phone.Number": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.FirstName": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.LastName": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.LastLoginAt": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.Settings.CultureCode": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Settings.LanguageCode": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.ExternalId": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.ExternalName": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Type": { "$ref": "#/components/schemas/AccountType" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.AddressLine1": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.AddressLine2": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.PostCode": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.City": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.State": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.Country": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.TechnicalSupportEmail": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Website": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Description": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Eligibility.Client": { "type": "boolean" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Eligibility.Partner": { "type": "boolean" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Contact.User.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Contact.User.Audit.InvitationAcceptedAt": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Contact.User.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Contact.Type": { "type": "string" }, "Seller.ErpLink.Buyer.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Activated.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Activated.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Id": { "type": "string" }, "Seller.ErpLink.Buyer.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Seller.ExternalId": { "type": "string" }, "Seller.ErpLink.Seller.Status": { "$ref": "#/components/schemas/SellerStatus" }, "Seller.ErpLink.Seller.Currencies": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "Seller.ErpLink.Seller.Buyers": { "type": "array", "items": { "$ref": "#/components/schemas/Buyer" } }, "Seller.ErpLink.Seller.ErpLink": { "$ref": "#/components/schemas/ErpLink" }, "Seller.ErpLink.Seller.Icon": { "type": "string" }, "Seller.ErpLink.Seller.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Seller.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Seller.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Seller.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Seller.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Seller.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Seller.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Seller.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Seller.ErpLink.Seller.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Seller.Id": { "type": "string" }, "Seller.ErpLink.Seller.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.BuyerId": { "type": "string" }, "Seller.ErpLink.SellerId": { "type": "string" }, "Seller.ErpLink.Name": { "type": "string" }, "Seller.ErpLink.CompanyName": { "type": "string" }, "Seller.ErpLink.Status": { "$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.Icon": { "type": "string" }, "Seller.ErpLink.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Audit.Blocked.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Blocked.ById": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.Name": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.Icon": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Audit.Blocked.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Audit.Blocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Audit.Blocked.By.Id": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Audit.Unblocked.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Unblocked.ById": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.Name": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.Icon": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Audit.Unblocked.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Audit.Unblocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Audit.Unblocked.By.Id": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.Name": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.Name": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Id": { "type": "string" }, "Seller.ErpLink.SystemId": { "type": "integer", "format": "int32" }, "Seller.Icon": { "type": "string" }, "Seller.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Audit.Created.ById": { "type": "string" }, "Seller.Audit.Created.By.Name": { "type": "string" }, "Seller.Audit.Created.By.Icon": { "type": "string" }, "Seller.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.Audit.Created.By.Id": { "type": "string" }, "Seller.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Audit.Updated.ById": { "type": "string" }, "Seller.Audit.Updated.By.Name": { "type": "string" }, "Seller.Audit.Updated.By.Icon": { "type": "string" }, "Seller.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Seller.Audit.Updated.By.Id": { "type": "string" }, "Seller.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.Id": { "type": "string" }, "Seller.SystemId": { "type": "integer", "format": "int32" }, "Eligibility.Client": { "type": "boolean" }, "Eligibility.Partner": { "type": "boolean" }, "Contact.Name": { "type": "string" }, "Contact.FirstName": { "type": "string" }, "Contact.LastName": { "type": "string" }, "Contact.Email": { "type": "string" }, "Contact.Phone.Prefix": { "type": "string" }, "Contact.Phone.Number": { "type": "string" }, "Contact.User.Email": { "type": "string" }, "Contact.User.Status": { "type": "string" }, "Contact.User.Phone.Prefix": { "type": "string" }, "Contact.User.Phone.Number": { "type": "string" }, "Contact.User.FirstName": { "type": "string" }, "Contact.User.LastName": { "type": "string" }, "Contact.User.Icon": { "type": "string" }, "Contact.User.LastLoginAt": { "type": "string", "format": "date-time" }, "Contact.User.Settings.CultureCode": { "type": "string" }, "Contact.User.Settings.LanguageCode": { "type": "string" }, "Contact.User.Name": { "type": "string" }, "Contact.User.Accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } }, "Contact.User.CurrentAccount.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Contact.User.CurrentAccount.ExternalId": { "type": "string" }, "Contact.User.CurrentAccount.ExternalName": { "type": "string" }, "Contact.User.CurrentAccount.Type": { "$ref": "#/components/schemas/AccountType" }, "Contact.User.CurrentAccount.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Contact.User.CurrentAccount.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "Contact.User.CurrentAccount.Address.AddressLine1": { "type": "string" }, "Contact.User.CurrentAccount.Address.AddressLine2": { "type": "string" }, "Contact.User.CurrentAccount.Address.PostCode": { "type": "string" }, "Contact.User.CurrentAccount.Address.City": { "type": "string" }, "Contact.User.CurrentAccount.Address.State": { "type": "string" }, "Contact.User.CurrentAccount.Address.Country": { "type": "string" }, "Contact.User.CurrentAccount.TechnicalSupportEmail": { "type": "string" }, "Contact.User.CurrentAccount.Website": { "type": "string" }, "Contact.User.CurrentAccount.Description": { "type": "string" }, "Contact.User.CurrentAccount.Name": { "type": "string" }, "Contact.User.CurrentAccount.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Contact.User.CurrentAccount.Eligibility.Client": { "type": "boolean" }, "Contact.User.CurrentAccount.Eligibility.Partner": { "type": "boolean" }, "Contact.User.CurrentAccount.Icon": { "type": "string" }, "Contact.User.CurrentAccount.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.CurrentAccount.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.CurrentAccount.Audit.Created.ById": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.Name": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.Icon": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.HasIcon": { "type": "boolean" }, "Contact.User.CurrentAccount.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Contact.User.CurrentAccount.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.CurrentAccount.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.CurrentAccount.Audit.Created.By.Id": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.CurrentAccount.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.CurrentAccount.Audit.Updated.ById": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.Name": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.Icon": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Contact.User.CurrentAccount.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Contact.User.CurrentAccount.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.CurrentAccount.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Contact.User.CurrentAccount.Audit.Updated.By.Id": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.CurrentAccount.Id": { "type": "string" }, "Contact.User.CurrentAccount.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.Audit.InvitationAcceptedAt": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Created.ById": { "type": "string" }, "Contact.User.Audit.Created.By.Name": { "type": "string" }, "Contact.User.Audit.Created.By.Icon": { "type": "string" }, "Contact.User.Audit.Created.By.HasIcon": { "type": "boolean" }, "Contact.User.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Contact.User.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Contact.User.Audit.Created.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Contact.User.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.Audit.Created.By.Id": { "type": "string" }, "Contact.User.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Updated.ById": { "type": "string" }, "Contact.User.Audit.Updated.By.Name": { "type": "string" }, "Contact.User.Audit.Updated.By.Icon": { "type": "string" }, "Contact.User.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Contact.User.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Contact.User.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Contact.User.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Contact.User.Audit.Updated.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.Audit.Updated.By.Id": { "type": "string" }, "Contact.User.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.Id": { "type": "string" }, "Contact.User.SystemId": { "type": "integer", "format": "int32" }, "Contact.Type": { "type": "string" }, "Icon": { "type": "string" }, "Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Disabled.At": { "type": "string", "format": "date-time" }, "Audit.Disabled.ById": { "type": "string" }, "Audit.Disabled.By.Name": { "type": "string" }, "Audit.Disabled.By.Icon": { "type": "string" }, "Audit.Disabled.By.HasIcon": { "type": "boolean" }, "Audit.Disabled.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Disabled.By.Id": { "type": "string" }, "Audit.Disabled.By.SystemId": { "type": "integer", "format": "int32" }, "Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Created.ById": { "type": "string" }, "Audit.Created.By.Name": { "type": "string" }, "Audit.Created.By.Icon": { "type": "string" }, "Audit.Created.By.HasIcon": { "type": "boolean" }, "Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Created.By.Id": { "type": "string" }, "Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Updated.ById": { "type": "string" }, "Audit.Updated.By.Name": { "type": "string" }, "Audit.Updated.By.Icon": { "type": "string" }, "Audit.Updated.By.HasIcon": { "type": "boolean" }, "Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Updated.By.Id": { "type": "string" }, "Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Id": { "type": "string" }, "SystemId": { "type": "integer", "format": "int32" } }, "description": "Json representation of the licensee" }, "logo": { "type": "string", "format": "binary", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } } }, "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 }, "LicenseeCreate": { "required": [ "buyer", "seller", "useBuyerAddress" ], "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/LicenseeAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "icon": { "maxLength": 2000, "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contact": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ContactQueryModel" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "maxLength": 500, "type": "string", "nullable": true, "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": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/LicenseeStatus" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Address" } ], "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Eligibility" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Licensee": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/LicenseeAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contact": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ContactQueryModel" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "nullable": true, "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": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/LicenseeStatus" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Address" } ], "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Eligibility" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "LicenseeAudit": { "type": "object", "properties": { "created": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "disabled": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "LicenseeListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Licensee" } } }, "additionalProperties": false }, "LicenseeUpdateFromForm": { "type": "object", "properties": { "licensee": { "type": "object", "properties": { "Name": { "type": "string" }, "ExternalId": { "type": "string" }, "Status": { "$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.Type": { "$ref": "#/components/schemas/AccountType" }, "Account.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Account.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "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.Name": { "type": "string" }, "Account.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Account.Eligibility.Client": { "type": "boolean" }, "Account.Eligibility.Partner": { "type": "boolean" }, "Account.Icon": { "type": "string" }, "Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Audit.Created.At": { "type": "string", "format": "date-time" }, "Account.Audit.Created.ById": { "type": "string" }, "Account.Audit.Created.By.Name": { "type": "string" }, "Account.Audit.Created.By.Icon": { "type": "string" }, "Account.Audit.Created.By.HasIcon": { "type": "boolean" }, "Account.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Account.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Account.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "Account.Audit.Created.By.Id": { "type": "string" }, "Account.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Account.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Account.Audit.Updated.ById": { "type": "string" }, "Account.Audit.Updated.By.Name": { "type": "string" }, "Account.Audit.Updated.By.Icon": { "type": "string" }, "Account.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Account.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Account.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "Account.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Account.Audit.Updated.By.Id": { "type": "string" }, "Account.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Account.Id": { "type": "string" }, "Account.SystemId": { "type": "integer", "format": "int32" }, "Buyer.ExternalIds.ErpCompanyContact": { "type": "string" }, "Buyer.ExternalIds.ErpCustomer": { "type": "string" }, "Buyer.ExternalIds.AccountExternalId": { "type": "string" }, "Buyer.Status": { "$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.Type": { "$ref": "#/components/schemas/AccountType" }, "Buyer.Account.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Buyer.Account.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "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.Name": { "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.Icon": { "type": "string" }, "Buyer.Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Account.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Account.Audit.Created.ById": { "type": "string" }, "Buyer.Account.Audit.Created.By.Name": { "type": "string" }, "Buyer.Account.Audit.Created.By.Icon": { "type": "string" }, "Buyer.Account.Audit.Created.By.HasIcon": { "type": "boolean" }, "Buyer.Account.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Account.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Account.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "Buyer.Account.Audit.Created.By.Id": { "type": "string" }, "Buyer.Account.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Account.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Account.Audit.Updated.ById": { "type": "string" }, "Buyer.Account.Audit.Updated.By.Name": { "type": "string" }, "Buyer.Account.Audit.Updated.By.Icon": { "type": "string" }, "Buyer.Account.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Buyer.Account.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Account.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "Buyer.Account.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Buyer.Account.Audit.Updated.By.Id": { "type": "string" }, "Buyer.Account.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Account.Id": { "type": "string" }, "Buyer.Account.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Name": { "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.Contact.Name": { "type": "string" }, "Buyer.Contact.FirstName": { "type": "string" }, "Buyer.Contact.LastName": { "type": "string" }, "Buyer.Contact.Email": { "type": "string" }, "Buyer.Contact.Phone.Prefix": { "type": "string" }, "Buyer.Contact.Phone.Number": { "type": "string" }, "Buyer.Contact.User.Email": { "type": "string" }, "Buyer.Contact.User.Status": { "type": "string" }, "Buyer.Contact.User.Phone.Prefix": { "type": "string" }, "Buyer.Contact.User.Phone.Number": { "type": "string" }, "Buyer.Contact.User.FirstName": { "type": "string" }, "Buyer.Contact.User.LastName": { "type": "string" }, "Buyer.Contact.User.Icon": { "type": "string" }, "Buyer.Contact.User.LastLoginAt": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.Settings.CultureCode": { "type": "string" }, "Buyer.Contact.User.Settings.LanguageCode": { "type": "string" }, "Buyer.Contact.User.Name": { "type": "string" }, "Buyer.Contact.User.Accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } }, "Buyer.Contact.User.CurrentAccount.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Buyer.Contact.User.CurrentAccount.ExternalId": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.ExternalName": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Type": { "$ref": "#/components/schemas/AccountType" }, "Buyer.Contact.User.CurrentAccount.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Buyer.Contact.User.CurrentAccount.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "Buyer.Contact.User.CurrentAccount.Address.AddressLine1": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Address.AddressLine2": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Address.PostCode": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Address.City": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Address.State": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Address.Country": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.TechnicalSupportEmail": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Website": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Description": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Name": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Buyer.Contact.User.CurrentAccount.Eligibility.Client": { "type": "boolean" }, "Buyer.Contact.User.CurrentAccount.Eligibility.Partner": { "type": "boolean" }, "Buyer.Contact.User.CurrentAccount.Icon": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Contact.User.CurrentAccount.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.ById": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Name": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Icon": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.HasIcon": { "type": "boolean" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.Id": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.ById": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Name": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Icon": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Id": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Contact.User.CurrentAccount.Id": { "type": "string" }, "Buyer.Contact.User.CurrentAccount.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Contact.User.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Contact.User.Audit.InvitationAcceptedAt": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.Audit.Created.ById": { "type": "string" }, "Buyer.Contact.User.Audit.Created.By.Name": { "type": "string" }, "Buyer.Contact.User.Audit.Created.By.Icon": { "type": "string" }, "Buyer.Contact.User.Audit.Created.By.HasIcon": { "type": "boolean" }, "Buyer.Contact.User.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Contact.User.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Contact.User.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Buyer.Contact.User.Audit.Created.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Buyer.Contact.User.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Contact.User.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Buyer.Contact.User.Audit.Created.By.Id": { "type": "string" }, "Buyer.Contact.User.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Contact.User.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.Audit.Updated.ById": { "type": "string" }, "Buyer.Contact.User.Audit.Updated.By.Name": { "type": "string" }, "Buyer.Contact.User.Audit.Updated.By.Icon": { "type": "string" }, "Buyer.Contact.User.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Buyer.Contact.User.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Contact.User.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Contact.User.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Buyer.Contact.User.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Buyer.Contact.User.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Contact.User.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Buyer.Contact.User.Audit.Updated.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Buyer.Contact.User.Audit.Updated.By.Id": { "type": "string" }, "Buyer.Contact.User.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Contact.User.Id": { "type": "string" }, "Buyer.Contact.User.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Contact.Type": { "type": "string" }, "Buyer.Icon": { "type": "string" }, "Buyer.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Buyer.Audit.Activated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Activated.ById": { "type": "string" }, "Buyer.Audit.Activated.By.Name": { "type": "string" }, "Buyer.Audit.Activated.By.Icon": { "type": "string" }, "Buyer.Audit.Activated.By.HasIcon": { "type": "boolean" }, "Buyer.Audit.Activated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Audit.Activated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Buyer.Audit.Activated.By.Id": { "type": "string" }, "Buyer.Audit.Activated.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Audit.Unassigned.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Unassigned.ById": { "type": "string" }, "Buyer.Audit.Unassigned.By.Name": { "type": "string" }, "Buyer.Audit.Unassigned.By.Icon": { "type": "string" }, "Buyer.Audit.Unassigned.By.HasIcon": { "type": "boolean" }, "Buyer.Audit.Unassigned.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Audit.Unassigned.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Buyer.Audit.Unassigned.By.Id": { "type": "string" }, "Buyer.Audit.Unassigned.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Audit.Disabled.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Disabled.ById": { "type": "string" }, "Buyer.Audit.Disabled.By.Name": { "type": "string" }, "Buyer.Audit.Disabled.By.Icon": { "type": "string" }, "Buyer.Audit.Disabled.By.HasIcon": { "type": "boolean" }, "Buyer.Audit.Disabled.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Buyer.Audit.Disabled.By.Id": { "type": "string" }, "Buyer.Audit.Disabled.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Audit.Created.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Created.ById": { "type": "string" }, "Buyer.Audit.Created.By.Name": { "type": "string" }, "Buyer.Audit.Created.By.Icon": { "type": "string" }, "Buyer.Audit.Created.By.HasIcon": { "type": "boolean" }, "Buyer.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Buyer.Audit.Created.By.Id": { "type": "string" }, "Buyer.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Buyer.Audit.Updated.ById": { "type": "string" }, "Buyer.Audit.Updated.By.Name": { "type": "string" }, "Buyer.Audit.Updated.By.Icon": { "type": "string" }, "Buyer.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Buyer.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Buyer.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Buyer.Audit.Updated.By.Id": { "type": "string" }, "Buyer.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Buyer.Id": { "type": "string" }, "Buyer.SystemId": { "type": "integer", "format": "int32" }, "Seller.ExternalId": { "type": "string" }, "Seller.Status": { "$ref": "#/components/schemas/SellerStatus" }, "Seller.Currencies": { "type": "array", "items": { "type": "string" } }, "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.Name": { "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": { "$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.Type": { "$ref": "#/components/schemas/AccountType" }, "Seller.ErpLink.Buyer.Account.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Seller.ErpLink.Buyer.Account.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "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.Name": { "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.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Type": { "$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.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Account.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Account.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Account.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Name": { "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.Contact.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.FirstName": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.LastName": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.Email": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.Phone.Prefix": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.Phone.Number": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Email": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Status": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Phone.Prefix": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Phone.Number": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.FirstName": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.LastName": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.LastLoginAt": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.Settings.CultureCode": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Settings.LanguageCode": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.ExternalId": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.ExternalName": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Type": { "$ref": "#/components/schemas/AccountType" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.AddressLine1": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.AddressLine2": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.PostCode": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.City": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.State": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Address.Country": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.TechnicalSupportEmail": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Website": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Description": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Eligibility.Client": { "type": "boolean" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Eligibility.Partner": { "type": "boolean" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.CurrentAccount.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Contact.User.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Contact.User.Audit.InvitationAcceptedAt": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Contact.User.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Contact.User.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Contact.Type": { "type": "string" }, "Seller.ErpLink.Buyer.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Activated.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Audit.Activated.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Activated.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Unassigned.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Disabled.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Buyer.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Buyer.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Buyer.Id": { "type": "string" }, "Seller.ErpLink.Buyer.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Seller.ExternalId": { "type": "string" }, "Seller.ErpLink.Seller.Status": { "$ref": "#/components/schemas/SellerStatus" }, "Seller.ErpLink.Seller.Currencies": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "Seller.ErpLink.Seller.Buyers": { "type": "array", "items": { "$ref": "#/components/schemas/Buyer" } }, "Seller.ErpLink.Seller.ErpLink": { "$ref": "#/components/schemas/ErpLink" }, "Seller.ErpLink.Seller.Icon": { "type": "string" }, "Seller.ErpLink.Seller.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Seller.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Seller.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Seller.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Seller.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Seller.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Seller.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Seller.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Seller.ErpLink.Seller.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Seller.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Seller.Id": { "type": "string" }, "Seller.ErpLink.Seller.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.BuyerId": { "type": "string" }, "Seller.ErpLink.SellerId": { "type": "string" }, "Seller.ErpLink.Name": { "type": "string" }, "Seller.ErpLink.CompanyName": { "type": "string" }, "Seller.ErpLink.Status": { "$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.Icon": { "type": "string" }, "Seller.ErpLink.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.ErpLink.Audit.Blocked.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Blocked.ById": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.Name": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.Icon": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Audit.Blocked.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Audit.Blocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Audit.Blocked.By.Id": { "type": "string" }, "Seller.ErpLink.Audit.Blocked.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Audit.Unblocked.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Unblocked.ById": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.Name": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.Icon": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Audit.Unblocked.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Audit.Unblocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Audit.Unblocked.By.Id": { "type": "string" }, "Seller.ErpLink.Audit.Unblocked.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Created.ById": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.Name": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.Icon": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Audit.Created.By.Id": { "type": "string" }, "Seller.ErpLink.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.ErpLink.Audit.Updated.ById": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.Name": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.Icon": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.ErpLink.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.ErpLink.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.ErpLink.Audit.Updated.By.Id": { "type": "string" }, "Seller.ErpLink.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.ErpLink.Id": { "type": "string" }, "Seller.ErpLink.SystemId": { "type": "integer", "format": "int32" }, "Seller.Icon": { "type": "string" }, "Seller.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Audit.Created.ById": { "type": "string" }, "Seller.Audit.Created.By.Name": { "type": "string" }, "Seller.Audit.Created.By.Icon": { "type": "string" }, "Seller.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.Audit.Created.By.Id": { "type": "string" }, "Seller.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Audit.Updated.ById": { "type": "string" }, "Seller.Audit.Updated.By.Name": { "type": "string" }, "Seller.Audit.Updated.By.Icon": { "type": "string" }, "Seller.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Seller.Audit.Updated.By.Id": { "type": "string" }, "Seller.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.Id": { "type": "string" }, "Seller.SystemId": { "type": "integer", "format": "int32" }, "Eligibility.Client": { "type": "boolean" }, "Eligibility.Partner": { "type": "boolean" }, "Contact.Name": { "type": "string" }, "Contact.FirstName": { "type": "string" }, "Contact.LastName": { "type": "string" }, "Contact.Email": { "type": "string" }, "Contact.Phone.Prefix": { "type": "string" }, "Contact.Phone.Number": { "type": "string" }, "Contact.User.Email": { "type": "string" }, "Contact.User.Status": { "type": "string" }, "Contact.User.Phone.Prefix": { "type": "string" }, "Contact.User.Phone.Number": { "type": "string" }, "Contact.User.FirstName": { "type": "string" }, "Contact.User.LastName": { "type": "string" }, "Contact.User.Icon": { "type": "string" }, "Contact.User.LastLoginAt": { "type": "string", "format": "date-time" }, "Contact.User.Settings.CultureCode": { "type": "string" }, "Contact.User.Settings.LanguageCode": { "type": "string" }, "Contact.User.Name": { "type": "string" }, "Contact.User.Accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } }, "Contact.User.CurrentAccount.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Contact.User.CurrentAccount.ExternalId": { "type": "string" }, "Contact.User.CurrentAccount.ExternalName": { "type": "string" }, "Contact.User.CurrentAccount.Type": { "$ref": "#/components/schemas/AccountType" }, "Contact.User.CurrentAccount.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Contact.User.CurrentAccount.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "Contact.User.CurrentAccount.Address.AddressLine1": { "type": "string" }, "Contact.User.CurrentAccount.Address.AddressLine2": { "type": "string" }, "Contact.User.CurrentAccount.Address.PostCode": { "type": "string" }, "Contact.User.CurrentAccount.Address.City": { "type": "string" }, "Contact.User.CurrentAccount.Address.State": { "type": "string" }, "Contact.User.CurrentAccount.Address.Country": { "type": "string" }, "Contact.User.CurrentAccount.TechnicalSupportEmail": { "type": "string" }, "Contact.User.CurrentAccount.Website": { "type": "string" }, "Contact.User.CurrentAccount.Description": { "type": "string" }, "Contact.User.CurrentAccount.Name": { "type": "string" }, "Contact.User.CurrentAccount.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Contact.User.CurrentAccount.Eligibility.Client": { "type": "boolean" }, "Contact.User.CurrentAccount.Eligibility.Partner": { "type": "boolean" }, "Contact.User.CurrentAccount.Icon": { "type": "string" }, "Contact.User.CurrentAccount.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.CurrentAccount.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.CurrentAccount.Audit.Created.ById": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.Name": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.Icon": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.HasIcon": { "type": "boolean" }, "Contact.User.CurrentAccount.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Contact.User.CurrentAccount.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.CurrentAccount.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.CurrentAccount.Audit.Created.By.Id": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.CurrentAccount.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.CurrentAccount.Audit.Updated.ById": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.Name": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.Icon": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Contact.User.CurrentAccount.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Contact.User.CurrentAccount.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.CurrentAccount.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Contact.User.CurrentAccount.Audit.Updated.By.Id": { "type": "string" }, "Contact.User.CurrentAccount.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.CurrentAccount.Id": { "type": "string" }, "Contact.User.CurrentAccount.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.Audit.InvitationAcceptedAt": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Created.ById": { "type": "string" }, "Contact.User.Audit.Created.By.Name": { "type": "string" }, "Contact.User.Audit.Created.By.Icon": { "type": "string" }, "Contact.User.Audit.Created.By.HasIcon": { "type": "boolean" }, "Contact.User.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Contact.User.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Contact.User.Audit.Created.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Contact.User.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.Audit.Created.By.Id": { "type": "string" }, "Contact.User.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Updated.ById": { "type": "string" }, "Contact.User.Audit.Updated.By.Name": { "type": "string" }, "Contact.User.Audit.Updated.By.Icon": { "type": "string" }, "Contact.User.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Contact.User.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Contact.User.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Contact.User.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Contact.User.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Contact.User.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Contact.User.Audit.Updated.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Contact.User.Audit.Updated.By.Id": { "type": "string" }, "Contact.User.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Contact.User.Id": { "type": "string" }, "Contact.User.SystemId": { "type": "integer", "format": "int32" }, "Contact.Type": { "type": "string" }, "Icon": { "type": "string" }, "Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Audit.Disabled.At": { "type": "string", "format": "date-time" }, "Audit.Disabled.ById": { "type": "string" }, "Audit.Disabled.By.Name": { "type": "string" }, "Audit.Disabled.By.Icon": { "type": "string" }, "Audit.Disabled.By.HasIcon": { "type": "boolean" }, "Audit.Disabled.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Disabled.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Disabled.By.Id": { "type": "string" }, "Audit.Disabled.By.SystemId": { "type": "integer", "format": "int32" }, "Audit.Created.At": { "type": "string", "format": "date-time" }, "Audit.Created.ById": { "type": "string" }, "Audit.Created.By.Name": { "type": "string" }, "Audit.Created.By.Icon": { "type": "string" }, "Audit.Created.By.HasIcon": { "type": "boolean" }, "Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Created.By.Id": { "type": "string" }, "Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Audit.Updated.At": { "type": "string", "format": "date-time" }, "Audit.Updated.ById": { "type": "string" }, "Audit.Updated.By.Name": { "type": "string" }, "Audit.Updated.By.Icon": { "type": "string" }, "Audit.Updated.By.HasIcon": { "type": "boolean" }, "Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Audit.Updated.By.Id": { "type": "string" }, "Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Id": { "type": "string" }, "SystemId": { "type": "integer", "format": "int32" } }, "description": "Json representation of the licensee" }, "logo": { "type": "string", "format": "binary", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } } }, "LicenseeStatus": { "enum": [ "Active", "Enabled", "Disabled", "Deleted" ], "type": "string" }, "LicenseeUpdate": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/LicenseeAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "icon": { "maxLength": 2000, "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contact": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ContactQueryModel" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "maxLength": 500, "type": "string", "nullable": true, "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": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/LicenseeStatus" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Address" } ], "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Eligibility" } ], "x-rql": { "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "authorization": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AuthorizationRef" } ], "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListingStatistics" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "eligibility": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListingEligibility" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ListMetadata": { "type": "object", "properties": { "pagination": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PaginationMetadata" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "omitted": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "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 }, "ListingListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListingEligibility" } ], "x-rql": { "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 }, "Module": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "description": { "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" ] } }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Filters" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "settings": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ModuleSettings" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/MarkupSourceRefPrice" } ], "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 }, "MediaType": { "enum": [ "Video", "Image" ], "type": "string" }, "ModuleDto": { "type": "object", "properties": { "id": { "type": "string", "allOf": [ { "pattern": "^MOD-\\d\\d\\d\\d$" }, { "pattern": "^MOD-\\d\\d\\d\\d$" }, { "pattern": "^MOD-\\d\\d\\d\\d$" } ], "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ModuleListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Module" } } }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ModuleSettingsEligibility" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "OrderAssetAudit": { "type": "object", "properties": { "created": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "draft": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "active": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "terminated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "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 }, "Order": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OrderAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "type": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/OrderType" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/OrderStatus" } ], "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" ] } }, "comments": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "statusNotes": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ParametrisedMessage" } ], "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" ] } }, "listing": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListingRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "authorization": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AuthorizationRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "agreement": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AgreementRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "assignee": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ExternalIds" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "price": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OrderSummaryPrice" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLine" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "subscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/OrderSubscription" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "assets": { "type": "array", "items": { "$ref": "#/components/schemas/OrderAsset" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "parameters": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ParameterBag" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "error": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ParametrisedMessage" } ], "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" ] } }, "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" ] } }, "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" ] } }, "vendor": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "billTo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BuyerRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Operations" ] } }, "pricingPolicy": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PricingPolicyRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "termsAndConditions": { "type": "array", "items": { "$ref": "#/components/schemas/CommerceTermsAndConditions" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "certificates": { "type": "array", "items": { "$ref": "#/components/schemas/CertificateRef" }, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "defaultMarkupSource": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/MarkupSource" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } } }, "additionalProperties": false }, "OrderAsset": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OrderAssetAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ExternalIds" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/AssetStatus" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "price": { "type": "object", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AssetParameterBag" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "terms": { "type": "object", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "completed": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "deleted": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "failed": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "processing": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "querying": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "quoted": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "OrderAssetListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderAsset" } } }, "additionalProperties": false }, "OrderSubscriptionAudit": { "type": "object", "properties": { "created": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "active": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "terminated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "terminating": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updating": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OrderLinePrice" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "item": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductItem" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "subscription": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OrderSubscription" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "asset": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OrderAsset" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "agreement": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Agreement" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "order": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Order" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "client": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Account" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "vendor": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Account" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "buyer": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Buyer" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "seller": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Seller" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "product": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Product" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "OrderLineListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLine" } } }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/MarkupSourcePrice" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "markupSource": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/MarkupSourcePrice" } ], "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 }, "OrderListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "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 }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OrderSubscriptionAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "name": { "type": "string", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ExternalIds" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "terms": { "type": "object", "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": { "type": "string", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SubscriptionParameterBag" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "agreement": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AgreementRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "price": { "type": "object", "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 }, "ParameterDefinition": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "name": { "type": "string", "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" ] } }, "group": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ParameterGroupRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "scope": { "enum": [ "Agreement", "Item", "Request", "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" ] } }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Constraints" } ], "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" ] } }, "options": { "nullable": true, "readOnly": 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": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "OrderSubscriptionListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderSubscription" } } }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/MarkupSourcePrice" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "markupSource": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/MarkupSourcePrice" } ], "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" }, "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 }, "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" ] } } }, "additionalProperties": false }, "ParameterDefinitionListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "name": { "type": "string", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ParameterGroup" } } }, "additionalProperties": false }, "ParameterValueDelta": { "type": "object", "properties": { "node": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ] }, "path": { "type": "string" }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ParameterValueModel" } ] }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ParameterPhase": { "enum": [ "Configuration", "Order", "Fulfillment" ], "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" ] } }, "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 }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ] }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ] }, "path": { "type": "string" }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ParameterValueUpdate" } ] }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ParameterValueUpdateListDelta": { "type": "object", "properties": { "node": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ] }, "path": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ParameterValueUpdate" }, "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "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 }, "ParametrisedMessage": { "required": [ "message" ], "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "message": { "maxLength": 4000, "minLength": 1, "type": "string" }, "parameters": { "nullable": true } }, "additionalProperties": false }, "ParametrisedMessageDelta": { "type": "object", "properties": { "node": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ] }, "path": { "type": "string" }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ParametrisedMessage" } ] }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PriceListItemAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "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" ] } }, "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 }, "PreValidation": { "type": "object", "properties": { "enrollmentDraft": { "type": "boolean" }, "enrollmentQuerying": { "type": "boolean" }, "reEnrollment": { "type": "boolean" } }, "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" ] } }, "productRequest": { "type": "boolean", "nullable": true, "x-rql": { "rqlType": "Reference", "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" ] } }, "productRequest": { "type": "boolean", "x-rql": { "core": true, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PriceListExternalIdBag" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "statistics": { "type": "object", "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 }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PriceListItem" } } }, "additionalProperties": false }, "PriceListItemAudit": { "type": "object", "properties": { "created": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "published": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unpublished": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "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", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unitLP": { "type": "number", "format": "double", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unitSP": { "type": "number", "format": "double", "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" ] } } }, "additionalProperties": false }, "PriceListUpdate": { "type": "object", "properties": { "externalIds": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/UpdatePriceListExternalId" } ], "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PriceList" } } }, "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 }, "PricingPolicyAudit": { "type": "object", "properties": { "created": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "activated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "deactivated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "PricingPolicy": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PricingPolicyAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PricingPolicyExternalIdBag" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "client": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Account" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "eligibility": { "type": "object", "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": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/PricingPolicyStatus" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "statistics": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PricingPolicyStatistics" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } } }, "additionalProperties": false }, "PricingPolicyAttachment": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "name": { "type": "string", "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" ] } } }, "additionalProperties": false }, "PricingPolicyAttachmentListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PricingPolicyAttachment" } } }, "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 }, "PricingPolicyEligibilityDelta": { "type": "object", "properties": { "node": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ] }, "path": { "type": "string" }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PricingPolicyEligibility" } ] }, "isDefined": { "type": "boolean", "readOnly": true } }, "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 }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PricingPolicy" } } }, "additionalProperties": false }, "ProductDocument": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "name": { "type": "string", "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 }, "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" }, "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": {} }, "Process": { "type": "object", "properties": { "message": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProcessEnrollmentRequest": { "type": "object", "properties": { "template": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProductDocumentListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductDocument" } } }, "additionalProperties": false }, "ProductItem": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductItemAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "name": { "type": "string", "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": { "type": "object", "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": { "type": "object", "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 }, "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 }, "ProductItemListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductItem" } } }, "additionalProperties": false }, "ProductItemAudit": { "type": "object", "properties": { "created": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "pending": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "published": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unpublished": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "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 }, "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 }, "ProductMedia": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "name": { "type": "string", "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 }, "ProductMediaListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductMedia" } } }, "additionalProperties": false }, "Product": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "name": { "type": "string", "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": { "type": "object", "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" ] } }, "icon": { "type": "string", "x-rql": { "core": true, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductSettings" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "statistics": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductStatistics" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProductAudit": { "type": "object", "properties": { "created": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "published": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "pending": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unpublished": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProductListDelta": { "type": "object", "properties": { "node": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ] }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } } }, "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 }, "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 }, "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": { "type": "object", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PreValidationSettings" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "splitBilling": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductSplitBillingRequestsSetting" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "subscriptionCessation": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SubscriptionCessationSetting" } ], "x-rql": { "core": true, "rqlType": "Reference", "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 }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductExternalIdBag" } ], "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 }, "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" ] } }, "requestCount": { "type": "integer", "format": "int32", "x-rql": { "core": true, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "name": { "type": "string", "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", "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 }, "ProgramApplicableTo": { "enum": [ "Buyer", "Licensee" ], "type": "string" }, "ProgramDocumentListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProgramDocument" } } }, "additionalProperties": false }, "Program": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProgramAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "name": { "type": "string", "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", "readOnly": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/ProgramStatus" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "eligibility": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProgramEligibility" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "applicableTo": { "type": "string", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProgramSettings" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "statistics": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProgramStatistics" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProgramDocumentStatus": { "enum": [ "Draft", "Published", "Unpublished" ], "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 }, "ProgramEligibilityDelta": { "type": "object", "properties": { "node": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ] }, "path": { "type": "string" }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProgramEligibility" } ] }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ProgramAudit": { "type": "object", "properties": { "created": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "published": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unpublished": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProgramListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Program" } } }, "additionalProperties": false }, "ProgramMedia": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "name": { "type": "string", "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", "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 }, "ProgramMediaListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "name": { "type": "string", "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" ] } }, "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" ] } }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Constraints" } ], "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" ] } }, "options": { "nullable": true, "readOnly": 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": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProgramMediaStatus": { "enum": [ "Draft", "Published", "Unpublished" ], "type": "string" }, "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 }, "ProgramParameterDefinitionListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProgramParameterDefinition" } } }, "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": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/ParameterType" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "phase": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/ProgramParameterPhase" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "error": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ParametrisedMessage" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "constraints": { "type": "object", "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 }, "ProgramParameterGroup": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "name": { "type": "string", "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 }, "ProgramParameterGroupListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProgramParameterGroup" } } }, "additionalProperties": false }, "ProgramTemplate": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "name": { "type": "string", "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" ] } }, "type": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/ProgramTemplateType" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "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" }, "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" ] } } }, "additionalProperties": false }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/TerminateOnExpiration" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "preValidation": { "type": "object", "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" }, "ProgramTemplateListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProgramTemplate" } } }, "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" ] } } }, "additionalProperties": false }, "ProgramTemplateType": { "enum": [ "EnrollmentProcessing", "EnrollmentQuerying", "EnrollmentCompleted" ], "type": "string" }, "ProgramTermsAndConditions": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProgramTermsAndConditionsAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "name": { "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" ] } }, "displayOrder": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "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 }, "ProgramTermsAndConditionsAudit": { "type": "object", "properties": { "created": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "published": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unpublished": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ProgramTermsAndConditionsListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "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" ] } }, "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" ] } }, "status": { "type": "string", "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": { "type": "object", "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" }, "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": { "type": "object", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ] }, "path": { "type": "string" }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProgramUpdate" } ] }, "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" ] } } } }, "Audit": { "type": "object", "properties": { "created": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Query": { "type": "object", "properties": { "message": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "QueryEnrollmentRequest": { "required": [ "template" ], "type": "object", "properties": { "template": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "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 }, "Event": { "type": "object", "properties": { "at": { "type": "string", "format": "date-time", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Identity" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Metadata": { "type": "object", "properties": { "omitted": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "RequestMessage": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "visibility": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestMessageVisibilityQuery" } ], "x-rql": { "core": true, "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" ] } }, "type": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "content": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "request": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Request" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "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 } ] }, "RequestAssignee": { "type": "object", "properties": { "id": { "type": "string" } }, "additionalProperties": false }, "RequestAttachment": { "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" ] } } } }, "RequestFrom": { "type": "object", "properties": { "id": { "type": "string" } }, "additionalProperties": false }, "RequestMessageListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RequestMessage" } } }, "additionalProperties": false }, "RequestParameters": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalId": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "title": { "type": "string", "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" ] } }, "value": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "displayOrder": { "type": "integer", "format": "int32", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "constraints": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestParameterConstraints" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "typeOptions": { "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "errorMessage": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "errorCode": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "request": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Request" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "RequestMessageVisibility": { "type": "object", "properties": { "client": { "type": "boolean" }, "operations": { "type": "boolean" }, "vendor": { "type": "boolean" } }, "additionalProperties": false }, "RequestMessageVisibilityQuery": { "type": "object", "properties": { "client": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "operations": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "vendor": { "type": "boolean", "x-rql": { "core": true, "rqlType": "Primitive", "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 }, "RequestObjectLinkDelta": { "type": "object", "properties": { "node": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ] }, "path": { "type": "string" }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ] }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "RequestObjectLinkListDelta": { "type": "object", "properties": { "node": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ] }, "path": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RequestObjectLink" }, "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "RequestParameterConstraints": { "type": "object", "properties": { "isReadonly": { "type": "boolean", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "isOptional": { "type": "boolean", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Request": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "externalId": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "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" ] } }, "error": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "from": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "requester": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/UserRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "assignee": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/UserRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "to": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountRef" } ], "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" ] } }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/RequestParameters" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/RequestMessage" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "RequestProduct": { "type": "object", "properties": { "id": { "type": "string" } }, "additionalProperties": false }, "RequestListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Request" } } }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "icon": { "type": "string", "nullable": true, "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": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/SellerStatus" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "currencies": { "minItems": 1, "type": "array", "items": { "maxLength": 3, "minLength": 1, "type": "string" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Address" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "maxLength": 500, "minLength": 1, "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "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 }, "RequestRequester": { "type": "object", "properties": { "id": { "type": "string" } }, "additionalProperties": false }, "RequestTo": { "type": "object", "properties": { "id": { "type": "string" } }, "additionalProperties": false }, "SelectionOption": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Seller": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "icon": { "type": "string", "nullable": true, "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": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/SellerStatus" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "currencies": { "type": "array", "items": { "type": "string" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Address" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "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 }, "SellerListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "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": { "$ref": "#/components/schemas/SellerStatus" }, "Seller.Data.Currencies": { "type": "array", "items": { "type": "string" } }, "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.Name": { "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": { "$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.Type": { "$ref": "#/components/schemas/AccountType" }, "Seller.Data.ErpLink.Buyer.Account.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Seller.Data.ErpLink.Buyer.Account.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "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.Name": { "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.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Created.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Created.By.Type": { "$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.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Created.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Account.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Account.SystemId": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Name": { "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.Contact.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.FirstName": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.LastName": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.Email": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.Phone.Prefix": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.Phone.Number": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Email": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Status": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Phone.Prefix": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Phone.Number": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.FirstName": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.LastName": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.LastLoginAt": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Contact.User.Settings.CultureCode": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Settings.LanguageCode": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.ExternalIds.PyraTenantId": { "type": "string", "format": "uuid" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.ExternalId": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.ExternalName": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Type": { "$ref": "#/components/schemas/AccountType" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Status": { "$ref": "#/components/schemas/AccountStatus" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Address.AddressLine1": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Address.AddressLine2": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Address.PostCode": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Address.City": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Address.State": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Address.Country": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.TechnicalSupportEmail": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Website": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Description": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Eligibility.Client": { "type": "boolean" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Eligibility.Partner": { "type": "boolean" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.CurrentAccount.SystemId": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Contact.User.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.InvitationAcceptedAt": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Created.By.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Created.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Created.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Created.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Updated.By.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Updated.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Created.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Created.By": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Updated.ById": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Updated.By.Audit.Updated.By": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Updated.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Contact.User.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Contact.User.SystemId": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Contact.Type": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Activated.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Activated.By.HasIcon": { "type": "boolean" }, "Seller.Data.ErpLink.Buyer.Audit.Activated.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Buyer.Audit.Activated.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Activated.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.By.HasIcon": { "type": "boolean" }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Unassigned.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.By.HasIcon": { "type": "boolean" }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Disabled.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Created.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.Data.ErpLink.Buyer.Audit.Created.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Buyer.Audit.Created.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Updated.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.Data.ErpLink.Buyer.Audit.Updated.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Buyer.Audit.Updated.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Buyer.Id": { "type": "string" }, "Seller.Data.ErpLink.Buyer.SystemId": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Seller.ExternalId": { "type": "string" }, "Seller.Data.ErpLink.Seller.Status": { "$ref": "#/components/schemas/SellerStatus" }, "Seller.Data.ErpLink.Seller.Currencies": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "Seller.Data.ErpLink.Seller.Buyers": { "type": "array", "items": { "$ref": "#/components/schemas/Buyer" } }, "Seller.Data.ErpLink.Seller.ErpLink": { "$ref": "#/components/schemas/ErpLink" }, "Seller.Data.ErpLink.Seller.Icon": { "type": "string" }, "Seller.Data.ErpLink.Seller.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "Seller.Data.ErpLink.Seller.Audit.Created.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Seller.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.Data.ErpLink.Seller.Audit.Created.By.Type": { "$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.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Seller.Audit.Created.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Seller.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.Data.ErpLink.Seller.Audit.Updated.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Seller.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.Data.ErpLink.Seller.Audit.Updated.By.Type": { "$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.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": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Seller.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Seller.Data.ErpLink.Seller.Audit.Updated.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Seller.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Seller.Id": { "type": "string" }, "Seller.Data.ErpLink.Seller.SystemId": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.BuyerId": { "type": "string" }, "Seller.Data.ErpLink.SellerId": { "type": "string" }, "Seller.Data.ErpLink.Name": { "type": "string" }, "Seller.Data.ErpLink.CompanyName": { "type": "string" }, "Seller.Data.ErpLink.Status": { "$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.Icon": { "type": "string" }, "Seller.Data.ErpLink.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "Seller.Data.ErpLink.Audit.Blocked.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Audit.Blocked.By.HasIcon": { "type": "boolean" }, "Seller.Data.ErpLink.Audit.Blocked.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.Data.ErpLink.Audit.Blocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Audit.Blocked.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Audit.Blocked.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.Data.ErpLink.Audit.Unblocked.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Audit.Unblocked.By.HasIcon": { "type": "boolean" }, "Seller.Data.ErpLink.Audit.Unblocked.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.Data.ErpLink.Audit.Unblocked.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Audit.Unblocked.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Audit.Unblocked.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.Data.ErpLink.Audit.Created.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.Data.ErpLink.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.Data.ErpLink.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Audit.Created.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "Seller.Data.ErpLink.Audit.Updated.By.Icon": { "type": "string" }, "Seller.Data.ErpLink.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.Data.ErpLink.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.Data.ErpLink.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.ErpLink.Audit.Updated.By.Id": { "type": "string" }, "Seller.Data.ErpLink.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.Data.ErpLink.Id": { "type": "string" }, "Seller.Data.ErpLink.SystemId": { "type": "integer", "format": "int32" }, "Seller.Data.Icon": { "type": "string" }, "Seller.Data.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.Audit.Created.At": { "type": "string", "format": "date-time" }, "Seller.Data.Audit.Created.ById": { "type": "string" }, "Seller.Data.Audit.Created.By.Name": { "type": "string" }, "Seller.Data.Audit.Created.By.Icon": { "type": "string" }, "Seller.Data.Audit.Created.By.HasIcon": { "type": "boolean" }, "Seller.Data.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.Data.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "Seller.Data.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.Audit.Created.By.Id": { "type": "string" }, "Seller.Data.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.Data.Audit.Updated.At": { "type": "string", "format": "date-time" }, "Seller.Data.Audit.Updated.ById": { "type": "string" }, "Seller.Data.Audit.Updated.By.Name": { "type": "string" }, "Seller.Data.Audit.Updated.By.Icon": { "type": "string" }, "Seller.Data.Audit.Updated.By.HasIcon": { "type": "boolean" }, "Seller.Data.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "Seller.Data.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "Seller.Data.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "Seller.Data.Audit.Updated.By.Id": { "type": "string" }, "Seller.Data.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "Seller.Data.Id": { "type": "string" }, "Seller.Data.SystemId": { "type": "integer", "format": "int32" }, "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" ] } } } }, "SellerStatus": { "enum": [ "Active", "Disabled", "Offline", "Deleted" ], "type": "string" }, "SubscriptionAudit": { "type": "object", "properties": { "created": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "active": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "terminated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "terminating": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updating": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "expired": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "renewed": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "rqlType": "Reference", "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" ] } } }, "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": { "maxLength": 5, "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "languageCode": { "maxLength": 5, "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 }, "SplitBillingAgreement": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SplitBillingAllocationPrice" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "statistics": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SplitBillingAllocationStatistics" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "type": "object", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "name": { "type": "string", "readOnly": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "nullable": true, "readOnly": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "subscription": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SubscriptionRef" } ], "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SplitBillingAllocationPrice" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "SplitStatus": { "enum": [ "Disabled", "Active", "Review" ], "type": "string" }, "State": { "enum": [ "Draft", "Pending", "Published", "Unpublished" ], "type": "string" }, "StringDelta": { "type": "object", "properties": { "node": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ] }, "path": { "type": "string" }, "data": { "type": "string", "nullable": true, "readOnly": true }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "StringJsonOptional": { "type": "object", "properties": { "hasValue": { "type": "boolean", "readOnly": true }, "value": { "type": "string" } }, "additionalProperties": false }, "StringStringDictionaryJsonOptional": { "type": "object", "properties": { "hasValue": { "type": "boolean", "readOnly": true }, "value": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "SubdomainOptions": { "type": "object", "properties": { "placeholderText": { "type": "string" }, "hintText": { "type": "string" }, "domainSuffix": { "type": "string" } }, "additionalProperties": false }, "Subscription": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SubscriptionAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "name": { "type": "string", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ExternalIds" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "terms": { "type": "object", "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": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/SubscriptionStatus" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "commitmentDate": { "type": "string", "format": "date-time", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "price": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SubscriptionSummaryPrice" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "parameters": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SubscriptionParameterBag" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "agreement": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AgreementRef" } ], "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" ] } }, "licensee": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/LicenseeRef" } ], "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SplitBillingSubscriptionRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Operations" ] } }, "splitStatus": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/SplitStatus" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementLine" }, "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 }, "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 }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "name": { "type": "string", "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", "RequestProcessing", "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" ] } }, "product": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "SubscriptionListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription" } } }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/MarkupSourcePrice" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "markupSource": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/MarkupSourcePrice" } ], "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 }, "TemplateListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Template" } } }, "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" ] } } }, "additionalProperties": false }, "TemplateStatus": { "enum": [ "Active", "Deleted" ], "type": "string" }, "TermsAndConditions": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/TermsAndConditionsAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "name": { "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" ] } }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ParametrisedMessage" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "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 }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/TermsAndConditions" } } }, "additionalProperties": false }, "TermsAndConditionsAudit": { "type": "object", "properties": { "created": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "published": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "pending": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unpublished": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "TermsAndConditionsVariant": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "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" ] } }, "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" ] } }, "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": { "type": "object", "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 }, "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 }, "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": { "type": "object", "properties": { "Required": { "type": "boolean" }, "Hidden": { "type": "boolean" }, "ReadOnly": { "type": "boolean" } }, "additionalProperties": false, "x-rql": { "rqlType": "Collection", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "description": { "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" ] } }, "statistics": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/UnitOfMeasureStatistics" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UnitOfMeasureListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/UnitOfMeasure" } } }, "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 }, "UpdateApiTokenDto": { "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" ] } }, "icon": { "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" ] } } }, "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 }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductItemExternalIdBag" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "group": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unit": { "type": "object", "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 }, "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": { "type": "object", "properties": { "Required": { "type": "boolean" }, "Hidden": { "type": "boolean" }, "ReadOnly": { "type": "boolean" } }, "additionalProperties": false, "x-rql": { "rqlType": "Collection", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/RequestObjectLink" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UserExtendedAccount": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountExternalIds" } ], "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" ] } }, "type": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/AccountType" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "serviceLevel": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/AccountServiceLevel" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "type": "object", "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" ] } }, "name": { "type": "string", "nullable": true, "x-rql": { "core": true, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Eligibility" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "invitation": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Invitation" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "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 }, "UpdateUserGroupDto": { "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" ] } }, "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" ] } } }, "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.Icon": { "type": "string" }, "User.Data.LastLoginAt": { "type": "string", "format": "date-time" }, "User.Data.Settings.CultureCode": { "type": "string" }, "User.Data.Settings.LanguageCode": { "type": "string" }, "User.Data.Name": { "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.Type": { "$ref": "#/components/schemas/AccountType" }, "User.Data.CurrentAccount.Status": { "$ref": "#/components/schemas/AccountStatus" }, "User.Data.CurrentAccount.ServiceLevel": { "$ref": "#/components/schemas/AccountServiceLevel" }, "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.Name": { "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.Icon": { "type": "string" }, "User.Data.CurrentAccount.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "User.Data.CurrentAccount.Audit.Created.By.Icon": { "type": "string" }, "User.Data.CurrentAccount.Audit.Created.By.HasIcon": { "type": "boolean" }, "User.Data.CurrentAccount.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "User.Data.CurrentAccount.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "User.Data.CurrentAccount.Audit.Created.By.Audit.Created": { "$ref": "#/components/schemas/Event" }, "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": { "$ref": "#/components/schemas/Identity" }, "User.Data.CurrentAccount.Audit.Created.By.Id": { "type": "string" }, "User.Data.CurrentAccount.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "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.Name": { "type": "string" }, "User.Data.CurrentAccount.Audit.Updated.By.Icon": { "type": "string" }, "User.Data.CurrentAccount.Audit.Updated.By.HasIcon": { "type": "boolean" }, "User.Data.CurrentAccount.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "User.Data.CurrentAccount.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "User.Data.CurrentAccount.Audit.Updated.By.Audit.Updated": { "$ref": "#/components/schemas/Event" }, "User.Data.CurrentAccount.Audit.Updated.By.Id": { "type": "string" }, "User.Data.CurrentAccount.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "User.Data.CurrentAccount.Id": { "type": "string" }, "User.Data.CurrentAccount.SystemId": { "type": "integer", "format": "int32" }, "User.Data.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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.Name": { "type": "string" }, "User.Data.Audit.Created.By.Icon": { "type": "string" }, "User.Data.Audit.Created.By.HasIcon": { "type": "boolean" }, "User.Data.Audit.Created.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "User.Data.Audit.Created.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "User.Data.Audit.Created.By.Id": { "type": "string" }, "User.Data.Audit.Created.By.SystemId": { "type": "integer", "format": "int32" }, "User.Data.Audit.Updated.At": { "type": "string", "format": "date-time" }, "User.Data.Audit.Updated.ById": { "type": "string" }, "User.Data.Audit.Updated.By.Name": { "type": "string" }, "User.Data.Audit.Updated.By.Icon": { "type": "string" }, "User.Data.Audit.Updated.By.HasIcon": { "type": "boolean" }, "User.Data.Audit.Updated.By.Type": { "$ref": "#/components/schemas/IdentityType" }, "User.Data.Audit.Updated.By.Metadata.OmittedProperties": { "type": "array", "items": { "type": "string" } }, "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": { "$ref": "#/components/schemas/Identity" }, "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": { "$ref": "#/components/schemas/Identity" }, "User.Data.Audit.Updated.By.Id": { "type": "string" }, "User.Data.Audit.Updated.By.SystemId": { "type": "integer", "format": "int32" }, "User.Data.Id": { "type": "string" }, "User.Data.SystemId": { "type": "integer", "format": "int32" }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/StringJsonOptional" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "url": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/UriJsonOptional" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "criteria": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/StringStringDictionaryJsonOptional" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "secret": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/StringJsonOptional" } ], "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" } }, "additionalProperties": false }, "UserAudit": { "type": "object", "properties": { "created": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "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 }, "UserExtendedAccountAudit": { "type": "object", "properties": { "created": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "invited": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "joined": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DateEvent" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "access": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DateEvent" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UserExtendedAccountListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserExtendedAccount" } } }, "additionalProperties": false }, "UserGroup": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "name": { "type": "string", "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" ] } }, "buyers": { "type": "array", "items": { "$ref": "#/components/schemas/BuyerRef" }, "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } } }, "additionalProperties": false }, "User": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/UserAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PhoneNumber" } ], "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" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/UserSettings" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "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 }, "UserProfileDto": { "required": [ "firstName", "lastName" ], "type": "object", "properties": { "email": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/EmailDto" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "firstName": { "minLength": 1, "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "lastName": { "minLength": 1, "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "phone": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SetPhoneNumberDto" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "settings": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SetUserSettingsDto" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "UserDelta": { "type": "object", "properties": { "node": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DeltaNode" } ] }, "path": { "type": "string" }, "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/User" } ] }, "isDefined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "UserListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } }, "additionalProperties": false }, "UserSettings": { "type": "object", "properties": { "cultureCode": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "languageCode": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AuditEventType": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "key": { "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" ] } } }, "additionalProperties": false }, "Validate": { "type": "object", "properties": { "error": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/ValidateParameter" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ValidateParameter": { "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" ] } }, "value": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "isValid": { "type": "boolean", "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" ] } } }, "additionalProperties": false }, "Webhook": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "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": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/WebhookStatus" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "type": "string", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/WebhookStatistics" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "objectType": { "type": "string", "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": { "type": "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/WebhookCall" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "lastFailure": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/WebhookCall" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "lastCall": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/WebhookCall" } ], "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": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/HttpStatusCode" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "WebhookCriteria": { "type": "object", "properties": { "key": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "value": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "WebhookListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "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": { "rqlType": "Primitive", "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" ] } } }, "additionalProperties": false }, "WebhookObjectType": { "enum": [ "Order", "Request", "Account", "Enrollment" ], "type": "string" }, "WebhookStatistics": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "successes": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "failures": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "failuresSinceLastSuccess": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "WebhookStatus": { "enum": [ "Enabled", "Disabled" ], "type": "string" }, "WebhookType": { "enum": [ "ValidatePurchaseOrderDraft", "ValidatePurchaseOrderQuerying", "ValidateChangeOrderDraft", "ValidateTerminateOrder", "ValidateRequest", "SelectOrderLines", "ValidateEnrollmentDraft", "ValidateEnrollmentQuerying", "ValidateReEnrollment", "ValidateConfigurationOrderDraft" ], "type": "string" }, "AuditEventTypeListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AuditEventType" } } }, "additionalProperties": false }, "AuditRecord": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "event": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "summary": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "details": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "object": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AuditRecordObject" } ] }, "timestamp": { "type": "string", "format": "date-time", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "actor": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AuditRecordActor" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/AuditRecordType" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "request": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AuditRecordRequest" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "documents": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/JsonNode" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "viewers": { "type": "array", "items": { "$ref": "#/components/schemas/AuditRecordViewer" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AuditRecordActor": { "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" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AuditRecordActorAccount" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AuditRecordActorAccount": { "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" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "accountType": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AuditRecordApiRequest": { "type": "object", "properties": { "ip": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "geolocation": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/GeolocationData" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "userAgent": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AuditRecordListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AuditRecord" } } }, "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 }, "AuditRecordLogInfo": { "type": "object", "properties": { "requestId": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "operationId": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AuditRecordObject": { "type": "object", "properties": { "id": { "type": "string", "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" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "objectType": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AuditRecordRequest": { "type": "object", "properties": { "api": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AuditRecordApiRequest" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "worker": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AuditRecordWorkerRequest" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "log": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AuditRecordLogInfo" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AuditRecordType": { "enum": [ "Private", "Public" ], "type": "string" }, "AuditRecordViewer": { "type": "object", "properties": { "id": { "type": "string", "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" ] } }, "type": { "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" ] } } }, "additionalProperties": false }, "AuditRecordWorkerRequest": { "type": "object", "properties": { "workerName": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "GeolocationData": { "type": "object", "properties": { "countryCode": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "countryName": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "region": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "JsonNode": { "type": "object", "properties": { "options": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/JsonNodeOptions" } ] }, "parent": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/JsonNode" } ] }, "root": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/JsonNode" } ] } }, "additionalProperties": false }, "JsonNodeOptions": { "type": "object", "properties": { "propertyNameCaseInsensitive": { "type": "boolean" } }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SpotlightQueryDto" } ], "x-rql": { "core": true, "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 }, "SpotlightObjectListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "name": { "type": "string", "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": { "type": "string", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "name": { "type": "string", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Invalidation" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "filter": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "scope": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/Scope" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "SpotlightQueryListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpotlightQuery" } } }, "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." }, "AuditBag": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/AuditCreatedEvent" } ], "description": "Contains details about the creation event of the entity.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/AuditUpdatedEvent" } ], "description": "Contains details about the most recent update event of the entity, if applicable.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a container for audit-related events, including creation and updates." }, "AuditCreatedEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event for the creation of an entity." }, "AuditEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a base class for audit events, such as creation or updates." }, "AuditUpdatedEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event for the update of an entity." }, "BillingAttachmentType": { "enum": [ "Attachment", "Input", "Output" ], "type": "string", "description": "Represents the type of billing attachment." }, "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" }, "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." }, "BillingType": { "enum": [ "Automated", "Manual" ], "type": "string", "description": "Represents the type of billing process." }, "Charge": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/Metadata" } ], "description": "Platform entity metadata.", "nullable": true }, "audit": { "allOf": [ { "$ref": "#/components/schemas/ChargeAuditBag" } ], "description": "Contains audit-related details for the entity.", "x-rql": { "rqlType": "Reference", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AgreementRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "subscription": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SubscriptionRef" } ], "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OrderRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "asset": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AssetRef" } ], "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AuthorizationRef" } ], "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/AuditEvent" } ], "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/AuditEvent" } ], "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, visible to operations.", "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, visible to operations.", "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, visible to vendors or operations.", "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, visible to vendors or operations.", "format": "double", "nullable": true, "example": 1000, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "unitSP": { "type": "number", "description": "Represents the unit sale price of the charge, visible to clients or operations.", "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, visible to clients or operations.", "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." }, "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": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/Metadata" } ], "description": "Platform entity metadata.", "nullable": true }, "audit": { "allOf": [ { "$ref": "#/components/schemas/CreditMemoAuditBag" } ], "description": "Contains audit-related details for the entity.", "x-rql": { "rqlType": "Reference", "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/ErpAttributes" } ], "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AgreementRef" } ], "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" ] } } }, "additionalProperties": false, "description": "Represents a credit memo in the billing system." }, "CreditMemoAttachment": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/Metadata" } ], "description": "Platform entity metadata.", "nullable": true }, "audit": { "allOf": [ { "$ref": "#/components/schemas/AuditBag" } ], "description": "Contains audit-related details for the entity.", "x-rql": { "rqlType": "Reference", "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/AuditCreatedEvent" } ], "description": "Contains details about the creation event of the entity.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/AuditUpdatedEvent" } ], "description": "Contains details about the most recent update event of the entity, if applicable.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "issued": { "allOf": [ { "$ref": "#/components/schemas/CreditMemoIssuedEvent" } ], "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" ] } }, "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." }, "CreditMemoIssuedEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the credit memo reached the \"Issued\" status." }, "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" }, "CustomLedger": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/Metadata" } ], "description": "Platform entity metadata.", "nullable": true }, "audit": { "allOf": [ { "$ref": "#/components/schemas/CustomLedgerAuditBag" } ], "description": "Contains audit-related details for the entity.", "x-rql": { "rqlType": "Reference", "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.0000000+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.0000000+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/IdentityRef" } ], "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" ] } } }, "additionalProperties": false, "description": "Represents a custom ledger in the billing system." }, "CustomLedgerAttachment": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/Metadata" } ], "description": "Platform entity metadata.", "nullable": true }, "audit": { "allOf": [ { "$ref": "#/components/schemas/AuditBag" } ], "description": "Contains audit-related details for the entity.", "x-rql": { "rqlType": "Reference", "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/AuditCreatedEvent" } ], "description": "Contains details about the creation event of the entity.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/AuditUpdatedEvent" } ], "description": "Contains details about the most recent update event of the entity, if applicable.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "draft": { "allOf": [ { "$ref": "#/components/schemas/CustomLedgerDraftEvent" } ], "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/CustomLedgerDeletedEvent" } ], "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/CustomLedgerValidatingEvent" } ], "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/CustomLedgerValidatedEvent" } ], "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/CustomLedgerErrorEvent" } ], "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/CustomLedgerGeneratingEvent" } ], "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/CustomLedgerGeneratedEvent" } ], "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/CustomLedgerQueuedEvent" } ], "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/CustomLedgerCompletedEvent" } ], "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" }, "CustomLedgerCompletedEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the custom ledger reached the \"Completed\" status." }, "CustomLedgerDeletedEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the custom ledger reached the \"Deleted\" status." }, "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 }, "CustomLedgerDraftEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the custom ledger reached the \"Draft\" status." }, "CustomLedgerErrorEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the custom ledger reached the \"Error\" status." }, "CustomLedgerGeneratedEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the custom ledger reached the \"Generated\" status." }, "CustomLedgerGeneratingEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the custom ledger reached the \"Generating\" status." }, "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, visible to operations.", "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, visible to operations.", "format": "double", "example": 20, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "totalPP": { "type": "number", "description": "Represents the total purchase price, visible to vendors or operations.", "format": "double", "example": 1000, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "totalSP": { "type": "number", "description": "Represents the total sale price, visible to clients or operations.", "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" ] } } }, "additionalProperties": false, "description": "Represents a detailed summary of pricing for a custom ledger, including currency and totals." }, "CustomLedgerQueuedEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the custom ledger reached the \"Queued\" status." }, "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." }, "CustomLedgerValidatedEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the custom ledger reached the \"Validated\" status." }, "CustomLedgerValidatingEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the custom ledger reached the \"Validating\" status." }, "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.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "end": { "type": "string", "description": "The end date and time of the period.", "format": "date-time", "example": "2025-01-31T23:59:59.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents the period during which a charge is applicable." }, "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": { "postingDate": { "type": "string", "description": "The date when the invoice was posted.", "format": "date-time", "nullable": true, "example": "2025-05-01T10:00:00.0000000+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.0000000+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." }, "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." }, "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 ." }, "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." }, "Invoice": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/Metadata" } ], "description": "Platform entity metadata.", "nullable": true }, "audit": { "allOf": [ { "$ref": "#/components/schemas/InvoiceAuditBag" } ], "description": "Contains audit-related details for the entity.", "x-rql": { "rqlType": "Reference", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AgreementRef" } ], "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" ] } }, "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" ] } } }, "additionalProperties": false, "description": "Represents an invoice entity in the billing system." }, "InvoiceAttachment": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/Metadata" } ], "description": "Platform entity metadata.", "nullable": true }, "audit": { "allOf": [ { "$ref": "#/components/schemas/AuditBag" } ], "description": "Contains audit-related details for the entity.", "x-rql": { "rqlType": "Reference", "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/AuditCreatedEvent" } ], "description": "Contains details about the creation event of the entity.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/AuditUpdatedEvent" } ], "description": "Contains details about the most recent update event of the entity, if applicable.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "issued": { "allOf": [ { "$ref": "#/components/schemas/InvoiceIssuedEvent" } ], "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/InvoicePaidEvent" } ], "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/InvoiceOverdueEvent" } ], "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.0000000+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.0000000+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.0000000+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.0000000+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.0000000+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.0000000+00:00", "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." }, "InvoiceIssuedEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the invoice reached the \"Issued\" status." }, "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 }, "InvoiceOverdueEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the invoice reached the \"Overdue\" status." }, "InvoicePaidEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the invoice reached the \"Paid\" status." }, "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." }, "Journal": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/Metadata" } ], "description": "Platform entity metadata.", "nullable": true }, "audit": { "allOf": [ { "$ref": "#/components/schemas/JournalAuditBag" } ], "description": "Contains audit-related details for the entity.", "x-rql": { "rqlType": "Reference", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AuthorizationRef" } ], "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.0000000+00:00", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "assignee": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "price": { "allOf": [ { "$ref": "#/components/schemas/PriceSummary" } ], "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" ] } } }, "additionalProperties": false, "description": "Represents a journal entry in the billing system." }, "JournalAcceptedEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the journal reached the \"Accepted\" status." }, "JournalAttachment": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/Metadata" } ], "description": "Platform entity metadata.", "nullable": true }, "audit": { "allOf": [ { "$ref": "#/components/schemas/AuditBag" } ], "description": "Contains audit-related details for the entity.", "x-rql": { "rqlType": "Reference", "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/AuditCreatedEvent" } ], "description": "Contains details about the creation event of the entity.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/AuditUpdatedEvent" } ], "description": "Contains details about the most recent update event of the entity, if applicable.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "draft": { "allOf": [ { "$ref": "#/components/schemas/JournalDraftEvent" } ], "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/JournalDeletedEvent" } ], "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/JournalErrorEvent" } ], "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/JournalValidatingEvent" } ], "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/JournalValidatedEvent" } ], "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/JournalReviewEvent" } ], "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/JournalEnquiringEvent" } ], "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/JournalGeneratingEvent" } ], "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/JournalGeneratedEvent" } ], "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/JournalAcceptedEvent" } ], "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/JournalCompletedEvent" } ], "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": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/Metadata" } ], "description": "Platform entity metadata.", "nullable": true }, "audit": { "allOf": [ { "$ref": "#/components/schemas/ChargeAuditBag" } ], "description": "Contains audit-related details for the entity.", "x-rql": { "rqlType": "Reference", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AgreementRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "subscription": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SubscriptionRef" } ], "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OrderRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "asset": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AssetRef" } ], "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AuthorizationRef" } ], "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." }, "JournalCompletedEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the journal reached the \"Completed\" status." }, "JournalDeletedEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the journal reached the \"Deleted\" status." }, "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 }, "JournalDraftEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the journal reached the \"Draft\" status." }, "JournalEnquiringEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the journal reached the \"Enquiring\" status." }, "JournalErrorEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the journal reached the \"Error\" status." }, "JournalGeneratedEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the journal reached the \"Generated\" status." }, "JournalGeneratingEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the journal reached the \"Generating\" status." }, "JournalListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Journal" } } }, "additionalProperties": false }, "JournalReviewEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the journal reached the \"Review\" status." }, "JournalSeller": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "allOf": [ { "$ref": "#/components/schemas/Metadata" } ], "nullable": true }, "icon": { "type": "string", "nullable": true, "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": { "type": "string" }, "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" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "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" ] } }, "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." }, "JournalValidatedEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the journal reached the \"Validated\" status." }, "JournalValidatingEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the journal reached the \"Validating\" status." }, "Ledger": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/Metadata" } ], "description": "Platform entity metadata.", "nullable": true }, "audit": { "allOf": [ { "$ref": "#/components/schemas/LedgerAuditBag" } ], "description": "Contains audit-related details for the entity.", "x-rql": { "rqlType": "Reference", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AuthorizationRef" } ], "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/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "price": { "allOf": [ { "$ref": "#/components/schemas/PriceSummary" } ], "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" ] } } }, "additionalProperties": false, "description": "Represents a ledger in the billing system." }, "LedgerAttachment": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/Metadata" } ], "description": "Platform entity metadata.", "nullable": true }, "audit": { "allOf": [ { "$ref": "#/components/schemas/AuditBag" } ], "description": "Contains audit-related details for the entity.", "x-rql": { "rqlType": "Reference", "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/AuditCreatedEvent" } ], "description": "Contains details about the creation event of the entity.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/AuditUpdatedEvent" } ], "description": "Contains details about the most recent update event of the entity, if applicable.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "rating": { "allOf": [ { "$ref": "#/components/schemas/LedgerRatingEvent" } ], "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/LedgerErrorEvent" } ], "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/LedgerReviewEvent" } ], "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/LedgerGeneratingEvent" } ], "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/LedgerGeneratedEvent" } ], "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/LedgerQueuedEvent" } ], "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/LedgerCompletedEvent" } ], "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" }, "LedgerCompletedEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the ledger reached the \"Completed\" status." }, "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 }, "LedgerErrorEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the ledger reached the \"Error\" status." }, "LedgerGeneratedEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the ledger reached the \"Generated\" status." }, "LedgerGeneratingEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the ledger reached the \"Generating\" status." }, "LedgerListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Ledger" } } }, "additionalProperties": false }, "LedgerQueuedEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the ledger reached the \"Queued\" status." }, "LedgerRatingEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the ledger reached the \"Rating\" status." }, "LedgerReviewEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the ledger reached the \"Review\" status." }, "LedgerStatus": { "enum": [ "Rating", "Error", "Review", "Generating", "Generated", "Queued", "Completed" ], "type": "string", "description": "Represents the various statuses a ledger can have in the billing system." }, "ManualOverrideAuditBag": { "type": "object", "properties": { "created": { "allOf": [ { "$ref": "#/components/schemas/AuditCreatedEvent" } ], "description": "Contains details about the creation event of the entity.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/AuditUpdatedEvent" } ], "description": "Contains details about the most recent update event of the entity, if applicable.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "active": { "allOf": [ { "$ref": "#/components/schemas/OverrideActiveEvent" } ], "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/OverrideDisabledEvent" } ], "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" }, "OriginalValues": { "type": "object", "properties": { "subscription": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SubscriptionRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "agreement": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AgreementRef" } ], "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OrderRef" } ], "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": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/Metadata" } ], "description": "Platform entity metadata.", "nullable": true }, "audit": { "allOf": [ { "$ref": "#/components/schemas/ManualOverrideAuditBag" } ], "description": "Contains audit-related details for the entity." }, "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." }, "OverrideActiveEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the override reached the \"Active\" status." }, "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 }, "OverrideDisabledEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the override reached the \"Disabled\" status." }, "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." }, "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." }, "PriceSummary": { "type": "object", "properties": { "markup": { "type": "number", "description": "Represents the markup value applied to the pricing, visible to operations.", "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, visible to operations.", "format": "double", "example": 20, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "totalPP": { "type": "number", "description": "Represents the total purchase price, visible to vendors or operations.", "format": "double", "example": 1000, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "totalSP": { "type": "number", "description": "Represents the total sale price, visible to clients or operations.", "format": "double", "example": 1200, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "currency": { "type": "string", "description": "Specifies the currency used in the pricing summary.", "example": "EUR", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a detailed summary of pricing." }, "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." }, "Reconciliation": { "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/ReconciliationType" } ], "description": "Type of action \u2014 either Mpt.Models.Billing.ReconciliationType.Match (linking the charge to a source object),\r\nMpt.Models.Billing.ReconciliationType.Ignore (excludes the charge from billing),\r\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.\r\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 \u2014 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" }, "Statement": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/Metadata" } ], "description": "Platform entity metadata.", "nullable": true }, "audit": { "allOf": [ { "$ref": "#/components/schemas/StatementAuditBag" } ], "description": "Contains audit-related details for the entity.", "x-rql": { "rqlType": "Reference", "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AgreementRef" } ], "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/ParametrisedMessage" } ], "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" ] } }, "creditMemos": { "type": "array", "items": { "$ref": "#/components/schemas/CreditMemoRef" }, "description": "Represents the credit memo associated with the statement, if applicable.", "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } }, "invoices": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceRef" }, "description": "Represents the invoices associated with the statement, if applicable.", "nullable": true, "x-rql": { "container": true, "rqlType": "Collection", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents a billing statement in the system, containing details about transactions, pricing, and associated entities." }, "StatementAttachment": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/Metadata" } ], "description": "Platform entity metadata.", "nullable": true }, "audit": { "allOf": [ { "$ref": "#/components/schemas/AuditBag" } ], "description": "Contains audit-related details for the entity.", "x-rql": { "rqlType": "Reference", "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/AuditCreatedEvent" } ], "description": "Contains details about the creation event of the entity.", "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "allOf": [ { "$ref": "#/components/schemas/AuditUpdatedEvent" } ], "description": "Contains details about the most recent update event of the entity, if applicable.", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "generated": { "allOf": [ { "$ref": "#/components/schemas/StatementGeneratedEvent" } ], "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/StatementQueuedEvent" } ], "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/StatementErrorEvent" } ], "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/StatementCancelledEvent" } ], "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/StatementPendingEvent" } ], "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/StatementIssuedEvent" } ], "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/StatementGeneratingEvent" } ], "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" ] } } }, "additionalProperties": false, "description": "Represents a container for audit-related events for a statement" }, "StatementCancelledEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the statement reached the \"Cancelled\" status." }, "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 }, "StatementErrorEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the statement reached the \"Error\" status." }, "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" ] } } }, "additionalProperties": false, "description": "Represents external identifiers associated with a billing statement." }, "StatementGeneratedEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the statement reached the \"Generated\" status." }, "StatementGeneratingEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the statement reached the \"Generating\" status." }, "StatementIssuedEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the statement reached the \"Issued\" status." }, "StatementListResponse": { "type": "object", "properties": { "$meta": { "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Statement" } } }, "additionalProperties": false }, "StatementPendingEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the statement reached the \"Pending\" status." }, "StatementPriceSummary": { "type": "object", "properties": { "markup": { "type": "number", "description": "Represents the markup value applied to the pricing, visible to operations.", "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, visible to operations.", "format": "double", "example": 20, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "totalPP": { "type": "number", "description": "Represents the total purchase price, visible to vendors or operations.", "format": "double", "example": 1000, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Vendor", "Operations" ] } }, "totalSP": { "type": "number", "description": "Represents the total sale price, visible to clients or operations.", "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" ] } }, "totalGT": { "type": "number", "description": "Represents the total gross amount for the statement, visible to clients or operations.", "format": "double", "nullable": true, "example": 1500.75, "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "totalST": { "type": "number", "description": "Represents the total net amount for the statement, visible to clients or operations.", "format": "double", "nullable": true, "example": 1200.5, "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." }, "StatementQueuedEvent": { "type": "object", "properties": { "at": { "type": "string", "description": "Indicates the date and time when the event occurred.", "format": "date-time", "nullable": true, "example": "2025-04-30T14:30:00.0000000+00:00", "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "by": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IdentityRef" } ], "x-rql": { "container": true, "rqlType": "Reference", "ownershipType": "Referenced", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false, "description": "Represents an audit event when the statement reached the \"Queued\" status." }, "StatementStatus": { "enum": [ "Generated", "Queued", "Error", "Cancelled", "Pending", "Issued", "Generating" ], "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." }, "Batch": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "category": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Category" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Account" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "subject": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "body": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "BatchListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Batch" } } }, "additionalProperties": false }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BuyerExternalIdsDto" } ], "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/CategoryAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "description": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "optOutAllowed": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Operations" ] } }, "name": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "note": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Operations" ] } }, "deleteAllowed": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Operations" ] } }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "statistics": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/CategoryStatistics" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Operations" ] } }, "lastUsed": { "type": "string", "format": "date-time", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CategoryAudit": { "type": "object", "properties": { "created": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "published": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "unpublished": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "deleted": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "CategoryListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } } }, "additionalProperties": false }, "CategoryStatistics": { "type": "object", "properties": { "month": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/CategoryStatisticsInterval" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "today": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/CategoryStatisticsInterval" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "week": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/CategoryStatisticsInterval" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } } }, "additionalProperties": false }, "CategoryStatisticsInterval": { "type": "object", "properties": { "bounced": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "complained": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "discarded": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "failed": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "sent": { "type": "integer", "format": "int32", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } }, "total": { "type": "integer", "format": "int32", "readOnly": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Operations" ] } } }, "additionalProperties": false }, "Contact": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ContactAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "blockedReason": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "email": { "type": "string", "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" ] } }, "optOuts": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryRef" }, "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" ] } }, "userId": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "user": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/User" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ContactAudit": { "type": "object", "properties": { "created": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "activated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "blocked": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "deleted": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "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" ] } } }, "additionalProperties": false }, "ContactListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "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 }, "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" ] } } }, "additionalProperties": false, "description": "CreateCategoryDto" }, "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" ] } }, "optOutAllowed": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "note": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "deleteAllowed": { "type": "boolean", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Message": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/MessageAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "batch": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Batch" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "contact": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Contact" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "category": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Category" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "discardReason": { "type": "string", "nullable": true, "deprecated": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Account" } ], "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" ] } }, "statusReason": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "subject": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "body": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" }, "nullable": true, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "MessageAudit": { "type": "object", "properties": { "created": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "queued": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "discarded": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "sent": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "bounced": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "complained": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "failed": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "MessageBatchDto": { "type": "object", "properties": { "category": { "type": "object", "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" ] } }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/ContactReferenceDto" }, "x-rql": { "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ReferenceDto" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "buyer": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BuyerReferenceDto" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "MessageListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Message" } } }, "additionalProperties": false }, "Recipients": { "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/User" }, "nullable": true, "x-rql": { "core": true, "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "userGroups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" }, "nullable": true, "x-rql": { "core": true, "rqlType": "Collection", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ReferenceDto": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "Subscriber": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "audit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SubscriberAudit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "note": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "recipients": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Recipients" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "account": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Account" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "category": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Category" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "SubscriberAudit": { "type": "object", "properties": { "created": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "updated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "activated": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "disabled": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "deleted": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Event" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "SubscriberListResponse": { "type": "object", "properties": { "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ListMetadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Subscriber" } } }, "additionalProperties": false }, "UpdateNoteSubscriber": { "type": "object", "properties": { "note": { "type": "string", "nullable": true, "x-rql": { "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/UpdateRecipients" } ], "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 }, "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" ] } }, "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 }, "UserRef": { "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" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "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" ] } }, "icon": { "type": "string", "nullable": true, "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" ] } } }, "additionalProperties": false }, "ModuleRef": { "type": "object", "properties": { "id": { "type": "string", "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" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "filters": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Filters" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "settings": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ModuleSettings" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AccountRef": { "required": [ "name", "status", "type" ], "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" ] } }, "type": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/AccountType" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "maxLength": 500, "minLength": 1, "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "ListingRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "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" ] } } }, "additionalProperties": false }, "AuthorizationRef": { "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" ] } }, "currency": { "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" ] } }, "icon": { "type": "string", "nullable": true, "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" ] } }, "externalId": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "AssetRef": { "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" ] } }, "status": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/AssetStatus" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "SubscriptionRef": { "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" ] } } }, "additionalProperties": false }, "SellerRef": { "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" ] } }, "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" ] } } }, "additionalProperties": false }, "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" ] } }, "externalIds": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductExternalIdBag" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "icon": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "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" ] } } }, "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" ] } }, "status": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/ProgramStatus" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "applicableTo": { "type": "string", "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 }, "AgreementRef": { "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" ] } }, "status": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/AgreementStatus" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "PriceListRef": { "type": "object", "properties": { "id": { "type": "string", "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 }, "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" ] } }, "type": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/ProgramTemplateType" } ], "x-rql": { "core": true, "rqlType": "Reference", "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" ] } }, "applicableTo": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/ProgramApplicableTo" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "type": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/EnrollmentType" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "eligibility": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProgramEligibility" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/EnrollmentStatus" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "IdentityRef": { "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 }, "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" ] } } }, "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" ] } }, "client": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Account" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "eligibility": { "type": "object", "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 }, "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" ] } }, "externalIds": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProductItemExternalIdBag" } ], "x-rql": { "core": true, "rqlType": "Reference", "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" ] } } }, "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" ] } } }, "additionalProperties": false }, "UnitOfMeasureRef": { "type": "object", "properties": { "id": { "type": "string", "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" ] } }, "name": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "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" ] } } }, "additionalProperties": false }, "ErpLinkRef": { "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" ] } }, "name": { "type": "string", "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": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/ErpLinkStatus" } ], "x-rql": { "core": true, "rqlType": "Reference", "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" ] } } }, "additionalProperties": false }, "SplitBillingSubscriptionRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "JournalRef": { "type": "object", "properties": { "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.0000000+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": { "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": { "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": { "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." }, "OrderRef": { "type": "object", "properties": { "id": { "type": "string", "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false }, "StatementRef": { "type": "object", "properties": { "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." }, "CreditMemoRef": { "type": "object", "properties": { "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": { "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." }, "CategoryRef": { "type": "object", "properties": { "id": { "type": "string", "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" ] } }, "name": { "type": "string", "nullable": true, "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" ] } }, "lastUsed": { "type": "string", "format": "date-time", "nullable": true, "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "$meta": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "icon": { "type": "string", "nullable": true, "x-rql": { "core": true, "rqlType": "Primitive", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "externalIds": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountExternalIds" } ], "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" ] } }, "type": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/AccountType" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "status": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/AccountStatus" } ], "x-rql": { "core": true, "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "serviceLevel": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/AccountServiceLevel" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } }, "address": { "type": "object", "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" ] } }, "name": { "maxLength": 500, "minLength": 1, "type": "string", "x-rql": { "core": true, "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": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Eligibility" } ], "x-rql": { "rqlType": "Reference", "ownershipType": "Owned", "access": [ "Client", "Vendor", "Operations" ] } } }, "additionalProperties": false } } }, "servers": [ { "url": "https://api.platform.softwareone.com" } ] }