{ "openapi": "3.0.4", "info": { "title": "Public User API", "description": "# Getting started\n\n## Access token\nAll requests to the API must include a access token in header to be authorized.\n\nFollow the get started to get a access token https://ancon.dev/get-started/.\n\nThe header must be named 'Access-Token' and have a valid token value otherwise a 401 Unauthorized repsonse is given.\n\n## Token levels\nAccess tokens has two levels it can be.\n\n### Tenant level\nTenant level tokens have read/write permissions on all endpoints.\n\n### Outlet level\nOutlet level tokens can only has read permissions on tenant level data and read/write on outlet level data for the specified outlet the token was created for.\n\n## Request limits\nRequest limit information is send back in response headers:\n\n* X-Rate-Limit-Limit: 1s\n* X-Rate-Limit-Remaining: 9\n* X-Rate-Limit-Reset: 2022-12-16T14:13:28.6783785Z\n\nIn this example the endpoint allows for max 10 requests each second.\n\n## Correlation-Id\n\nCorrelation id is a unique id of the request and is sent back as a response header, include this in any question or bugreport you make.\n\nCan also be sent in as a request header to correlate any logging you may do on your side then the sent in correlation id will be used in our logging aswell.\n\n## Filtering\nFiltering is done with query parameters, and available properties that can be filtered on is documented per endpoint.\n\nFiltering specification: https://ancon.dev/wp-content/uploads/2022/12/Filtering-2022-12-16.pdf\n\n## Deprecation of endpoints\nEndpoints can be deprecated because a newer version is added and the existing will eventually expire out from the api.\n\nIf a endpoint is deprecated it will be shown here in the documentation.\n\nIt is also included in response headers:\n* Deprecation-Sunset: 2024-10-01 00:00:00\n* Deprecation: This API endpoint is deprecated and will be removed in a future version, use a newer version.\n\nIt is recomended to implement alerting on this so you can get notified if you're using a deprecated endpont version to avoid any disruptions.\n\n# Webhooks\nWebhooks are found in https://cloud.ancon.io on the integration page for public api, webhooks will be sent out once a url is configured there.\n\nUpon failures we will try to send out the webhook for max 3 tries with 3 minutes between.\n\nAll webhooks will be sent with headers:\n\n* Api-Version: 1.0\n* Try: 1\n* MaxTries: 3\n\n## Customer\nCustomer added: [Webhook payload](https://user-api.ancon.io/docs-v1/index.html#tag/Customers/paths/~1api~1v1~1Tenants~1%7BtenantId%7D~1Customers~1%7BcustomerId%7D/get)", "contact": { "name": "", "email": "integration-support@ancon.io" }, "version": "public-v1", "x-logo": { "url": "https://ancon.dev/wp-content/uploads/2022/12/logo-tango_L-no-transp.png" } }, "paths": { "/public/api/v1/Outlets/{outletId}/Companies/{companyId}": { "get": { "tags": [ "Companies" ], "summary": "Get company details", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.Queries.Detail.DetailCompanyQueryResponse" }, "example": { "company": { "id": "c267ad2a-f4e0-4c5d-80d1-650f9a1b6e03", "created": "2026-10-23T14:33:35.4407903Z", "modified": "2026-10-23T14:33:35.4407904Z", "tenantId": "07575b16-b132-486d-83b7-61eb3c2262ed", "name": "Nice food AB", "businessNumber": "551245-1523", "addressId": "126bb42f-16e7-4fe0-a08f-2a6b90d76d48", "invoiceAddress": { "street": "Kompanigatan 36", "street2": "Höhögatan 69", "zipCode": "666 69", "city": "Höhs" }, "countryCode": "SE", "phoneNumber": "", "invoiceEmail": "example@company.io", "defaultInvoiceReferenceNote": "Conference room 12", "isDeleted": false, "originatingOutletId": "935874c9-2b78-4521-b113-41743e68db9f", "originatingOutletName": null, "originatingIntegrationType": 3, "gln": "1234567890123", "companyReference": "Example Company", "guestGroupId": null, "integrationExternalIds": { } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BaseResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.NotFoundResponse" } } } } }, "deprecated": true }, "put": { "tags": [ "Companies" ], "summary": "Update company", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.Commands.Update.UpdateCompanyCommand" } ] }, "example": { "name": "Updated - Nice food AB", "businessNumber": "551245-1523", "invoiceAddress": { "addressId": null, "addressType": 0, "street": "Kompanigatan 36", "street2": "Höhögatan 69", "zipCode": "666 69", "city": "Höhs" }, "countryCode": null, "phoneNumber": "46623879876", "invoiceEmail": "example@company.io", "defaultInvoiceReferenceNote": "Conference room 12", "gln": null, "companyReference": null } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.Commands.Update.UpdateCompanyCommandResponse" }, "example": { "company": { "id": "7f4ceecd-9c6e-4f5f-898c-731174572f57", "created": "2026-10-23T14:33:35.4431363Z", "modified": "2026-10-23T14:33:35.4431364Z", "tenantId": "43312cc4-29d9-4721-a68a-d456381f7777", "name": "Nice food AB", "businessNumber": "551245-1523", "addressId": "299c0494-9a43-4606-9700-0a57229956da", "invoiceAddress": { "street": "Kompanigatan 36", "street2": "Höhögatan 69", "zipCode": "666 69", "city": "Höhs" }, "countryCode": "SE", "phoneNumber": "", "invoiceEmail": "example@company.io", "defaultInvoiceReferenceNote": "Conference room 12", "isDeleted": false, "originatingOutletId": "f9373409-ee32-40b7-99e3-e63d1159be9d", "originatingOutletName": null, "originatingIntegrationType": 3, "gln": "1234567890123", "companyReference": "Example Company", "guestGroupId": null, "integrationExternalIds": { } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BadRequestResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BaseResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.NotFoundResponse" } } } } }, "deprecated": true }, "delete": { "tags": [ "Companies" ], "summary": "Delete company", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.Commands.Delete.DeleteCompanyCommandResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BadRequestResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BaseResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.NotFoundResponse" } } } } }, "deprecated": true } }, "/public/api/v1/Tenants/{tenantId}/Companies/{companyId}": { "get": { "tags": [ "Companies" ], "summary": "Get company details", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.Queries.Detail.DetailCompanyQueryResponse" }, "example": { "company": { "id": "a9535301-18d0-4c58-97e3-92c9d8d5804b", "created": "2026-10-23T14:33:35.4443957Z", "modified": "2026-10-23T14:33:35.4443957Z", "tenantId": "24b3b40d-23ab-4c4e-bbf0-07427db712f7", "name": "Nice food AB", "businessNumber": "551245-1523", "addressId": "99085567-7809-4546-afb3-6a2df16dce89", "invoiceAddress": { "street": "Kompanigatan 36", "street2": "Höhögatan 69", "zipCode": "666 69", "city": "Höhs" }, "countryCode": "SE", "phoneNumber": "", "invoiceEmail": "example@company.io", "defaultInvoiceReferenceNote": "Conference room 12", "isDeleted": false, "originatingOutletId": "42c18708-176b-47cd-a170-d37ffb0ece9f", "originatingOutletName": null, "originatingIntegrationType": 3, "gln": "1234567890123", "companyReference": "Example Company", "guestGroupId": null, "integrationExternalIds": { } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BaseResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.NotFoundResponse" } } } } }, "deprecated": true }, "put": { "tags": [ "Companies" ], "summary": "Update tenant company", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.Commands.Update.UpdateCompanyCommand" } ] }, "example": { "name": "Updated - Nice food AB", "businessNumber": "551245-1523", "invoiceAddress": { "addressId": null, "addressType": 0, "street": "Kompanigatan 36", "street2": "Höhögatan 69", "zipCode": "666 69", "city": "Höhs" }, "countryCode": null, "phoneNumber": "46623879876", "invoiceEmail": "example@company.io", "defaultInvoiceReferenceNote": "Conference room 12", "gln": null, "companyReference": null } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.Commands.Update.UpdateCompanyCommandResponse" }, "example": { "company": { "id": "980f0974-4335-450a-a869-edc02d8ac08c", "created": "2026-10-23T14:33:35.4452955Z", "modified": "2026-10-23T14:33:35.4452956Z", "tenantId": "b4bb720f-ff1b-4fb5-a2a4-8ab237442ff0", "name": "Nice food AB", "businessNumber": "551245-1523", "addressId": "40253039-601e-4c0b-b07f-8fdeb940bb8c", "invoiceAddress": { "street": "Kompanigatan 36", "street2": "Höhögatan 69", "zipCode": "666 69", "city": "Höhs" }, "countryCode": "SE", "phoneNumber": "", "invoiceEmail": "example@company.io", "defaultInvoiceReferenceNote": "Conference room 12", "isDeleted": false, "originatingOutletId": "e3029247-7e1e-4486-91f3-0f59a485710f", "originatingOutletName": null, "originatingIntegrationType": 3, "gln": "1234567890123", "companyReference": "Example Company", "guestGroupId": null, "integrationExternalIds": { } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BadRequestResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BaseResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.NotFoundResponse" } } } } }, "deprecated": true }, "delete": { "tags": [ "Companies" ], "summary": "Delete tenant company", "parameters": [ { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.Commands.Delete.DeleteCompanyCommandResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BadRequestResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BaseResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.NotFoundResponse" } } } } } } }, "/public/api/v1/Outlets/{outletId}/Companies": { "get": { "tags": [ "Companies" ], "summary": "Get company list", "description": "### Available filter properties\r\n- created (datetime)\r\n- name (string)\r\n- businessnumber (string)\r\n- ordercreated (datetime)\r\n- externalid (string)", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.Queries.List.ListCompanyResponse" }, "example": { "items": [ { "id": "66952e8b-1c4f-46a2-872d-0d618ca45ed2", "name": "Nice food AB", "created": "2026-10-23T14:33:35.4512533Z", "lastOrderedAt": "2026-10-23T08:33:35.4512533Z", "invoiceCount": 41, "totalSpent": 12423.23, "originatingOutletId": null, "originatingOutletName": null, "originatingIntegrationType": null }, { "id": "b550c836-8435-4974-a932-a0676336e9c2", "name": "Okay food AB", "created": "2026-10-23T14:33:35.4512634Z", "lastOrderedAt": "2026-10-23T08:33:35.4512634Z", "invoiceCount": 23, "totalSpent": 5003.0, "originatingOutletId": null, "originatingOutletName": null, "originatingIntegrationType": null } ], "meta": { "count": 2, "offset": 0 } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BadRequestResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BaseResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.NotFoundResponse" } } } } }, "deprecated": true }, "post": { "tags": [ "Companies" ], "summary": "Create company", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.Commands.Create.CreateCompanyCommand" } ] }, "example": { "name": "Nice food AB", "businessNumber": "551245-1523", "invoiceAddress": { "addressId": null, "addressType": 0, "street": "Kompanigatan 36", "street2": "Höhögatan 69", "zipCode": "666 69", "city": "Höhs" }, "countryCode": null, "phoneNumber": "46623879876", "invoiceEmail": "example@company.io", "defaultInvoiceReferenceNote": "Conference room 12", "companyReference": "example company", "gln": "1234567890123", "customerId": "1234" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.Commands.Create.CreateCompanyCommandResponse" }, "example": { "company": { "id": "3195798b-632d-445d-9948-c9608c743d72", "created": "2026-10-23T14:33:35.4525166Z", "modified": "2026-10-23T14:33:35.4525166Z", "tenantId": "bc487768-1e0c-4681-addc-44dfed559065", "name": "Nice food AB", "businessNumber": "551245-1523", "addressId": "b522f74e-687e-4903-bf39-eb25a4cdf2d6", "invoiceAddress": { "street": "Kompanigatan 36", "street2": "Höhögatan 69", "zipCode": "666 69", "city": "Höhs" }, "countryCode": "SE", "phoneNumber": "", "invoiceEmail": "example@company.io", "defaultInvoiceReferenceNote": "Conference room 12", "isDeleted": false, "originatingOutletId": "20672af1-d2d5-4e10-892f-c4f814e8ca64", "originatingOutletName": null, "originatingIntegrationType": 3, "gln": "1234567890123", "companyReference": "Example Company", "guestGroupId": null, "integrationExternalIds": { } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BadRequestResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BaseResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.NotFoundResponse" } } } } }, "deprecated": true } }, "/public/api/v1/Tenants/{tenantId}/Companies": { "get": { "tags": [ "Companies" ], "summary": "Get tenant company list", "description": "### Available filter properties\r\n- created (datetime)\r\n- name (string)\r\n- businessnumber (string)\r\n- ordercreated (datetime)\r\n- externalid (string)", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.Queries.List.ListCompanyResponse" }, "example": { "items": [ { "id": "886f510e-815d-41a8-8fe1-425437539e56", "name": "Nice food AB", "created": "2026-10-23T14:33:35.4532909Z", "lastOrderedAt": "2026-10-23T08:33:35.4532909Z", "invoiceCount": 41, "totalSpent": 12423.23, "originatingOutletId": null, "originatingOutletName": null, "originatingIntegrationType": null }, { "id": "0494e5ed-35d8-4a18-92fe-23ccd6a060ab", "name": "Okay food AB", "created": "2026-10-23T14:33:35.4532976Z", "lastOrderedAt": "2026-10-23T08:33:35.4532977Z", "invoiceCount": 23, "totalSpent": 5003.0, "originatingOutletId": null, "originatingOutletName": null, "originatingIntegrationType": null } ], "meta": { "count": 2, "offset": 0 } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BadRequestResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BaseResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.NotFoundResponse" } } } } } }, "post": { "tags": [ "Companies" ], "summary": "Create tenant company", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.Commands.Create.CreateCompanyCommand" } ] }, "example": { "name": "Nice food AB", "businessNumber": "551245-1523", "invoiceAddress": { "addressId": null, "addressType": 0, "street": "Kompanigatan 36", "street2": "Höhögatan 69", "zipCode": "666 69", "city": "Höhs" }, "countryCode": null, "phoneNumber": "46623879876", "invoiceEmail": "example@company.io", "defaultInvoiceReferenceNote": "Conference room 12", "companyReference": "example company", "gln": "1234567890123", "customerId": "1234" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.Commands.Create.CreateCompanyCommandResponse" }, "example": { "company": { "id": "024b5603-c049-480a-9009-9142bc9aec03", "created": "2026-10-23T14:33:35.4540945Z", "modified": "2026-10-23T14:33:35.4540946Z", "tenantId": "81a629c7-c885-4832-96ec-2c1914387923", "name": "Nice food AB", "businessNumber": "551245-1523", "addressId": "e2ce034e-1a0f-481a-9c67-6f1e1634279b", "invoiceAddress": { "street": "Kompanigatan 36", "street2": "Höhögatan 69", "zipCode": "666 69", "city": "Höhs" }, "countryCode": "SE", "phoneNumber": "", "invoiceEmail": "example@company.io", "defaultInvoiceReferenceNote": "Conference room 12", "isDeleted": false, "originatingOutletId": "2a92e9ee-8587-48ec-9b8b-c91262ec799d", "originatingOutletName": null, "originatingIntegrationType": 3, "gln": "1234567890123", "companyReference": "Example Company", "guestGroupId": null, "integrationExternalIds": { } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BadRequestResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BaseResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.NotFoundResponse" } } } } } } }, "/public/api/v1/Outlets/{outletId}/Companies/{companyId}/Members": { "post": { "tags": [ "Companies" ], "summary": "Create company member", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.CompanyMembers.Commands.Create.CreateCompanyMemberCommand" } ] }, "example": { "firstName": "John", "lastName": "Doe", "email": "johnjoe@ancon.io", "phoneNumber": "123456789", "department": "IT" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.CompanyMembers.Commands.Create.CreateCompanyMemberCommandResponse" }, "example": { "companyMember": { "id": "091ee127-5577-4b9f-b77a-d461979e3818", "fullName": "John Doe", "name": { "firstName": "John", "lastName": "Doe" }, "email": "johnjoe@ancon.io", "phoneNumber": "123456789", "department": "IT" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BadRequestResponse" } } } } }, "deprecated": true }, "get": { "tags": [ "Companies" ], "summary": "Get company members list", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.CompanyMembers.Queries.List.ListCompanyMemberQueryResponse" }, "example": { "items": [ { "id": "5100f725-5be4-4826-869d-c51bdea0ac46", "fullName": "John Doe", "firstName": "John", "lastName": "Doe", "email": "johnjoe@ancon.io", "phoneNumber": "123456789", "department": "IT", "emailVerified": true } ], "meta": { "count": 1, "offset": 0 } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.NotFoundResponse" } } } } }, "deprecated": true } }, "/public/api/v1/Tenants/{tenantId}/Companies/{companyId}/Members": { "post": { "tags": [ "Companies" ], "summary": "Create tenant company member", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.CompanyMembers.Commands.Create.CreateCompanyMemberCommand" } ] }, "example": { "firstName": "John", "lastName": "Doe", "email": "johnjoe@ancon.io", "phoneNumber": "123456789", "department": "IT" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.CompanyMembers.Commands.Create.CreateCompanyMemberCommandResponse" }, "example": { "companyMember": { "id": "5a80ff11-0841-4abb-9410-9c27519ff9e5", "fullName": "John Doe", "name": { "firstName": "John", "lastName": "Doe" }, "email": "johnjoe@ancon.io", "phoneNumber": "123456789", "department": "IT" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BadRequestResponse" } } } } } }, "get": { "tags": [ "Companies" ], "summary": "Get tenant company members list", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.CompanyMembers.Queries.List.ListCompanyMemberQueryResponse" }, "example": { "items": [ { "id": "8ef24e59-aac5-4f43-bd46-fc54e4b70e48", "fullName": "John Doe", "firstName": "John", "lastName": "Doe", "email": "johnjoe@ancon.io", "phoneNumber": "123456789", "department": "IT", "emailVerified": true } ], "meta": { "count": 1, "offset": 0 } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.NotFoundResponse" } } } } } } }, "/public/api/v1/Outlets/{outletId}/Companies/{companyId}/Members/{memberId}": { "get": { "tags": [ "Companies" ], "summary": "Get company members details", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "memberId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.CompanyMembers.Queries.Detail.DetailCompanyMemberQueryResponse" }, "example": { "id": "9f820ff7-d30e-4c2c-ac09-f81c8da2014c", "fullName": "John Doe", "firstName": "John", "lastName": "Doe", "email": "johnjoe@ancon.io", "phoneNumber": "123456789", "department": "IT", "emailVerified": true } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.NotFoundResponse" } } } } }, "deprecated": true }, "put": { "tags": [ "Companies" ], "summary": "Update company member", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "memberId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.CompanyMembers.Commands.Update.UpdateCompanyMemberCommand" } ] }, "example": { "firstName": "John", "lastName": "Doe", "phoneNumber": "123456789", "department": "IT" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.CompanyMembers.Commands.Update.UpdateCompanyMemberCommandResponse" }, "example": { "companyMember": { "id": "b7a0353f-fb75-4824-98db-c2622a7a09a7", "fullName": "John Doe", "name": { "firstName": "John", "lastName": "Doe" }, "email": "johnjoe@ancon.io", "phoneNumber": "123456789", "department": "IT" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BadRequestResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.NotFoundResponse" } } } } }, "deprecated": true }, "delete": { "tags": [ "Companies" ], "summary": "Delete company member", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "memberId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.CompanyMembers.Commands.Delete.DeleteCompanyMemberCommandResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BadRequestResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BaseResponse" } } } } }, "deprecated": true } }, "/public/api/v1/Tenants/{tenantId}/Companies/{companyId}/Members/{memberId}": { "get": { "tags": [ "Companies" ], "summary": "Get tenant company members details", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "memberId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.CompanyMembers.Queries.Detail.DetailCompanyMemberQueryResponse" }, "example": { "id": "ebc0a572-de32-4311-a61d-482b7ef9ae98", "fullName": "John Doe", "firstName": "John", "lastName": "Doe", "email": "johnjoe@ancon.io", "phoneNumber": "123456789", "department": "IT", "emailVerified": true } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.NotFoundResponse" } } } } } }, "put": { "tags": [ "Companies" ], "summary": "Update tenant company member", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "memberId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.CompanyMembers.Commands.Update.UpdateCompanyMemberCommand" } ] }, "example": { "firstName": "John", "lastName": "Doe", "phoneNumber": "123456789", "department": "IT" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.CompanyMembers.Commands.Update.UpdateCompanyMemberCommandResponse" }, "example": { "companyMember": { "id": "75e7df23-c154-439f-a1f2-b4783aca6dff", "fullName": "John Doe", "name": { "firstName": "John", "lastName": "Doe" }, "email": "johnjoe@ancon.io", "phoneNumber": "123456789", "department": "IT" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BadRequestResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.NotFoundResponse" } } } } } }, "delete": { "tags": [ "Companies" ], "summary": "Delete tenant company member", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "memberId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.CompanyMembers.Commands.Delete.DeleteCompanyMemberCommandResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BadRequestResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BaseResponse" } } } } } } }, "/public/api/v1/Tenants/{tenantId}/Companies/{companyId}/ExternalReference": { "put": { "tags": [ "Companies" ], "summary": "Update company external reference", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.ExternalReference.Commands.Update.UpdateCompanyExternalReferenceCommand" } ] }, "example": { "customerId": "1234" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.ExternalReference.Commands.Update.UpdateCompanyExternalReferenceCommandResponse" }, "example": { "companyIntegration": { "id": "0abaa86d-baca-4415-8ebc-88bce4984fcc", "integrationId": null, "externalId": "1234", "integrationType": null, "created": "2026-10-23T14:33:35.467083Z", "modified": "2026-10-23T14:33:35.4670832Z" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BadRequestResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.NotFoundResponse" } } } } } } }, "/public/api/v1.1/Tenants/{tenantId}/Companies/{companyId}": { "get": { "tags": [ "Companies" ], "summary": "Get company details 1.1", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V1.Queries.Detail.DetailCompanyQueryResponse" }, "example": { "company": { "id": "bdd0b338-c413-4509-94f1-d3a7f81d1fd2", "created": "2026-10-23T14:33:35.4684853Z", "modified": "2026-10-23T14:33:35.4684853Z", "tenantId": "960003f0-5bd3-4fbf-a657-735831b357df", "name": "Nice food AB", "businessNumber": "551245-1523", "addressId": "74651262-0cd1-46dc-87fb-c0fd09e71d74", "invoiceAddress": { "street": "Kompanigatan 36", "street2": "Höhögatan 69", "zipCode": "666 69", "city": "Höhs" }, "countryCode": "SE", "phoneNumber": "", "invoiceEmail": "example@company.io", "defaultInvoiceReferenceNote": "Conference room 12", "isDeleted": false, "originatingOutletId": "9904d12c-f9a9-4234-994b-bc88bf68409b", "originatingOutletName": null, "originatingIntegrationType": 3, "gln": "1234567890123", "companyReference": "Example Company", "guestGroupId": null, "integrationExternalIds": [ ] }, "guestGroup": null } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BaseResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.NotFoundResponse" } } } } } }, "put": { "tags": [ "Companies" ], "summary": "Update tenant company", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V1.Commands.Update.UpdateCompanyCommand" } ] }, "example": { "name": "Updated - Nice food AB", "businessNumber": "551245-1523", "invoiceAddress": { "addressId": null, "addressType": 0, "street": "Kompanigatan 36", "street2": "Höhögatan 69", "zipCode": "666 69", "city": "Höhs" }, "countryCode": null, "phoneNumber": "46623879876", "invoiceEmail": "example@company.io", "defaultInvoiceReferenceNote": "Conference room 12", "gln": null, "companyReference": null, "guestGroupId": null } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V1.Commands.Update.UpdateCompanyCommandResponse" }, "example": { "company": { "id": "52b5bafa-d472-45de-9bc7-267aa2f08003", "created": "2026-10-23T14:33:35.4697317Z", "modified": "2026-10-23T14:33:35.4697318Z", "tenantId": "6ac82107-ec1d-4e85-89f7-fc9c58116221", "name": "Nice food AB", "businessNumber": "551245-1523", "addressId": "7b128539-c50a-4daf-8fc1-bf7e3289ce11", "invoiceAddress": { "street": "Kompanigatan 36", "street2": "Höhögatan 69", "zipCode": "666 69", "city": "Höhs" }, "countryCode": "SE", "phoneNumber": "", "invoiceEmail": "example@company.io", "defaultInvoiceReferenceNote": "Conference room 12", "isDeleted": false, "originatingOutletId": "f4290401-4390-419b-9c61-026e46392fa0", "originatingOutletName": null, "originatingIntegrationType": 3, "gln": "1234567890123", "companyReference": "Example Company", "guestGroupId": null, "integrationExternalIds": [ ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BadRequestResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BaseResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.NotFoundResponse" } } } } } } }, "/public/api/v1/Tenants/{tenantId}/Customers/{customerId}": { "get": { "tags": [ "Customers" ], "summary": "Get tenant customer details", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Customers.V0.Queries.DetailByTenant.DetailByTenantCustomerQueryResponse" }, "example": { "customer": { "id": "fc4dc968-b596-406e-b363-fc1f167dc9f7", "created": "2026-10-23T14:33:35.4711515Z", "modified": "2026-10-23T14:33:35.4711516Z", "identityUserId": "e5752462-d190-4a89-92f0-c668fe1fb0ba", "firstName": "John", "lastName": "Smith", "email": "john@smith.com", "dateOfBirth": "1999-10-23T14:33:35.4711522Z", "gender": 1, "telephoneNumber": "+1 555-123456", "languageCode": "en-US", "isDeleted": false, "isDisabled": false, "addresses": [ { "id": "153a875c-3303-4ed8-8c47-6ccee058f55c", "addressType": 1, "title": "Microsoft Corporation", "street": "One Microsoft Way", "zipCode": "98052-6399", "city": "Redmond", "state": "Washington", "country": "United States of America", "location": { "latitude": 47.6370891183, "longitude": -122.123736172 }, "note": "Watch out for Steve Ballmer's ghost." }, { "id": "d6ef50f4-8962-47a7-abe4-b1765efdf102", "addressType": 1, "title": "Google HQ", "street": "1600 Amphitheatre Pkwy", "zipCode": "94043", "city": "Mountain View", "state": "CA", "country": "United States", "location": { "latitude": 37.42204695516293, "longitude": -122.08549661991442 }, "note": "Yes, Google is my second work." }, { "id": "231332f6-1830-4366-810f-db5d510a88a3", "addressType": 0, "title": "The Mansion", "street": "The street 1", "zipCode": "123 45", "city": "Under the Sea", "state": null, "country": null, "location": { "latitude": 31.19669, "longitude": -38.84766 }, "note": "btw, I live under the ocean." } ], "saleAllTime": [ { "id": "ae9c5af7-4722-413f-ba40-6d51d18ab53f", "outletId": "a6588eff-bd22-45d3-a206-0214e0748b28", "tenantId": "cf1e4390-0321-4210-a478-e44e4ac941eb", "totalSpent": { "amount": 5345.0, "currency": "USD" }, "totalOnlineOrders": 23, "totalPosOrders": 105, "firstOrder": "2024-10-24T14:33:35.4711445Z", "lastOrder": "2025-10-24T14:33:35.4711458Z", "customerOrderFormatSales": [ { "orderFormat": 1, "orderCount": 105, "totalAmount": { "amount": 4000.0, "currency": "SEK" } }, { "orderFormat": 8, "orderCount": 23, "totalAmount": { "amount": 1345.0, "currency": "SEK" } } ] }, { "id": "9079f1cf-410a-4772-ab00-23f389a7c244", "outletId": "a3a4fdce-1af6-4332-b84b-33b1dffc536e", "tenantId": "cf1e4390-0321-4210-a478-e44e4ac941eb", "totalSpent": { "amount": 180547.0, "currency": "USD" }, "totalOnlineOrders": 524, "totalPosOrders": 1051, "firstOrder": "2024-10-25T14:33:35.4711486Z", "lastOrder": "2025-10-25T14:33:35.4711488Z", "customerOrderFormatSales": [ { "orderFormat": 1, "orderCount": 551, "totalAmount": { "amount": 50000.0, "currency": "SEK" } }, { "orderFormat": 4, "orderCount": 500, "totalAmount": { "amount": 50000.0, "currency": "SEK" } }, { "orderFormat": 8, "orderCount": 23, "totalAmount": { "amount": 80547.0, "currency": "SEK" } } ] }, { "id": "d24d1bb0-6cb7-4d22-9ba2-1d0496b44b8f", "outletId": "ea49792c-359d-4993-85d9-9c9e43c1da0d", "tenantId": "cf1e4390-0321-4210-a478-e44e4ac941eb", "totalSpent": { "amount": 154.0, "currency": "USD" }, "totalOnlineOrders": 6, "totalPosOrders": 0, "firstOrder": "2024-10-26T14:33:35.4711505Z", "lastOrder": "2025-10-26T14:33:35.4711506Z", "customerOrderFormatSales": [ { "orderFormat": 1, "orderCount": 6, "totalAmount": { "amount": 154.0, "currency": "USD" } } ] } ] } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BaseResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.NotFoundResponse" } } } } }, "deprecated": true } }, "/public/api/v1/Tenants/{tenantId}/Customers": { "get": { "tags": [ "Customers" ], "summary": "Get Customer list by tenant", "description": "### Available filter properties\r\n- name (string)\r\n- firstname (string)\r\n- lastname (string)\r\n- created (datetime)\r\n- email (string)\r\n- firstorder (datetime)\r\n- lastorder (datetime)\r\n- totalonlineorders (int)\r\n- totalposorders (int)\r\n- totalspent (decimal)\r\n- outletid (guid)\r\n- tenantid (guid)\r\n- ordersonoutlets (guid)\r\n- salesourceid (nullable guid)", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Customers.V0.Queries.List.ListCustomerQueryResponse" }, "example": { "items": [ { "id": "d37b745b-fa9b-43bc-94a7-96ce8a2d7c31", "created": "2026-10-20T14:33:35.4723209Z", "firstName": "Adrian", "lastName": "Svensson", "email": "adrian@svensson.io", "languageCode": "sv-SE", "isDeleted": false, "isDisabled": false, "totalOnlineOrders": 1, "totalPosOrders": 0, "totalSpent": { "amount": 123.0, "currency": "SEK" }, "firstOrder": "2026-10-21T14:33:35.4723221Z", "lastOrder": "2026-10-22T14:33:35.4723222Z", "saleSourceId": null }, { "id": "de50495c-6a32-45a2-9e78-5f83c9b0fcde", "created": "2026-10-11T14:33:35.4723249Z", "firstName": "John", "lastName": "Smith", "email": "john@smith.io", "languageCode": "en-US", "isDeleted": false, "isDisabled": false, "totalOnlineOrders": 0, "totalPosOrders": 3, "totalSpent": { "amount": 1223.0, "currency": "SEK" }, "firstOrder": "2026-10-20T14:33:35.472325Z", "lastOrder": "2026-10-21T14:33:35.472325Z", "saleSourceId": null }, { "id": "585bf898-6ddf-45fd-8b0a-0113340788fd", "created": "2026-10-03T14:33:35.472344Z", "firstName": null, "lastName": null, "email": null, "languageCode": "en-US", "isDeleted": true, "isDisabled": false, "totalOnlineOrders": 3, "totalPosOrders": 5, "totalSpent": { "amount": 805.0, "currency": "SEK" }, "firstOrder": "2026-10-21T14:33:35.4723441Z", "lastOrder": "2026-10-22T14:33:35.4723442Z", "saleSourceId": null }, { "id": "e7ac74e8-7a42-4444-8a94-d2c00f3aaeb5", "created": "2026-04-26T14:33:35.4723452Z", "firstName": null, "lastName": null, "email": null, "languageCode": "nb-NO", "isDeleted": false, "isDisabled": true, "totalOnlineOrders": 0, "totalPosOrders": 123, "totalSpent": { "amount": 121233.0, "currency": "SEK" }, "firstOrder": "2026-10-15T14:33:35.4723453Z", "lastOrder": "2026-10-16T14:33:35.4723454Z", "saleSourceId": null } ], "meta": null } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BaseResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.NotFoundResponse" } } } } }, "deprecated": true } }, "/public/api/v1.1/Tenants/{tenantId}/Customers/{customerId}": { "get": { "tags": [ "Customers" ], "summary": "Get tenant customer details", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Customers.V1.Queries.DetailByTenant.DetailByTenantCustomerQueryResponse" }, "example": { "customer": { "id": "eb9893d5-2c82-4f78-be18-f3e120a7c376", "created": "2026-10-23T14:33:35.4737184Z", "modified": "2026-10-23T14:33:35.4737184Z", "identityUserId": "a4f519b2-13ff-46e0-9b55-e719530d3418", "firstName": "John", "lastName": "Smith", "email": "john@smith.com", "dateOfBirth": "1999-10-23T14:33:35.4737191Z", "gender": 1, "telephoneNumber": "+1 555-123456", "languageCode": "en-US", "isDeleted": false, "isDisabled": false, "addresses": [ { "id": "20f87097-c804-4ed1-9cad-4939b54990c5", "addressType": 1, "title": "Microsoft Corporation", "street": "One Microsoft Way", "zipCode": "98052-6399", "city": "Redmond", "state": "Washington", "country": "United States of America", "location": { "latitude": 47.6370891183, "longitude": -122.123736172 }, "note": "Watch out for Steve Ballmer's ghost." }, { "id": "278c6f94-6294-48c3-bad8-5ec36fe0871c", "addressType": 1, "title": "Google HQ", "street": "1600 Amphitheatre Pkwy", "zipCode": "94043", "city": "Mountain View", "state": "CA", "country": "United States", "location": { "latitude": 37.42204695516293, "longitude": -122.08549661991442 }, "note": "Yes, Google is my second work." }, { "id": "07d3bd45-21bf-46c5-b1a2-b3e5632257ef", "addressType": 0, "title": "The Mansion", "street": "The street 1", "zipCode": "123 45", "city": "Under the Sea", "state": null, "country": null, "location": { "latitude": 31.19669, "longitude": -38.84766 }, "note": "btw, I live under the ocean." } ], "saleAllTime": [ { "id": "c90450e2-bb22-42b1-886a-967ad9636ed0", "outletId": "30fcad95-c17f-43a1-953e-eb17fa69df34", "tenantId": "cf1e4390-0321-4210-a478-e44e4ac941eb", "totalSpent": { "amount": 5345.0, "currency": "USD" }, "totalOnlineOrders": 23, "totalPosOrders": 105, "firstOrder": "2024-10-24T14:33:35.4737112Z", "lastOrder": "2025-10-24T14:33:35.4737125Z", "customerOrderFormatSales": [ { "orderFormat": 1, "orderCount": 105, "totalAmount": { "amount": 4000.0, "currency": "SEK" } }, { "orderFormat": 8, "orderCount": 23, "totalAmount": { "amount": 1345.0, "currency": "SEK" } } ] }, { "id": "3acba8fa-e10a-4a70-b150-f1fcf01d3ee6", "outletId": "888a881e-3759-4ca5-8e42-bcd338dc6ace", "tenantId": "cf1e4390-0321-4210-a478-e44e4ac941eb", "totalSpent": { "amount": 180547.0, "currency": "USD" }, "totalOnlineOrders": 524, "totalPosOrders": 1051, "firstOrder": "2024-10-25T14:33:35.473715Z", "lastOrder": "2025-10-25T14:33:35.4737151Z", "customerOrderFormatSales": [ { "orderFormat": 1, "orderCount": 551, "totalAmount": { "amount": 50000.0, "currency": "SEK" } }, { "orderFormat": 4, "orderCount": 500, "totalAmount": { "amount": 50000.0, "currency": "SEK" } }, { "orderFormat": 8, "orderCount": 23, "totalAmount": { "amount": 80547.0, "currency": "SEK" } } ] }, { "id": "7b175c56-c041-4de3-ad1d-4dcf3958bbe3", "outletId": "f2add6e3-860f-469d-945a-1909c8ff4a13", "tenantId": "cf1e4390-0321-4210-a478-e44e4ac941eb", "totalSpent": { "amount": 154.0, "currency": "USD" }, "totalOnlineOrders": 6, "totalPosOrders": 0, "firstOrder": "2024-10-26T14:33:35.4737168Z", "lastOrder": "2025-10-26T14:33:35.4737169Z", "customerOrderFormatSales": [ { "orderFormat": 1, "orderCount": 6, "totalAmount": { "amount": 154.0, "currency": "USD" } } ] } ], "guestGroups": null }, "guestGroup": { "id": "395b7b8b-f4b5-4e6b-8c7a-a8e3d7c6d547", "name": "VIP Guests" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BaseResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.NotFoundResponse" } } } } } } }, "/public/api/v1.1/Tenants/{tenantId}/Customers": { "get": { "tags": [ "Customers" ], "summary": "Get Customer list by tenant", "description": "### Available filter properties\r\n- name (string)\r\n- firstname (string)\r\n- lastname (string)\r\n- created (datetime)\r\n- email (string)\r\n- firstorder (datetime)\r\n- lastorder (datetime)\r\n- totalonlineorders (int)\r\n- totalposorders (int)\r\n- totalspent (decimal)\r\n- outletid (guid)\r\n- tenantid (guid)\r\n- ordersonoutlets (guid)\r\n- salesourceid (nullable guid)", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Customers.V1.Queries.List.ListCustomerQueryResponse" }, "example": { "items": [ { "id": "000b4bb8-3cf8-4213-915b-b34b823fd087", "created": "2026-10-20T14:33:35.477122Z", "firstName": "Adrian", "lastName": "Svensson", "email": "adrian@svensson.io", "languageCode": "sv-SE", "isDeleted": false, "isDisabled": false, "totalOnlineOrders": 1, "totalPosOrders": 0, "totalSpent": { "amount": 123.0, "currency": "SEK" }, "firstOrder": "2026-10-21T14:33:35.4771271Z", "lastOrder": "2026-10-22T14:33:35.4771276Z", "saleSourceId": null }, { "id": "a8d501a3-2035-4387-afc0-438d24d08808", "created": "2026-10-11T14:33:35.4771331Z", "firstName": "John", "lastName": "Smith", "email": "john@smith.io", "languageCode": "en-US", "isDeleted": false, "isDisabled": false, "totalOnlineOrders": 0, "totalPosOrders": 3, "totalSpent": { "amount": 1223.0, "currency": "SEK" }, "firstOrder": "2026-10-20T14:33:35.4771336Z", "lastOrder": "2026-10-21T14:33:35.4771337Z", "saleSourceId": null }, { "id": "665bf9a6-b4ff-44b2-a478-981a32dca520", "created": "2026-10-18T14:33:35.4771522Z", "firstName": null, "lastName": null, "email": null, "languageCode": "en-US", "isDeleted": true, "isDisabled": false, "totalOnlineOrders": 3, "totalPosOrders": 5, "totalSpent": { "amount": 805.0, "currency": "SEK" }, "firstOrder": null, "lastOrder": null, "saleSourceId": null }, { "id": "15b50854-48fa-4fb6-aa14-428b9b5a9486", "created": "2026-04-26T14:33:35.4771547Z", "firstName": null, "lastName": null, "email": null, "languageCode": "nb-NO", "isDeleted": false, "isDisabled": true, "totalOnlineOrders": 0, "totalPosOrders": 123, "totalSpent": { "amount": 121233.0, "currency": "NOK" }, "firstOrder": "2026-10-15T14:33:35.4771561Z", "lastOrder": "2026-10-16T14:33:35.4771561Z", "saleSourceId": null } ], "meta": null } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BaseResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.NotFoundResponse" } } } } } } }, "/public/api/v1.1/Tenants/{tenantId}/Customers/{customerId}/AssignGuestGroup": { "put": { "tags": [ "Customers" ], "summary": "Assign customer guest group", "parameters": [ { "name": "tenantId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Customers.V1.Commands.AssignGuestGroup.AssignCustomerGuestGroupCommand" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Customers.V1.Commands.AssignGuestGroup.AssignCustomerGuestGroupCommandResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BaseResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BadRequestResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.NotFoundResponse" } } } } } } }, "/public/api/v1/Tenants/{tenantId}/GuestGroups": { "get": { "tags": [ "GuestGroups" ], "summary": "Get guest group list by tenant id.", "description": "### Available filter properties\r\n- name (string)\r\n- signindiscountid (nullable guid)\r\n- walletdiscountid (nullable guid)\r\n", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Extent.Discounts", "in": "query", "schema": { "type": "boolean" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.GuestGroups.V0.Queries.List.ListGuestGroupQueryResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BadRequestResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.NotFoundResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BaseResponse" } } } } } } }, "/SelfLog": { "get": { "tags": [ "Meta" ], "summary": " (Auth policies: meta)", "parameters": [ { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/ErrorCodes": { "get": { "tags": [ "Meta" ], "summary": " (Auth policies: meta)", "parameters": [ { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/Version": { "get": { "tags": [ "Meta" ], "parameters": [ { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/Environment": { "get": { "tags": [ "Meta" ], "parameters": [ { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/public/api/v1/Tenants/{tenantId}/TenantUsers/{tenantUserId}": { "get": { "tags": [ "TenantUsers" ], "summary": "Get tenant user details", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "tenantUserId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.TenantUsers.V0.Queries.Detail.DetailTenantUserQueryResponse" }, "example": { "tenantUser": { "id": "c6b09312-d98b-4c05-8fac-439977205a88", "created": "2026-10-23T14:33:35.481183Z", "email": "example@ancon.io", "firstName": "Timon", "lastName": "Quinn", "socialSecurityNumber": "871210-1475", "modified": "2026-10-23T14:33:35.481183Z", "isDisabled": false, "disabled": null, "isDeleted": false, "deleted": null, "isTenantAdmin": false, "identityUserId": "10ce7d53-0f04-4091-beb3-47dc230fe70a", "receiveBroadcastEmails": false } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.BaseResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.NotFoundResponse" } } } } } } } }, "components": { "schemas": { "Shared.Enums.AddressTypes": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "Shared.Enums.GenderTypes": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "Shared.Enums.IntegrationTypes": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, -2, -1 ], "type": "integer", "format": "int32" }, "Shared.Enums.OrderFormats": { "enum": [ 0, 1, 2, 4, 8, 16, 32, 64, 128, 159, 191 ], "type": "integer", "format": "int32" }, "Shared.ValueObjects.IdName": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Shared.ValueObjects.PersonalName": { "type": "object", "properties": { "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.BadRequestResponse": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "format": "uuid" }, "additionalData": { "nullable": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.BaseResponse": { "type": "object", "additionalProperties": false }, "User.Api.Controllers.Public.V1.Companies.V0.Commands.CompanyAddressModel": { "type": "object", "properties": { "addressId": { "type": "string", "format": "uuid", "nullable": true }, "addressType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.AddressTypes" } ] }, "street": { "type": "string", "nullable": true }, "street2": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Companies.V0.Commands.Create.CreateCompanyCommand": { "required": [ "invoiceAddress", "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string", "description": "Name of the company" }, "businessNumber": { "type": "string", "description": "Business number of the company", "nullable": true }, "invoiceAddress": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.Commands.CompanyAddressModel" } ] }, "countryCode": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "description": "Phonenumber of the company", "nullable": true }, "invoiceEmail": { "type": "string", "description": "Email of the company or person in the company", "nullable": true }, "defaultInvoiceReferenceNote": { "type": "string", "description": "Will be the default reference note for all new invoices from this company.", "nullable": true }, "companyReference": { "type": "string", "description": "Company reference note for the company. This maps to YourReference property on Fortnox.", "nullable": true }, "gln": { "type": "string", "description": "GLN of the company.", "nullable": true }, "customerId": { "type": "string", "description": "ExternalID reference of the company.", "nullable": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Companies.V0.Commands.Create.CreateCompanyCommandResponse": { "type": "object", "properties": { "company": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.CompanyModel" } ], "nullable": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Companies.V0.Commands.Delete.DeleteCompanyCommandResponse": { "type": "object", "additionalProperties": false }, "User.Api.Controllers.Public.V1.Companies.V0.Commands.Update.UpdateCompanyCommand": { "required": [ "invoiceAddress", "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "businessNumber": { "type": "string", "nullable": true }, "invoiceAddress": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.Commands.CompanyAddressModel" } ] }, "countryCode": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "invoiceEmail": { "type": "string", "nullable": true }, "defaultInvoiceReferenceNote": { "type": "string", "nullable": true }, "gln": { "type": "string", "nullable": true }, "companyReference": { "type": "string", "nullable": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Companies.V0.Commands.Update.UpdateCompanyCommandResponse": { "type": "object", "properties": { "company": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.CompanyModel" } ], "nullable": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Companies.V0.CompanyMembers.Commands.Create.CreateCompanyMemberCommand": { "type": "object", "properties": { "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "department": { "type": "string", "nullable": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Companies.V0.CompanyMembers.Commands.Create.CreateCompanyMemberCommandResponse": { "type": "object", "properties": { "companyMember": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.CompanyMembers.CompanyMemberModel" } ], "nullable": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Companies.V0.CompanyMembers.Commands.Delete.DeleteCompanyMemberCommandResponse": { "type": "object", "additionalProperties": false }, "User.Api.Controllers.Public.V1.Companies.V0.CompanyMembers.Commands.Update.UpdateCompanyMemberCommand": { "required": [ "firstName", "lastName" ], "type": "object", "properties": { "firstName": { "minLength": 1, "type": "string" }, "lastName": { "minLength": 1, "type": "string" }, "phoneNumber": { "type": "string", "nullable": true }, "department": { "type": "string", "nullable": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Companies.V0.CompanyMembers.Commands.Update.UpdateCompanyMemberCommandResponse": { "type": "object", "properties": { "companyMember": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.CompanyMembers.CompanyMemberModel" } ], "nullable": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Companies.V0.CompanyMembers.CompanyMemberModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "fullName": { "type": "string", "nullable": true }, "name": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.PersonalName" } ], "nullable": true }, "email": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "department": { "type": "string", "nullable": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Companies.V0.CompanyMembers.Queries.Detail.DetailCompanyMemberQueryResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "fullName": { "type": "string", "nullable": true, "readOnly": true }, "firstName": { "type": "string", "nullable": true, "readOnly": true }, "lastName": { "type": "string", "nullable": true, "readOnly": true }, "email": { "type": "string", "nullable": true, "readOnly": true }, "phoneNumber": { "type": "string", "nullable": true, "readOnly": true }, "department": { "type": "string", "nullable": true, "readOnly": true }, "emailVerified": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Companies.V0.CompanyMembers.Queries.List.CompanyMemberModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "fullName": { "type": "string", "nullable": true, "readOnly": true }, "firstName": { "type": "string", "nullable": true, "readOnly": true }, "lastName": { "type": "string", "nullable": true, "readOnly": true }, "email": { "type": "string", "nullable": true, "readOnly": true }, "phoneNumber": { "type": "string", "nullable": true, "readOnly": true }, "department": { "type": "string", "nullable": true, "readOnly": true }, "emailVerified": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Companies.V0.CompanyMembers.Queries.List.ListCompanyMemberQueryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.CompanyMembers.Queries.List.CompanyMemberModel" }, "nullable": true }, "meta": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.PagedResponseMetadata" } ], "nullable": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Companies.V0.CompanyModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "tenantId": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "businessNumber": { "type": "string", "nullable": true, "readOnly": true }, "addressId": { "type": "string", "format": "uuid", "readOnly": true }, "invoiceAddress": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.V1.Companies.V0.Queries.InvoiceAddressModel" } ], "nullable": true, "readOnly": true }, "countryCode": { "type": "string", "nullable": true, "readOnly": true }, "phoneNumber": { "type": "string", "nullable": true, "readOnly": true }, "invoiceEmail": { "type": "string", "nullable": true, "readOnly": true }, "defaultInvoiceReferenceNote": { "type": "string", "nullable": true, "readOnly": true }, "isDeleted": { "type": "boolean", "readOnly": true }, "originatingOutletId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "originatingOutletName": { "type": "string", "nullable": true }, "originatingIntegrationType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.IntegrationTypes" } ], "nullable": true, "readOnly": true }, "gln": { "type": "string", "nullable": true, "readOnly": true }, "companyReference": { "type": "string", "nullable": true, "readOnly": true }, "guestGroupId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "integrationExternalIds": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Companies.V0.ExternalReference.Commands.Update.UpdateCompanyExternalReferenceCommand": { "type": "object", "properties": { "customerId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Companies.V0.ExternalReference.Commands.Update.UpdateCompanyExternalReferenceCommandResponse": { "type": "object", "properties": { "companyIntegration": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.ExternalReference.CompanyIntegrationModel" } ], "nullable": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Companies.V0.ExternalReference.CompanyIntegrationModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "integrationId": { "type": "string", "format": "uuid", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "integrationType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.IntegrationTypes" } ], "nullable": true }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Companies.V0.Queries.Detail.DetailCompanyQueryResponse": { "type": "object", "properties": { "company": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.CompanyModel" } ], "nullable": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Companies.V0.Queries.List.CompanyModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "lastOrderedAt": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "invoiceCount": { "type": "integer", "format": "int32", "readOnly": true }, "totalSpent": { "type": "number", "format": "double", "readOnly": true }, "originatingOutletId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "originatingOutletName": { "type": "string", "nullable": true }, "originatingIntegrationType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.IntegrationTypes" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Companies.V0.Queries.List.ListCompanyResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V0.Queries.List.CompanyModel" }, "nullable": true }, "meta": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.PagedResponseMetadata" } ], "nullable": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Companies.V1.Commands.CompanyAddressModel": { "type": "object", "properties": { "addressId": { "type": "string", "format": "uuid", "nullable": true }, "addressType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.AddressTypes" } ] }, "street": { "type": "string", "nullable": true }, "street2": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Companies.V1.Commands.Update.UpdateCompanyCommand": { "required": [ "invoiceAddress", "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "businessNumber": { "type": "string", "nullable": true }, "invoiceAddress": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V1.Commands.CompanyAddressModel" } ] }, "countryCode": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "invoiceEmail": { "type": "string", "nullable": true }, "defaultInvoiceReferenceNote": { "type": "string", "nullable": true }, "gln": { "type": "string", "nullable": true }, "companyReference": { "type": "string", "nullable": true }, "guestGroupId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Companies.V1.Commands.Update.UpdateCompanyCommandResponse": { "type": "object", "properties": { "company": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V1.CompanyModel" } ], "nullable": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Companies.V1.CompanyIntegrationExternalIdModel": { "type": "object", "properties": { "integrationId": { "type": "string", "format": "uuid", "nullable": true }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Companies.V1.CompanyModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "tenantId": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "businessNumber": { "type": "string", "nullable": true, "readOnly": true }, "addressId": { "type": "string", "format": "uuid", "readOnly": true }, "invoiceAddress": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V1.InvoiceAddressModel" } ], "nullable": true, "readOnly": true }, "countryCode": { "type": "string", "nullable": true, "readOnly": true }, "phoneNumber": { "type": "string", "nullable": true, "readOnly": true }, "invoiceEmail": { "type": "string", "nullable": true, "readOnly": true }, "defaultInvoiceReferenceNote": { "type": "string", "nullable": true, "readOnly": true }, "isDeleted": { "type": "boolean", "readOnly": true }, "originatingOutletId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "originatingOutletName": { "type": "string", "nullable": true }, "originatingIntegrationType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.IntegrationTypes" } ], "nullable": true, "readOnly": true }, "gln": { "type": "string", "nullable": true, "readOnly": true }, "companyReference": { "type": "string", "nullable": true, "readOnly": true }, "guestGroupId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "integrationExternalIds": { "type": "array", "items": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V1.CompanyIntegrationExternalIdModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Companies.V1.InvoiceAddressModel": { "type": "object", "properties": { "street": { "type": "string", "nullable": true }, "street2": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Companies.V1.Queries.Detail.DetailCompanyQueryResponse": { "type": "object", "properties": { "company": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Companies.V1.CompanyModel" } ], "nullable": true }, "guestGroup": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.IdName" } ], "nullable": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Customers.V0.CustomerAddressModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "addressType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.AddressTypes" } ], "readOnly": true }, "title": { "type": "string", "nullable": true, "readOnly": true }, "street": { "type": "string", "nullable": true, "readOnly": true }, "zipCode": { "type": "string", "nullable": true, "readOnly": true }, "city": { "type": "string", "nullable": true, "readOnly": true }, "state": { "type": "string", "nullable": true, "readOnly": true }, "country": { "type": "string", "nullable": true, "readOnly": true }, "location": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.LocationModel" } ], "nullable": true, "readOnly": true }, "note": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Customers.V0.CustomerModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "identityUserId": { "type": "string", "format": "uuid", "readOnly": true }, "firstName": { "type": "string", "nullable": true, "readOnly": true }, "lastName": { "type": "string", "nullable": true, "readOnly": true }, "email": { "type": "string", "nullable": true, "readOnly": true }, "dateOfBirth": { "type": "string", "format": "date-time", "readOnly": true }, "gender": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.GenderTypes" } ], "readOnly": true }, "telephoneNumber": { "type": "string", "nullable": true, "readOnly": true }, "languageCode": { "type": "string", "nullable": true, "readOnly": true }, "isDeleted": { "type": "boolean", "readOnly": true }, "isDisabled": { "type": "boolean", "readOnly": true }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Customers.V0.CustomerAddressModel" }, "nullable": true, "readOnly": true }, "saleAllTime": { "type": "array", "items": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Customers.V0.CustomerSaleAllTimeModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Customers.V0.CustomerOrderFormatSaleModel": { "type": "object", "properties": { "orderFormat": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ], "readOnly": true }, "orderCount": { "type": "integer", "format": "int32", "readOnly": true }, "totalAmount": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Customers.V0.CustomerSaleAllTimeModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "outletId": { "type": "string", "format": "uuid", "readOnly": true }, "tenantId": { "type": "string", "format": "uuid", "readOnly": true }, "totalSpent": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "totalOnlineOrders": { "type": "integer", "format": "int32", "readOnly": true }, "totalPosOrders": { "type": "integer", "format": "int32", "readOnly": true }, "firstOrder": { "type": "string", "format": "date-time", "readOnly": true }, "lastOrder": { "type": "string", "format": "date-time", "readOnly": true }, "customerOrderFormatSales": { "type": "array", "items": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Customers.V0.CustomerOrderFormatSaleModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Customers.V0.CustomerViewModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "firstName": { "type": "string", "nullable": true, "readOnly": true }, "lastName": { "type": "string", "nullable": true, "readOnly": true }, "email": { "type": "string", "nullable": true, "readOnly": true }, "languageCode": { "type": "string", "nullable": true, "readOnly": true }, "isDeleted": { "type": "boolean", "readOnly": true }, "isDisabled": { "type": "boolean", "readOnly": true }, "totalOnlineOrders": { "type": "integer", "format": "int32", "readOnly": true }, "totalPosOrders": { "type": "integer", "format": "int32", "readOnly": true }, "totalSpent": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "firstOrder": { "type": "string", "format": "date-time", "readOnly": true }, "lastOrder": { "type": "string", "format": "date-time", "readOnly": true }, "saleSourceId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Customers.V0.Queries.DetailByTenant.DetailByTenantCustomerQueryResponse": { "type": "object", "properties": { "customer": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Customers.V0.CustomerModel" } ], "nullable": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Customers.V0.Queries.List.ListCustomerQueryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Customers.V0.CustomerViewModel" }, "nullable": true }, "meta": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.PagedResponseMetadata" } ], "nullable": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Customers.V1.Commands.AssignGuestGroup.AssignCustomerGuestGroupCommand": { "type": "object", "properties": { "guestGroupId": { "type": "string", "format": "uuid", "nullable": true }, "outletId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Customers.V1.Commands.AssignGuestGroup.AssignCustomerGuestGroupCommandResponse": { "type": "object", "properties": { "customer": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Customers.V1.CustomerModel" } ], "nullable": true }, "guestGroup": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.IdNameModel" } ], "nullable": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Customers.V1.CustomerAddressModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "addressType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.AddressTypes" } ], "readOnly": true }, "title": { "type": "string", "nullable": true, "readOnly": true }, "street": { "type": "string", "nullable": true, "readOnly": true }, "zipCode": { "type": "string", "nullable": true, "readOnly": true }, "city": { "type": "string", "nullable": true, "readOnly": true }, "state": { "type": "string", "nullable": true, "readOnly": true }, "country": { "type": "string", "nullable": true, "readOnly": true }, "location": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.LocationModel" } ], "nullable": true, "readOnly": true }, "note": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Customers.V1.CustomerGuestGroupModel": { "type": "object", "properties": { "tenantId": { "type": "string", "format": "uuid", "readOnly": true }, "guestGroupId": { "type": "string", "format": "uuid", "readOnly": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Customers.V1.CustomerModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "identityUserId": { "type": "string", "format": "uuid", "readOnly": true }, "firstName": { "type": "string", "nullable": true, "readOnly": true }, "lastName": { "type": "string", "nullable": true, "readOnly": true }, "email": { "type": "string", "nullable": true, "readOnly": true }, "dateOfBirth": { "type": "string", "format": "date-time", "readOnly": true }, "gender": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.GenderTypes" } ], "readOnly": true }, "telephoneNumber": { "type": "string", "nullable": true, "readOnly": true }, "languageCode": { "type": "string", "nullable": true, "readOnly": true }, "isDeleted": { "type": "boolean", "readOnly": true }, "isDisabled": { "type": "boolean", "readOnly": true }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Customers.V1.CustomerAddressModel" }, "nullable": true, "readOnly": true }, "saleAllTime": { "type": "array", "items": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Customers.V1.CustomerSaleAllTimeModel" }, "nullable": true, "readOnly": true }, "guestGroups": { "type": "array", "items": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Customers.V1.CustomerGuestGroupModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Customers.V1.CustomerOrderFormatSaleModel": { "type": "object", "properties": { "orderFormat": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ], "readOnly": true }, "orderCount": { "type": "integer", "format": "int32", "readOnly": true }, "totalAmount": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Customers.V1.CustomerSaleAllTimeModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "outletId": { "type": "string", "format": "uuid", "readOnly": true }, "tenantId": { "type": "string", "format": "uuid", "readOnly": true }, "totalSpent": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "totalOnlineOrders": { "type": "integer", "format": "int32", "readOnly": true }, "totalPosOrders": { "type": "integer", "format": "int32", "readOnly": true }, "firstOrder": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "lastOrder": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "customerOrderFormatSales": { "type": "array", "items": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Customers.V1.CustomerOrderFormatSaleModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Customers.V1.CustomerViewModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "firstName": { "type": "string", "nullable": true, "readOnly": true }, "lastName": { "type": "string", "nullable": true, "readOnly": true }, "email": { "type": "string", "nullable": true, "readOnly": true }, "languageCode": { "type": "string", "nullable": true, "readOnly": true }, "isDeleted": { "type": "boolean", "readOnly": true }, "isDisabled": { "type": "boolean", "readOnly": true }, "totalOnlineOrders": { "type": "integer", "format": "int32", "readOnly": true }, "totalPosOrders": { "type": "integer", "format": "int32", "readOnly": true }, "totalSpent": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "firstOrder": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "lastOrder": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "saleSourceId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Customers.V1.Queries.DetailByTenant.DetailByTenantCustomerQueryResponse": { "type": "object", "properties": { "customer": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Customers.V1.CustomerModel" } ], "nullable": true }, "guestGroup": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.IdNameModel" } ], "nullable": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.Customers.V1.Queries.List.ListCustomerQueryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.Customers.V1.CustomerViewModel" }, "nullable": true }, "meta": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.PagedResponseMetadata" } ], "nullable": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.GuestGroups.V0.Queries.List.GuestGroupListModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "hasAssignedGuests": { "type": "boolean", "readOnly": true }, "signInDiscountId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "walletDiscountId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "isDefault": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.GuestGroups.V0.Queries.List.ListGuestGroupQueryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.GuestGroups.V0.Queries.List.GuestGroupListModel" }, "nullable": true }, "meta": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.PagedResponseMetadata" } ], "nullable": true }, "discounts": { "type": "array", "items": { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.IdNameModel" }, "nullable": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.IdNameModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.LocationModel": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.MoneyModel": { "type": "object", "properties": { "amount": { "type": "number", "format": "double" }, "currency": { "type": "string", "nullable": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.NotFoundResponse": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.PagedResponseMetadata": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "offset": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.TenantUsers.V0.Queries.Detail.DetailTenantUserQueryResponse": { "type": "object", "properties": { "tenantUser": { "allOf": [ { "$ref": "#/components/schemas/User.Api.Controllers.Public.V1.TenantUsers.V0.TenantUserModel" } ], "nullable": true } }, "additionalProperties": false }, "User.Api.Controllers.Public.V1.TenantUsers.V0.TenantUserModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "email": { "type": "string", "nullable": true, "readOnly": true }, "firstName": { "type": "string", "nullable": true, "readOnly": true }, "lastName": { "type": "string", "nullable": true, "readOnly": true }, "socialSecurityNumber": { "type": "string", "nullable": true, "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "isDisabled": { "type": "boolean", "readOnly": true }, "disabled": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "isDeleted": { "type": "boolean", "readOnly": true }, "deleted": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "isTenantAdmin": { "type": "boolean", "readOnly": true }, "identityUserId": { "type": "string", "format": "uuid", "readOnly": true }, "receiveBroadcastEmails": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "User.Api.Controllers.V1.Companies.V0.Queries.InvoiceAddressModel": { "type": "object", "properties": { "street": { "type": "string", "nullable": true }, "street2": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "JWT Authorization header using bearer scheme", "name": "Authorization", "in": "header" }, "Access-Token": { "type": "apiKey", "description": "Access token in header", "name": "Access-Token", "in": "header" } } }, "tags": [ { "name": "Companies" }, { "name": "Customers" }, { "name": "GuestGroups" }, { "name": "Meta" }, { "name": "TenantUsers" } ] }