{ "info": { "name": "Solution Center API v2", "description": "Auto-generated Postman collection for Solution Center API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_postman_id": "185762ff-a478-4f50-89ca-121df3b50db8" }, "item": [ { "name": "Application Versions", "description": null, "item": [ { "name": "Get version settings for a company", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ApplicationVersion/company/:companyId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ApplicationVersion", "company", ":companyId" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" } ] }, "description": "Retrieves the current application version settings for a company,\n including Arranger and Connections versions.", "auth": null, "body": null } }, { "name": "Set Arranger version for a company", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ApplicationVersion/company/:companyId/arranger", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ApplicationVersion", "company", ":companyId", "arranger" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" } ] }, "description": "Updates the Arranger version setting for a company. This affects all funeral homes\n that don\u0027t have an override set.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Set Connections version for a company", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ApplicationVersion/company/:companyId/connections", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ApplicationVersion", "company", ":companyId", "connections" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" } ] }, "description": "Updates the Connections version setting for a company. This affects all funeral homes\n that don\u0027t have an override set.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get all funeral homes with version overrides", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ApplicationVersion/company/:companyId/overrides", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ApplicationVersion", "company", ":companyId", "overrides" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" } ] }, "description": "Returns a list of all funeral homes in the company that have version overrides set.\n Useful for displaying in company settings to show which locations have customizations.", "auth": null, "body": null } }, { "name": "Get version settings for a funeral home", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ApplicationVersion/funeralhome/:funeralHomeId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ApplicationVersion", "funeralhome", ":funeralHomeId" ], "query": null, "variable": [ { "key": "funeralHomeId", "value": "\u003CfuneralHomeId\u003E", "type": "string" } ] }, "description": "Retrieves the application version settings for a funeral home,\n including inherited company settings and any overrides.", "auth": null, "body": null } }, { "name": "Set Arranger version override for a funeral home", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ApplicationVersion/funeralhome/:funeralHomeId/arranger", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ApplicationVersion", "funeralhome", ":funeralHomeId", "arranger" ], "query": null, "variable": [ { "key": "funeralHomeId", "value": "\u003CfuneralHomeId\u003E", "type": "string" } ] }, "description": "Sets or clears the Arranger version override for a funeral home.\n Pass null to inherit from company.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Set Connections version override for a funeral home", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ApplicationVersion/funeralhome/:funeralHomeId/connections", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ApplicationVersion", "funeralhome", ":funeralHomeId", "connections" ], "query": null, "variable": [ { "key": "funeralHomeId", "value": "\u003CfuneralHomeId\u003E", "type": "string" } ] }, "description": "Sets or clears the Connections version override for a funeral home.\n Pass null to inherit from company.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Resolve effective version for a funeral home", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ApplicationVersion/resolve/:funeralHomeId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ApplicationVersion", "resolve", ":funeralHomeId" ], "query": [ { "key": "application", "value": "\u003Capplication\u003E", "description": "Which application (\u0022arranger\u0022 or \u0022connections\u0022)", "disabled": true }, { "key": "preview", "value": "\u003Cpreview\u003E", "description": "Optional preview override version", "disabled": true } ], "variable": [ { "key": "funeralHomeId", "value": "\u003CfuneralHomeId\u003E", "type": "string" } ] }, "description": "Returns just the resolved/effective version for a funeral home.\n Used by the UI to determine which version to display.\n Supports preview override via query parameter.", "auth": null, "body": null } } ], "request": null }, { "name": "Applications", "description": null, "item": [ { "name": "Get Accessible Applications", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Apps", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Apps" ], "query": [ { "key": "mobileOnly", "value": "\u003CmobileOnly\u003E", "description": "Optional flag indicating whether to return only applications visible in the Solution Center mobile app.\r\nDefault is \u0060false\u0060.", "disabled": true } ], "variable": null }, "description": "Retrieves a filtered list of applications available to the current user, based on their roles,\n company edition, and assigned permissions.\n This endpoint excludes internal or restricted applications unless the user has elevated access.\n\n**Usage Notes:**\n\n- Applications are filtered by both company edition and assigned roles.\n- Internal-use-only applications are hidden from non-administrative users.\n- Ifis true, only apps flagged for mobile visibility are included.\n\n\n**Tags:**Apps, Permissions, Roles, Interface", "auth": null, "body": null } } ], "request": null }, { "name": "Arrangement Templates", "description": null, "item": [ { "name": "Get arrangement template configuration for a company.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ArrangementTemplates/:companyId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ArrangementTemplates", ":companyId" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" } ] }, "description": "Get arrangement template configuration for a company.", "auth": null, "body": null } }, { "name": "Create or update arrangement template configuration.", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ArrangementTemplates/:companyId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ArrangementTemplates", ":companyId" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" } ] }, "description": "Create or update arrangement template configuration.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete arrangement template configuration for a company (resets to default).", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ArrangementTemplates/:companyId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ArrangementTemplates", ":companyId" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" } ] }, "description": "Delete arrangement template configuration for a company (resets to default).", "auth": null, "body": null } }, { "name": "Get arrangement template configuration for the arranger (public endpoint for rendering).\n Returns default configuration if none exists.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ArrangementTemplates/:companyId/active", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ArrangementTemplates", ":companyId", "active" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" } ] }, "description": "Get arrangement template configuration for the arranger (public endpoint for rendering).\n Returns default configuration if none exists.", "auth": null, "body": null } }, { "name": "Get arrangement template configuration for an arranger guide.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ArrangementTemplates/Guide/:guideId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ArrangementTemplates", "Guide", ":guideId" ], "query": null, "variable": [ { "key": "guideId", "value": "\u003CguideId\u003E", "type": "string" } ] }, "description": "Get arrangement template configuration for an arranger guide.", "auth": null, "body": null } }, { "name": "Create or update arrangement template configuration for an arranger guide.", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ArrangementTemplates/Guide/:guideId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ArrangementTemplates", "Guide", ":guideId" ], "query": null, "variable": [ { "key": "guideId", "value": "\u003CguideId\u003E", "type": "string" } ] }, "description": "Create or update arrangement template configuration for an arranger guide.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get arrangement template configuration for an arranger guide (read-only, for rendering).\n Returns null if no guide-specific template is configured.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ArrangementTemplates/Guide/:guideId/active", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ArrangementTemplates", "Guide", ":guideId", "active" ], "query": null, "variable": [ { "key": "guideId", "value": "\u003CguideId\u003E", "type": "string" } ] }, "description": "Get arrangement template configuration for an arranger guide (read-only, for rendering).\n Returns null if no guide-specific template is configured.", "auth": null, "body": null } } ], "request": null }, { "name": "Arrangements", "description": null, "item": [ { "name": "Get Arrangement Progress", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Arrangement/:caseId/Progress", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Arrangement", ":caseId", "Progress" ], "query": null, "variable": [ { "key": "caseId", "value": "\u003CcaseId\u003E", "type": "string" } ] }, "description": "Returns saved page completion progress for the specified case.", "auth": null, "body": null } }, { "name": "Save Arrangement Progress", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Arrangement/:caseId/Progress", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Arrangement", ":caseId", "Progress" ], "query": null, "variable": [ { "key": "caseId", "value": "\u003CcaseId\u003E", "type": "string" } ] }, "description": "Saves page completion progress for the specified case. Creates a new record or updates existing.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } } ], "request": null }, { "name": "Arrangements: Data", "description": null, "item": [ { "name": "Get product categories for a funeral home.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ArrangementData/Categories/:fhId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ArrangementData", "Categories", ":fhId" ], "query": [ { "key": "dispositionCategoryId", "value": "\u003CdispositionCategoryId\u003E", "description": "Disposition filter (1=Burial, 2=Cremation, 4=All).", "disabled": true } ], "variable": [ { "key": "fhId", "value": "\u003CfhId\u003E", "type": "string" } ] }, "description": "Get product categories for a funeral home.", "auth": null, "body": null } }, { "name": "Get products for a funeral home (lean DTO for Arranger 2.0).", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ArrangementData/Products/:fhId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ArrangementData", "Products", ":fhId" ], "query": [ { "key": "dispositionCategoryId", "value": "\u003CdispositionCategoryId\u003E", "description": "Disposition filter (1=Burial, 2=Cremation, 4=All).", "disabled": true } ], "variable": [ { "key": "fhId", "value": "\u003CfhId\u003E", "type": "string" } ] }, "description": "Get products for a funeral home (lean DTO for Arranger 2.0).", "auth": null, "body": null } }, { "name": "Get selection guide attribute values with product counts for the guided funnel.\n Returns attributes ordered by SelectionGuideOrder for the 4 main attributes:\n Exterior Material, Exterior Color, Interior Material, Interior Color.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ArrangementData/SelectionGuideAttributes/:fhId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ArrangementData", "SelectionGuideAttributes", ":fhId" ], "query": [ { "key": "dispositionCategoryId", "value": "\u003CdispositionCategoryId\u003E", "description": "Disposition filter (1=Burial, 2=Cremation, 4=All).", "disabled": true } ], "variable": [ { "key": "fhId", "value": "\u003CfhId\u003E", "type": "string" } ] }, "description": "Get selection guide attribute values with product counts for the guided funnel.\n Returns attributes ordered by SelectionGuideOrder for the 4 main attributes:\n Exterior Material, Exterior Color, Interior Material, Interior Color.", "auth": null, "body": null } }, { "name": "Get showrooms for a funeral home.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ArrangementData/Showrooms/:fhId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ArrangementData", "Showrooms", ":fhId" ], "query": [ { "key": "dispositionCategoryId", "value": "\u003CdispositionCategoryId\u003E", "description": "Disposition filter (1=Burial, 2=Cremation, 4=All).", "disabled": true } ], "variable": [ { "key": "fhId", "value": "\u003CfhId\u003E", "type": "string" } ] }, "description": "Get showrooms for a funeral home.", "auth": null, "body": null } } ], "request": null }, { "name": "Arranger Guides", "description": null, "item": [ { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/:entityType/:entityId/ArrangerGuide", "host": [ "{{baseUrl}}" ], "path": [ "v2", ":entityType", ":entityId", "ArrangerGuide" ], "query": null, "variable": [ { "key": "entityType", "value": "\u003CentityType\u003E", "type": "string" }, { "key": "entityId", "value": "\u003CentityId\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ArrangerGuide", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ArrangerGuide" ], "query": [ { "key": "includeInactive", "value": "\u003CincludeInactive\u003E", "description": null, "disabled": true } ], "variable": null }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ArrangerGuide", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ArrangerGuide" ], "query": [ { "key": "corporationId", "value": "\u003CcorporationId\u003E", "description": null, "disabled": true } ], "variable": null }, "description": "", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ArrangerGuide/:globalId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ArrangerGuide", ":globalId" ], "query": null, "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ArrangerGuide/:globalId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ArrangerGuide", ":globalId" ], "query": null, "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ArrangerGuide/:globalId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ArrangerGuide", ":globalId" ], "query": null, "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ArrangerGuide/:globalId/Duplicate", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ArrangerGuide", ":globalId", "Duplicate" ], "query": [ { "key": "newName", "value": "\u003CnewName\u003E", "description": null, "disabled": true } ], "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ArrangerGuide/:globalId/Export", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ArrangerGuide", ":globalId", "Export" ], "query": null, "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ArrangerGuide/:globalId/Media", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ArrangerGuide", ":globalId", "Media" ], "query": null, "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ArrangerGuide/:globalId/Media", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ArrangerGuide", ":globalId", "Media" ], "query": null, "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ArrangerGuide/:globalId/Media/:mediaId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ArrangerGuide", ":globalId", "Media", ":mediaId" ], "query": [ { "key": "width", "value": "\u003Cwidth\u003E", "description": null, "disabled": true }, { "key": "height", "value": "\u003Cheight\u003E", "description": null, "disabled": true }, { "key": "fit", "value": "\u003Cfit\u003E", "description": null, "disabled": true } ], "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" }, { "key": "mediaId", "value": "\u003CmediaId\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ArrangerGuide/:globalId/Media/:mediaId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ArrangerGuide", ":globalId", "Media", ":mediaId" ], "query": null, "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" }, { "key": "mediaId", "value": "\u003CmediaId\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ArrangerGuide/:globalId/Media/CopyFromLibrary", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ArrangerGuide", ":globalId", "Media", "CopyFromLibrary" ], "query": null, "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ArrangerGuide/Assignment", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ArrangerGuide", "Assignment" ], "query": [ { "key": "entityType", "value": "\u003CentityType\u003E", "description": null, "disabled": true }, { "key": "entityId", "value": "\u003CentityId\u003E", "description": null, "disabled": true } ], "variable": null }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ArrangerGuide/Assignment", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ArrangerGuide", "Assignment" ], "query": null, "variable": null }, "description": "", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ArrangerGuide/Assignment", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ArrangerGuide", "Assignment" ], "query": [ { "key": "entityType", "value": "\u003CentityType\u003E", "description": null, "disabled": true }, { "key": "entityId", "value": "\u003CentityId\u003E", "description": null, "disabled": true } ], "variable": null }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ArrangerGuide/Default", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ArrangerGuide", "Default" ], "query": null, "variable": null }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ArrangerGuide/Import", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ArrangerGuide", "Import" ], "query": [ { "key": "corporationId", "value": "\u003CcorporationId\u003E", "description": null, "disabled": true }, { "key": "nameOverride", "value": "\u003CnameOverride\u003E", "description": null, "disabled": true }, { "key": "overrideGuideId", "value": "\u003CoverrideGuideId\u003E", "description": null, "disabled": true } ], "variable": null }, "description": "", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ArrangerGuide/Import/Template/:templateName", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ArrangerGuide", "Import", "Template", ":templateName" ], "query": null, "variable": [ { "key": "templateName", "value": "\u003CtemplateName\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ArrangerGuide/Import/Templates", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ArrangerGuide", "Import", "Templates" ], "query": null, "variable": null }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ArrangerGuide/Import/Validate", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ArrangerGuide", "Import", "Validate" ], "query": [ { "key": "overrideGuideId", "value": "\u003CoverrideGuideId\u003E", "description": null, "disabled": true } ], "variable": null }, "description": "", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } } ], "request": null }, { "name": "Authentication", "description": null, "item": [ { "name": "Authenticate via Solution Center Identity (legacy MATTSEC route)", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Auth/MATTSEC", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Auth", "MATTSEC" ], "query": null, "variable": null }, "description": "Authenticates a user against the Solution Center Identity user access management system.\n Returns authorization details, claims, and required user metadata if authentication succeeds.\n Note: The route name MATTSEC and the response type MattsecAuthorizationResponse\n are retained for backward compatibility with existing API consumers. The underlying identity provider\n is now Solution Center Identity.\n\n**Tags:**Authentication, Authorization, Solution Center Identity\n\n**Behavior:**\n\n- Checks credentials against the UAM (User Access Management) database.\n- Returns\u0060ErrorMessage\u0060if credentials are invalid or the account is locked.\n- Populates\u0060Claims\u0060,\u0060Roles\u0060, and\u0060RequiredClaims\u0060upon success.\n\n\n**Example:**POST /v2/Auth/MATTSEC\n {\n \u0022username\u0022: \u0022jdoe@example.com\u0022,\n \u0022password\u0022: \u0022MySecurePassword123\u0022\n }", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } } ], "request": null }, { "name": "Branding", "description": null, "item": [ { "name": "Get all branding kits", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/BrandingKit", "host": [ "{{baseUrl}}" ], "path": [ "v2", "BrandingKit" ], "query": [ { "key": "includeInactive", "value": "\u003CincludeInactive\u003E", "description": "Whether to include inactive kits", "disabled": true } ], "variable": null }, "description": "Retrieves all branding kits visible to the user\u0027s company.\n Includes global kits (available to all) and company-specific kits.", "auth": null, "body": null } }, { "name": "Create a new branding kit", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/BrandingKit", "host": [ "{{baseUrl}}" ], "path": [ "v2", "BrandingKit" ], "query": [ { "key": "corporationId", "value": "\u003CcorporationId\u003E", "description": "Optional corporation ID for corporation-level kits", "disabled": true } ], "variable": null }, "description": "Creates a new branding kit owned by the specified company or corporation.\n Corporation-level kits require Zeus, AuroraAdmin, or CorporateManager role.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a specific branding kit", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/BrandingKit/:globalId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "BrandingKit", ":globalId" ], "query": null, "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" } ] }, "description": "Retrieves a single branding kit by its global ID, including all colors, fonts, and logos.", "auth": null, "body": null } }, { "name": "Update a branding kit", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/BrandingKit/:globalId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "BrandingKit", ":globalId" ], "query": null, "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" } ] }, "description": "Updates an existing branding kit. Only company-owned kits can be modified.\n Global kits cannot be edited. Corporation kits require Zeus, AuroraAdmin, or CorporateManager role.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a branding kit", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/BrandingKit/:globalId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "BrandingKit", ":globalId" ], "query": null, "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" } ] }, "description": "Soft deletes a branding kit by setting it to inactive.\n Global kits and the default kit cannot be deleted.\n Corporation kits require Zeus, AuroraAdmin, or CorporateManager role.", "auth": null, "body": null } }, { "name": "Duplicate a branding kit", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/BrandingKit/:globalId/Duplicate", "host": [ "{{baseUrl}}" ], "path": [ "v2", "BrandingKit", ":globalId", "Duplicate" ], "query": [ { "key": "newName", "value": "\u003CnewName\u003E", "description": "The name for the new kit", "disabled": true } ], "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" } ] }, "description": "Creates a copy of an existing branding kit with a new name.\n The new kit will be owned by the user\u0027s company.", "auth": null, "body": null } }, { "name": "Export a branding kit as a ZIP", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/BrandingKit/:globalId/Export", "host": [ "{{baseUrl}}" ], "path": [ "v2", "BrandingKit", ":globalId", "Export" ], "query": null, "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" } ] }, "description": "Exports a branding kit to a portable ZIP format containing branding-kit.json\n and any font files embedded under a fonts/ directory.", "auth": null, "body": null } }, { "name": "Validate a branding kit", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/BrandingKit/:globalId/Validate", "host": [ "{{baseUrl}}" ], "path": [ "v2", "BrandingKit", ":globalId", "Validate" ], "query": null, "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" } ] }, "description": "Performs comprehensive validation of a branding kit including:\n - WCAG color contrast checking\n - Logo dimension validation\n - Font URL accessibility checking\n - Completeness checking (required colors, fonts, logos)\n - Consistency checking (similar colors, light text, etc.)", "auth": null, "body": null } }, { "name": "Get branding assignment for an entity", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/BrandingKit/Assignment", "host": [ "{{baseUrl}}" ], "path": [ "v2", "BrandingKit", "Assignment" ], "query": [ { "key": "entityType", "value": "\u003CentityType\u003E", "description": "Corporation, Company, or FuneralHome", "disabled": true }, { "key": "entityId", "value": "\u003CentityId\u003E", "description": "The entity\u0027s ID", "disabled": true } ], "variable": null }, "description": "Retrieves the branding kit assignment for a specific entity.", "auth": null, "body": null } }, { "name": "Assign a branding kit to an entity", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/BrandingKit/Assignment", "host": [ "{{baseUrl}}" ], "path": [ "v2", "BrandingKit", "Assignment" ], "query": null, "variable": null }, "description": "Assigns a branding kit to a Corporation, Company, or FuneralHome.\n Replaces any existing assignment for the entity.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove branding assignment from an entity", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/BrandingKit/Assignment", "host": [ "{{baseUrl}}" ], "path": [ "v2", "BrandingKit", "Assignment" ], "query": [ { "key": "entityType", "value": "\u003CentityType\u003E", "description": "Corporation, Company, or FuneralHome", "disabled": true }, { "key": "entityId", "value": "\u003CentityId\u003E", "description": "The entity\u0027s ID", "disabled": true } ], "variable": null }, "description": "Removes the branding kit assignment from a Corporation, Company, or FuneralHome.\n The entity will inherit branding from its parent in the hierarchy.", "auth": null, "body": null } }, { "name": "Get the default branding kit", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/BrandingKit/Default", "host": [ "{{baseUrl}}" ], "path": [ "v2", "BrandingKit", "Default" ], "query": null, "variable": null }, "description": "Retrieves the system default branding kit.", "auth": null, "body": null } }, { "name": "Import a branding kit from JSON", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/BrandingKit/Import", "host": [ "{{baseUrl}}" ], "path": [ "v2", "BrandingKit", "Import" ], "query": [ { "key": "corporationId", "value": "\u003CcorporationId\u003E", "description": "Optional corporation ID for corporation-level kits", "disabled": true }, { "key": "name", "value": "\u003Cname\u003E", "description": "Optional name to use instead of the exported name", "disabled": true } ], "variable": null }, "description": "Creates a new branding kit from an exported JSON file.\n Corporation-level kits require Zeus, AuroraAdmin, or CorporateManager role.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Validate a branding kit import file", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/BrandingKit/Import/Validate", "host": [ "{{baseUrl}}" ], "path": [ "v2", "BrandingKit", "Import", "Validate" ], "query": null, "variable": null }, "description": "Validates a JSON or ZIP file for import without creating the kit.\n Returns validation results and any warnings.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Download branding media", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/BrandingKit/Media/:mediaGuid", "host": [ "{{baseUrl}}" ], "path": [ "v2", "BrandingKit", "Media", ":mediaGuid" ], "query": [ { "key": "width", "value": "\u003Cwidth\u003E", "description": "Optional width for resizing", "disabled": true }, { "key": "height", "value": "\u003Cheight\u003E", "description": "Optional height for resizing", "disabled": true }, { "key": "fit", "value": "\u003Cfit\u003E", "description": "Optional fit mode for resizing", "disabled": true } ], "variable": [ { "key": "mediaGuid", "value": "\u003CmediaGuid\u003E", "type": "string" } ] }, "description": "Downloads a branding media file by its GUID.\n Supports optional width/height parameters for image resizing.", "auth": null, "body": null } }, { "name": "Upload branding media", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/BrandingKit/Media/Upload", "host": [ "{{baseUrl}}" ], "path": [ "v2", "BrandingKit", "Media", "Upload" ], "query": [ { "key": "kitId", "value": "\u003CkitId\u003E", "description": "Optional branding kit ID for organization", "disabled": true }, { "key": "context", "value": "\u003Ccontext\u003E", "description": "Optional context (e.g., \u0022Primary\u0022, \u0022Favicon\u0022)", "disabled": true } ], "variable": null }, "description": "Uploads an image file for use in branding kits (logos, fonts, etc).\n Files are stored in a dedicated branding media container organized by kit.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Generate branding preview", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/BrandingKit/Preview", "host": [ "{{baseUrl}}" ], "path": [ "v2", "BrandingKit", "Preview" ], "query": null, "variable": null }, "description": "Generates a preview of branding changes without persisting them.\n Returns CSS variables and WCAG contrast warnings.\n Used for live preview in the admin UI.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Validate branding preview", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/BrandingKit/Validate", "host": [ "{{baseUrl}}" ], "path": [ "v2", "BrandingKit", "Validate" ], "query": null, "variable": null }, "description": "Validates proposed branding changes without persisting them.\n Useful for showing validation warnings in the editor before saving.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get resolved branding for a company", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/:companyId/Branding", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", ":companyId", "Branding" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" } ] }, "description": "Resolves the effective branding for a company by walking up the hierarchy.\n Checks Company -\u003E Corporation -\u003E Default.", "auth": null, "body": null } }, { "name": "Get resolved branding for a corporation", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Corporation/:corporationId/Branding", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Corporation", ":corporationId", "Branding" ], "query": null, "variable": [ { "key": "corporationId", "value": "\u003CcorporationId\u003E", "type": "string" } ] }, "description": "Resolves the effective branding for a corporation.\n Checks Corporation -\u003E Default.", "auth": null, "body": null } }, { "name": "Get resolved branding for a funeral home", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/FuneralHome/:fhId/Branding", "host": [ "{{baseUrl}}" ], "path": [ "v2", "FuneralHome", ":fhId", "Branding" ], "query": null, "variable": [ { "key": "fhId", "value": "\u003CfhId\u003E", "type": "string" } ] }, "description": "Resolves the effective branding for a funeral home by walking up the hierarchy.\n Checks FuneralHome -\u003E Company -\u003E Corporation -\u003E Default.\n Returns ready-to-use CSS variables.", "auth": null, "body": null } } ], "request": null }, { "name": "CareAssist", "description": null, "item": [ { "name": "", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/CareAssist/:companyId/:caseId/action", "host": [ "{{baseUrl}}" ], "path": [ "v2", "CareAssist", ":companyId", ":caseId", "action" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" }, { "key": "caseId", "value": "\u003CcaseId\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/CareAssist/:companyId/:caseId/error", "host": [ "{{baseUrl}}" ], "path": [ "v2", "CareAssist", ":companyId", ":caseId", "error" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" }, { "key": "caseId", "value": "\u003CcaseId\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/CareAssist/:companyId/:caseId/extraction", "host": [ "{{baseUrl}}" ], "path": [ "v2", "CareAssist", ":companyId", ":caseId", "extraction" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" }, { "key": "caseId", "value": "\u003CcaseId\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/CareAssist/:companyId/:caseId/pending", "host": [ "{{baseUrl}}" ], "path": [ "v2", "CareAssist", ":companyId", ":caseId", "pending" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" }, { "key": "caseId", "value": "\u003CcaseId\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/CareAssist/:companyId/:caseId/status", "host": [ "{{baseUrl}}" ], "path": [ "v2", "CareAssist", ":companyId", ":caseId", "status" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" }, { "key": "caseId", "value": "\u003CcaseId\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/CareAssist/:companyId/:caseId/transcript", "host": [ "{{baseUrl}}" ], "path": [ "v2", "CareAssist", ":companyId", ":caseId", "transcript" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" }, { "key": "caseId", "value": "\u003CcaseId\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } } ], "request": null }, { "name": "CareAssist: AI", "description": null, "item": [ { "name": "Ask a question about the CareAssist transcript.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/CareAssist/:caseId/chat", "host": [ "{{baseUrl}}" ], "path": [ "v2", "CareAssist", ":caseId", "chat" ], "query": null, "variable": [ { "key": "caseId", "value": "\u003CcaseId\u003E", "type": "string" } ] }, "description": "Ask a question about the CareAssist transcript.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Extract people mentioned in the CareAssist transcript.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/CareAssist/:caseId/people", "host": [ "{{baseUrl}}" ], "path": [ "v2", "CareAssist", ":caseId", "people" ], "query": null, "variable": [ { "key": "caseId", "value": "\u003CcaseId\u003E", "type": "string" } ] }, "description": "Extract people mentioned in the CareAssist transcript.", "auth": null, "body": null } }, { "name": "Generate an AI summary of the CareAssist transcript.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/CareAssist/:caseId/summary", "host": [ "{{baseUrl}}" ], "path": [ "v2", "CareAssist", ":caseId", "summary" ], "query": null, "variable": [ { "key": "caseId", "value": "\u003CcaseId\u003E", "type": "string" } ] }, "description": "Generate an AI summary of the CareAssist transcript.", "auth": null, "body": null } } ], "request": null }, { "name": "CareAssist: Chat", "description": null, "item": [ { "name": "List chat sessions for a case.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/CareAssist/:caseId/chat/sessions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "CareAssist", ":caseId", "chat", "sessions" ], "query": null, "variable": [ { "key": "caseId", "value": "\u003CcaseId\u003E", "type": "string" } ] }, "description": "List chat sessions for a case.", "auth": null, "body": null } }, { "name": "Save or update a chat session.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/CareAssist/:caseId/chat/sessions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "CareAssist", ":caseId", "chat", "sessions" ], "query": null, "variable": [ { "key": "caseId", "value": "\u003CcaseId\u003E", "type": "string" } ] }, "description": "Save or update a chat session.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a specific chat session with full messages.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/CareAssist/:caseId/chat/sessions/:sessionId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "CareAssist", ":caseId", "chat", "sessions", ":sessionId" ], "query": null, "variable": [ { "key": "caseId", "value": "\u003CcaseId\u003E", "type": "string" }, { "key": "sessionId", "value": "\u003CsessionId\u003E", "type": "string" } ] }, "description": "Get a specific chat session with full messages.", "auth": null, "body": null } }, { "name": "Delete a chat session.", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/CareAssist/:caseId/chat/sessions/:sessionId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "CareAssist", ":caseId", "chat", "sessions", ":sessionId" ], "query": null, "variable": [ { "key": "caseId", "value": "\u003CcaseId\u003E", "type": "string" }, { "key": "sessionId", "value": "\u003CsessionId\u003E", "type": "string" } ] }, "description": "Delete a chat session.", "auth": null, "body": null } } ], "request": null }, { "name": "CareAssist: Results", "description": null, "item": [ { "name": "Get a saved CareAssist result (summary or people).", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/CareAssist/:caseId/result/:resultType", "host": [ "{{baseUrl}}" ], "path": [ "v2", "CareAssist", ":caseId", "result", ":resultType" ], "query": null, "variable": [ { "key": "caseId", "value": "\u003CcaseId\u003E", "type": "string" }, { "key": "resultType", "value": "\u003CresultType\u003E", "type": "string" } ] }, "description": "Get a saved CareAssist result (summary or people).", "auth": null, "body": null } } ], "request": null }, { "name": "CareAssist: Transcript", "description": null, "item": [ { "name": "Get the stored CareAssist transcript(s) for a case. Merges all transcript files into one conversation.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/CareAssist/:caseId/stored-transcript", "host": [ "{{baseUrl}}" ], "path": [ "v2", "CareAssist", ":caseId", "stored-transcript" ], "query": null, "variable": [ { "key": "caseId", "value": "\u003CcaseId\u003E", "type": "string" } ] }, "description": "Get the stored CareAssist transcript(s) for a case. Merges all transcript files into one conversation.", "auth": null, "body": null } }, { "name": "Get transcript status (timestamps, staleness) for a case \u2014 lightweight check for auto-generation decisions.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/CareAssist/:caseId/transcript-status", "host": [ "{{baseUrl}}" ], "path": [ "v2", "CareAssist", ":caseId", "transcript-status" ], "query": null, "variable": [ { "key": "caseId", "value": "\u003CcaseId\u003E", "type": "string" } ] }, "description": "Get transcript status (timestamps, staleness) for a case \u2014 lightweight check for auto-generation decisions.", "auth": null, "body": null } } ], "request": null }, { "name": "CareTrack", "description": null, "item": [ { "name": "Add a Case Tracking record", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/CareTrack", "host": [ "{{baseUrl}}" ], "path": [ "v2", "CareTrack" ], "query": null, "variable": null }, "description": "Adds a Case Tracking record for Case Id specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Case Tracking Information", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/CareTrack/:callId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "CareTrack", ":callId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Returns list of Case Tracking Information for Case Id specified in request.", "auth": null, "body": null } } ], "request": null }, { "name": "Cart", "description": null, "item": [ { "name": "Get Cart Items", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Cart", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Cart" ], "query": [ { "key": "pageNumber", "value": "\u003CpageNumber\u003E", "description": "Optional. The page number to retrieve (1-based). Defaults to null (no paging).\r\nWhen null, all cart items are returned. When specified, must be greater than 0.", "disabled": true }, { "key": "pageSize", "value": "\u003CpageSize\u003E", "description": "Optional. The number of items per page. Defaults to null (no paging).\r\nWhen null, all cart items are returned. When specified, must be greater than 0.\r\nBoth pageNumber and pageSize must be provided together for paging to be applied.", "disabled": true }, { "key": "hideAdvisorItems", "value": "\u003ChideAdvisorItems\u003E", "description": "Optional. When set to true, filters out Advisor items (items with a CallId) from the results.\r\nUse this to retrieve only non-case-linked cart items.", "disabled": true } ], "variable": null }, "description": "Retrieves all active items currently in the user\u0027s cart for the specified company.\n Executes the stored procedure usp_GetCartItems_v5 to return detailed cart contents,\n including product information and associated media. Supports optional paging for large result sets.\n\n**Usage Notes:**\n\n- Results are scoped to the authenticated user based on their Advisor user ID.\n- Executes the\u0060usp_GetCartItems_v5\u0060stored procedure with\u0060@CountOnly = 0\u0060to retrieve full item details.\n- Automatically enriches the result set with item media via\u0060AddItemMedia\u0060.\n- Used to populate shopping cart and order preview interfaces.\n- When paging parameters are omitted, returns all cart items (backward compatible behavior).\n- When paging is enabled, both pageNumber and pageSize should be provided for optimal results.\n\n\n**Paging Examples:**\n\n- No paging (all items):\u0060GET /cart?companyId=3779\u0060\n- First page (20 items):\u0060GET /cart?companyId=3779\u0026pageNumber=1\u0026pageSize=20\u0060\n- Second page (20 items):\u0060GET /cart?companyId=3779\u0026pageNumber=2\u0026pageSize=20\u0060\n\n\n**Tags:**Cart, Orders, E-Commerce", "auth": null, "body": null } }, { "name": "Add To Cart", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Cart", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Cart" ], "query": null, "variable": null }, "description": "Adds a specified product to the user\uFFFDs shopping cart, optionally linking it to a parent order item.\n\n**Usage Notes:**\n\n- Resolves Bill-To and Ship-To funeral home relationships automatically.\n- Supports hierarchical cart structures via the\u0060ParentOrderItemId\u0060property.\n- Initializes engraving data when applicable.\n- Used to populate the user\uFFFDs active shopping cart.\n\n\n**Tags:**Cart, Orders, E-Commerce", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Order Details", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Cart", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Cart" ], "query": null, "variable": null }, "description": "Updates details for a specific order item and its related records, including associated\n contract details and engraving information.\n\n**Usage Notes:**\n\n- Performs batch updates for order items and contract details.\n- Ensures consistency between parent and child order items.\n- Automatically updates engraving information for the parent order item.\n- Uses EF Core\u0060ExecuteUpdateAsync\u0060for efficient SQL updates.\n\n\n**Tags:**Orders, Updates, E-Commerce", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Cart Item", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Cart/:orderItemId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Cart", ":orderItemId" ], "query": null, "variable": [ { "key": "orderItemId", "value": "\u003CorderItemId\u003E", "type": "string" } ] }, "description": "Removes an item from the user\uFFFDs cart by its order item ID, ensuring that the item is not\n linked to an existing Advisor contract before deletion.\n\n**Usage Notes:**\n\n- Deletes related engraving information before removing the cart item.\n- Prevents removal of items tied to Advisor contract details.\n- Used for cart cleanup and product removal prior to checkout.\n\n\n**Tags:**Cart, Orders, E-Commerce", "auth": null, "body": null } }, { "name": "Add To Cart Now", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Cart/AddToCartNow", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Cart", "AddToCartNow" ], "query": null, "variable": null }, "description": "Creates a new order item and immediately adds it to the cart for the specified funeral home.\n This operation supports adding the primary product, as well as associated panel and corner items,\n and initializes any engraving information linked to the order.\n\n**Usage Notes:**\n\n- Automatically determines the correct Bill-To and Ship-To funeral home based on configuration.\n- Creates order items for the main product and optionally for related panel and corner items.\n- Initializes engraving information for applicable products using\u0060AddOrUpdateEngravingInformationForOrderItem\u0060.\n- Used for quick order placement and bypasses standard cart review flow.\n- Ensures database consistency by saving each order item as it is created.\n\n\n**Tags:**Ordering, Cart, E-Commerce", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Buy It Now", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Cart/BuyItNow", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Cart", "BuyItNow" ], "query": [ { "key": "orderSource", "value": "\u003CorderSource\u003E", "description": "The source of the order (e.g., Solution Center V2). Optional.", "disabled": true } ], "variable": null }, "description": "Creates an immediate order for a single product and related accessories (panels, corners)\n and directly submits it for checkout without adding it to the cart.\n\n**Usage Notes:**\n\n- Immediately creates and submits order items for the specified product.\n- Optionally includes panel and corner items based on the input DTO.\n- Applies engraving data and submits the order via\u0060CompleteCheckout\u0060.\n- Used for one-click purchasing without using the shopping cart.\n\n\n**Tags:**Orders, Checkout, E-Commerce", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Cart Count", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Cart/Count", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Cart", "Count" ], "query": [ { "key": "hideAdvisorItems", "value": "\u003ChideAdvisorItems\u003E", "description": "Optional. When set to true, excludes Advisor items (items with a CallId) from the count.\r\nUse this to get a count of only non-case-linked cart items.", "disabled": true } ], "variable": null }, "description": "Retrieves the total number of items currently in the user\uFFFDs cart for the specified company.\n Executes the stored procedure usp_GetCartItems_v5 in count-only mode.\n\n**Usage Notes:**\n\n- Uses\u0060@CountOnly = 1\u0060in the stored procedure to return only the total count.\n- Count reflects active cart items that have not yet been submitted for order.\n- Useful for displaying cart badges or quick summaries in the UI.\n\n\n**Tags:**Cart, Count, E-Commerce", "auth": null, "body": null } }, { "name": "Get Order History", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Cart/History", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Cart", "History" ], "query": [ { "key": "startDate", "value": "\u003CstartDate\u003E", "description": "The start date of the date range for filtering historical orders.", "disabled": true }, { "key": "endDate", "value": "\u003CendDate\u003E", "description": "The end date of the date range for filtering historical orders.", "disabled": true } ], "variable": null }, "description": "Retrieves a list of previously ordered items for the specified company and date range.\n Combines order, funeral home, contract, and engraving information to provide a\n complete order history view for the logged-in user.\n\n**Usage Notes:**\n\n- Filters results based on the provided\u0060startDate\u0060and\u0060endDate\u0060.\n- Includes both user-created and case-linked orders (where\u0060CallId\u0060is present).\n- Joins data from Advisor Orders, Advisor Master, and Client databases.\n- Populates funeral home, contract, and engraving information for each order item.\n- Uses\u0060AddItemMedia\u0060to enrich items with media metadata.\n\n\n**Tags:**Orders, History, E-Commerce, Reporting", "auth": null, "body": null } }, { "name": "Mark Item Needs Ordered", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Cart/MarkNeedsOrdered", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Cart", "MarkNeedsOrdered" ], "query": null, "variable": null }, "description": "Resets an order item to indicate it still needs to be ordered, clearing related SAP and tracking data.\n\n**Usage Notes:**\n\n- Clears order ID, SAP delivery information, and other related fields.\n- Used to roll back mistakenly marked orders to a \uFFFDpending\uFFFD state.\n- Commonly triggered when an external order submission fails or is canceled.\n\n\n**Tags:**Orders, Reset, E-Commerce", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Mark Item Ordered", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Cart/MarkOrdered", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Cart", "MarkOrdered" ], "query": null, "variable": null }, "description": "Marks a specific order item as ordered, setting the timestamp and user who performed the action.\n\n**Usage Notes:**\n\n- Records the user and date of the \uFFFDMark Ordered\uFFFD action for auditing.\n- Used by fulfillment workflows to update order progress.\n- Does not trigger any automatic downstream integration (manual step only).\n\n\n**Tags:**Orders, Cart, Status", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Mark Item Received", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Cart/MarkReceived", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Cart", "MarkReceived" ], "query": null, "variable": null }, "description": "Marks an order item as received by setting its received date to the current time.\n\n**Usage Notes:**\n\n- Sets\u0060DateReceived\u0060to the current timestamp.\n- Used for tracking delivery confirmation of ordered products.\n- Completes the fulfillment lifecycle for individual order items.\n\n\n**Tags:**Orders, Receiving, Inventory", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Submit Order", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Cart/SubmitOrder/:orderSource", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Cart", "SubmitOrder", ":orderSource" ], "query": null, "variable": [ { "key": "orderSource", "value": "\u003CorderSource\u003E", "type": "string" } ] }, "description": "Finalizes checkout for the specified order items, submitting them to the Advisor ordering system\n and generating a confirmation number upon success.\n\n**Usage Notes:**\n\n- Invokes\u0060CompleteCheckout\u0060to process all included items.\n- Used as the primary endpoint for submitting pending cart items as an order.\n- Returns confirmation data used for order tracking and customer notification.\n\n\n**Tags:**Orders, Checkout, E-Commerce", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } } ], "request": null }, { "name": "Cases", "description": null, "item": [ { "name": "Advanced Search Cases", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/AdvancedSearch", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "AdvancedSearch" ], "query": null, "variable": null }, "description": "Returns a list of Cases matching Advanced Search Criteria payload in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Call Details", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves comprehensive details for a specific case (call), including decedent information,\n location data, biographical information, assigned reports, and profile pictures. This endpoint\n provides all essential case information needed for case management and reporting.\n\n**Usage Notes:**\n\n- Report links are dynamically determined based on location-specific or company-wide report configurations.\n- Standard reports include: Contract, Detailed Statement, Selections Summary, Gatherings Summary, and People Summary.\n- Profile picture URLs default to a placeholder image if no profile picture is set.\n- Biographical dates (birth and death) are formatted and combined into a RelevantDates field.\n- Trade firm pricing tier information is included when applicable.\n- Pre-need conversion information and case transfer details are included when available.\n\n\n**Tags:**Cases, Call Details, Case Management, Reports", "auth": null, "body": null } }, { "name": "Get Arranger History", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/ArrangerHistory", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "ArrangerHistory" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Returns list of Arranger History matching Call Id in request.", "auth": null, "body": null } }, { "name": "Claim a Case", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/ClaimCall", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "ClaimCall" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Allows for a Case to be claimed using Call Id and Claim payload in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Pre-Need Conversion History", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/ConversionHistory", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "ConversionHistory" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves conversion history for pre-need cases that have been converted to at-need, or\n for at-need cases that were converted from pre-need. Shows the relationship between\n pre-need and at-need cases and tracks conversion details.\n\n**Usage Notes:**\n\n- For at-need cases (NeedTypeId = 1), shows the pre-need case it was converted from if applicable.\n- For pre-need cases (NeedTypeId = 2), shows the at-need case(s) it has been converted to if applicable.\n- Includes case numbers, decedent names, and conversion dates for tracking purposes.\n- Returns empty/null values if the case has no conversion history.\n- Useful for tracking pre-need policy fulfillment and at-need case origin.\n\n\n**Tags:**Case Management, Pre-Need, At-Need, Conversion, History", "auth": null, "body": null } }, { "name": "Get Case Disposition", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Disposition", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Disposition" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves the disposition category for a case. The disposition indicates the final placement or handling\n method for the decedent\u0027s remains, such as burial, cremation, entombment, or other disposition types\n configured in the system.\n\n**Usage Notes:**\n\n- Returns null if no disposition has been assigned to the case.\n- Throws an exception if the case is not found.\n- The disposition category ID references a DispositionCategory lookup table.\n- Common disposition types include burial, cremation, entombment, and donation.\n- Use the UpdateDisposition endpoint to assign or change the disposition.\n\n\n**Tags:**Case Management, Disposition, Final Placement", "auth": null, "body": null } }, { "name": "Update Case Disposition", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Disposition", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Disposition" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Updates the disposition category for a case. This endpoint allows changing the final placement or handling\n method for the decedent\u0027s remains. The disposition category must be a valid value from the system\u0027s\n DispositionCategory lookup table.\n\n**Usage Notes:**\n\n- Throws an exception if the case is not found.\n- The DispositionCategoryId must reference a valid entry in the DispositionCategory lookup table.\n- Common disposition types include burial, cremation, entombment, and donation.\n- The updated disposition is immediately saved to the database.\n- Can be set to null to clear the disposition for a case.\n\n\n**Tags:**Case Management, Disposition, Updates, Final Placement", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Export Case Data as XML", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Export", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Export" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Exports complete case data as XML for integration with external systems, form filling, or data archival. The XML\n includes all case information: decedent details, family/arranger information, service details, contract information,\n custom fields, and more. This comprehensive export is commonly used for PDF form population and third-party integrations.\n\n**Usage Notes:**\n\n- Returns a complete XML document with all case information.\n- XML structure includes: call metadata, decedent info, people/relationships, services, contract details, custom fields.\n- Used for PDF form filling via form field mappings (XPath-based field population).\n- Commonly integrated with document management systems and third-party software.\n- XML is UTF-8 encoded with proper XML declaration.\n- The export is generated dynamically and reflects the current state of the case.\n- Custom fields are included in CustomFieldData section with CustomDataFieldId attributes.\n- Use GetExportFields endpoint to see all available fields and their values for a case.\n\n\n**Tags:**Export, XML, Integration, Data Export, Form Filling", "auth": null, "body": null } }, { "name": "Get Export Field Values for Case", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Export/Fields", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Export", "Fields" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves all form field mappings with their actual values populated from the case data. This endpoint exports the\n case as XML, evaluates each XPath expression against the XML, and returns the field names with their corresponding\n values. Includes a QR code for mobile case access. Used for preview and debugging form field mappings.\n\n**Usage Notes:**\n\n- Generates case XML export and evaluates all XPath expressions against it.\n- Returns actual values from the case for each mapped field.\n- Includes error messages if XPath evaluation fails (invalid XPath or missing data).\n- ValueClass indicates status: \u0022normal\u0022 for success, \u0022error\u0022 for failures.\n- Automatically includes a QR code image URL for the case (dec_QRCodeImage field).\n- QR code contains JSON with CompanyKey and CallId for mobile access.\n- Useful for debugging form field mappings and previewing PDF form data.\n- Shows which fields have values and which are missing or have mapping errors.\n\n\n**Tags:**Export, Field Mapping, PDF Forms, Data Preview, QR Code", "auth": null, "body": null } }, { "name": "Update Financial Disclaimer", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/FinancialDisclaimer", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "FinancialDisclaimer" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Updates the financial disclaimer text for a case. Financial disclaimers are custom messages that can be\n added to contracts to provide important financial information, payment terms, or legal disclaimers. The\n update only occurs if the provided disclaimer text is not null or whitespace.\n\n**Usage Notes:**\n\n- Throws an exception if the case is not found.\n- Only updates the disclaimer if the provided text is not null or whitespace.\n- If the disclaimer text is empty, whitespace, or null, no database update occurs.\n- Financial disclaimers are typically displayed on printed contracts.\n- The updated disclaimer is immediately saved to the database.\n- Common uses include payment policy statements, cancellation terms, or legal notices.\n\n\n**Tags:**Case Management, Financial Disclaimer, Updates, Contract Messages", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Case Posting History", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/History", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "History" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves the complete posting and export history for a case, showing when the case was\n posted to accounting systems or exported. User names are enriched for each history entry\n to show who performed each action.\n\n**Usage Notes:**\n\n- History entries are ordered by date created in descending order (most recent first).\n- User names are looked up from AdvisorUsers and formatted as \u0022FirstName LastName\u0022 or username.\n- If the case has been exported, the export event is prepended to the history list.\n- Export events have CallPostId = 0 and Posted = false to distinguish them from post events.\n- The Posted flag indicates whether the event was a posting (true) or export (false) operation.\n- This history provides an audit trail of financial system integrations.\n\n\n**Tags:**Case Management, History, Audit, Posting, Export, Accounting", "auth": null, "body": null } }, { "name": "Mark Case as Active", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/MarkActive", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "MarkActive" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Marks a case as active, returning it to active case lists and workflows. This endpoint also\n deactivates any \u0022LOST CALL\u0022 notes associated with the case to reflect the status change.\n\n**Usage Notes:**\n\n- Reactivates a previously inactive or lost case.\n- Automatically deactivates any notes containing \u0022LOST CALL\u0022 in their content.\n- The case returns to active case lists and search results.\n- Useful for cases that were mistakenly marked inactive or lost but are now proceeding.\n\n\n**Tags:**Case Management, Status, Reactivate", "auth": null, "body": null } }, { "name": "Mark Case as Inactive", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/MarkInactive", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "MarkInactive" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Marks a case as inactive, removing it from active case lists and workflows. Inactive cases\n are archived but retained in the system for historical records and reporting.\n\n**Usage Notes:**\n\n- Inactive cases are excluded from default case lists and search results.\n- The case data is preserved; this is not a deletion operation.\n- Cases can be reactivated using the MarkActive endpoint.\n- Useful for archiving cancelled or declined arrangements.\n\n\n**Tags:**Case Management, Status, Archive", "auth": null, "body": null } }, { "name": "Mark Case as Lost", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/MarkLost", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "MarkLost" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Marks a case as lost with a reason, changing the case status and creating a note documenting\n why the arrangement was lost. This is used when a family chooses another funeral home or\n declines services.\n\n**Usage Notes:**\n\n- Changes the case status to \u0022Lost\u0022 (MasterId 210).\n- Marks the case as inactive, removing it from active case lists.\n- Creates an active note with the format \u0022LOST CALL REASON : [reason]\u0022.\n- The note is created as a Call note type and is visible to all staff (not arranger-only).\n- Useful for tracking lost business and understanding competitive losses.\n\n\n**Tags:**Case Management, Status, Lost Call, Analytics", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a case\u0027s need type ID.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/NeedTypeId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "NeedTypeId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Get a case\u0027s need type ID.", "auth": null, "body": null } }, { "name": "Get Contract Items Missing Cost", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/NoCost/:contractId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "NoCost", ":contractId" ], "query": [ { "key": "showWarnings", "value": "\u003CshowWarnings\u003E", "description": "Controls which items are returned: 0 = none, 1 = ad-hoc items only, 2 = all items with missing cost (default).", "disabled": true } ], "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "contractId", "value": "\u003CcontractId\u003E", "type": "string" } ] }, "description": "Retrieves a list of product items on a contract that are missing cost values (items with null or zero cost).\n This endpoint is used to identify inventory items that need cost information populated before finalizing\n the contract or performing financial calculations.\n\n**Usage Notes:**\n\n- Only product items (items with IsProduct = true) are included in results.\n- Items are considered \u0022missing cost\u0022 if Cost is null or equals zero.\n- Package items (PackageDetailId is set) are always excluded since their cost is bundled in the package.\n- When showWarnings = 1, only ad-hoc items (ItemStatus = AdHoc) are returned.\n- Each result includes the item type, name, location item details, and current price.\n- This endpoint is commonly used in contract validation workflows to ensure pricing completeness.\n- Results include ContractDetailId to facilitate quick cost updates on identified items.\n\n\n**Tags:**Contract Management, Pricing, Validation, Products", "auth": null, "body": null } }, { "name": "Get Case Overview", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Overview", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Overview" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves a comprehensive overview of a case including decedent biographical information,\n disposition details, service information, and related metadata. This endpoint provides\n a summary view of key case information for dashboard and overview displays.\n\n**Usage Notes:**\n\n- Includes decedent\u0027s full biographical information such as birth/death dates, SSN, and personal details.\n- Provides disposition information including cremation, burial, or other final disposition details.\n- Includes service/gathering information with dates and locations.\n- SSN values are decrypted before being returned if present.\n- Combines data from multiple related tables (Calls, BioGraphicalInfo, Disposition, Events).\n- This endpoint is typically used for overview/dashboard displays and summary printouts.\n- Empty or null values are returned for optional fields that haven\u0027t been populated.\n\n\n**Tags:**Case Management, Overview, Dashboard, Case Summary", "auth": null, "body": null } }, { "name": "Mark Case as Posted to Accounting", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/PostCall", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "PostCall" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Marks a case as \u0022posted\u0022 to indicate that it has been posted to the accounting system.\n This operation is typically performed after finalizing the contract and before exporting\n financial data to accounting software. Requires the AllowCallPosting permission.\n\n**Usage Notes:**\n\n- Requires the AllowCallPosting permission for the specified funeral home.\n- Uses the PostCaseCommand handler to execute the posting logic.\n- Posting a case typically locks it from certain modifications.\n- Posted cases can be unposted using the UnPostCall endpoint if needed.\n- This operation creates an audit trail entry in the call post history.\n- Once posted, the case is ready for accounting export operations.\n\n\n**Tags:**Case Management, Accounting, Posting, Financial Management", "auth": null, "body": null } }, { "name": "Get Contract Sale Date", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/SaleDate", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "SaleDate" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves the sale date (contract date) from the default contract associated with the specified case.\n Only non-addendum contracts are considered when determining the sale date. This date represents when\n the original contract was signed by the client.\n\n**Usage Notes:**\n\n- Only the default (non-addendum) contract is queried for the sale date.\n- Addendum contracts are explicitly excluded from this lookup.\n- Returns null if no default contract exists for the specified case.\n- The sale date corresponds to the ContractDate property on the Contract entity.\n- This date is commonly used for regulatory reporting and financial tracking.\n\n\n**Tags:**Contract Management, Sale Date, Contract Date", "auth": null, "body": null } }, { "name": "Update Contract Sale Date", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/SaleDate", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "SaleDate" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Updates the sale date (contract date) on the default contract for the specified case.\n This endpoint modifies the contract date on the original non-addendum contract to reflect\n when the contract was signed by the client.\n\n**Usage Notes:**\n\n- Only the default (non-addendum) contract is updated.\n- Throws an exception if no default contract exists for the case.\n- The sale date is persisted to the ContractDate property on the Contract entity.\n- This operation does not affect addendum contracts.\n- The updated date is immediately saved to the database.\n\n\n**Tags:**Contract Management, Sale Date, Contract Date, Updates", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Sales Tax Prepaid Summary", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/TaxPrepaidSummary", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "TaxPrepaidSummary" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Returns a brief summary indicating whether the case has any contract detail rows flagged\n as having sales tax prepaid, along with the earliest source date among those rows.", "auth": null, "body": null } }, { "name": "Get Tax Prepayment Eligibility", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/TaxPrepaymentEligibility", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "TaxPrepaymentEligibility" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Determines whether the pre-need case is eligible for tax prepayment based on the\n case\u0027s location state and the company\u0027s pre-need tax prepayment state configuration.", "auth": null, "body": null } }, { "name": "Transfer Case to Different Location", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Transfer", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Transfer" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Transfers an existing case to a different funeral home location within the company.\n This process updates the case\u0027s location assignment, generates a new case number, and\n allows selective retention of notes, attachments, people, and gatherings.\n\n**Usage Notes:**\n\n- The original case ID is preserved; only the location, case number, and selected data are updated.\n- All contract details are removed during transfer; a new contract must be created at the target location.\n- The original location is saved in OriginalLocationId for historical tracking.\n- The previous case number is saved in PreviousCaseNumber before generating a new one.\n- A new case number is automatically generated based on the target location\u0027s numbering rules.\n- The CaseTransferDate is set to the current UTC timestamp.\n- Notes, Attachments, People, and Gatherings are selectively retained based on the Keep list in the request.\n- Items not in the Keep list are permanently removed (not soft-deleted).\n- The transfer operation is transactional; if any step fails, all changes are rolled back.\n\n\n**Tags:**Case Management, Case Transfer, Location Transfer", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Mark Case as Unposted (Reverse Posting)", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/UnPostCall/:wasAdminUnposting", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "UnPostCall", ":wasAdminUnposting" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "wasAdminUnposting", "value": "\u003CwasAdminUnposting\u003E", "type": "string" } ] }, "description": "Marks a previously posted case as \u0022unposted\u0022 to allow modifications to the contract or financial data.\n This operation reverses the posting action and creates an audit trail entry. It also removes empty\n contract addendums (addendums with no contract details) to maintain data integrity.\n\n**Usage Notes:**\n\n- Requires the AllowCallPosting permission for the specified funeral home.\n- Sets the Posted property of the case to false.\n- Creates a CallPostHistory entry to track the unposting action with timestamp.\n- Automatically removes empty contract addendums (addendums with no contract details).\n- The wasAdminUnposting parameter tracks whether an admin performed the operation.\n- Unposting allows the case to be modified before re-posting to accounting.\n\n\n**Tags:**Case Management, Accounting, Posting, Unposting, Financial Management", "auth": null, "body": null } }, { "name": "Get Pre-Need Contract Date", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:preneedCallId/PreNeedContractDate", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":preneedCallId", "PreNeedContractDate" ], "query": null, "variable": [ { "key": "preneedCallId", "value": "\u003CpreneedCallId\u003E", "type": "string" } ] }, "description": "Returns the effective pre-need contract date for the specified pre-need case. The date is\n taken from the earliest contract on the case, falling back to the case\u0027s creation date when\n no contract date is available.", "auth": null, "body": null } }, { "name": "Check if Running Addendums Enabled for Company", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/AreRunningAddendumsEnabledForCompany", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", "AreRunningAddendumsEnabledForCompany" ], "query": null, "variable": null }, "description": "Checks whether the \u0022running addendums\u0022 feature is enabled for the specified company. When running\n addendums are enabled, only one addendum can exist at a time for any case. This setting affects\n how addendums are created and managed across all cases for the company.\n\n**Usage Notes:**\n\n- This is a company-wide configuration setting that affects all cases.\n- When true, only one addendum can exist per case at any given time.\n- This setting is enforced in the CreateNewContractAddendum endpoint.\n- The configuration is stored in the company\u0027s database settings.\n- Useful for UI to determine whether to allow multiple addendums for a case.\n\n\n**Tags:**Contract Management, Addendums, Configuration, Company Settings", "auth": null, "body": null } }, { "name": "Check Case Number Availability", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/CheckCaseNumber", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", "CheckCaseNumber" ], "query": [ { "key": "caseNumber", "value": "\u003CcaseNumber\u003E", "description": "The case number string to verify for uniqueness.\r\nThis is the value that will be checked against existing cases.", "disabled": true }, { "key": "locationId", "value": "\u003ClocationId\u003E", "description": "Optional location ID to scope the check to a specific location.\r\nIf provided, only checks for duplicates within that location; otherwise checks company-wide.", "disabled": true } ], "variable": null }, "description": "Verifies whether a case number is already in use within the company or at a specific location.\n This endpoint helps prevent duplicate case numbers by checking for existing cases before\n assignment or manual entry.\n\n**Usage Notes:**\n\n- This is a read-only validation endpoint that does not modify any data.\n- Case number comparison is exact and case-sensitive.\n- If no location ID is provided, the check searches across all locations in the company.\n- If a location ID is provided, the check is limited to cases at that specific location.\n- This endpoint should be called before allowing users to manually assign or change case numbers.\n- The case number must not be null, empty, or whitespace only.\n\n\n**Tags:**Case Management, Validation, Case Number", "auth": null, "body": null } }, { "name": "Convert Pre-Need Call to At-Need Call", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/ConvertPreneed/:preneedCallId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", "ConvertPreneed", ":preneedCallId" ], "query": null, "variable": [ { "key": "preneedCallId", "value": "\u003CpreneedCallId\u003E", "type": "string" } ] }, "description": "Converts an existing pre-need case to an at-need case when the death occurs. This process\n creates a new at-need case while preserving the original pre-need case for historical reference.\n Contract details, people, and attachments are copied based on company settings.\n\n**Usage Notes:**\n\n- The original pre-need case is marked with a conversion date but remains in the system for historical reference.\n- A new at-need case is created with a link back to the original pre-need case via PreNeedCallId.\n- Contract copying behavior is controlled by the ExcludeContractFromPreNeedConversion company setting.\n- If contract exclusion is disabled, all pre-need contract details are copied to the at-need case.\n- If contract exclusion is enabled, a blank contract is created for the at-need case.\n- All people associated with the pre-need case are copied to the new at-need case.\n- All attachments (including profile pictures) are duplicated for the new at-need case.\n- A new case number is generated for the at-need case based on company numbering settings.\n- The conversion process is transactional; if any step fails, all changes are rolled back.\n\n\n**Tags:**Pre-Need, At-Need, Case Conversion, Case Management", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create New Call (Case)", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/Create", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", "Create" ], "query": null, "variable": null }, "description": "Creates a new case (call) for the specified company. This endpoint initializes a new at-need\n or pre-need case with the provided vital information, generates a case number, creates the\n initial contract, and optionally processes ship-track removal requests.\n\n**Usage Notes:**\n\n- This endpoint uses the CreateCaseCommand handler to ensure proper case initialization.\n- A case number is automatically generated based on company settings and naming conventions.\n- A default contract is created automatically for the new case.\n- The need type ID determines whether the case is at-need (1) or pre-need (2).\n- If ShipTrackRemoval is enabled, the ship-track processing is triggered after case creation.\n- The source system is automatically set to \u0022Advisor\u0022 for tracking purposes.\n\n\n**Tags:**Case Creation, Case Management, New Case", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Logged In User\u0027s Person Information", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/LoggedInUserPerson", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", "LoggedInUserPerson" ], "query": null, "variable": null }, "description": "Retrieves the person information for the currently logged-in user based on the user\u0027s ID and company. If no person is found, returns null.", "auth": null, "body": null } }, { "name": "Get Cases by Date Range", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/CasesByDate", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "CasesByDate" ], "query": [ { "key": "startDate", "value": "\u003CstartDate\u003E", "description": "The start date of the date range (inclusive).\r\nCases created or modified on or after this date will be included.", "disabled": true }, { "key": "endDate", "value": "\u003CendDate\u003E", "description": "The end date of the date range (inclusive).\r\nCases created or modified on or before this date will be included.", "disabled": true } ], "variable": null }, "description": "Retrieves a filtered list of active cases within a specified date range for the current user.\n Cases are filtered by funeral home access, creation date, and modification date. This endpoint\n also includes queued cases if the user has appropriate permissions.\n\n**Usage Notes:**\n\n- Results are filtered by the user\u0027s assigned funeral homes unless they have elevated roles (Zeus, AuroraAdmin, CorporateManager).\n- Only active cases are returned; pre-need cases that have been converted are excluded.\n- If the user has CreateQueuedCase permission, queued cases are included in the results.\n- Both new queued cases (CallQueue) and legacy V1 queued cases are retrieved when applicable.\n- Results are ordered by last modification date in descending order.\n- Profile picture URLs and tracking location information are included when available.\n\n\n**Tags:**Cases, Date Range, Case Management, Queued Cases", "auth": null, "body": null } }, { "name": "Queue a Case", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Queue", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Queue" ], "query": null, "variable": null }, "description": "Queues a Case using payload in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a Queued Case", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Queue/:callQueueId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Queue", ":callQueueId" ], "query": null, "variable": [ { "key": "callQueueId", "value": "\u003CcallQueueId\u003E", "type": "string" } ] }, "description": "Deletes a Queued Case using Queued Case Id in request.", "auth": null, "body": null } }, { "name": "Convert a Queued Case", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Queue/:callQueueId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Queue", ":callQueueId" ], "query": null, "variable": [ { "key": "callQueueId", "value": "\u003CcallQueueId\u003E", "type": "string" } ] }, "description": "Converts a Queued Case using Queued Case Id in request.", "auth": null, "body": null } }, { "name": "Delete Legacy Queued Case", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/QueueLegacy/:callQueueId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "QueueLegacy", ":callQueueId" ], "query": null, "variable": [ { "key": "callQueueId", "value": "\u003CcallQueueId\u003E", "type": "string" } ] }, "description": "Permanently deletes a legacy queued case entry from the historical queue table using its integer identifier.\n\n**Usage Notes:**\n\n- Targets the deprecated\u0060Queues\u0060table used by older workflows.\n- Requires both company access and queued case management permission.\n- Throws\u0060SolutionCenterException\u0060when the queue ID is invalid.\n\n\n**Tags:**Advisor, Case Management, Legacy", "auth": null, "body": null } }, { "name": "Convert a Legacy Queued Case", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/QueueLegacy/:callQueueId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "QueueLegacy", ":callQueueId" ], "query": null, "variable": [ { "key": "callQueueId", "value": "\u003CcallQueueId\u003E", "type": "string" } ] }, "description": "Converts a Queued Case using Queued Case Id in request.", "auth": null, "body": null } }, { "name": "Get Recent Cases", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/RecentCases", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "RecentCases" ], "query": null, "variable": null }, "description": "Retrieves a list of cases that have been created or modified within the last 12 months\n for the specified company. This endpoint provides a quick view of recently active cases\n to help users track current workload and recent activity.\n\n**Usage Notes:**\n\n- Cases are included if created or modified within the last 12 months.\n- Results are ordered by last modification date in descending order.\n- Each case includes decedent information, location, call type, and dates.\n- This endpoint is useful for dashboard views and recent activity tracking.\n\n\n**Tags:**Cases, Recent Activity, Case Management", "auth": null, "body": null } }, { "name": "Search Cases by Name or Case Number", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Search", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Search" ], "query": [ { "key": "searchTerm", "value": "\u003CsearchTerm\u003E", "description": "The search text to match against case numbers and decedent names.\r\nSupports partial matching (e.g., \u0022Smith\u0022 finds \u0022John Smith\u0022, \u0022Jane Smithson\u0022).", "disabled": true } ], "variable": null }, "description": "Searches for cases by decedent name or case number across the company\u0027s database. Supports partial matching\n and returns cases ordered by sale date with the current company\u0027s cases prioritized first. Administrators\n and Zeus users can search all companies, while regular users are restricted to their accessible companies.\n\n**Usage Notes:**\n\n- Searches both CaseNumber and DecedentName (First \u002B Last) with partial matching.\n- AuroraAdmin and Zeus roles can search the specified company only.\n- Regular users can search across all companies they have access to.\n- Results are ordered: current company first, then by sale date descending.\n- Only returns cases with a DecedentName (DecedPurchPerson must exist).\n- Includes case metadata: location, call type, need type (At-Need/Pre-Need/Trade), posted status.\n- Returns dates: DateCreated, DateOfDeath, SaleDate (contract date).\n- Director name shown as \u0022N/A\u0022 if not assigned.\n\n\n**Tags:**Search, Cases, Case Search, Decedent Search", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/SearchPeople", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "SearchPeople" ], "query": [ { "key": "searchTerm", "value": "\u003CsearchTerm\u003E", "description": null, "disabled": true } ], "variable": null }, "description": "", "auth": null, "body": null } }, { "name": "Search Queued Cases", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/SearchQueue", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "SearchQueue" ], "query": [ { "key": "searchTerm", "value": "\u003CsearchTerm\u003E", "description": "Search Term", "disabled": true } ], "variable": null }, "description": "Returns a list of Queued Cases matching Search Term in request.", "auth": null, "body": null } } ], "request": null }, { "name": "Cases: Allowances", "description": null, "item": [ { "name": "Get All Unused Package Allowances", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/UnusedAllowances", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "UnusedAllowances" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves all unused allowances from packages selected in the case\u0027s contracts. Allowances\n are credit amounts included in packages that can be applied toward specific item types\n (e.g., $500 casket allowance). This endpoint calculates remaining allowances after deducting\n items already selected.\n\n**Usage Notes:**\n\n- Calculates total allowances from all packages on all contracts for the case.\n- Deducts the retail value of items already selected in each item type category.\n- Only returns allowances with remaining balance greater than zero.\n- Common allowance types: casket, outer burial container, memorial package, flowers.\n- Useful for showing families what credits they have left to use.\n\n\n**Tags:**Allowances, Contracts, Packages, Financial, Case Management", "auth": null, "body": null } }, { "name": "Get Unused Allowances for Specific Contract", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/UnusedAllowances/:contractId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "UnusedAllowances", ":contractId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "contractId", "value": "\u003CcontractId\u003E", "type": "string" } ] }, "description": "Retrieves unused allowances from packages selected in a specific contract. Similar to\n GetAllUnusedAllowances but filtered to a single contract, useful when working with\n contract addendums or viewing allowances per contract.\n\n**Usage Notes:**\n\n- Calculates allowances only from packages in the specified contract.\n- Deducts items selected in this contract from the allowance amounts.\n- Useful for viewing allowances specific to primary contract vs. addendums.\n- Only returns allowances with remaining balance greater than zero.\n\n\n**Tags:**Allowances, Contracts, Packages, Financial, Case Management", "auth": null, "body": null } } ], "request": null }, { "name": "Cases: Attachments", "description": null, "item": [ { "name": "Upload Call Attachments", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Attachment", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Attachment" ], "query": [ { "key": "isTranscript", "value": "\u003CisTranscript\u003E", "description": "Indicates if the attachment is the CareAssist transcript", "disabled": true } ], "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Uploads one or more files as attachments to a specific case (call). Files are stored in\n cloud storage and associated with the case for future retrieval. This endpoint handles\n file validation, upload to blob storage, and database record creation.\n\n**Usage Notes:**\n\n- At least one file must be provided; empty requests will fail.\n- Maximum number of files per request is enforced (see MediaConstants.MaxFileUploadCount).\n- Zero-length files are rejected with a descriptive error message.\n- Files are stored in Azure Blob Storage using the pattern: companyId/callKey/storageKey.\n- MIME types are automatically determined from file extensions.\n- Each file receives a unique storage key (GUID) for secure retrieval.\n- All attachments are marked as active and not profile pictures by default.\n- The ManageCallAttachments permission is required for this operation.\n\n\n**Tags:**Attachments, Case Management, Upload, Files, Documents", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Call Attachment", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Attachment/:callAttachmentId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Attachment", ":callAttachmentId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "callAttachmentId", "value": "\u003CcallAttachmentId\u003E", "type": "string" } ] }, "description": "Performs a soft delete on a call attachment by marking it as inactive. The attachment file\n remains in storage but is excluded from queries and listings. If the attachment was set as\n a profile picture, that flag is also cleared.\n\n**Usage Notes:**\n\n- This is a soft delete operation; the attachment record remains in the database but is marked inactive.\n- The actual file in blob storage is not removed and could potentially be recovered.\n- If the attachment was set as the profile picture, the IsProfilePicture flag is cleared.\n- Attempting to delete an already-deleted attachment returns a 400 error.\n- The attachment must belong to the specified call ID; mismatches return a 400 error.\n- Requires the ManageCallAttachments permission.\n\n\n**Tags:**Attachments, Delete, Case Management, Soft Delete", "auth": null, "body": null } }, { "name": "Set Call Attachment as Profile Picture", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Attachment/:callAttachmentId/ProfilePicture", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Attachment", ":callAttachmentId", "ProfilePicture" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "callAttachmentId", "value": "\u003CcallAttachmentId\u003E", "type": "string" } ] }, "description": "Designates a specific call attachment as the profile picture for the case. Only one attachment\n can be the profile picture at a time; this operation automatically unsets any previously designated\n profile picture for the case.\n\n**Usage Notes:**\n\n- Only one attachment per case can be designated as the profile picture.\n- Setting a new profile picture automatically clears the IsProfilePicture flag on all other attachments for the case.\n- The attachment must be active; attempting to set a deleted attachment as profile picture returns an error.\n- The attachment must belong to the specified call ID.\n- Profile pictures are typically displayed prominently in case listings and detail views.\n- Requires the ManageCallAttachments permission.\n\n\n**Tags:**Attachments, Profile Picture, Case Management, Update", "auth": null, "body": null } }, { "name": "Unset Call Attachment as Profile Picture", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Attachment/:callAttachmentId/ProfilePicture", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Attachment", ":callAttachmentId", "ProfilePicture" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "callAttachmentId", "value": "\u003CcallAttachmentId\u003E", "type": "string" } ] }, "description": "Removes the profile picture designation from a specific call attachment. The attachment itself\n remains active and available; only the IsProfilePicture flag is cleared. This allows removing\n a profile picture without deleting the attachment file.\n\n**Usage Notes:**\n\n- This operation only clears the IsProfilePicture flag; the attachment remains active and accessible.\n- After this operation, the case will have no profile picture unless another attachment is designated.\n- The attachment must be active; attempting to modify a deleted attachment returns an error.\n- The attachment must belong to the specified call ID.\n- Requires the ManageCallAttachments permission.\n\n\n**Tags:**Attachments, Profile Picture, Case Management, Update", "auth": null, "body": null } }, { "name": "Get Call Attachments", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Attachments", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Attachments" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves a complete list of all active file attachments associated with a specific case (call).\n Attachments may include documents, images, forms, or other files uploaded during the case workflow.\n This endpoint provides metadata and access URLs for each attachment.\n\n**Usage Notes:**\n\n- Only active attachments are returned; soft-deleted attachments are excluded.\n- Results are ordered by creation date and attachment ID.\n- Each attachment includes a full URL for downloading/viewing the file.\n- MIME types are automatically determined based on file extensions.\n- User information (modified by name) is enriched from the AdvisorUsers table.\n- Profile pictures are indicated with the IsProfilePicture flag.\n\n\n**Tags:**Attachments, Case Management, Files, Documents", "auth": null, "body": null } }, { "name": "Download multiple call attachments as a ZIP file.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Attachments/Download", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Attachments", "Download" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Download multiple call attachments as a ZIP file.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Reorder call attachments by setting their display order.", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Attachments/Reorder", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Attachments", "Reorder" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Reorder call attachments by setting their display order.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Download Call Attachment File", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/Attachment/:companyId/:callKey/:storageKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", "Attachment", ":companyId", ":callKey", ":storageKey" ], "query": [ { "key": "width", "value": "\u003Cwidth\u003E", "description": "Optional desired width in pixels for image resizing.\r\nOnly applies to image file types; ignored for other file types.", "disabled": true }, { "key": "height", "value": "\u003Cheight\u003E", "description": "Optional desired height in pixels for image resizing.\r\nOnly applies to image file types; ignored for other file types.", "disabled": true }, { "key": "fit", "value": "\u003Cfit\u003E", "description": "Optional ImageResizeFit parameter specifying how the image should be resized.\r\nOptions include fit, fill, crop, pad, etc. Only applies to image files.", "disabled": true } ], "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" }, { "key": "callKey", "value": "\u003CcallKey\u003E", "type": "string" }, { "key": "storageKey", "value": "\u003CstorageKey\u003E", "type": "string" } ] }, "description": "Downloads a specific call attachment file from cloud storage. This endpoint supports optional\n image resizing for efficient delivery and caching. The endpoint is publicly accessible (anonymous)\n to support embedding in reports and external viewing scenarios.\n\n**Usage Notes:**\n\n- This endpoint allows anonymous access to support embedding attachments in public-facing reports and documents.\n- Files are stored in blob storage using the path pattern: companyId/callKey/storageKey.\n- Response is cached for 600 seconds (10 minutes) on the client side to improve performance.\n- Cache varies by all query string parameters (width, height, fit) to support multiple sizes.\n- Image resizing is performed on-demand by the media service when width/height parameters are provided.\n- The original file is returned if no resize parameters are specified.\n\n\n**Tags:**Attachments, Download, Files, Media, Images", "auth": null, "body": null } } ], "request": null }, { "name": "Cases: Configuration", "description": null, "item": [ { "name": "Create a Case Management Configuration", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/CaseManagementConfig", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "CaseManagementConfig" ], "query": null, "variable": null }, "description": "Creates a new Case Management Configuration for a company.\n\n**Tags:**Advisor, Case Management, Configuration", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a Specific Case Management Configuration", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/CaseManagementConfig/:caseManagementConfigId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "CaseManagementConfig", ":caseManagementConfigId" ], "query": null, "variable": [ { "key": "caseManagementConfigId", "value": "\u003CcaseManagementConfigId\u003E", "type": "string" } ] }, "description": "Retrieves a specific Case Management Configuration by its ID for the given company.\n\n**Tags:**Advisor, Case Management, Configuration", "auth": null, "body": null } }, { "name": "Update a Case Management Configuration", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/CaseManagementConfig/:caseManagementConfigId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "CaseManagementConfig", ":caseManagementConfigId" ], "query": null, "variable": [ { "key": "caseManagementConfigId", "value": "\u003CcaseManagementConfigId\u003E", "type": "string" } ] }, "description": "Updates an existing Case Management Configuration for the specified company and configuration ID.\n\n**Tags:**Advisor, Case Management, Configuration", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a Case Management Configuration", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/CaseManagementConfig/:caseManagementConfigId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "CaseManagementConfig", ":caseManagementConfigId" ], "query": null, "variable": [ { "key": "caseManagementConfigId", "value": "\u003CcaseManagementConfigId\u003E", "type": "string" } ] }, "description": "Deletes an existing Case Management Configuration by its ID for the specified company.\n\n**Tags:**Advisor, Case Management, Configuration", "auth": null, "body": null } }, { "name": "Get Case Management Configuration by Call", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/CaseManagementConfig/Call/:callId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "CaseManagementConfig", "Call", ":callId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves the most applicable Case Management Configuration for a given call, based on company ID and call parameters.\n\n**Tags:**Advisor, Case Management, Configuration\n\n**Behavior:**\n\n- Attempts to find the most specific configuration match using precedence rules.\n- If no company configuration is found, falls back to the master configuration for the Need Type.\n", "auth": null, "body": null } }, { "name": "Get Case Management Configurations", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/CaseManagementConfigs", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "CaseManagementConfigs" ], "query": null, "variable": null }, "description": "Retrieves all active Case Management Configurations for the specified company.\n\n**Tags:**Advisor, Case Management, Configuration\n\n**Behavior:**\n\n- Manually maps\u0060NeedType\u0060names from AdvisorMaster.\n- Results are sorted by Need Type, Call Type, and Location.\n", "auth": null, "body": null } } ], "request": null }, { "name": "Cases: Contracts", "description": null, "item": [ { "name": "Add Adjustment to Contract", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Contract/:contractId/Adjustment", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Contract", ":contractId", "Adjustment" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "contractId", "value": "\u003CcontractId\u003E", "type": "string" } ] }, "description": "Adds a price adjustment to a contract to increase or decrease the total contract amount. Unlike deductions,\n adjustments can be either positive (additions) or negative (reductions) and are typically used for miscellaneous\n charges or credits not associated with inventory items. Adjustments include a description and adjustment type.\n\n**Usage Notes:**\n\n- The Amount must not be zero.\n- MathType determines if the adjustment adds (Positive) or subtracts (Negative) from the contract total.\n- Negative adjustments are stored as negative Price and TaxableAmount values.\n- Adjustments do not use LocationItemId - they are contract-specific line items.\n- The Description field is stored in the Notes property of the contract detail.\n- AdjustmentTypeId categorizes the adjustment (e.g., admin fee, credit, misc charge).\n- Can be associated with a specific contract detail via AssociatedContractDetailId.\n- Posted contracts cannot have adjustments added unless on an unlocked addendum.\n- Automatically triggers package and tax recalculation for the contract.\n\n\n**Tags:**Contract Management, Adjustments, Price Adjustments, Contract Modifications", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Add Deduction to Contract", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Contract/:contractId/Deduction", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Contract", ":contractId", "Deduction" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "contractId", "value": "\u003CcontractId\u003E", "type": "string" } ] }, "description": "Adds a deduction (discount or credit) to a contract to reduce the total contract amount. Deductions can be\n predefined deduction types or custom ad-hoc deductions created on the fly. Deductions can optionally be\n associated with a specific contract detail item. Posted contracts and locked addendums cannot be modified.\n\n**Usage Notes:**\n\n- The Amount must be greater than zero (positive value representing the deduction amount).\n- Deductions are stored as negative values in the contract details.\n- If DeductionId is not provided, a custom ad-hoc deduction item is created using OtherName.\n- Custom deductions create new Item and LocationItem records with status = AdHoc.\n- Deductions are always non-taxable (Taxable = false).\n- Can be associated with a specific contract detail via AssociatedContractDetailId (DiscountContractDetailId).\n- Posted contracts cannot have deductions added unless on an unlocked addendum.\n- Automatically triggers package and tax recalculation for the contract.\n\n\n**Tags:**Contract Management, Deductions, Discounts, Contract Adjustments", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Add Item to Contract", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Contract/:contractId/Detail", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Contract", ":contractId", "Detail" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "contractId", "value": "\u003CcontractId\u003E", "type": "string" } ] }, "description": "Adds a new item (service, product, or merchandise) to a contract or addendum. This endpoint creates a contract\n detail record that associates an inventory item with a specific contract, including pricing, quantity, and tax\n information. The item must be from the location\u0027s inventory.\n\n**Usage Notes:**\n\n- Creates a new ContractDetail record with pricing and tax calculations.\n- The LocationItemId must reference a valid inventory item for the case\u0027s location.\n- Pricing is calculated based on the location item\u0027s price and any package associations.\n- Tax calculations are performed automatically based on the item\u0027s taxable flag.\n- Returns the complete contract detail with all calculated fields populated.\n- The current user\u0027s ID is recorded as the creator for audit tracking.\n- This endpoint is used when adding individual items to a contract during arrangement.\n\n\n**Tags:**Contract Management, Contract Details, Items, Contract Modifications", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Contract Detail Item", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Contract/:contractId/Detail/:contractDetailId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Contract", ":contractId", "Detail", ":contractDetailId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "contractId", "value": "\u003CcontractId\u003E", "type": "string" }, { "key": "contractDetailId", "value": "\u003CcontractDetailId\u003E", "type": "string" } ] }, "description": "Updates an existing contract detail item with new pricing, quantity, or other modifications. This endpoint\n allows changes to items already on a contract, including price adjustments, quantity changes, and notes updates.\n The operation includes automatic tax and package recalculation.\n\n**Usage Notes:**\n\n- Updates are applied through the SaveContractDetail method which handles validation and calculations.\n- Price and quantity changes automatically recalculate extended price, tax, and package totals.\n- The current user\u0027s ID is recorded for audit tracking.\n- Returns the complete updated contract detail with all recalculated fields.\n- Tax amounts are recalculated based on updated taxable amounts and tax rates.\n- Package allowances are recalculated if the item is part of a package.\n\n\n**Tags:**Contract Management, Contract Details, Updates, Item Modifications", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Contract Detail Item", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Contract/:contractId/Detail/:contractDetailId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Contract", ":contractId", "Detail", ":contractDetailId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "contractId", "value": "\u003CcontractId\u003E", "type": "string" }, { "key": "contractDetailId", "value": "\u003CcontractDetailId\u003E", "type": "string" } ] }, "description": "Removes an item from a contract, including associated engraving information and order records. If the item is\n an ad-hoc item not used on any other contracts, the item and location item are automatically deactivated.\n Posted contracts and locked addendums cannot have items deleted. This operation creates an audit trail entry.\n\n**Usage Notes:**\n\n- This is a permanent deletion - the contract detail is removed from the database.\n- An audit trail entry is created in ContractDetailAudit for record-keeping.\n- Posted contracts cannot have items deleted unless the item is on an unlocked addendum.\n- Locked addendums cannot have items deleted - must be unlocked first.\n- If the item has engraving, both the engraving information AND the engraving package detail are deleted.\n- Any associated OrderItem records in AdvisorOrders are removed.\n- Ad-hoc items: If this is the last usage of an ad-hoc item, the Item and LocationItem are deactivated.\n- Regular catalog items are not affected - only the contract detail is removed.\n- Triggers automatic package and tax recalculation for the contract.\n\n\n**Tags:**Contract Management, Contract Details, Deletion, Item Removal", "auth": null, "body": null } }, { "name": "Update Contract Detail Date Created (addendums only)", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Contract/:contractId/Detail/:contractDetailId/DateCreated", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Contract", ":contractId", "Detail", ":contractDetailId", "DateCreated" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "contractId", "value": "\u003CcontractId\u003E", "type": "string" }, { "key": "contractDetailId", "value": "\u003CcontractDetailId\u003E", "type": "string" } ] }, "description": "Updates the DateCreated on a single addendum contract-detail line item.\n Restricted to , , and\n . The target row must belong to a contract\n where IsAddendum == true; otherwise 400 Bad Request is returned.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Add Engraving to Contract Item", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Contract/:contractId/Detail/:contractDetailId/Engraving", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Contract", ":contractId", "Detail", ":contractDetailId", "Engraving" ], "query": [ { "key": "itemCode", "value": "\u003CitemCode\u003E", "description": "The item code of the product being engraved (parent item).\r\nUsed for tracking and linking the engraving to the specific product.", "disabled": true } ], "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "contractId", "value": "\u003CcontractId\u003E", "type": "string" }, { "key": "contractDetailId", "value": "\u003CcontractDetailId\u003E", "type": "string" } ] }, "description": "Adds engraving information to a contract detail item (typically a casket, urn, or memorial product). This operation\n creates both an engraving package contract detail (for the engraving service charge) and an engraving information\n record (containing the personalization details). If the operation fails, the engraving package detail is automatically\n rolled back to maintain data consistency.\n\n**Usage Notes:**\n\n- This operation creates TWO records: a contract detail for the engraving package and an engraving information record.\n- EngravingPackage must be in format \u0022ItemCode_Description\u0022 (e.g., \u0022ENG-BRONZE_Bronze Engraving\u0022).\n- The engraving package item code is extracted from before the underscore.\n- The engraving package is added to the contract as a billable line item.\n- Engraving information is stored in the AdvisorOrders database for order processing.\n- Supports up to 4 lines of engraving text, font selection, and clip art.\n- If ProofRequested = true, a proof email will be sent to the specified ProofEmailAddress.\n- Automatic rollback: if engraving info creation fails, the contract detail is deleted.\n\n\n**Tags:**Contract Management, Engraving, Personalization, Contract Details", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Contract Detail Engraving", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Contract/:contractId/Detail/:contractDetailId/Engraving", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Contract", ":contractId", "Detail", ":contractDetailId", "Engraving" ], "query": [ { "key": "itemCode", "value": "\u003CitemCode\u003E", "description": "Item code related to the engraving information.", "disabled": true } ], "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "contractId", "value": "\u003CcontractId\u003E", "type": "string" }, { "key": "contractDetailId", "value": "\u003CcontractDetailId\u003E", "type": "string" } ] }, "description": "Updates existing engraving information for a contract detail. The method updates properties\n such as clip art file, engraving location, font, and various lines of text. It also handles\n the item code and proof email address based on the provided DTO. The method saves changes to\n the database and returns the updated engraving information.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Contract Detail Cost (Wholesale Price)", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Contract/:contractId/Detail/:contractDetailId/UpdateCost", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Contract", ":contractId", "Detail", ":contractDetailId", "UpdateCost" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "contractId", "value": "\u003CcontractId\u003E", "type": "string" }, { "key": "contractDetailId", "value": "\u003CcontractDetailId\u003E", "type": "string" } ] }, "description": "Updates the cost (wholesale/purchase price) of a contract detail item. This operation modifies only the cost field\n without affecting retail pricing or other contract detail properties. Cost updates are subject to contract state\n restrictions - posted contracts and locked addendums cannot be modified.\n\n**Usage Notes:**\n\n- Only updates the Cost field - does not affect Price, Quantity, or other fields.\n- Cost represents the wholesale/purchase price paid to suppliers.\n- Posted contracts cannot have costs updated unless the item is on an unlocked addendum.\n- Locked addendums cannot have costs modified - must be unlocked first.\n- Cost changes do not trigger tax or package recalculations.\n- Used for tracking profit margins and cost of goods sold.\n- The cost field is typically hidden from clients and used for internal accounting.\n\n\n**Tags:**Contract Management, Cost Updates, Wholesale Pricing, Accounting", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Add Custom Ad-Hoc Item to Contract", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Contract/:contractId/Detail/AdHoc", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Contract", ":contractId", "Detail", "AdHoc" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "contractId", "value": "\u003CcontractId\u003E", "type": "string" } ] }, "description": "Creates and adds a custom ad-hoc item to a contract that doesn\u0027t exist in the standard inventory. This endpoint\n dynamically creates a new Item and LocationItem record with AdHoc status, then adds it to the contract. Useful\n for one-off products, special requests, or items not in the regular catalog.\n\n**Usage Notes:**\n\n- Creates THREE records: Item, LocationItem, and ContractDetail.\n- The new item is marked with ItemStatus = AdHoc to distinguish it from catalog items.\n- The Item and LocationItem are set to Active = true and AuroraProduct = false.\n- ItemName is required and must not be empty or whitespace.\n- Quantity must be greater than zero.\n- ItemTypeId must reference a valid ItemType for the company.\n- The ad-hoc item is associated with the case\u0027s location.\n- If the ad-hoc item is later deleted from all contracts, it will be automatically deactivated.\n- Useful for custom items, special requests, or products not in the standard catalog.\n\n\n**Tags:**Contract Management, Ad-Hoc Items, Custom Items, Contract Details", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Contract Details for Specific Contract", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Contract/:contractId/Details", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Contract", ":contractId", "Details" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "contractId", "value": "\u003CcontractId\u003E", "type": "string" } ] }, "description": "Retrieves contract detail items (products, services, merchandise) for a specific contract or addendum.\n This endpoint returns only the items that belong to the specified contract, allowing for granular\n access to items on individual contracts or addendums.\n\n**Usage Notes:**\n\n- Returns items only from the specified contract or addendum.\n- Each contract detail includes item information, pricing, quantities, and notes.\n- Results include both active and deleted items (check the Active flag).\n- Use this endpoint when you need items from a specific contract or addendum.\n- To retrieve all items across all contracts for a case, use the overload without contractId.\n\n\n**Tags:**Contract Management, Contract Details, Items, Services, Products", "auth": null, "body": null } }, { "name": "Delete Package from Contract", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Contract/:contractId/Package/:packageLocationId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Contract", ":contractId", "Package", ":packageLocationId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "contractId", "value": "\u003CcontractId\u003E", "type": "string" }, { "key": "packageLocationId", "value": "\u003CpackageLocationId\u003E", "type": "string" } ] }, "description": "Removes an entire package and all its associated items from a contract. When a package is deleted, all contract\n details linked to that package (via PackageLocationId) are removed, including any engraving information. This\n operation is useful for removing pre-selected service packages when clients change their service selections.\n\n**Usage Notes:**\n\n- Removes ALL contract details associated with the specified PackageLocationId.\n- Posted contracts cannot have packages deleted unless the package is on an unlocked addendum.\n- Locked addendums cannot have packages deleted - must be unlocked first.\n- Engraving information for all items in the package is automatically removed.\n- This operation creates audit trail entries for each deleted contract detail.\n- Useful for removing service packages (e.g., removing a full-service package to select itemized services).\n- Triggers automatic tax recalculation for the contract.\n- Package allowances are recalculated after deletion.\n\n\n**Tags:**Contract Management, Packages, Deletion, Service Packages", "auth": null, "body": null } }, { "name": "Update Contract Detail Notes", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Contract/Detail/:contractDetailId/Notes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Contract", "Detail", ":contractDetailId", "Notes" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "contractDetailId", "value": "\u003CcontractDetailId\u003E", "type": "string" } ] }, "description": "Updates only the notes field of a contract detail item without modifying pricing, quantity, or other properties.\n This lightweight operation is useful for adding product-specific notes, instructions, or special handling information\n to a line item on a contract.\n\n**Usage Notes:**\n\n- Only updates the Notes field - does not affect Price, Quantity, Cost, or other fields.\n- The notes are stored in the contract detail\u0027s Notes property.\n- Notes can include special instructions, personalization details, or internal comments.\n- This is a lightweight operation that doesn\u0027t trigger tax or package recalculations.\n- Notes are typically displayed on contracts and work orders.\n- Can be used to track special handling requirements or customer preferences.\n\n\n**Tags:**Contract Management, Contract Details, Notes, Item Annotations", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get All Contract Details for Case", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Contract/Details", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Contract", "Details" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves all contract detail items (products, services, merchandise) for all contracts and addendums\n associated with a case. This endpoint returns a comprehensive list of all items that have been added\n to any contract for the case, including items on the original contract and all addendums.\n\n**Usage Notes:**\n\n- Returns items from both the original contract and all addendums.\n- Each contract detail includes item information, pricing, quantities, and notes.\n- Results include both active and deleted items (check the Active flag).\n- Use this endpoint to get a complete view of all items across all contracts for a case.\n- To retrieve items for a specific contract only, use the contract-specific overload.\n\n\n**Tags:**Contract Management, Contract Details, Items, Services, Products", "auth": null, "body": null } }, { "name": "Get Case Contracts and Addendums", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Contracts", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Contracts" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves all contracts and contract addendums for a specific case. The primary contract\n is listed first, followed by any addendums in order. Each contract includes metadata such\n as contract date, lock status, and addendum flag.\n\n**Usage Notes:**\n\n- Contracts are ordered with primary contract (IsAddendum = false) first, then addendums by ContractId.\n- Each contract includes metadata like ContractDate, IsLocked, and IsAddendum flags.\n- Most cases have one primary contract, but addendums are created for contract modifications.\n- Addendums allow changes to be tracked separately while preserving the original contract.\n\n\n**Tags:**Contracts, Case Management, Addendums", "auth": null, "body": null } }, { "name": "Get Contract Financial Summary", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/ContractSummary", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "ContractSummary" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves a comprehensive financial summary of a case\u0027s contract including subtotal, adjustments,\n tax, grand total, payments made, and outstanding balance. This provides a complete financial\n overview of the arrangement contract.\n\n**Usage Notes:**\n\n- Subtotal includes all line items without adjustment types (merchandise, services, cash advances).\n- Adjustments include items with adjustment types (discounts, credits, additional charges).\n- Tax is the sum of TotalTax2 from all contract details.\n- Grand Total = Subtotal \u002B Adjustments \u002B Tax.\n- Payments includes only active payments for the call.\n- Balance = Grand Total - Payments.\n- The Addendums field is currently always false (legacy field).\n- Throws an exception if no contract details exist (null check).\n\n\n**Tags:**Contracts, Financial, Case Management, Summary, Payments, Balance", "auth": null, "body": null } }, { "name": "Contract Summaries", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/ContractSummaryBreakdown", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "ContractSummaryBreakdown" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Returns list of Contract Summaries matching Call Id specified in request.", "auth": null, "body": null } }, { "name": "Get Contract Grand Total", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/ContractTotal", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "ContractTotal" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Calculates and returns the grand total amount for a case\u0027s contract by summing all line item\n extended prices and taxes. This provides a quick total without the detailed breakdown.\n\n**Usage Notes:**\n\n- The grand total is calculated as the sum of (ExtendedPrice \u002B TotalTax2) for all contract details.\n- Includes all contract details: merchandise, services, cash advances, adjustments, and deductions.\n- Returns 0 if no contract details exist for the case.\n- This is a simplified calculation; use GetContractSummary for a detailed breakdown.\n\n\n**Tags:**Contracts, Financial, Case Management, Totals", "auth": null, "body": null } }, { "name": "Create Contract Addendum", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/CreateNewContractAddendum", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "CreateNewContractAddendum" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Creates a new contract addendum for a posted case. Addendums allow additional items or charges\n to be added to a contract after the original contract has been posted to accounting. The case\n must be in a posted state before an addendum can be created. Companies with running addendums\n enabled can only have one addendum at a time.\n\n**Usage Notes:**\n\n- Requires the CreateAddendum permission for the specified funeral home.\n- The case must be in a posted state before an addendum can be created.\n- Throws an exception if the case is not posted.\n- For companies with running addendums enabled, only one addendum can exist at a time.\n- The new addendum is created with IsAddendum = true to distinguish it from the original contract.\n- Addendums can have items added to them and can be locked separately from the original contract.\n\n\n**Tags:**Contract Management, Addendums, Contract Modifications, Posted Cases", "auth": null, "body": null } }, { "name": "Delete Contract Addendum", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/DeleteContractAddendum/:contractId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "DeleteContractAddendum", ":contractId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "contractId", "value": "\u003CcontractId\u003E", "type": "string" } ] }, "description": "Deletes a contract addendum and all associated contract details and engraving information. An addendum\n must be unlocked before it can be deleted, and it cannot be deleted if any of its items have been\n exported to accounting systems. This operation permanently removes the addendum and all related data.\n\n**Usage Notes:**\n\n- Requires the DeleteAddendum permission for the specified funeral home.\n- The addendum must be unlocked before deletion - throws exception if locked.\n- Throws an exception if any contract details have been exported to accounting.\n- Deletes all associated engraving information for items on the addendum.\n- Removes all contract details before removing the contract itself.\n- This is a permanent deletion operation and cannot be undone.\n- Changes are saved to both the client database and the advisor orders database.\n\n\n**Tags:**Contract Management, Addendums, Deletion, Contract Removal", "auth": null, "body": null } }, { "name": "Get Deleted Contract Details (Audit History)", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/DeletedContractDetails", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "DeletedContractDetails" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves all contract details that have been deleted from a case by querying the audit history table.\n This endpoint provides visibility into items that were previously on contracts but have been removed,\n allowing users to review deleted items for audit purposes or to restore information if needed.\n\n**Usage Notes:**\n\n- Retrieves data from the ContractDetailAudit table using XML parsing of DeletedRecords column.\n- Includes comprehensive item information by joining with Location_Item, Item, ItemType, PackageLocation, and Package tables.\n- Each deleted item includes pricing, quantities, tax information, and modification tracking.\n- Results include ModifiedBy user display names for audit tracking.\n- Items are sorted by RetailPrice (descending) and then ContractDetailId.\n- Deleted deductions show DiscountAmount as the RetailPrice.\n- Useful for reviewing contract changes and understanding what items were removed.\n\n\n**Tags:**Contract Management, Contract Details, Audit History, Deleted Items", "auth": null, "body": null } }, { "name": "Get Latest Contract ID for Case", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/GetLatestContractId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "GetLatestContractId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves the most recent contract ID for a case by returning the highest (most recent) contract ID value.\n This endpoint is useful for determining the latest contract or addendum that was created for a case, as\n contract IDs are assigned sequentially.\n\n**Usage Notes:**\n\n- Returns the contract with the highest ContractId value (most recently created).\n- Includes both original contracts and addendums in the search.\n- Throws an exception if no contract exists for the case.\n- Useful for identifying the active or current contract/addendum for a case.\n- Contract IDs are auto-incrementing, so higher values indicate newer contracts.\n\n\n**Tags:**Contract Management, Contract ID, Latest Contract", "auth": null, "body": null } }, { "name": "Lock Contract Addendum", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/LockContractAddendum/:contractId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "LockContractAddendum", ":contractId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "contractId", "value": "\u003CcontractId\u003E", "type": "string" } ] }, "description": "Locks a contract addendum to prevent further modifications. Once locked, the addendum cannot be edited\n unless it is explicitly unlocked. An addendum must have at least one contract detail item added to it\n before it can be locked. Locking an addendum records the lock timestamp and the user who performed the lock.\n\n**Usage Notes:**\n\n- Requires the LockAddendum permission for the specified funeral home.\n- The addendum must have at least one contract detail item before it can be locked.\n- Throws an exception if attempting to lock an empty addendum.\n- Sets IsAddendumLocked = true, DateAddendumLocked = current timestamp, and AddendumLockedBy = current user ID.\n- Locked addendums cannot be modified without first unlocking them.\n- This operation is commonly used to finalize an addendum before accounting export.\n\n\n**Tags:**Contract Management, Addendums, Locking, Contract Security", "auth": null, "body": null } }, { "name": "Unlock Contract Addendum", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/UnLockContractAddendum/:contractId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "UnLockContractAddendum", ":contractId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "contractId", "value": "\u003CcontractId\u003E", "type": "string" } ] }, "description": "Unlocks a previously locked contract addendum to allow modifications. Before unlocking an addendum,\n the system verifies that no other unlocked addendums exist for the same case (only one addendum can\n be unlocked at a time). Unlocking clears the lock timestamp and user information.\n\n**Usage Notes:**\n\n- Requires the LockAddendum permission for the specified funeral home.\n- Only one addendum can be unlocked at a time for any given case.\n- Throws an exception if another unlocked addendum exists - it must be locked or deleted first.\n- Sets IsAddendumLocked = false and clears DateAddendumLocked and AddendumLockedBy fields.\n- Unlocking allows the addendum to be modified before re-locking.\n- This operation is commonly used when corrections need to be made to a locked addendum.\n\n\n**Tags:**Contract Management, Addendums, Unlocking, Contract Security", "auth": null, "body": null } } ], "request": null }, { "name": "Cases: Death Certificates", "description": null, "item": [ { "name": "Get Death Certificate Note", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/DeathCertificateNote", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "DeathCertificateNote" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves the death certificate note associated with a specific case (call).\n This note contains special instructions or information related to death certificate processing\n and filing for the case.\n\n**Usage Notes:**\n\n- This is a specialized note field specific to death certificate processing.\n- The note is stored as a single text field on the Call entity.\n- Returns an empty value if no death certificate note has been created.\n\n\n**Tags:**Death Certificates, Notes, Case Management", "auth": null, "body": null } }, { "name": "Update Death Certificate Note", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/DeathCertificateNote", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "DeathCertificateNote" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Updates the death certificate note for a specific case (call). This note is used to\n document special instructions or information related to death certificate processing,\n filing requirements, or coordination with vital statistics offices.\n\n**Usage Notes:**\n\n- The note can be set to any text value or cleared by providing an empty/null value.\n- This operation updates the note directly on the Call entity.\n- No audit trail is maintained for death certificate note changes beyond standard entity tracking.\n\n\n**Tags:**Death Certificates, Notes, Case Management, Update", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Death Certificate Note", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/DeathCertificateNote", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "DeathCertificateNote" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Clears the death certificate note for a specific case (call) by setting it to null.\n This effectively removes any special instructions or information previously documented\n for death certificate processing.\n\n**Usage Notes:**\n\n- This operation sets the death certificate note to null rather than performing a soft delete.\n- The operation is idempotent; clearing an already empty note will succeed without error.\n- No audit trail is maintained beyond standard entity tracking.\n\n\n**Tags:**Death Certificates, Notes, Case Management, Delete", "auth": null, "body": null } } ], "request": null }, { "name": "Cases: Disclosures", "description": null, "item": [ { "name": "Toggle Case Contract Disclosure", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Disclosure", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Disclosure" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Adds or removes a contract disclosure for a case. If the CallContractDisclosureId is 0,\n a new disclosure is added. If an ID is provided, the existing disclosure is removed.\n This toggle behavior allows easy management of which disclosures apply to a case.\n\n**Usage Notes:**\n\n- If CallContractDisclosureId = 0, creates a new CallContractDisclosure record.\n- If CallContractDisclosureId \u003E 0, removes the existing CallContractDisclosure record.\n- This toggle pattern simplifies UI checkbox-style disclosure management.\n- Only the ContractDisclosureId is needed when adding a new disclosure.\n- Removal is a hard delete from the database.\n\n\n**Tags:**Contracts, Disclosures, Toggle, Case Management", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Case Contract Disclosures", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Disclosures", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Disclosures" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves all contract disclosures associated with a case. Disclosures are legal statements\n and consumer notices that must be presented during the arrangement process, such as GPL\n requirements, embalming disclosures, and other regulatory notices.\n\n**Usage Notes:**\n\n- Disclosures include FTC-required GPL disclosures, state-specific notices, and embalming disclosures.\n- Each disclosure tracks which regulatory requirements have been presented to the family.\n- Required for compliance with funeral industry regulations.\n- Disclosures are typically presented during arrangement conferences and signed contracts.\n\n\n**Tags:**Contracts, Disclosures, Compliance, GPL, Case Management", "auth": null, "body": null } } ], "request": null }, { "name": "Cases: Engraving", "description": null, "item": [ { "name": "Engraving Items", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/:fhId/EngravingItems", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", ":fhId", "EngravingItems" ], "query": null, "variable": [ { "key": "fhId", "value": "\u003CfhId\u003E", "type": "string" } ] }, "description": "Returns list of Engraving Items matching Funeral Home Id in request.", "auth": null, "body": null } }, { "name": "Get Engraving Information for Contract Details", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/ContractDetail/:contractDetailId/EngravingInformation", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "ContractDetail", ":contractDetailId", "EngravingInformation" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "contractDetailId", "value": "\u003CcontractDetailId\u003E", "type": "string" } ] }, "description": "Retrieves engraving information associated with a specific contract detail and call. Returns null if no engraving information is found.", "auth": null, "body": null } }, { "name": "Update Engraving Information Contract Detail ID", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Detail/:contractDetailId/UpdateEngravingInformationContractDetailId/:engravingInformationContractDetailId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Detail", ":contractDetailId", "UpdateEngravingInformationContractDetailId", ":engravingInformationContractDetailId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "contractDetailId", "value": "\u003CcontractDetailId\u003E", "type": "string" }, { "key": "engravingInformationContractDetailId", "value": "\u003CengravingInformationContractDetailId\u003E", "type": "string" } ] }, "description": "Updates the EngravingInformation.EngravingInformationContractDetailId\n for the engraving record linked to the specified call and contract detail, typically after moving or replacing the originating package line.\n\n**Usage Notes:**\n - This endpoint is used when reassigning engraving information to a different package line item.\n - The engraving information is located by the original contract detail and call combination.\n - Updates are persisted to the AdvisorOrders database context.", "auth": null, "body": null } }, { "name": "Delete Engraving Information", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Engraving/:engravingInformationId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Engraving", ":engravingInformationId" ], "query": null, "variable": [ { "key": "engravingInformationId", "value": "\u003CengravingInformationId\u003E", "type": "string" } ] }, "description": "Deletes an engraving information record from Advisor Orders and, when applicable, removes the associated\n engraving contract detail from the client database. Ensures both sources stay in sync, rolling back if either\n delete fails.\n\n**Usage Notes:**\n\n- Deletes the Advisor Orders record first, then removes the linked client contract detail if one exists.\n- Attempts to reinsert the Advisor Orders record if the client delete fails.\n- Throws\u0060SolutionCenterException\u0060when the engraving record cannot be found.\n\n\n**Tags:**Advisor, Contracts, Engraving", "auth": null, "body": null } } ], "request": null }, { "name": "Cases: Gatherings", "description": null, "item": [ { "name": "Get Call Events (Gatherings)", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/CallEvents", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "CallEvents" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves all events (gatherings) associated with a specific case (call). Events include\n services, visitations, and other scheduled gatherings. This endpoint provides event details\n including type, date, time, location, and associated notes.\n\n**Usage Notes:**\n\n- Events include services, visitations, viewings, burials, and other scheduled gatherings.\n- Each event includes the event type name, date, start/end times, and family arrival time.\n- Location information is included when the event is held at a specific facility.\n- Special flags identify the main service, first visitation, and second visitation events.\n- Event notes capture special instructions, clergy information, or other important details.\n- This data is used for scheduling, obituary publishing, and coordinating event logistics.\n\n\n**Tags:**Events, Gatherings, Case Management, Scheduling", "auth": null, "body": null } }, { "name": "Create Event (Gathering)", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Event", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Event" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Creates a new event (gathering) for a specific case. Events include services, visitations,\n viewings, burials, and other scheduled gatherings. Special handling applies for \u0022Arrangement Conference\u0022\n events which sync with case arrangement information and are limited to one per case.\n\n**Usage Notes:**\n\n- The event type ID must be valid and enabled for the location.\n- A contract must exist for the case before events can be created.\n- \u0022Arrangement Conference\u0022 events have special rules: only one per case is allowed.\n- When creating an \u0022Arrangement Conference\u0022, the arrangement date/time are synced to the case\u0027s ArrangementDateTime field.\n- Events are associated with the primary (non-addendum) contract for the case.\n- After creation, the complete event details are retrieved via IEventService for consistency.\n- The created event can include date, time, end time, family arrival time, location, and notes.\n\n\n**Tags:**Events, Gatherings, Case Management, Create, Services", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Specific Event Details", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Event/:eventId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Event", ":eventId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "eventId", "value": "\u003CeventId\u003E", "type": "string" } ] }, "description": "Retrieves detailed information about a specific event (gathering) associated with a case.\n This endpoint provides comprehensive event details including type, scheduling, location,\n resources, and participants. Delegates to the event service for consistent data retrieval.\n\n**Usage Notes:**\n\n- The endpoint delegates to IEventService.GetCallEvent for business logic.\n- Returns event type, date, start/end times, family arrival time, and location information.\n- Includes associated resources such as chapels, vehicles, and equipment.\n- Includes participant information such as clergy, musicians, and other service providers.\n- Special flags indicate if the event is the main service, first visitation, or second visitation.\n- Returns 400 Bad Request if the event is not found rather than 404 Not Found.\n- This endpoint is used for event detail views and editing forms.\n\n\n**Tags:**Events, Gatherings, Case Management, Event Details", "auth": null, "body": null } }, { "name": "Update Event (Gathering)", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Event/:eventId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Event", ":eventId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "eventId", "value": "\u003CeventId\u003E", "type": "string" } ] }, "description": "Updates an existing event (gathering) with new information. This endpoint allows modification\n of event details including date, time, location, and notes. Special handling applies for\n \u0022Arrangement Conference\u0022 events which sync with case arrangement information.\n\n**Usage Notes:**\n\n- The event must belong to the specified call; mismatches return an error.\n- If an event sub type is provided, it must be valid for the company.\n- \u0022Arrangement Conference\u0022 events have special handling: date/time changes sync to the case\u0027s ArrangementDateTime.\n- For \u0022Arrangement Conference\u0022 events, the location is also synced to ArrangementLocationId on the case.\n- All event fields can be updated including date, time, end time, family arrival time, location, notes, and sub type.\n- The update operation validates event ownership before applying changes.\n\n\n**Tags:**Events, Gatherings, Case Management, Update, Services", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Event (Gathering)", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Event/:eventId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Event", ":eventId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "eventId", "value": "\u003CeventId\u003E", "type": "string" } ] }, "description": "Permanently deletes an event (gathering) from a case. This is a hard delete operation that\n removes the event and all associated resources and participants. Special handling applies for\n \u0022Arrangement Conference\u0022 events which also clear the case\u0027s arrangement information.\n\n**Usage Notes:**\n\n- This is a permanent hard delete; the event cannot be recovered after deletion.\n- All associated EventResources (chapels, vehicles, equipment) are removed first.\n- All associated PersonPersonTypes (participants like clergy, musicians) are removed.\n- The event record itself is then permanently deleted from the database.\n- For \u0022Arrangement Conference\u0022 events, the case\u0027s arrangement information is cleared (ArrangementDateTime, ArrangementTime, ArrangementLocationId, ArrangementNotes).\n- The event must belong to the specified call; mismatches return an error.\n- Use this operation with caution as it cannot be undone.\n\n\n**Tags:**Events, Gatherings, Case Management, Delete, Hard Delete", "auth": null, "body": null } }, { "name": "Add Participant to Event", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Event/:eventId/Participant/:personId/Role/:personTypeId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Event", ":eventId", "Participant", ":personId", "Role", ":personTypeId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "eventId", "value": "\u003CeventId\u003E", "type": "string" }, { "key": "personId", "value": "\u003CpersonId\u003E", "type": "string" }, { "key": "personTypeId", "value": "\u003CpersonTypeId\u003E", "type": "string" } ] }, "description": "Adds a person as a participant to an event with a specific role. Participants are individuals\n who actively contribute to conducting the gathering, such as clergy, musicians, or celebrants.\n The person type must be marked as a participant role.\n\n**Usage Notes:**\n\n- The person type must be marked as IsParticipantRole to be used for event participants.\n- A person can have multiple roles in the same event (added separately with different personTypeIds).\n- Duplicate checking prevents adding the same person in the same role twice.\n- After adding, the SynchronizeUnspecifiedPersonType method is called to clean up orphaned roles.\n- Common participant roles include: Clergy, Musician, Celebrant, Pallbearer, Speaker.\n\n\n**Tags:**Events, Participants, Gatherings, Case Management, People, Add", "auth": null, "body": null } }, { "name": "Remove Participant from Event", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Event/:eventId/Participant/:personId/Role/:personTypeId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Event", ":eventId", "Participant", ":personId", "Role", ":personTypeId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "eventId", "value": "\u003CeventId\u003E", "type": "string" }, { "key": "personId", "value": "\u003CpersonId\u003E", "type": "string" }, { "key": "personTypeId", "value": "\u003CpersonTypeId\u003E", "type": "string" } ] }, "description": "Removes a person\u0027s participant role from an event. This permanently deletes the PersonPersonType\n association for the specific role. After removal, the SynchronizeUnspecifiedPersonType method\n ensures the person maintains appropriate associations with the case.\n\n**Usage Notes:**\n\n- This is a permanent deletion of the specific role assignment for the event.\n- The person type must be marked as IsParticipantRole.\n- If the person has multiple roles in the event, only the specified role is removed.\n- After removal, SynchronizeUnspecifiedPersonType is called to manage the person\u0027s case association.\n- If removing the last role leaves the person with no roles on the case, an \u0022Unspecified\u0022 role is automatically added.\n- If the person has other roles, any \u0022Unspecified\u0022 role is automatically removed.\n\n\n**Tags:**Events, Participants, Gatherings, Delete, Case Management, People", "auth": null, "body": null } }, { "name": "Get Event Participants", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Event/:eventId/Participants", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Event", ":eventId", "Participants" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "eventId", "value": "\u003CeventId\u003E", "type": "string" } ] }, "description": "Retrieves all people participating in a specific event in participant roles. Participants\n include clergy, musicians, celebrants, pallbearers, and other individuals who have active\n roles in conducting or supporting the gathering.\n\n**Usage Notes:**\n\n- Only people with active participant role person types are returned.\n- Each person can have multiple roles in the same event (e.g., clergy and celebrant).\n- Person types are ordered by their sort order for consistent display.\n- Duplicate persons are consolidated with their roles listed in PersonTypeIds.\n- Common participant roles include: Clergy, Musician, Celebrant, Pallbearer, Speaker, Officiant.\n\n\n**Tags:**Events, Participants, Gatherings, Case Management, People", "auth": null, "body": null } }, { "name": "Assign Resource to Event", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Event/:eventId/Resource/:resourceId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Event", ":eventId", "Resource", ":resourceId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "eventId", "value": "\u003CeventId\u003E", "type": "string" }, { "key": "resourceId", "value": "\u003CresourceId\u003E", "type": "string" } ] }, "description": "Assigns a resource (chapel, vehicle, equipment) to a specific event. This creates a reservation\n of the resource for the event\u0027s date and time. The resource must be active and available\n during the event\u0027s scheduled time.\n\n**Usage Notes:**\n\n- The resource must be active to be assigned to an event.\n- This creates an EventResource association record in the database.\n- No duplicate checking is performed; the same resource can be assigned multiple times (though this should be avoided).\n- Resource availability should be checked using GetAvailableLocationResources before assignment.\n- Common resources include chapels, visitation rooms, hearses, limousines, and audio/visual equipment.\n\n\n**Tags:**Events, Resources, Gatherings, Assignment, Case Management", "auth": null, "body": null } }, { "name": "Remove Resource from Event", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Event/:eventId/Resource/:resourceId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Event", ":eventId", "Resource", ":resourceId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "eventId", "value": "\u003CeventId\u003E", "type": "string" }, { "key": "resourceId", "value": "\u003CresourceId\u003E", "type": "string" } ] }, "description": "Removes a resource assignment from an event, freeing the resource for other uses during\n that time period. This is a permanent deletion of the EventResource association.\n\n**Usage Notes:**\n\n- This is a permanent deletion of the EventResource association.\n- The resource itself is not deleted, only its assignment to this specific event.\n- The resource becomes available for other events once removed.\n- Returns an error if the event doesn\u0027t have the specified resource assigned.\n\n\n**Tags:**Events, Resources, Gatherings, Delete, Case Management", "auth": null, "body": null } }, { "name": "Get Event Resources", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Event/:eventId/Resources", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Event", ":eventId", "Resources" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "eventId", "value": "\u003CeventId\u003E", "type": "string" } ] }, "description": "Retrieves all resources (chapels, vehicles, equipment) assigned to a specific event.\n Resources are physical or spatial assets required for conducting the gathering.\n\n**Usage Notes:**\n\n- Resources include chapels, visitation rooms, vehicles, and equipment.\n- Only resources currently assigned to the event are returned.\n- Resource information includes name, type, and capacity details.\n- This endpoint is used to display which resources are reserved for the event.\n\n\n**Tags:**Events, Resources, Gatherings, Case Management", "auth": null, "body": null } }, { "name": "Get Case Events (Gatherings)", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Events", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Events" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves all events (gatherings) associated with a specific case. Events include services,\n visitations, viewings, burials, cremations, and other scheduled gatherings. This endpoint\n delegates to the event service for consistent event retrieval logic.\n\n**Usage Notes:**\n\n- Events are ordered chronologically by date and time.\n- Each event includes type, date, start/end times, location, and special designation flags.\n- Special flags identify main service, first visitation, and second visitation events.\n- The endpoint delegates to IEventService.GetCallEvents for business logic.\n- Events include associated resources (chapels, vehicles) and participants (clergy, musicians).\n- This endpoint is used for event management screens, scheduling, and obituary publishing.\n\n\n**Tags:**Events, Gatherings, Case Management, Services, Scheduling", "auth": null, "body": null } }, { "name": "Get Gathering Settings", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/GatheringSettings", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "GatheringSettings" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves the gathering configuration for a specific case, identifying which events\n are designated as the main service, first visitation, and second visitation.\n These settings determine how events are displayed on reports and in the user interface.\n\n**Usage Notes:**\n\n- Only one event can be designated as the main service per case.\n- Only one event can be designated as visitation 1 per case.\n- Only one event can be designated as visitation 2 per case.\n- Null values indicate no event is currently assigned to that role.\n- These settings affect how events appear on printable forms and summaries.\n\n\n**Tags:**Gatherings, Events, Case Management, Settings", "auth": null, "body": null } }, { "name": "Update Gathering Settings", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/GatheringSettings", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "GatheringSettings" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Updates the gathering configuration for a specific case, designating which events\n should serve as the main service, first visitation, and second visitation. This endpoint\n clears any previous designations and applies the new settings atomically.\n\n**Usage Notes:**\n\n- All previous main service, visitation 1, and visitation 2 designations are cleared before applying new settings.\n- Only events belonging to the specified call can be designated.\n- Designating an invalid event ID will not fail but will have no effect.\n- All settings are applied in a single database transaction for consistency.\n- These settings immediately affect report generation and UI displays.\n\n\n**Tags:**Gatherings, Events, Case Management, Settings, Update", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Available Event Types for Location", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/EventTypes/:callId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "EventTypes", ":callId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves the list of event types available for a specific case based on its location.\n Event types are filtered by location configuration to show only types that are enabled\n for the funeral home location associated with the case.\n\n**Usage Notes:**\n\n- Event types are filtered based on the LocationEventTypes configuration for the call\u0027s location.\n- Only active event types that are enabled for the location are returned.\n- Results are ordered alphabetically by event type name for easier selection.\n- Common event types include: Service, Visitation, Viewing, Burial, Cremation, Memorial, Graveside.\n- Special event type \u0022Arrangement Conference\u0022 may have unique business rules.\n- Each location can have different event types enabled based on their facilities and services.\n- This endpoint is used to populate event type dropdowns when creating new events.\n\n\n**Tags:**Events, Event Types, Case Management, Gatherings, Configuration", "auth": null, "body": null } }, { "name": "Get Available Location Resources for Event Time", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Location/:locationId/Events/:eventId/AvailableResources", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Location", ":locationId", "Events", ":eventId", "AvailableResources" ], "query": [ { "key": "eventDate", "value": "\u003CeventDate\u003E", "description": "The date on which the event will occur.", "disabled": true }, { "key": "startTime", "value": "\u003CstartTime\u003E", "description": "The start time of the event.", "disabled": true }, { "key": "endTime", "value": "\u003CendTime\u003E", "description": "The end time of the event.", "disabled": true } ], "variable": [ { "key": "locationId", "value": "\u003ClocationId\u003E", "type": "string" }, { "key": "eventId", "value": "\u003CeventId\u003E", "type": "string" } ] }, "description": "Retrieves resources at a specific location that are available during the specified event time window.\n This endpoint checks for scheduling conflicts and applies a scheduling buffer to prevent\n double-booking of resources. Only unbooked resources are returned.\n\n**Usage Notes:**\n\n- Only active resources at the specified location are considered.\n- The company\u0027s SchedulingBuffer setting adds buffer time before/after events to prevent conflicts.\n- The specified eventId is excluded from conflict checks (allows editing existing events).\n- Overlapping event times are calculated including the scheduling buffer.\n- Resources already booked during the time window (including buffer) are excluded from results.\n- This endpoint is used when adding or editing events to show available resource options.\n\n\n**Tags:**Events, Resources, Gatherings, Availability, Scheduling", "auth": null, "body": null } } ], "request": null }, { "name": "Cases: Messages", "description": null, "item": [ { "name": "Get Financial Disclaimer for Case", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/FinancialDisclaimer", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "FinancialDisclaimer" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves the financial disclaimer text associated with a case. Financial disclaimers are custom\n messages that can be added to contracts to provide important financial information, payment terms,\n or legal disclaimers specific to the case.\n\n**Usage Notes:**\n\n- Returns null if no financial disclaimer has been set for the case.\n- Throws an exception if the case is not found.\n- Financial disclaimers are typically displayed on printed contracts.\n- The disclaimer text is stored in the FinancialDisclaimer property of the Call entity.\n- Use the PutFinancialDisclaimer endpoint to update the disclaimer text.\n\n\n**Tags:**Case Management, Financial Disclaimer, Contract Messages", "auth": null, "body": null } }, { "name": "Get Call Warning Message", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/WarningMessage", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "WarningMessage" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves the warning message associated with a specific case (call). Warning messages\n are displayed prominently in the UI to alert staff about important case-specific information\n such as special circumstances, restrictions, or alerts that require attention.\n\n**Usage Notes:**\n\n- Warning messages are displayed prominently to ensure staff awareness.\n- The message is stored as a single text field on the Call entity.\n- Returns an empty value if no warning message has been set.\n- Common uses include credit holds, special handling instructions, or family situation alerts.\n\n\n**Tags:**Warnings, Case Management, Alerts", "auth": null, "body": null } }, { "name": "Update Call Warning Message", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/WarningMessage", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "WarningMessage" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Updates the warning message for a specific case (call). Warning messages are prominently\n displayed in the UI to alert staff about critical case information such as credit holds,\n special handling requirements, or important family situation alerts.\n\n**Usage Notes:**\n\n- Warning messages should be used for critical alerts that require staff attention when viewing the case.\n- The message can be cleared by providing an empty or null value in the DTO.\n- Warning messages are displayed prominently throughout the case management interface.\n- Common use cases include credit holds, special payment arrangements, family restrictions, and handling instructions.\n- The warning message is stored directly on the Call entity and persists until explicitly changed or removed.\n\n\n**Tags:**Warnings, Case Management, Alerts, Update", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Call Warning Message", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/WarningMessage", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "WarningMessage" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Clears the warning message for a specific case (call) by setting it to null.\n This removes any critical alerts or warnings that were previously displayed to staff\n when viewing the case.\n\n**Usage Notes:**\n\n- This operation clears the warning message by setting it to null rather than performing a soft delete.\n- The operation is idempotent; clearing an already empty warning message will succeed without error.\n- After deletion, no warning message will be displayed for the case in the UI.\n- This endpoint internally calls the Put endpoint with an empty DTO to clear the message.\n\n\n**Tags:**Warnings, Case Management, Alerts, Delete", "auth": null, "body": null } } ], "request": null }, { "name": "Cases: Miscellaneous Sales", "description": null, "item": [ { "name": "Post Case Sale", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/MiscSale/Case", "host": [ "{{baseUrl}}" ], "path": [ "v2", "MiscSale", "Case" ], "query": null, "variable": null }, "description": "Creates a new miscellaneous sale associated with a case, including details from the case.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } } ], "request": null }, { "name": "Cases: New Call", "description": null, "item": [ { "name": "Create New Call Designer", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/NewCall/Designer", "host": [ "{{baseUrl}}" ], "path": [ "v2", "NewCall", "Designer" ], "query": null, "variable": null }, "description": "Creates a new call designer configuration for the specified company and need type after ensuring no duplicate exists.\n\n**Usage Notes:**\n\n- Ensures the DTO\u0027s Company ID matches the request header.\n- Prevents duplicate need-type designers for a company.\n\n\n**Tags:**NewCall, Designer", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get New Call Designer", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/NewCall/Designer/:newCallDesignerId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "NewCall", "Designer", ":newCallDesignerId" ], "query": null, "variable": [ { "key": "newCallDesignerId", "value": "\u003CnewCallDesignerId\u003E", "type": "string" } ] }, "description": "Retrieves a single new call designer definition by its identifier, including the readable need type.\n\n**Tags:**NewCall, Designer", "auth": null, "body": null } }, { "name": "Update New Call Designer", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/NewCall/Designer/:newCallDesignerId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "NewCall", "Designer", ":newCallDesignerId" ], "query": null, "variable": [ { "key": "newCallDesignerId", "value": "\u003CnewCallDesignerId\u003E", "type": "string" } ] }, "description": "Updates an existing new call designer definition including its page data and active status.\n\n**Tags:**NewCall, Designer", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete New Call Designer", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/NewCall/Designer/:newCallDesignerId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "NewCall", "Designer", ":newCallDesignerId" ], "query": null, "variable": [ { "key": "newCallDesignerId", "value": "\u003CnewCallDesignerId\u003E", "type": "string" } ] }, "description": "Delete a New Call Designer for Company Id and New Call Designer Id specified in request.", "auth": null, "body": null } }, { "name": "Get New Call Designer by Need Type", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/NewCall/DesignerByNeedType/:needTypeId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "NewCall", "DesignerByNeedType", ":needTypeId" ], "query": null, "variable": [ { "key": "needTypeId", "value": "\u003CneedTypeId\u003E", "type": "string" } ] }, "description": "Retrieves a new call designer configuration for the specified company and need type.\n Used by the Create New Call form to determine if a custom flow exists.\n\n**Tags:**NewCall, Designer", "auth": null, "body": null } }, { "name": "Get New Call Designers", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/NewCall/Designers", "host": [ "{{baseUrl}}" ], "path": [ "v2", "NewCall", "Designers" ], "query": null, "variable": null }, "description": "Retrieves all new call designer configurations for the specified company, including need type names.\n\n**Usage Notes:**\n\n- Need type names are populated manually because they originate from Advisor Master.\n- Results are sorted alphabetically by need type for UI convenience.\n\n\n**Tags:**NewCall, Designer", "auth": null, "body": null } } ], "request": null }, { "name": "Cases: Notes", "description": null, "item": [ { "name": "Get Aggregated Case Notes", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/CaseNotes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "CaseNotes" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves all notes associated with a case from multiple sources: call fields,\n note table, events, cemetery plots, crematory info, embalming info, persons on case,\n and product notes. This mirrors the SCV1 usp_CaseNotes stored procedure behavior.\n\n**Tags:**Notes, Case Management, Documentation", "auth": null, "body": null } }, { "name": "Get Call Embalming Notes", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/EmbalmingNotes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "EmbalmingNotes" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves embalming notes associated with a specific case (call). This includes pre-embalming,\n embalming, and post-embalming notes that document the preparation process. These notes are\n critical for tracking embalmer procedures, conditions, and special circumstances.\n\n**Usage Notes:**\n\n- Embalming notes are stored on the decedent person record, not the call itself.\n- If no embalming information has been recorded, the endpoint returns empty strings for all note fields.\n- Pre-embalming notes document observations before the embalming process begins.\n- Embalming notes record procedures, chemicals used, and conditions during the process.\n- Post-embalming notes capture the final results and any special care instructions.\n- These notes are typically used by embalmers and preparation staff for documentation and compliance.\n\n\n**Tags:**Embalming, Notes, Case Management, Preparation", "auth": null, "body": null } }, { "name": "Create Call Note", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Note", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Note" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Creates a new note associated with a specific case (call). Notes are used to document\n important information, communications, and observations related to the case throughout\n the arrangement process.\n\n**Usage Notes:**\n\n- Notes are created with the \u0022Call\u0022 note type automatically assigned.\n- The note is marked as active upon creation.\n- ArrangerOnly flag is set to false by default, making the note visible to all authorized users.\n- The current user and timestamp are automatically captured for audit purposes.\n\n\n**Tags:**Notes, Case Management, Documentation", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Call Note", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Note/:noteId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Note", ":noteId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "noteId", "value": "\u003CnoteId\u003E", "type": "string" } ] }, "description": "Updates an existing note associated with a specific case (call). This endpoint allows\n modification of note content and metadata while maintaining audit trails and ensuring\n only active call notes can be modified.\n\n**Usage Notes:**\n\n- Only active notes can be updated; inactive notes will throw an exception.\n- The note must be of type \u0022Call\u0022 to be updated through this endpoint.\n- Modification timestamp and user information are automatically updated.\n- All validations are performed before any changes are persisted.\n\n\n**Tags:**Notes, Case Management, Update, Documentation", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Call Note", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Note/:noteId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Note", ":noteId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "noteId", "value": "\u003CnoteId\u003E", "type": "string" } ] }, "description": "Performs a soft delete on an existing call note by marking it as inactive.\n This endpoint ensures notes are never permanently removed from the system,\n maintaining data integrity and audit trails for compliance purposes.\n\n**Usage Notes:**\n\n- This is a soft delete operation; the note remains in the database but is marked as inactive.\n- Inactive notes will not appear in standard note retrieval operations.\n- The note must be of type \u0022Call\u0022 to be deleted through this endpoint.\n- The operation is idempotent; deleting an already inactive note will succeed without error.\n\n\n**Tags:**Notes, Case Management, Delete, Soft Delete", "auth": null, "body": null } }, { "name": "Get Call Notes", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Notes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Notes" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves all active notes associated with a specific case (call). Notes include\n documentation of communications, observations, and important case-related information.\n User information is enriched to display the names of users who modified each note.\n\n**Usage Notes:**\n\n- Only active notes are returned; soft-deleted notes are excluded.\n- Results are ordered by last modification date, creation date, and note ID.\n- Modified by names are enriched from the AdvisorUsers table using first/last name or username.\n- Notes without a modification timestamp use the creation date as the last modified date.\n- Notes without a modifier are labeled \u0022N/A\u0022 in the ModifiedByName field.\n\n\n**Tags:**Notes, Case Management, Documentation", "auth": null, "body": null } }, { "name": "Get Notes Printout Overview", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/NotesPrintoutOverview", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "NotesPrintoutOverview" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves an overview of case information specifically formatted for notes printouts.\n This endpoint provides essential case details including decedent information, dates,\n personnel, and system metadata optimized for printed case documentation.\n\n**Usage Notes:**\n\n- This endpoint is specifically designed for generating printed case notes documentation.\n- Includes decedent name in reversed format (Last, First) for formal documentation.\n- Provides dates of birth and death when available from biographical information.\n- Includes director name, family care advisor, and recorder information.\n- Shows the contract sale date and source system for audit purposes.\n- Identifies the informant from the people associated with the case.\n- The output format is optimized for header information on printed case notes.\n\n\n**Tags:**Notes, Case Management, Printout, Overview, Documentation", "auth": null, "body": null } }, { "name": "Get Call Product Notes", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/ProductNotes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "ProductNotes" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves all product-specific notes associated with a specific case (call). Product notes\n capture special instructions, customizations, or important details about items, packages,\n and adjustments selected on the contract.\n\n**Usage Notes:**\n\n- Only contract details with non-empty notes are included in the results.\n- Product notes can apply to items (caskets, urns, services), packages, or adjustments.\n- The item name is resolved from the location-specific item name first, falling back to the master item name.\n- For adjustments, the adjustment type name is used instead of an item name.\n- For packages, the package name is used.\n- These notes are typically used for special engraving instructions, customizations, or handling requirements.\n\n\n**Tags:**Products, Notes, Case Management, Contract Details", "auth": null, "body": null } } ], "request": null }, { "name": "Cases: Obituary", "description": null, "item": [ { "name": "Get Obituary", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Obituary/:callId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Obituary", ":callId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves an obituary based on the specified call ID and company ID. The returned obituary is filtered for active status and sorted by chosen and family approval status.", "auth": null, "body": null } }, { "name": "Put Obituary", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Obituary/:callId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Obituary", ":callId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Updates an existing obituary or creates a new one if none exists. Only modifies active obituaries, marks the updated one as chosen, and updates others as unchosen.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Obituary", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Obituary/:callId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Obituary", ":callId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Deactivates all active obituaries for the specified call. Does not permanently delete but sets the active status to false.", "auth": null, "body": null } }, { "name": "Generate Obituary from Call", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Obituary/:callId/Generate", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Obituary", ":callId", "Generate" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Generates an obituary based on details from the specified call. Retrieves the prompt for the call and generates the obituary text accordingly.", "auth": null, "body": null } }, { "name": "Generate Prompt from Call", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Obituary/:callId/Generate/Prompt", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Obituary", ":callId", "Generate", "Prompt" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Generates a prompt for obituary generation based on the specified call details. Returns the prompt text in a DTO.", "auth": null, "body": null } }, { "name": "Submit Obituary to CFS", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Obituary/:callId/Submit/CFS", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Obituary", ":callId", "Submit", "CFS" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Submits the obituary and associated event information to the CFS platform. Includes handling of profile picture attachments.", "auth": null, "body": null } }, { "name": "Submit Obituary to FuneralTech", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Obituary/:callId/Submit/FuneralTech", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Obituary", ":callId", "Submit", "FuneralTech" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Submits the obituary information and related details to the FuneralTech platform. Includes handling of event types and profile picture attachments.", "auth": null, "body": null } }, { "name": "Generate Obituary from Prompt", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Obituary/Generate", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Obituary", "Generate" ], "query": null, "variable": null }, "description": "Generates an obituary based on the provided prompt and optionally the original obituary text. Returns the generated text in a DTO.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Obituary Template", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Obituary/Template/:obituaryTemplateId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Obituary", "Template", ":obituaryTemplateId" ], "query": null, "variable": [ { "key": "obituaryTemplateId", "value": "\u003CobituaryTemplateId\u003E", "type": "string" } ] }, "description": "Retrieves the specified obituary template for the given company. The template is returned as a DTO if found.", "auth": null, "body": null } }, { "name": "Get Processed Obituary", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Obituary/Template/:obituaryTemplateId/GetProcessedObituary/:callId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Obituary", "Template", ":obituaryTemplateId", "GetProcessedObituary", ":callId" ], "query": null, "variable": [ { "key": "obituaryTemplateId", "value": "\u003CobituaryTemplateId\u003E", "type": "string" }, { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves and processes the obituary template with details from the specified call. Replaces placeholders in the template with actual data from the call and obituary info.", "auth": null, "body": null } } ], "request": null }, { "name": "Cases: Payments", "description": null, "item": [ { "name": "Get Anticipated Payments for Case", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/AnticipatedPayments", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "AnticipatedPayments" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves all anticipated (expected) payments for a case. Anticipated payments represent payment commitments\n or expected payment sources that have not yet been received. These are tracked separately from actual payments\n and can be converted to actual payments when received.\n\n**Usage Notes:**\n\n- Anticipated payments are tracked in the ContractPaymentSources table.\n- Each anticipated payment includes amount, payer information, and notes.\n- Payer information can be either a person or a third-party organization (e.g., insurance company).\n- Returns payments for all contracts associated with the case.\n- When an anticipated payment is converted to an actual payment, it is removed from this list.\n- Results include ModifiedBy user display names for audit tracking.\n\n\n**Tags:**Payment Management, Anticipated Payments, Payment Sources, Financial Planning", "auth": null, "body": null } }, { "name": "Create Anticipated Payment", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/AnticipatedPayments", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "AnticipatedPayments" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Creates a new anticipated (expected) payment for a case. Anticipated payments are used to track expected\n payment sources such as insurance claims, installment payments, or other promised payments that have not\n yet been received. These can later be converted to actual payments when the funds are received.\n\n**Usage Notes:**\n\n- The CoId (company ID) is automatically set to the value from the header.\n- Payer can be either a Person or a ThirdPartyOrganization (e.g., insurance company).\n- The anticipated payment is associated with a specific contract via ContractId.\n- Can include notes to track additional information about the expected payment.\n- When the actual payment is received, use the AddPayment endpoint and reference the ContractPaymentSourceId.\n- The anticipated payment will be automatically deleted when converted to an actual payment.\n\n\n**Tags:**Payment Management, Anticipated Payments, Payment Creation, Financial Planning", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Anticipated Payment", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/AnticipatedPayments/:paymentId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "AnticipatedPayments", ":paymentId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "paymentId", "value": "\u003CpaymentId\u003E", "type": "string" } ] }, "description": "Permanently deletes an anticipated (expected) payment from a case. This is a hard delete operation that\n completely removes the payment source record from the database. Use this when an anticipated payment\n is no longer expected or was entered in error.\n\n**Usage Notes:**\n\n- This is a permanent deletion - the anticipated payment is completely removed from the database.\n- Throws an exception if the case is not found.\n- Throws an exception if the anticipated payment ID is invalid.\n- Use this when the anticipated payment is no longer expected or was added in error.\n- If converting an anticipated payment to an actual payment, use AddPayment instead - it will automatically delete the anticipated payment.\n\n\n**Tags:**Payment Management, Anticipated Payments, Deletion, Payment Removal", "auth": null, "body": null } }, { "name": "Add Arranger History", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/ArrangerHistory", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "ArrangerHistory" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Adds Arranger History matching Call Id in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Case Payments", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Payments", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Payments" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves all payments recorded for a case, including payment details, payer information, payment types,\n and export status. This endpoint returns comprehensive payment data including transaction information,\n QuickBooks integration status, PayPal payment links, and TSYS credit card processing details.\n\n**Usage Notes:**\n\n- Returns all payments including active and inactive (deleted) payments.\n- Each payment includes payment type, amount, check number, payment date, and payer information.\n- Payer information can be either a person or a third-party organization.\n- Includes export tracking with DateExported and ExportedBy for accounting integration.\n- Includes DateImported for payments imported from external sources like QuickBooks.\n- Indicates TSYS credit card transactions with IsTsys flag based on Tsysresponse data.\n- Tracks PayPal payments through PaymentPayPalPaymentLinks.\n- Returns ModifiedBy and ExportedBy user display names for audit tracking.\n\n\n**Tags:**Payment Management, Payments, Financial Transactions, Accounting", "auth": null, "body": null } }, { "name": "Add Payment (Record Received Payment)", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Payments", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Payments" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Records a new payment received for a case. This endpoint creates an actual payment record to track funds\n received from clients, insurance companies, or other payers. If the payment is associated with an anticipated\n payment, the anticipated payment will be automatically removed when the actual payment is recorded.\n\n**Usage Notes:**\n\n- If ContractPaymentSourceId is provided, the corresponding anticipated payment is automatically deleted.\n- The payment is assigned a transaction number for tracking within the case.\n- Payer can be either a Person or a ThirdPartyOrganization (e.g., insurance company).\n- Payment types include cash, check, credit card, insurance, etc.\n- Include check number for check payments for tracking and reconciliation.\n- Payments can be soft-deleted later using the DeletePayment endpoint if needed.\n\n\n**Tags:**Payment Management, Payments, Payment Recording, Financial Transactions", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Payment (Soft Delete with Reason)", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Payments/:paymentId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Payments", ":paymentId" ], "query": [ { "key": "deleteReason", "value": "\u003CdeleteReason\u003E", "description": "The reason for deleting the payment, provided as a query string parameter.\r\nThis is a required field and must not be empty or whitespace.\r\nThe reason will be appended to the payment notes with a \u0022Deleted Reason:\u0022 prefix.", "disabled": true } ], "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "paymentId", "value": "\u003CpaymentId\u003E", "type": "string" } ] }, "description": "Soft-deletes a payment by marking it as inactive and recording the deletion reason. This operation does not\n permanently remove the payment from the database but instead flags it as deleted while preserving the payment\n record for audit purposes. The deletion reason is appended to the payment notes for tracking.\n\n**Usage Notes:**\n\n- This is a soft delete - the payment record is retained but marked as inactive (Active = false).\n- The delete reason is required and must not be empty or whitespace.\n- The delete reason is appended to the existing payment notes with \u0022Deleted Reason:\u0022 prefix.\n- Throws an exception if the case is not found.\n- Throws an exception if the payment ID is invalid.\n- Deleted payments will still appear in payment queries but can be filtered using the Active flag.\n- Use this for correcting errors or voiding payments - the audit trail is preserved.\n\n\n**Tags:**Payment Management, Payments, Deletion, Soft Delete, Audit Trail", "auth": null, "body": null } }, { "name": "Saves Arrangement Completion", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/Arrangement/Completion", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", "Arrangement", "Completion" ], "query": null, "variable": null }, "description": "Updates Call Status to Arrangement Complete.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Invoice Payments from Trade Firms", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Payments/Invoice", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Payments", "Invoice" ], "query": null, "variable": null }, "description": "Retrieves invoice payments made by trade firms (suppliers/vendors) on behalf of cases. These payments represent\n credits or advances from suppliers like casket manufacturers or vault companies. Returns payments with calculated\n remaining balances based on how much has been applied to actual case payments. Only includes recent payments\n (last 6 years) or payments with remaining balances.\n\n**Usage Notes:**\n\n- Requires ManageInvoicePayments permission for the specified funeral home.\n- AmountRemaining is calculated as: Amount - Sum(applied case payments).\n- Only returns payments from the last 6 years OR payments with remaining balance \u003E 0.\n- Trade firms are suppliers/vendors (casket companies, vault companies, etc.).\n- Invoice payments can be applied to multiple case payments until fully used.\n- Used to track supplier credits and advances applied to customer cases.\n- Includes payment type, check number, and payment date information.\n\n\n**Tags:**Payments, Invoice Payments, Trade Firms, Vendor Credits", "auth": null, "body": null } }, { "name": "Add Invoice Payment from Trade Firm", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Payments/Invoice", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Payments", "Invoice" ], "query": null, "variable": null }, "description": "Records a new invoice payment received from a trade firm (supplier/vendor). Invoice payments represent credits\n or advances from suppliers that can be applied to case payments. Common scenarios include casket manufacturer\n credits, vault company advances, or promotional allowances from suppliers.\n\n**Usage Notes:**\n\n- Requires ManageInvoicePayments permission for the specified funeral home.\n- The invoice payment is automatically set to Active = true.\n- CoId is automatically set from the header parameter.\n- TradeFirmLocationId must reference a valid trade firm/supplier location.\n- The full amount is available for application to case payments initially.\n- Can be applied to multiple case payments until fully consumed.\n- Common payment types: Check, ACH, Credit, Promotional Allowance.\n- Used to track supplier credits applied to reduce customer balances.\n\n\n**Tags:**Payments, Invoice Payments, Trade Firms, Vendor Credits", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Invoice Payment By ID", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Payments/Invoice/:invoicePaymentId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Payments", "Invoice", ":invoicePaymentId" ], "query": null, "variable": [ { "key": "invoicePaymentId", "value": "\u003CinvoicePaymentId\u003E", "type": "string" } ] }, "description": "Retrieves the invoice payment details including payment type, trade firm location, and amount remaining. Requires permission to manage invoice payments.", "auth": null, "body": null } }, { "name": "Invoice Payment Outstanding Balances", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Payments/Invoice/:invoicePaymentId/Calls", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Payments", "Invoice", ":invoicePaymentId", "Calls" ], "query": null, "variable": [ { "key": "invoicePaymentId", "value": "\u003CinvoicePaymentId\u003E", "type": "string" } ] }, "description": "Returns list of Invoice Payment Outstanding Balances matching Invoice Payment Id in request.", "auth": null, "body": null } }, { "name": "Invoice Payment Payments", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Payments/Invoice/:invoicePaymentId/Payments", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Payments", "Invoice", ":invoicePaymentId", "Payments" ], "query": null, "variable": [ { "key": "invoicePaymentId", "value": "\u003CinvoicePaymentId\u003E", "type": "string" } ] }, "description": "Returns list of Invoice Payment Payments matching Invoice Payment Id in request.", "auth": null, "body": null } }, { "name": "Adds a Payment to an Invoice Payment", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Payments/Invoice/:invoicePaymentId/Payments", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Payments", "Invoice", ":invoicePaymentId", "Payments" ], "query": null, "variable": [ { "key": "invoicePaymentId", "value": "\u003CinvoicePaymentId\u003E", "type": "string" } ] }, "description": "Adds a Payment to an Invoice Payment matching Invoice Payment Id in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } } ], "request": null }, { "name": "Cases: People", "description": null, "item": [ { "name": "Get Person ID by Full Name", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/GetPersonByFullName/:customerName", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "GetPersonByFullName", ":customerName" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "customerName", "value": "\u003CcustomerName\u003E", "type": "string" } ] }, "description": "Searches for a person by their full name and returns their person ID. This endpoint performs\n a case-insensitive search and is typically used for person lookup operations during case\n management workflows when only the person\u0027s name is known.\n\n**Usage Notes:**\n\n- The search is case-insensitive using CurrentCultureIgnoreCase comparison.\n- The search matches against the Person.FullName computed field, not individual name components.\n- Only the first matching person is returned; if multiple people have the same name, only one is returned.\n- The call ID parameter is currently not used in filtering but is part of the route for consistency.\n- This endpoint is useful for linking existing persons to cases or events.\n- An exception is thrown if no matching person is found, rather than returning null or 404.\n\n\n**Tags:**People, Case Management, Person Search, Lookup", "auth": null, "body": null } }, { "name": "Case People", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/PeopleOnCase", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "PeopleOnCase" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Returns People associated with a Case for the Call Id specified in request.", "auth": null, "body": null } }, { "name": "Add Person to Case", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Person", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Person" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Creates a new person record and associates them with a specific case (call). This endpoint\n is used to add family members, friends, clergy, or other individuals connected to the case.\n The person is created with specified roles and biographical information.\n\n**Usage Notes:**\n\n- All newly created persons are marked with \u0022Unreviewed\u0022 status for data quality purposes.\n- The person is marked as active upon creation.\n- A PersonTypeId must be provided to establish the person\u0027s relationship to the case (e.g., spouse, child, clergy).\n- If PersonTypeId is not provided, the person is assigned the \u0022Unspecified\u0022 role.\n- AutomaticRoles can be specified to assign multiple roles simultaneously (e.g., informant and next-of-kin).\n- The DoNotContact flag prevents automated communications to this person.\n- The IncludeInObituary flag determines whether the person appears in published obituaries.\n- Organizations can be created by setting IsOrganization to true.\n- Email addresses and phone numbers are optional and can be marked as \u0022not provided\u0022 with appropriate flags.\n\n\n**Tags:**People, Case Management, Person Creation", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove Person from Case", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Person/:personId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Person", ":personId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "personId", "value": "\u003CpersonId\u003E", "type": "string" } ] }, "description": "Permanently removes a person and their associated roles from a specific case (call). This is\n a hard delete operation that removes the person record entirely from the database. Use this\n endpoint with caution as the deletion cannot be undone.\n\n**Usage Notes:**\n\n- This is a permanent hard delete operation; the person record is completely removed from the database.\n- All PersonPersonType associations for the person and call are removed first.\n- The person record itself is then deleted from the People table.\n- This operation cannot be undone; consider carefully before deleting.\n- If the person is associated with other cases, only their association with this specific case is removed.\n- Use this endpoint only when a person was added in error or is no longer relevant to the case.\n\n\n**Tags:**People, Case Management, Delete, Hard Delete", "auth": null, "body": null } }, { "name": "Get Person Details for Editing", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Person/:personId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Person", ":personId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "personId", "value": "\u003CpersonId\u003E", "type": "string" } ] }, "description": "Retrieves comprehensive information about a specific person associated with a case, formatted\n for editing purposes. This includes personal information, address, contact details, SSN (decrypted),\n relationship to the case, and assigned case roles.\n\n**Usage Notes:**\n\n- The person\u0027s SSN is decrypted from storage before being returned.\n- Address information is included with related county data when available.\n- PersonTypeId represents the person\u0027s primary relationship to the decedent (e.g., spouse, child, friend).\n- CaseRoles is an array of role IDs representing functional roles on the case (e.g., informant, next-of-kin, clergy).\n- Only roles marked as IsRelationship are considered for PersonTypeId.\n- Only roles marked as IsCaseRole or IsParticipantRole are included in the CaseRoles array.\n- This endpoint is typically used to populate edit forms in the user interface.\n\n\n**Tags:**People, Case Management, Person Details, Edit", "auth": null, "body": null } }, { "name": "Update Person Information (Partial)", "description": null, "item": null, "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Person/:personId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Person", ":personId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "personId", "value": "\u003CpersonId\u003E", "type": "string" } ] }, "description": "Performs a partial update on a person\u0027s information using JSON Patch operations. This endpoint\n supports updating personal details, relationship type, case roles, and special handling for\n parent biographical information. SSN values are automatically encrypted when updated.\n\n**Usage Notes:**\n\n- Uses JSON Patch (RFC 6902) for partial updates; only specified fields are modified.\n- SSN values are automatically encrypted before saving when the Ssn field is patched.\n- Updating PersonTypeId changes the person\u0027s relationship role (e.g., spouse, child, friend).\n- Updating CaseRoles modifies the person\u0027s functional roles on the case (e.g., informant, next-of-kin).\n- When PersonTypeId is set to Father or Mother, birth location is copied to the decedent\u0027s biographical info.\n- The endpoint automatically manages PersonPersonType associations when roles change.\n- If no CaseRoles are provided, all existing case roles are removed.\n- The SynchronizeUnspecifiedPersonType method is called after save to clean up orphaned \u0022Unspecified\u0022 roles.\n- Model validation is performed after applying the patch; invalid data returns a 400 error with details.\n\n\n**Tags:**People, Case Management, Update, PATCH, JSON Patch", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Person Address (Partial)", "description": null, "item": null, "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Person/:personId/Address", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Person", ":personId", "Address" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "personId", "value": "\u003CpersonId\u003E", "type": "string" } ] }, "description": "Performs a partial update on a person\u0027s address using JSON Patch operations. If the person\n doesn\u0027t have an address, a new address record is created. County information is automatically\n resolved and linked based on the provided county name.\n\n**Usage Notes:**\n\n- Uses JSON Patch (RFC 6902) for partial updates; only specified fields are modified.\n- If the person doesn\u0027t have an existing address, a new address record is automatically created.\n- The address is marked as active and associated with the company upon creation.\n- County information is automatically resolved and linked based on the county name provided in the patch.\n- Model validation is performed after applying the patch; invalid data returns a 400 error with details.\n- The person record is automatically linked to the new address if one is created.\n- Address fields include street, city, state, ZIP code, county, and country.\n\n\n**Tags:**People, Address, Case Management, Update, PATCH, JSON Patch", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Mark all Call Attachments as not a Profile Picture", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/ProfilePicture", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "ProfilePicture" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Updates all Call Attachment for the Call Id specified in request to not be Profile Pictures.", "auth": null, "body": null } } ], "request": null }, { "name": "Cases: QR", "description": null, "item": [ { "name": "Gets or creates a QR token for a case. Used by the PeopleQR PageBuilder component.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/QrToken", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "QrToken" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Gets or creates a QR token for a case. Used by the PeopleQR PageBuilder component.", "auth": null, "body": null } } ], "request": null }, { "name": "Cases: QuickBooks", "description": null, "item": [ { "name": "Retrieves all QuickBooks payments that have not yet been marked as imported.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Payments/QuickbooksImportPayments", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Payments", "QuickbooksImportPayments" ], "query": [ { "key": "realmId", "value": "\u003CrealmId\u003E", "description": null, "disabled": true } ], "variable": null }, "description": "This endpoint is typically used by integration services to identify which QuickBooks\n payments need to be processed and marked as imported.", "auth": null, "body": null } }, { "name": "Updates the import status of a specific QuickBooks payment by setting its DateImported to the current UTC time.", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Payments/UpdateQuickbooksPaymentImport/:paymentId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Payments", "UpdateQuickbooksPaymentImport", ":paymentId" ], "query": null, "variable": [ { "key": "paymentId", "value": "\u003CpaymentId\u003E", "type": "string" } ] }, "description": "This endpoint is typically called after a successful import operation to prevent duplicate processing\n of the same QuickBooks payment record.", "auth": null, "body": null } } ], "request": null }, { "name": "Cases: Services", "description": null, "item": [ { "name": "Get Available Deductions for Case", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/AvailableDeductions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "AvailableDeductions" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves all available deduction items that can be applied to a case\u0027s contract. Deductions are special\n items that reduce the total contract price, such as discounts, credits, trade allowances, or package\n deductions. Only active, non-discontinued deduction items from the case\u0027s location are returned.\n\n**Usage Notes:**\n\n- Returns only items with MasterItemTypeId = Deduction.\n- Filters to include only active items (both location item and master item must be active).\n- Only includes items with ItemStatus of Active or Modified.\n- Each deduction includes item name, description, cost, price, and GL code information.\n- Deductions appear as negative amounts when applied to contracts.\n- Common deduction types include trade-ins, package allowances, and promotional discounts.\n- The Taxable flag indicates whether the deduction affects taxable amounts.\n\n\n**Tags:**Deductions, Discounts, Contract Adjustments, Pricing", "auth": null, "body": null } }, { "name": "Get Available Service Selections for Case", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Selection/Services", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Selection", "Services" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves all available professional service items (excluding gatherings) that can be added to a case\u0027s contract.\n This endpoint returns items based on the case\u0027s location and disposition, filtering out inactive, discontinued,\n or incompatible items. Items already on the contract are included with their contract detail information.\n\n**Usage Notes:**\n\n- Returns only professional service items (IsProfessionalService = true), excluding gatherings.\n- Items already on any contract for the case are included with ContractDetailId and quantity/price information.\n- Filters out inactive items, discontinued items, and items with incompatible disposition categories.\n- Disposition filtering ensures only appropriate items for burial/cremation/both are shown.\n- Results are sorted by item type sort order, then display order, then item name.\n- Includes pricing tier information for trade/wholesale pricing.\n- Single-select items and variable-price items are flagged in the response.\n- Ad-hoc items (custom items) are identified with the IsAdHoc flag.\n\n\n**Tags:**Service Selection, Professional Services, Contract Items, Item Catalog", "auth": null, "body": null } }, { "name": "Get Available Service Selections for Specific Contract", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Call/:callId/Selection/Services/:contractId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Call", ":callId", "Selection", "Services", ":contractId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "contractId", "value": "\u003CcontractId\u003E", "type": "string" } ] }, "description": "Retrieves available professional service items for a specific contract or addendum. This endpoint is similar\n to GetCallServiceSelection but filters items to show only those already on the specified contract or those\n available to add to that contract. Useful when working with addendums or specific contract versions.\n\n**Usage Notes:**\n\n- Returns only professional service items (IsProfessionalService = true), excluding gatherings.\n- Items already on the specified contract are included with ContractDetailId and quantity/price information.\n- Items from other contracts on the same case are NOT included in contract details.\n- Filters out inactive items, discontinued items, and items with incompatible disposition categories.\n- Useful for managing addendums or viewing contract-specific item selections.\n- Results are sorted by item type sort order, then display order, then item name.\n- Includes pricing tier information for trade/wholesale pricing.\n\n\n**Tags:**Service Selection, Professional Services, Contract Items, Addendums", "auth": null, "body": null } } ], "request": null }, { "name": "Cases: Summary Actions", "description": null, "item": [ { "name": "Gets all action configurations for a company.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/SummaryActions/:companyId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "SummaryActions", ":companyId" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" } ] }, "description": "Gets all action configurations for a company.", "auth": null, "body": null } }, { "name": "Updates an action configuration.", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/SummaryActions/:companyId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "SummaryActions", ":companyId" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" } ] }, "description": "Updates an action configuration.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Resets all actions to defaults for a company.", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/SummaryActions/:companyId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "SummaryActions", ":companyId" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" } ] }, "description": "Resets all actions to defaults for a company.", "auth": null, "body": null } }, { "name": "Gets only enabled actions for a company.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/SummaryActions/:companyId/enabled", "host": [ "{{baseUrl}}" ], "path": [ "v2", "SummaryActions", ":companyId", "enabled" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" } ] }, "description": "Gets only enabled actions for a company.", "auth": null, "body": null } }, { "name": "Reorders actions for a company.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/SummaryActions/:companyId/reorder", "host": [ "{{baseUrl}}" ], "path": [ "v2", "SummaryActions", ":companyId", "reorder" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" } ] }, "description": "Reorders actions for a company.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } } ], "request": null }, { "name": "Cases: Tasks", "description": null, "item": [ { "name": "Get Call Tasks", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Task/Call/:callId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Task", "Call", ":callId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "This method retrieves a list of tasks associated with a specific call ID and company ID.\n It performs permission checks to ensure the requesting user has the necessary rights to view the tasks.\n Sample patch document for HttpPatch methods is not applicable here.", "auth": null, "body": null } } ], "request": null }, { "name": "Cases: Vitals", "description": null, "item": [ { "name": "Case Vitals", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Vital/Call/:callId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Vital", "Call", ":callId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Returns Vitals associated a Case for Company Id specified in request.", "auth": null, "body": null } }, { "name": "Patch Vitals", "description": null, "item": null, "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Vital/Call/:callId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Vital", "Call", ":callId" ], "query": [ { "key": "suppressNotification", "value": "\u003CsuppressNotification\u003E", "description": "When true, skips the SignalR notification to the current user. Use only for auto-save\r\noperations where the edit originates from the same browser session (e.g., biography page).", "disabled": true } ], "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Patches Vitals matching Company Id and Call Id using Vitals patch payload specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Call Residence Location Id", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Vital/Call/:callId/GetLocationFromResidenceAddress", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Vital", "Call", ":callId", "GetLocationFromResidenceAddress" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Returns Residence Location Id (or null) matching Company Id and Call Id specified in request.", "auth": null, "body": null } }, { "name": "Get Residence Address", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Vital/Call/:callId/GetResidenceAddress", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Vital", "Call", ":callId", "GetResidenceAddress" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves the residence address of the deceased or purchaser associated with the specified call. Includes details such as the county.\n If no address is found, returns null.", "auth": null, "body": null } }, { "name": "Vital Page by Page Name", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Vital/Call/:callId/Page/:pageName", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Vital", "Call", ":callId", "Page", ":pageName" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" }, { "key": "pageName", "value": "\u003CpageName\u003E", "type": "string" } ] }, "description": "Returns Vital Page matching Company Id, Call Id and Page Name specified in request.", "auth": null, "body": null } }, { "name": "Vital Page Names", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Vital/Call/:callId/PageNames", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Vital", "Call", ":callId", "PageNames" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Returns list of Vital Page Names matching Company Id and Call Id specified in request.", "auth": null, "body": null } }, { "name": "Vital Pages", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Vital/Call/:callId/Pages", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Vital", "Call", ":callId", "Pages" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Returns list of Vital Pages matching Company Id and Call Id specified in request.", "auth": null, "body": null } }, { "name": "Post Requirements", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Vital/Call/:callId/PostRequirements", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Vital", "Call", ":callId", "PostRequirements" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Returns List of Post Requirements matching Company Id and Call Id specified in request.", "auth": null, "body": null } }, { "name": "Create a Custom Field", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Vital/CustomField", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Vital", "CustomField" ], "query": null, "variable": null }, "description": "Creates a Custom Field for Company Id and Funeral Home Id specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Case Custom Field", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Vital/CustomField/:customFieldId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Vital", "CustomField", ":customFieldId" ], "query": null, "variable": [ { "key": "customFieldId", "value": "\u003CcustomFieldId\u003E", "type": "string" } ] }, "description": "Updates a Custom Field matching Company Id and Custom Field Id in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a Custom Field", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Vital/CustomField/:customFieldId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Vital", "CustomField", ":customFieldId" ], "query": null, "variable": [ { "key": "customFieldId", "value": "\u003CcustomFieldId\u003E", "type": "string" } ] }, "description": "Deletes a Custom Field matching Company Id and Custom Field Id specified in request.", "auth": null, "body": null } }, { "name": "Custom Fields", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Vital/CustomFields", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Vital", "CustomFields" ], "query": null, "variable": null }, "description": "Returns list of Custom Fields matching Company Id specified in request.", "auth": null, "body": null } }, { "name": "Describe Vital DTO Fields", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Vital/DescribeVitals", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Vital", "DescribeVitals" ], "query": null, "variable": null }, "description": "Generates metadata and sample patch operations for every property on ,\n including display labels, group names, descriptions, and inferred data types.\n\n**Usage Notes:**\n\n- Introspects\u0060VitalDto\u0060with reflection and custom attributes.\n- Sample patch includes up to five representative field edits.\n- Helpful for API clients seeking dynamic form generation or documentation.\n\n\n**Tags:**Vitals, Metadata, Documentation", "auth": null, "body": null } }, { "name": "Create a Vital Field Flow", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Vital/FieldFlow", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Vital", "FieldFlow" ], "query": null, "variable": null }, "description": "Creates a Vital Field Flow for Company Id, Funeral Home and Vital Field Flow payload specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Vital Field Flow", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Vital/FieldFlow/:vitalFieldFlowId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Vital", "FieldFlow", ":vitalFieldFlowId" ], "query": null, "variable": [ { "key": "vitalFieldFlowId", "value": "\u003CvitalFieldFlowId\u003E", "type": "string" } ] }, "description": "Fetches the vital field flow based on the specified ID within the given company.\n The \u0060NeedType\u0060 is manually mapped from a different database (AdvisorMaster) because it cannot be automatically mapped by AutoMapper.", "auth": null, "body": null } }, { "name": "Update a Vital Field Flow", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Vital/FieldFlow/:vitalFieldFlowId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Vital", "FieldFlow", ":vitalFieldFlowId" ], "query": null, "variable": [ { "key": "vitalFieldFlowId", "value": "\u003CvitalFieldFlowId\u003E", "type": "string" } ] }, "description": "Updates a Vital Field Flow for Company Id, Funeral Home and Vital Field Flow Id/ payload specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a Vital Field Flow", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Vital/FieldFlow/:vitalFieldFlowId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Vital", "FieldFlow", ":vitalFieldFlowId" ], "query": null, "variable": [ { "key": "vitalFieldFlowId", "value": "\u003CvitalFieldFlowId\u003E", "type": "string" } ] }, "description": "Delete a Vital Field Flow for Company Id, Funeral Home and Vital Field Flow Id specified in request.", "auth": null, "body": null } }, { "name": "Vital Field Flows", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Vital/FieldFlows", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Vital", "FieldFlows" ], "query": null, "variable": null }, "description": "Returns list of Vital Field Flows matching Company Id in request", "auth": null, "body": null } }, { "name": "Validates whether the given page/section filter exists in all active vital field flows for the company.\n Returns a list of flow display names that are missing the specified page and/or section.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Vital/FieldFlows/ValidateFilter", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Vital", "FieldFlows", "ValidateFilter" ], "query": [ { "key": "pageName", "value": "\u003CpageName\u003E", "description": "The page name to check for.", "disabled": true }, { "key": "sectionName", "value": "\u003CsectionName\u003E", "description": "The section name to check for within the page.", "disabled": true } ], "variable": null }, "description": "Validates whether the given page/section filter exists in all active vital field flows for the company.\n Returns a list of flow display names that are missing the specified page and/or section.", "auth": null, "body": null } }, { "name": "Get Legacy Custom Field Names", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Vital/LegacyCustomFieldNames", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Vital", "LegacyCustomFieldNames" ], "query": null, "variable": null }, "description": "Retrieves custom field names for the specified company. If no custom field names are found, a new record is created and returned.", "auth": null, "body": null } }, { "name": "Update Legacy Custom Field Names", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Vital/LegacyCustomFieldNames", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Vital", "LegacyCustomFieldNames" ], "query": null, "variable": null }, "description": "Updates the legacy custom field names for the specified company.\n If no record exists, returns 404.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create a Master Field Flow", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Vital/MasterFieldFlow", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Vital", "MasterFieldFlow" ], "query": null, "variable": null }, "description": "Create a Master Field Flow for Master Field Flow payload specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Master Vital Flow", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Vital/MasterFieldFlow/:masterVitalFieldFlowId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Vital", "MasterFieldFlow", ":masterVitalFieldFlowId" ], "query": null, "variable": [ { "key": "masterVitalFieldFlowId", "value": "\u003CmasterVitalFieldFlowId\u003E", "type": "string" } ] }, "description": "Fetches the master vital field flow based on the specified ID from the AdvisorMaster database.", "auth": null, "body": null } }, { "name": "Update a Master Field Flow", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Vital/MasterFieldFlow/:masterVitalFieldFlowId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Vital", "MasterFieldFlow", ":masterVitalFieldFlowId" ], "query": null, "variable": [ { "key": "masterVitalFieldFlowId", "value": "\u003CmasterVitalFieldFlowId\u003E", "type": "string" } ] }, "description": "Update a Master Field Flow matching Master Field Flow Id/ payload specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a Master Field Flow", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Vital/MasterFieldFlow/:masterVitalFieldFlowId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Vital", "MasterFieldFlow", ":masterVitalFieldFlowId" ], "query": null, "variable": [ { "key": "masterVitalFieldFlowId", "value": "\u003CmasterVitalFieldFlowId\u003E", "type": "string" } ] }, "description": "Delete a Master Field Flow matching Master Field Flow Id specified in request.", "auth": null, "body": null } }, { "name": "Get Master Field Flow by Need Type", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Vital/MasterFieldFlowByNeedTypeId/:needTypeId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Vital", "MasterFieldFlowByNeedTypeId", ":needTypeId" ], "query": null, "variable": [ { "key": "needTypeId", "value": "\u003CneedTypeId\u003E", "type": "string" } ] }, "description": "Returns Master Field Flow matching Need Type Id specified in request.", "auth": null, "body": null } }, { "name": "Master Field Flows", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Vital/MasterFieldFlows", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Vital", "MasterFieldFlows" ], "query": null, "variable": null }, "description": "Returns list of Master Field Flows.", "auth": null, "body": null } }, { "name": "Create New Call Flow", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Vital/NewCallFlow", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Vital", "NewCallFlow" ], "query": null, "variable": null }, "description": "Creates a new call flow configuration for the specified company and need type after ensuring no duplicate exists.\n\n**Usage Notes:**\n\n- Ensures the DTO\u2019s Company ID matches the request header.\n- Prevents duplicate need-type flows for a company.\n\n\n**Tags:**Vitals, FieldFlows", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get New Call Flow", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Vital/NewCallFlow/:newCallFlowId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Vital", "NewCallFlow", ":newCallFlowId" ], "query": null, "variable": [ { "key": "newCallFlowId", "value": "\u003CnewCallFlowId\u003E", "type": "string" } ] }, "description": "Retrieves a single new call flow definition by its identifier, including the readable need type.\n\n**Tags:**Vitals, FieldFlows", "auth": null, "body": null } }, { "name": "Update New Call Flow", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Vital/NewCallFlow/:newCallFlowId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Vital", "NewCallFlow", ":newCallFlowId" ], "query": null, "variable": [ { "key": "newCallFlowId", "value": "\u003CnewCallFlowId\u003E", "type": "string" } ] }, "description": "Updates an existing new call flow definition for the company using the supplied DTO.\n\n**Tags:**Vitals, FieldFlows", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a New Call Flow", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Vital/NewCallFlow/:newCallFlowId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Vital", "NewCallFlow", ":newCallFlowId" ], "query": null, "variable": [ { "key": "newCallFlowId", "value": "\u003CnewCallFlowId\u003E", "type": "string" } ] }, "description": "Delete a New Call Flow for Company Id and New Call Flow Id specified in request.", "auth": null, "body": null } }, { "name": "Get New Call Flows", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Vital/NewCallFlows", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Vital", "NewCallFlows" ], "query": null, "variable": null }, "description": "Retrieves all new call flow configurations for the specified company, including need type names.\n\n**Usage Notes:**\n\n- Need type names are populated manually because they originate from Advisor Master.\n- Results are sorted alphabetically by need type for UI convenience.\n\n\n**Tags:**Vitals, FieldFlows", "auth": null, "body": null } }, { "name": "Stationary Fields", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/Vital/Stationery", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "Vital", "Stationery" ], "query": [ { "key": "callId", "value": "\u003CcallId\u003E", "description": "Call Id", "disabled": true } ], "variable": null }, "description": "Returns a List of Stationary Fields matching Company Id and Call Id specified in request.", "auth": null, "body": null } } ], "request": null }, { "name": "Cash Receipts", "description": null, "item": [ { "name": "Get Cash Receipts", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/CashReceipt", "host": [ "{{baseUrl}}" ], "path": [ "v2", "CashReceipt" ], "query": [ { "key": "startDate", "value": "\u003CstartDate\u003E", "description": "Start date for filtering receipts.", "disabled": true }, { "key": "endDate", "value": "\u003CendDate\u003E", "description": "End date for filtering receipts.", "disabled": true } ], "variable": null }, "description": "Retrieves a list of cash receipts for the specified company within the given date range, checking for necessary permissions.", "auth": null, "body": null } }, { "name": "Create Cash Receipt", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/CashReceipt", "host": [ "{{baseUrl}}" ], "path": [ "v2", "CashReceipt" ], "query": null, "variable": null }, "description": "Creates a new cash receipt for the specified company, ensuring the user has the necessary permissions.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Patch Cash Receipt", "description": null, "item": null, "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/CashReceipt/:receiptId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "CashReceipt", ":receiptId" ], "query": null, "variable": [ { "key": "receiptId", "value": "\u003CreceiptId\u003E", "type": "string" } ] }, "description": "Applies a patch to the specified cash receipt, ensuring the user has the necessary permissions.\n \n Sample Patch Document:\n {\n \u0022op\u0022: \u0022replace\u0022,\n \u0022path\u0022: \u0022/propertyName\u0022,\n \u0022value\u0022: \u0022newValue\u0022\n }", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } } ], "request": null }, { "name": "Catalog", "description": null, "item": [ { "name": "Get Catalog Items", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Categories/:fhid", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Categories", ":fhid" ], "query": null, "variable": [ { "key": "fhid", "value": "\u003Cfhid\u003E", "type": "string" } ] }, "description": "Returns a list of Catalog Items for the specified Funeral Home Id.", "auth": null, "body": null } }, { "name": "Clip Art Files", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/ClipArt", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "ClipArt" ], "query": null, "variable": null }, "description": "Returns list of clipart available in Engraving", "auth": null, "body": null } }, { "name": "Download Clip Art File", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/ClipArt/:fileName", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "ClipArt", ":fileName" ], "query": [ { "key": "width", "value": "\u003Cwidth\u003E", "description": "Optional width to resize the image to.", "disabled": true }, { "key": "height", "value": "\u003Cheight\u003E", "description": "Optional height to resize the image to.", "disabled": true }, { "key": "fit", "value": "\u003Cfit\u003E", "description": "Optional resize fit mode.", "disabled": true } ], "variable": [ { "key": "fileName", "value": "\u003CfileName\u003E", "type": "string" } ] }, "description": "Streams a clip art image from blob storage, with optional resizing parameters to optimize display.\n\n**Tags:**Catalog, Engraving", "auth": null, "body": null } }, { "name": "Download Font File", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Font/:fileName", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Font", ":fileName" ], "query": null, "variable": [ { "key": "fileName", "value": "\u003CfileName\u003E", "type": "string" } ] }, "description": "Streams an engraving font file from blob storage for client consumption.\n\n**Tags:**Catalog, Engraving", "auth": null, "body": null } }, { "name": "Engraving Fonts", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Fonts", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Fonts" ], "query": null, "variable": null }, "description": "Returns list of fonts available in Engraving", "auth": null, "body": null } }, { "name": "Integration Embeds", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Integration/:companyId/:embedKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Integration", ":companyId", ":embedKey" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" }, { "key": "embedKey", "value": "\u003CembedKey\u003E", "type": "string" } ] }, "description": "Returns Embeds for Integration", "auth": null, "body": null } }, { "name": "Get Integration Company Details", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Integration/:companyId/Company", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Integration", ":companyId", "Company" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" } ] }, "description": "Retrieves company details based on the provided company ID. The company details are projected to \u0060CompanyBaseDto\u0060 for response.\n If the company is not found, a \u0060NotFound\u0060 response is returned.", "auth": null, "body": null } }, { "name": "Patch an Embed", "description": null, "item": null, "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Integration/:embedKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Integration", ":embedKey" ], "query": null, "variable": [ { "key": "embedKey", "value": "\u003CembedKey\u003E", "type": "string" } ] }, "description": "Patch an Embed using Patch payload specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete an Embed", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Integration/:embedKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Integration", ":embedKey" ], "query": null, "variable": [ { "key": "embedKey", "value": "\u003CembedKey\u003E", "type": "string" } ] }, "description": "Deletes an Embed using Embed Key specified in request.", "auth": null, "body": null } }, { "name": "Family Links", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Integration/FamilyLinks", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Integration", "FamilyLinks" ], "query": null, "variable": null }, "description": "Returns a list of Embeds that are Family Links.", "auth": null, "body": null } }, { "name": "Create a Family Link", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Integration/FamilyLinks", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Integration", "FamilyLinks" ], "query": null, "variable": null }, "description": "Creates a new Embed for Family Links.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "My Websites", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Integration/MyWebsites", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Integration", "MyWebsites" ], "query": null, "variable": null }, "description": "Returns a list of Embeds that are My Websites.", "auth": null, "body": null } }, { "name": "My Websites", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Integration/MyWebsites", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Integration", "MyWebsites" ], "query": null, "variable": null }, "description": "Creates a new Embed for My Websites.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create Item", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item" ], "query": null, "variable": null }, "description": "Creates an Item using Item payload specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Catalog Search", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/:fhId/CatalogSearch", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", ":fhId", "CatalogSearch" ], "query": [ { "key": "keyword", "value": "\u003Ckeyword\u003E", "description": "Keyword", "disabled": true } ], "variable": [ { "key": "fhId", "value": "\u003CfhId\u003E", "type": "string" } ] }, "description": "Returns List of Catalog Items matching Funeral Home Id and Keyword specified in request.", "auth": null, "body": null } }, { "name": "Arrangement AddOns", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/:funeralHomeKey/GetArrangementAddOns/:callId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", ":funeralHomeKey", "GetArrangementAddOns", ":callId" ], "query": null, "variable": [ { "key": "funeralHomeKey", "value": "\u003CfuneralHomeKey\u003E", "type": "string" }, { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Returns list of Arrangement AddOns matching Funeral Home Key.", "auth": null, "body": null } }, { "name": "Catalog AddOns", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/:funeralHomeKey/GetCatalogAddOns", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", ":funeralHomeKey", "GetCatalogAddOns" ], "query": null, "variable": [ { "key": "funeralHomeKey", "value": "\u003CfuneralHomeKey\u003E", "type": "string" } ] }, "description": "Returns list of Catalog AddOns.", "auth": null, "body": null } }, { "name": "Get Item Details", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/:itemId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", ":itemId" ], "query": null, "variable": [ { "key": "itemId", "value": "\u003CitemId\u003E", "type": "string" } ] }, "description": "Retrieves details of an item based on the provided item ID. The item details are projected to \u0060ItemDto\u0060 for response.\n If the item is not found, a \u0060BadRequest\u0060 response is returned. The method also applies view permissions to the result.", "auth": null, "body": null } }, { "name": "Update Item", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/:itemId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", ":itemId" ], "query": null, "variable": [ { "key": "itemId", "value": "\u003CitemId\u003E", "type": "string" } ] }, "description": "Updates an Item matching Item Id and using Item payload specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Item Attributes", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/:itemId/Attributes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", ":itemId", "Attributes" ], "query": null, "variable": [ { "key": "itemId", "value": "\u003CitemId\u003E", "type": "string" } ] }, "description": "Returns a list of Item Attributes for the specified Item Id.", "auth": null, "body": null } }, { "name": "Update Item Attributes", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/:itemId/Attributes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", ":itemId", "Attributes" ], "query": null, "variable": [ { "key": "itemId", "value": "\u003CitemId\u003E", "type": "string" } ] }, "description": "Updates an Item\u0027s Atributes matching Item Id and using Item Attributes payload specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Location Item", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/:itemId/Location/:locationId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", ":itemId", "Location", ":locationId" ], "query": null, "variable": [ { "key": "itemId", "value": "\u003CitemId\u003E", "type": "string" }, { "key": "locationId", "value": "\u003ClocationId\u003E", "type": "string" } ] }, "description": "Returns a Location Item matching Item Id and Location Id.", "auth": null, "body": null } }, { "name": "Update Location Item", "description": null, "item": null, "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/:itemId/Location/:locationId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", ":itemId", "Location", ":locationId" ], "query": null, "variable": [ { "key": "itemId", "value": "\u003CitemId\u003E", "type": "string" }, { "key": "locationId", "value": "\u003ClocationId\u003E", "type": "string" } ] }, "description": "Updates a Location Item matching Item Id and Location Id using Location Item payload specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Location Item Call Type Codes", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/:itemId/Location/:locationId/CallTypeCodes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", ":itemId", "Location", ":locationId", "CallTypeCodes" ], "query": null, "variable": [ { "key": "itemId", "value": "\u003CitemId\u003E", "type": "string" }, { "key": "locationId", "value": "\u003ClocationId\u003E", "type": "string" } ] }, "description": "Returns a list of Location Item Call Type Codes matching Item Id and Location Id.", "auth": null, "body": null } }, { "name": "Update Location Item Call Type Codes", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/:itemId/Location/:locationId/CallTypeCodes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", ":itemId", "Location", ":locationId", "CallTypeCodes" ], "query": null, "variable": [ { "key": "itemId", "value": "\u003CitemId\u003E", "type": "string" }, { "key": "locationId", "value": "\u003ClocationId\u003E", "type": "string" } ] }, "description": "Updates a Location Item matching Item Id and Location Id using Location Item Call Types payload specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Item Case Search", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/:itemTypeId/Call/:callId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", ":itemTypeId", "Call", ":callId" ], "query": null, "variable": [ { "key": "itemTypeId", "value": "\u003CitemTypeId\u003E", "type": "string" }, { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Search for Items by Item Type Id and Call Id.", "auth": null, "body": null } }, { "name": "Item Miscellaenous Sale Search", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/:itemTypeId/MiscSale/:miscSaleId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", ":itemTypeId", "MiscSale", ":miscSaleId" ], "query": null, "variable": [ { "key": "itemTypeId", "value": "\u003CitemTypeId\u003E", "type": "string" }, { "key": "miscSaleId", "value": "\u003CmiscSaleId\u003E", "type": "string" } ] }, "description": "Search for Items by Item Type Id and Miscellaneous Sale Id", "auth": null, "body": null } }, { "name": "Batch Update Item Costs", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/Costs", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", "Costs" ], "query": null, "variable": null }, "description": "Batch Update Item Prices using Item Prices payload specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Items Matching Corners", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/GetMatchingCorners", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", "GetMatchingCorners" ], "query": [ { "key": "cornerGroup", "value": "\u003CcornerGroup\u003E", "description": "Corner Group", "disabled": true } ], "variable": null }, "description": "Returns list of Items Matching Corner Group.", "auth": null, "body": null } }, { "name": "Panel Items", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/GetPanels", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", "GetPanels" ], "query": null, "variable": null }, "description": "Returns list of Panel Items.", "auth": null, "body": null } }, { "name": "Items matching Item Name or Item Code", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/MatchingNameOrItemCode", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", "MatchingNameOrItemCode" ], "query": [ { "key": "newItemName", "value": "\u003CnewItemName\u003E", "description": "Item Name", "disabled": true }, { "key": "newItemCode", "value": "\u003CnewItemCode\u003E", "description": "Item Code", "disabled": true }, { "key": "locationId", "value": "\u003ClocationId\u003E", "description": "Location Id", "disabled": true }, { "key": "itemTypeId", "value": "\u003CitemTypeId\u003E", "description": "Item Type Id", "disabled": true } ], "variable": null }, "description": "Returns a list of Items with Location Item matching Item Name or Item Code.", "auth": null, "body": null } }, { "name": "Batch Update Item Prices", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/Prices", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", "Prices" ], "query": null, "variable": null }, "description": "Batch Update Item Prices using Item Prices payload specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Item Pricing", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/Pricing", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", "Pricing" ], "query": [ { "key": "locationId", "value": "\u003ClocationId\u003E", "description": null, "disabled": true }, { "key": "itemTypeId", "value": "\u003CitemTypeId\u003E", "description": "Item Type Id", "disabled": true }, { "key": "itemCode", "value": "\u003CitemCode\u003E", "description": "Item Code", "disabled": true }, { "key": "showroomId", "value": "\u003CshowroomId\u003E", "description": "Showroom Id", "disabled": true }, { "key": "status", "value": "\u003Cstatus\u003E", "description": null, "disabled": true }, { "key": "exteriorMaterialTypeId", "value": "\u003CexteriorMaterialTypeId\u003E", "description": "Exterior Material Id", "disabled": true }, { "key": "productCategoryId", "value": "\u003CproductCategoryId\u003E", "description": "Product Category Id", "disabled": true }, { "key": "manufacturerId", "value": "\u003CmanufacturerId\u003E", "description": "Manufacturer Id", "disabled": true }, { "key": "minCost", "value": "\u003CminCost\u003E", "description": "Minimum Cost", "disabled": true }, { "key": "maxCost", "value": "\u003CmaxCost\u003E", "description": "Maximum Cost", "disabled": true }, { "key": "minPrice", "value": "\u003CminPrice\u003E", "description": "Minimum Price", "disabled": true }, { "key": "maxPrice", "value": "\u003CmaxPrice\u003E", "description": "Maximum Price", "disabled": true }, { "key": "keyword", "value": "\u003Ckeyword\u003E", "description": "Keyword", "disabled": true }, { "key": "couchStyleId", "value": "\u003CcouchStyleId\u003E", "description": "Couch Style", "disabled": true } ], "variable": null }, "description": "Returns List of Item Pricing Data matching criteria specified in request.", "auth": null, "body": null } }, { "name": "Get Print Retail Pricing Data", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/Pricing/PrintRetailPricing", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", "Pricing", "PrintRetailPricing" ], "query": [ { "key": "locationId", "value": "\u003ClocationId\u003E", "description": null, "disabled": true }, { "key": "itemTypeId", "value": "\u003CitemTypeId\u003E", "description": null, "disabled": true }, { "key": "showroomId", "value": "\u003CshowroomId\u003E", "description": null, "disabled": true }, { "key": "exteriorMaterialTypeId", "value": "\u003CexteriorMaterialTypeId\u003E", "description": null, "disabled": true }, { "key": "productCategoryId", "value": "\u003CproductCategoryId\u003E", "description": null, "disabled": true }, { "key": "manufacturerId", "value": "\u003CmanufacturerId\u003E", "description": null, "disabled": true }, { "key": "minPrice", "value": "\u003CminPrice\u003E", "description": "Minimum price filter.", "disabled": true }, { "key": "maxPrice", "value": "\u003CmaxPrice\u003E", "description": "Maximum price filter.", "disabled": true }, { "key": "priceType", "value": "\u003CpriceType\u003E", "description": "Type of price to print (e.g., \u0022Wholesale\u0022).", "disabled": true } ], "variable": null }, "description": "Retrieves pricing data for items based on various filters, including item types, manufacturers, and price ranges.\n The results include information about funeral homes, scheduled price updates, and disclosure details.\n If \u0060showroomIds\u0060 is provided, it filters the results to include only those items associated with the specified showrooms.", "auth": null, "body": null } }, { "name": "Batch Create Item Scheduled Costs", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/ScheduledCosts", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", "ScheduledCosts" ], "query": null, "variable": null }, "description": "Batch Create Item Scheduled Costs using Item Scheduled Costs payload specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Batch Delete Item Scheduled Costs", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/ScheduledCosts", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", "ScheduledCosts" ], "query": null, "variable": null }, "description": "Batch Delete Item Scheduled Costs using Item Scheduled Costs payload specified in request.", "auth": null, "body": null } }, { "name": "Batch Update Item Scheduled Costs", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/ScheduledCosts", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", "ScheduledCosts" ], "query": null, "variable": null }, "description": "Batch Update Item Scheduled Costs using Item Scheduled Costs payload specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Batch Create Item Scheduled Prices", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/ScheduledPrices", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", "ScheduledPrices" ], "query": null, "variable": null }, "description": "Batch Create Item Scheduled Prices using Item Scheduled Prices payload specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Batch Delete Item Scheduled Prices", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/ScheduledPrices", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", "ScheduledPrices" ], "query": null, "variable": null }, "description": "Batch Delete Item Scheduled Prices using Item Scheduled Prices payload specified in request.", "auth": null, "body": null } }, { "name": "Batch Update Item Scheduled Prices", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/ScheduledPrices", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", "ScheduledPrices" ], "query": null, "variable": null }, "description": "Batch Update Item Scheduled Prices using Item Scheduled Prices payload specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Item Scheduled Visibilities for Effective Date", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/ScheduledVisibilities", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", "ScheduledVisibilities" ], "query": [ { "key": "effectiveDate", "value": "\u003CeffectiveDate\u003E", "description": "Effective Date", "disabled": true } ], "variable": null }, "description": "Returns a list of Location Item Scheduled Visibilities for the specified effective date.", "auth": null, "body": null } }, { "name": "Batch Create Item Scheduled Visibilities", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/ScheduledVisibilities", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", "ScheduledVisibilities" ], "query": null, "variable": null }, "description": "Batch Create Item Scheduled Visibilities using Item Scheduled Visibilities payload specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Batch Update Item Scheduled Visibilities", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/ScheduledVisibilities", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", "ScheduledVisibilities" ], "query": null, "variable": null }, "description": "Batch Update Item Scheduled Visibilities using Item Scheduled Visibilities payload specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Batch Delete Item Scheduled Visibilities", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/ScheduledVisibilities", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", "ScheduledVisibilities" ], "query": null, "variable": null }, "description": "Batch Delete Item Scheduled Visibilities using Item Scheduled Visibilities payload specified in request.", "auth": null, "body": null } }, { "name": "Item Scheduled Visibility Effective Dates", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/ScheduledVisibility/EffectiveDates", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", "ScheduledVisibility", "EffectiveDates" ], "query": null, "variable": null }, "description": "Returns a list of Item Scheduled Visibility Effective Dates.", "auth": null, "body": null } }, { "name": "Item Search", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/Search", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", "Search" ], "query": [ { "key": "isProduct", "value": "\u003CisProduct\u003E", "description": "Is Product?", "disabled": true }, { "key": "keyword", "value": "\u003Ckeyword\u003E", "description": "Keyword", "disabled": true }, { "key": "itemTypeId", "value": "\u003CitemTypeId\u003E", "description": "Item Type ID", "disabled": true }, { "key": "itemCode", "value": "\u003CitemCode\u003E", "description": "Item Code", "disabled": true }, { "key": "exteriorMaterialTypeId", "value": "\u003CexteriorMaterialTypeId\u003E", "description": "Exterial Material Type Id", "disabled": true }, { "key": "manufacturerId", "value": "\u003CmanufacturerId\u003E", "description": "Manufacturer Id", "disabled": true }, { "key": "status", "value": "\u003Cstatus\u003E", "description": null, "disabled": true }, { "key": "minCost", "value": "\u003CminCost\u003E", "description": "Minimum Cost", "disabled": true }, { "key": "maxCost", "value": "\u003CmaxCost\u003E", "description": "Maximum Cost", "disabled": true }, { "key": "minPrice", "value": "\u003CminPrice\u003E", "description": "Minimum Price", "disabled": true }, { "key": "maxPrice", "value": "\u003CmaxPrice\u003E", "description": "Maximum Price", "disabled": true } ], "variable": null }, "description": "Returns list of Item Search Results matching search criteria specified in request.", "auth": null, "body": null } }, { "name": "Item Services", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/Services", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", "Services" ], "query": null, "variable": null }, "description": "Returns list of Product Items.", "auth": null, "body": null } }, { "name": "Update Location Items Display Order", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/Services/:itemId/DisplayOrder", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", "Services", ":itemId", "DisplayOrder" ], "query": null, "variable": [ { "key": "itemId", "value": "\u003CitemId\u003E", "type": "string" } ] }, "description": "Updates Display Order of Location Items matching Item Id to Product Item payload Display Order specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Batch Update Item Visibilities", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/Visibilities", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", "Visibilities" ], "query": null, "variable": null }, "description": "Batch Update Item Visibilities using Item Visibilities payload specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Item Visibility", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Item/Visibility", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Item", "Visibility" ], "query": [ { "key": "locationId", "value": "\u003ClocationId\u003E", "description": null, "disabled": true }, { "key": "itemTypeId", "value": "\u003CitemTypeId\u003E", "description": "Item Type Id", "disabled": true }, { "key": "itemCode", "value": "\u003CitemCode\u003E", "description": "Item Code", "disabled": true }, { "key": "showroomId", "value": "\u003CshowroomId\u003E", "description": "Showroom Id", "disabled": true }, { "key": "status", "value": "\u003Cstatus\u003E", "description": null, "disabled": true }, { "key": "exteriorMaterialTypeId", "value": "\u003CexteriorMaterialTypeId\u003E", "description": "Exterior Material Type Id", "disabled": true }, { "key": "couchStyleId", "value": "\u003CcouchStyleId\u003E", "description": "Couch Style Id", "disabled": true }, { "key": "productCategoryId", "value": "\u003CproductCategoryId\u003E", "description": "Product Category Id", "disabled": true }, { "key": "manufacturerId", "value": "\u003CmanufacturerId\u003E", "description": "Manufacturer Id", "disabled": true }, { "key": "taxable", "value": "\u003Ctaxable\u003E", "description": "Taxable?", "disabled": true }, { "key": "active", "value": "\u003Cactive\u003E", "description": "Active?", "disabled": true }, { "key": "embedCatalog", "value": "\u003CembedCatalog\u003E", "description": "Embed Catelog?", "disabled": true }, { "key": "digitalCatalog", "value": "\u003CdigitalCatalog\u003E", "description": "Digital Catalog?", "disabled": true }, { "key": "connections", "value": "\u003Cconnections\u003E", "description": "Connections?", "disabled": true }, { "key": "minCost", "value": "\u003CminCost\u003E", "description": "Minimum Cost", "disabled": true }, { "key": "maxCost", "value": "\u003CmaxCost\u003E", "description": "Maximum Cost", "disabled": true }, { "key": "minPrice", "value": "\u003CminPrice\u003E", "description": "Minimum Price", "disabled": true }, { "key": "maxPrice", "value": "\u003CmaxPrice\u003E", "description": "Maximum Price", "disabled": true } ], "variable": null }, "description": "Returns List of Item Visibilities matching criteria specified in request.", "auth": null, "body": null } }, { "name": "Create Item Attribute", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/ItemAttribute", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "ItemAttribute" ], "query": null, "variable": null }, "description": "Creates an Item Attribute.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Item Attribute Values", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/ItemAttribute/:itemAttributeId/Values", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "ItemAttribute", ":itemAttributeId", "Values" ], "query": null, "variable": [ { "key": "itemAttributeId", "value": "\u003CitemAttributeId\u003E", "type": "string" } ] }, "description": "Returns list of Item Attribute Values matching Item Attribute Id specified in request.", "auth": null, "body": null } }, { "name": "Update Item Attribute Values", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/ItemAttribute/:itemAttributeId/Values", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "ItemAttribute", ":itemAttributeId", "Values" ], "query": null, "variable": [ { "key": "itemAttributeId", "value": "\u003CitemAttributeId\u003E", "type": "string" } ] }, "description": "Updates Item Attribute Values matching Item Attribute Id and Item Attributes payload specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Item Attributes", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/ItemAttributes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "ItemAttributes" ], "query": null, "variable": null }, "description": "Returns list of Item Attributes", "auth": null, "body": null } }, { "name": "Create Items", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Items", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Items" ], "query": null, "variable": null }, "description": "Batch creates Items using Items payload specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Items with Location Item", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Items", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Items" ], "query": null, "variable": null }, "description": "Returns List of Item with Location Item.", "auth": null, "body": null } }, { "name": "Create an Item Type", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/ItemType", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "ItemType" ], "query": null, "variable": null }, "description": "Creates an Item Type matching Item Type payload specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Item Type", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/ItemType/:itemTypeId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "ItemType", ":itemTypeId" ], "query": null, "variable": [ { "key": "itemTypeId", "value": "\u003CitemTypeId\u003E", "type": "string" } ] }, "description": "Retrieves the details of the specified item type and includes any associated photo paragraph text from miscellaneous page data.\n Applies view permissions based on the provided identifier for permissions check.", "auth": null, "body": null } }, { "name": "Update an Item Type", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/ItemType/:itemTypeId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "ItemType", ":itemTypeId" ], "query": null, "variable": [ { "key": "itemTypeId", "value": "\u003CitemTypeId\u003E", "type": "string" } ] }, "description": "Updates an Item Type matching Item Type Id and using payload specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Item Type (patch)", "description": null, "item": null, "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/ItemType/:itemTypeId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "ItemType", ":itemTypeId" ], "query": null, "variable": [ { "key": "itemTypeId", "value": "\u003CitemTypeId\u003E", "type": "string" } ] }, "description": "Updates an Item Type matching Item Type Id and using patch payload specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Item Type Availability", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/ItemType/:itemTypeId/Availability", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "ItemType", ":itemTypeId", "Availability" ], "query": null, "variable": [ { "key": "itemTypeId", "value": "\u003CitemTypeId\u003E", "type": "string" } ] }, "description": "Returns list of Item Type Availability matching Item Type Id specified in request.", "auth": null, "body": null } }, { "name": "Updates Item Type Availabilities", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/ItemType/:itemTypeId/Availability", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "ItemType", ":itemTypeId", "Availability" ], "query": null, "variable": [ { "key": "itemTypeId", "value": "\u003CitemTypeId\u003E", "type": "string" } ] }, "description": "Updates Item Type Availabilities matching Item Type Id and Availabilties payload specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Item Type Call Type Codes", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/ItemType/:itemTypeId/CallTypeCodes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "ItemType", ":itemTypeId", "CallTypeCodes" ], "query": null, "variable": [ { "key": "itemTypeId", "value": "\u003CitemTypeId\u003E", "type": "string" } ] }, "description": "Returns list of Item Type Call Type Codes matching Item Type Id specified in request.", "auth": null, "body": null } }, { "name": "Updates Item Type Call Type Codes", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/ItemType/:itemTypeId/CallTypeCodes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "ItemType", ":itemTypeId", "CallTypeCodes" ], "query": null, "variable": [ { "key": "itemTypeId", "value": "\u003CitemTypeId\u003E", "type": "string" } ] }, "description": "Updates Item Type Call Type Codes matching Item Type Id using Call Type Codes payload specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Item Type Item Attribute Values", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/ItemType/:itemTypeId/ItemAttribute/:itemAttributeId/Values", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "ItemType", ":itemTypeId", "ItemAttribute", ":itemAttributeId", "Values" ], "query": null, "variable": [ { "key": "itemTypeId", "value": "\u003CitemTypeId\u003E", "type": "string" }, { "key": "itemAttributeId", "value": "\u003CitemAttributeId\u003E", "type": "string" } ] }, "description": "Returns list of Item Attribute Values matching Item Type Id and Item Attribute Id specified in request.", "auth": null, "body": null } }, { "name": "Item Type Item Attributes", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/ItemType/:itemTypeId/ItemAttributes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "ItemType", ":itemTypeId", "ItemAttributes" ], "query": null, "variable": [ { "key": "itemTypeId", "value": "\u003CitemTypeId\u003E", "type": "string" } ] }, "description": "Returns list of Item Type Item Attributes matching Item Type Id specified in request.", "auth": null, "body": null } }, { "name": "Update Item Type Item Attributes", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/ItemType/:itemTypeId/ItemAttributes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "ItemType", ":itemTypeId", "ItemAttributes" ], "query": null, "variable": [ { "key": "itemTypeId", "value": "\u003CitemTypeId\u003E", "type": "string" } ] }, "description": "Updates Item Type Item Attributes matching Item Type Id and Item Attributes payload specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Item Type Location Codes", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/ItemType/:itemTypeId/LocationCodes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "ItemType", ":itemTypeId", "LocationCodes" ], "query": null, "variable": [ { "key": "itemTypeId", "value": "\u003CitemTypeId\u003E", "type": "string" } ] }, "description": "Returns a list of Item Type Location Codes matching Item Type Id specified in request.", "auth": null, "body": null } }, { "name": "Update Item Type Location Codes", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/ItemType/:itemTypeId/LocationCodes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "ItemType", ":itemTypeId", "LocationCodes" ], "query": null, "variable": [ { "key": "itemTypeId", "value": "\u003CitemTypeId\u003E", "type": "string" } ] }, "description": "Updates Item Type Location Codes matching Item Type Id and Location Codes payload specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Item Type Media", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/ItemType/:itemTypeId/Media", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "ItemType", ":itemTypeId", "Media" ], "query": null, "variable": [ { "key": "itemTypeId", "value": "\u003CitemTypeId\u003E", "type": "string" } ] }, "description": "Returns list of Item Type Media matching Item Type Id specified in request.", "auth": null, "body": null } }, { "name": "Uploads/ creates Item Type Media", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/ItemType/:itemTypeId/Media", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "ItemType", ":itemTypeId", "Media" ], "query": null, "variable": [ { "key": "itemTypeId", "value": "\u003CitemTypeId\u003E", "type": "string" } ] }, "description": "Uploads and creates Item Type Media for Item Type Id and Item Type Media payload specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Deletes Item Type Medium", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/ItemType/:itemTypeId/Media/:itemTypeMediumId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "ItemType", ":itemTypeId", "Media", ":itemTypeMediumId" ], "query": null, "variable": [ { "key": "itemTypeId", "value": "\u003CitemTypeId\u003E", "type": "string" }, { "key": "itemTypeMediumId", "value": "\u003CitemTypeMediumId\u003E", "type": "string" } ] }, "description": "Deletes Item Type Medium for Item Type Id and Item Type Media Id specified in request.", "auth": null, "body": null } }, { "name": "Item Sub Type Names", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/ItemType/:itemTypeId/SubTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "ItemType", ":itemTypeId", "SubTypes" ], "query": null, "variable": [ { "key": "itemTypeId", "value": "\u003CitemTypeId\u003E", "type": "string" } ] }, "description": "Returns Item Sub Type Names matching Item Type Id specified in request.", "auth": null, "body": null } }, { "name": "Updates Item Sub Type Names", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/ItemType/:itemTypeId/SubTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "ItemType", ":itemTypeId", "SubTypes" ], "query": null, "variable": [ { "key": "itemTypeId", "value": "\u003CitemTypeId\u003E", "type": "string" } ] }, "description": "Updates Item Sub Type Names matching Item Type Id using Sub Type Names specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Item Type Media by Medium Id", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/ItemType/Media/:itemTypeMediumId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "ItemType", "Media", ":itemTypeMediumId" ], "query": [ { "key": "width", "value": "\u003Cwidth\u003E", "description": "Width", "disabled": true }, { "key": "height", "value": "\u003Cheight\u003E", "description": "Height", "disabled": true }, { "key": "fit", "value": "\u003Cfit\u003E", "description": "Fit", "disabled": true } ], "variable": [ { "key": "itemTypeMediumId", "value": "\u003CitemTypeMediumId\u003E", "type": "string" } ] }, "description": "Returns stream for Item Type Medium matching Item Type Medium Id specified in request.", "auth": null, "body": null } }, { "name": "Item Sub Types", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/ItemType/SubTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "ItemType", "SubTypes" ], "query": null, "variable": null }, "description": "Returns list of Item Sub Types", "auth": null, "body": null } }, { "name": "Item Types", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/ItemTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "ItemTypes" ], "query": null, "variable": null }, "description": "Returns list of Item Types.", "auth": null, "body": null } }, { "name": "Item Types by Location", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/ItemTypes/Location/:locationId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "ItemTypes", "Location", ":locationId" ], "query": null, "variable": [ { "key": "locationId", "value": "\u003ClocationId\u003E", "type": "string" } ] }, "description": "Returns list of Item Types matching Location Id specified in request.", "auth": null, "body": null } }, { "name": "Package Overviews", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Package", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Package" ], "query": [ { "key": "userTimeZone", "value": "\u003CuserTimeZone\u003E", "description": "IANA timezone id used to anchor \u0022today\u0022 when classifying package effective dates.", "disabled": true } ], "variable": null }, "description": "Returns list of Package Overviews.", "auth": null, "body": null } }, { "name": "Create a new package", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Package", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Package" ], "query": null, "variable": null }, "description": "Creates a new package with the provided details including name, description, and sort order.\n The package is set to active by default and saved to the database. The method returns the\n ID of the newly created package.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Package Details", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Package/:packageId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Package", ":packageId" ], "query": null, "variable": [ { "key": "packageId", "value": "\u003CpackageId\u003E", "type": "string" } ] }, "description": "Retrieves details of a package based on the provided package ID. The package details are projected to \u0060PackageDto\u0060 for response.\n The method includes related data such as package locations, details, tax rate types, and call type codes.\n If the package is not found, a \u0060NotFound\u0060 response is returned.", "auth": null, "body": null } }, { "name": "Update a Package", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Package/:packageId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Package", ":packageId" ], "query": null, "variable": [ { "key": "packageId", "value": "\u003CpackageId\u003E", "type": "string" } ] }, "description": "Update a Package using Package payload specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Scheduled Package Changes", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Package/:packageId/ScheduledChanges", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Package", ":packageId", "ScheduledChanges" ], "query": [ { "key": "effectiveDate", "value": "\u003CeffectiveDate\u003E", "description": "Effective date of the scheduled change.", "disabled": true } ], "variable": [ { "key": "packageId", "value": "\u003CpackageId\u003E", "type": "string" } ] }, "description": "Removes pending package schedule changes (overview, codes, contents, and locations) for the specified effective date.\n\n**Tags:**Catalog, Packages, Scheduling", "auth": null, "body": null } }, { "name": "Package by Location", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Package/Location/:locationId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Package", "Location", ":locationId" ], "query": [ { "key": "callId", "value": "\u003CcallId\u003E", "description": "Provide call ID to ensure inactive packages on a call still show", "disabled": true }, { "key": "saleId", "value": "\u003CsaleId\u003E", "description": "Provide misc sale ID to ensure inactive packages on a misc sale still show", "disabled": true }, { "key": "arrangerOnly", "value": "\u003CarrangerOnly\u003E", "description": "Show only packages visible in arranger", "disabled": true } ], "variable": [ { "key": "locationId", "value": "\u003ClocationId\u003E", "type": "string" } ] }, "description": "Returns a list of Packages by Location Id.", "auth": null, "body": null } }, { "name": "Reorder Packages", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Package/Reorder", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Package", "Reorder" ], "query": null, "variable": null }, "description": "Updates the sort order for multiple packages in bulk, allowing clients to re-sequence package presentation.\n\n**Tags:**Catalog, Packages", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Selected Item Urn Disposition", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/SelectedItem/:itemId/UrnDisposition", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "SelectedItem", ":itemId", "UrnDisposition" ], "query": [ { "key": "itemType", "value": "\u003CitemType\u003E", "description": "Optional item type filter (unused but preserved for compatibility).", "disabled": true } ], "variable": [ { "key": "itemId", "value": "\u003CitemId\u003E", "type": "string" } ] }, "description": "Returns the urn disposition attributes assigned to the specified item, concatenated into a user-friendly string.\n\n**Tags:**Catalog, Attributes", "auth": null, "body": null } }, { "name": "Get Selected Item Dimensions", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/SelectedItem/Dimensions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "SelectedItem", "Dimensions" ], "query": [ { "key": "itemCode", "value": "\u003CitemCode\u003E", "description": "Material number or item code to look up.", "disabled": true } ], "variable": null }, "description": "Retrieves exterior and interior dimensions for a merchandise item by querying the SAP-to-SQL digital asset attributes.\n\n**Tags:**Catalog, Dimensions", "auth": null, "body": null } }, { "name": "Selection Guides", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/SelectionGuide/:fhid", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "SelectionGuide", ":fhid" ], "query": [ { "key": "isArranger", "value": "\u003CisArranger\u003E", "description": "Is Arranger", "disabled": true }, { "key": "dispositionCategoryId", "value": "\u003CdispositionCategoryId\u003E", "description": "Disposition to filter by", "disabled": true } ], "variable": [ { "key": "fhid", "value": "\u003Cfhid\u003E", "type": "string" } ] }, "description": "Returns Selection Guide Items for a given Funeral Home.", "auth": null, "body": null } }, { "name": "Discoutinued Service Center Items", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/ServiceCenter/Items/Discontinued", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "ServiceCenter", "Items", "Discontinued" ], "query": null, "variable": null }, "description": "Search for Discontinued Items in Service Center.", "auth": null, "body": null } }, { "name": "New Service Center Items", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/ServiceCenter/Items/New", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "ServiceCenter", "Items", "New" ], "query": null, "variable": null }, "description": "Returns New Service Center Items.", "auth": null, "body": null } }, { "name": "Get Showroom by Identifier", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Showroom/:showroomId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Showroom", ":showroomId" ], "query": null, "variable": [ { "key": "showroomId", "value": "\u003CshowroomId\u003E", "type": "string" } ] }, "description": "Retrieves the showroom details by its identifier. If the catalog\u0027s out-of-stock type is set to hidden and a funeral home ID is provided, out-of-stock items will be excluded from the results. Permissions are applied based on the provided funeral home ID.", "auth": null, "body": null } }, { "name": "Update a Showroom", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Showroom/:showRoomId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Showroom", ":showRoomId" ], "query": null, "variable": [ { "key": "showRoomId", "value": "\u003CshowRoomId\u003E", "type": "string" } ] }, "description": "Updates a Showroom matching Showroom Id and using Showroom payload specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a Showroom", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Showroom/:showRoomId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Showroom", ":showRoomId" ], "query": null, "variable": [ { "key": "showRoomId", "value": "\u003CshowRoomId\u003E", "type": "string" } ] }, "description": "Deletes a Showroom matching Showroom Id specified in request.", "auth": null, "body": null } }, { "name": "Showroom Items", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Showroom/:showRoomId/Items", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Showroom", ":showRoomId", "Items" ], "query": [ { "key": "dispositionCategoryId", "value": "\u003CdispositionCategoryId\u003E", "description": "Optional Disposition Category Id to filter items", "disabled": true } ], "variable": [ { "key": "showRoomId", "value": "\u003CshowRoomId\u003E", "type": "string" } ] }, "description": "Returns list of Showroom Items matching Showroom Id specified in request. Optionally filtered by Disposition Category.", "auth": null, "body": null } }, { "name": "Showroom Items for Funeral Home", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Showroom/:showRoomId/Items/:fhid", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Showroom", ":showRoomId", "Items", ":fhid" ], "query": null, "variable": [ { "key": "showRoomId", "value": "\u003CshowRoomId\u003E", "type": "string" }, { "key": "fhid", "value": "\u003Cfhid\u003E", "type": "string" } ] }, "description": "Returns list of Showroom Catalog Items matching Showroom Id and Funeral Home Id specified in request.", "auth": null, "body": null } }, { "name": "Showroom Locations", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Showroom/:showRoomId/Locations", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Showroom", ":showRoomId", "Locations" ], "query": null, "variable": [ { "key": "showRoomId", "value": "\u003CshowRoomId\u003E", "type": "string" } ] }, "description": "Returns list of Showroom Location Display Rooms matching Showroom Id specified in request.", "auth": null, "body": null } }, { "name": "Update Showroom Sort Order", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Showroom/:showRoomId/SortOrder", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Showroom", ":showRoomId", "SortOrder" ], "query": null, "variable": [ { "key": "showRoomId", "value": "\u003CshowRoomId\u003E", "type": "string" } ] }, "description": "Updates the sort order for a showroom attribute value list so that display rooms render in the specified order across locations.\n\n**Tags:**Catalog, Showrooms", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Showrooms", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Showrooms", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Showrooms" ], "query": null, "variable": null }, "description": "Returns list of Showrooms.", "auth": null, "body": null } }, { "name": "Creates a Showroom", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Showrooms", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Showrooms" ], "query": null, "variable": null }, "description": "Creates a Showroom matching Showroom payload in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Showrooms by Funeral Home", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Catalog/Showrooms/:fhid", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Catalog", "Showrooms", ":fhid" ], "query": null, "variable": [ { "key": "fhid", "value": "\u003Cfhid\u003E", "type": "string" } ] }, "description": "Returns a list of Showrooms matching Funeral Home Id specified in request.", "auth": null, "body": null } } ], "request": null }, { "name": "Company", "description": null, "item": [ { "name": "Get All Companies", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Companies", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Companies" ], "query": null, "variable": null }, "description": "Retrieves a list of all available companies, ordered alphabetically by name.\n This includes both corporate and individual company records.\n\n**Usage Notes:**\n\n- Does not require a company header since it enumerates all accessible companies.\n- Supports permission-based filtering when loaded in the UI.\n- Typically used for global company selection and administrative dashboards.\n\n\n**Tags:**Companies, Directory, Management", "auth": null, "body": null } }, { "name": "Get Companies by RepCode", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Companies/ByRepCode", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Companies", "ByRepCode" ], "query": null, "variable": null }, "description": "Retrieves companies associated with customers in the current user\u0027s sales territory (RepCode).\n Used by mobile applications (Procura) to get company details for any company\n associated with the user\u0027s assigned customers.", "auth": null, "body": null } }, { "name": "Get Company", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company" ], "query": null, "variable": null }, "description": "Retrieves details of a specific company based on the provided company ID.\n This endpoint returns the company profile as a .\n\n**Usage Notes:**\n\n- Requires valid company context and permission verification.\n- Primarily used to load company profile information in management views.\n- Results are mapped using AutoMapper from the Advisor Master database.\n\n\n**Tags:**Companies, Profile, Management", "auth": null, "body": null } }, { "name": "Patch Company", "description": null, "item": null, "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company" ], "query": null, "variable": null }, "description": "Applies JSON Patch operations to a company, ensuring the user has permission to modify the record.\n\n**Usage Notes:**\n\n- Ensures patch operations comply with user access restrictions.\n- Validates model state after applying patch operations.\n- Automatically persists changes via the Advisor Master DbContext.\n\n\n**Example Patch Document:**[\n { \u0022op\u0022: \u0022replace\u0022, \u0022path\u0022: \u0022/address\u0022, \u0022value\u0022: \u0022New Address\u0022 }\n ]\n\n**Tags:**Companies, Updates, Management", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Patch Specified Company", "description": null, "item": null, "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/:companyId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", ":companyId" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" } ] }, "description": "Applies partial updates to a company record identified by its ID, verifying user permissions.\n\n**Usage Notes:**\n\n- Delegates to\u0060Patch\u0060for shared patch handling logic.\n- Validates that the user can modify the targeted company.\n- Does not allow structural changes to the company hierarchy.\n\n\n**Example Patch Document:**[\n { \u0022op\u0022: \u0022replace\u0022, \u0022path\u0022: \u0022/name\u0022, \u0022value\u0022: \u0022UpdatedCompanyName\u0022 }\n ]\n\n**Tags:**Companies, Updates, Management", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Company Funeral Homes", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/:companyId/FuneralHomes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", ":companyId", "FuneralHomes" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" } ] }, "description": "Retrieves all funeral homes associated with the specified company.\n Acts as a route-specific wrapper for the GetFuneralHomes method.\n\n**Usage Notes:**\n\n- Delegates execution to\u0060GetFuneralHomes\u0060for unified logic.\n- Commonly used by company detail views and administrative tools.\n\n\n**Tags:**Companies, Funeral Homes, Management", "auth": null, "body": null } }, { "name": "Get Company Preferences Key-Value", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/:companyId/Preferences", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", ":companyId", "Preferences" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" } ] }, "description": "Returns the company\u2019s preferences as an by translating stored key-value pairs.\n\n**Usage Notes:**\n\n- Used by legacy components expecting a flattened settings object.\n- Normalizes stored key names by removing spaces to match property names.\n\n\n**Tags:**Preferences, Settings", "auth": null, "body": null } }, { "name": "Get Company Security Roles", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/:companyId/SecurityRoles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", ":companyId", "SecurityRoles" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" } ] }, "description": "Retrieves all security roles associated with a specific company, optionally filtered by\n a provided Funeral Home ID for permission validation.\n\n**Usage Notes:**\n\n- Calls\u0060GetSecurityRoles\u0060internally to resolve role data.\n- Used to populate company-specific role configuration screens.\n\n\n**Tags:**Companies, Roles, Security", "auth": null, "body": null } }, { "name": "Patch Company Tags", "description": null, "item": null, "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/:companyId/Tags", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", ":companyId", "Tags" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" } ] }, "description": "Applies partial updates to the tags associated with a specific company using a JSON Patch document.\n Supports adding, removing, or replacing tag relationships.\n\n**Usage Notes:**\n\n- Supports JSON Patch operations such as\u0060add\u0060,\u0060remove\u0060, and\u0060replace\u0060.\n- Requires the company to be within the user\u2019s permission scope.\n- Use for tag management interfaces and dynamic metadata updates.\n\n\n**Example Patch Document:**[\n { \u0022op\u0022: \u0022add\u0022, \u0022path\u0022: \u0022/companyTags/-\u0022, \u0022value\u0022: \u0022NewTag\u0022 },\n { \u0022op\u0022: \u0022remove\u0022, \u0022path\u0022: \u0022/companyTags/0\u0022 }\n ]\n\n**Tags:**Tags, Companies, Metadata", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Company Case Number Settings", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/CaseNumberSettings", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "CaseNumberSettings" ], "query": null, "variable": null }, "description": "Retrieves the company-wide case number settings including formats, counters, and enforcement flags.\n\n**Usage Notes:**\n\n- Used by Settings \u003E Case Numbers to populate edit forms.\n- Combines values from Advisor Master and the client database.\n\n\n**Tags:**CaseNumbers, Settings", "auth": null, "body": null } }, { "name": "Patch Company Case Number Settings", "description": null, "item": null, "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/CaseNumberSettings", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "CaseNumberSettings" ], "query": null, "variable": null }, "description": "Applies a JSON Patch document to the company-level case number settings and persists the changes.\n\n**Usage Notes:**\n\n- Persists both Advisor Master fields and client DB app settings.\n- Converts boolean toggles to the expected \u00221\u0022/\u00220\u0022 storage format.\n\n\n**Tags:**CaseNumbers, Settings", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Case View Data", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/CaseViewData", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "CaseViewData" ], "query": null, "variable": null }, "description": "Aggregates calls, events, notes, tasks, and resources needed to populate the Case View dashboard for the company.\n\n**Usage Notes:**\n\n- Includes calls from the last month or those with future events.\n- Optimized via batch queries to minimize DB round-trips.\n\n\n**Tags:**Cases, Dashboard, Analytics", "auth": null, "body": null } }, { "name": "Get Cash Accounts", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/CashAccount", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "CashAccount" ], "query": null, "variable": null }, "description": "Returns all cash accounts configured for the company, including their location assignments.\n\n**Usage Notes:**\n\n- Feeds Settings UIs that manage payment routing per location.\n- Uses AutoMapper projection to avoid over-fetching entity graphs.\n\n\n**Tags:**Finance, CashAccounts, Settings", "auth": null, "body": null } }, { "name": "Create Cash Account", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/CashAccount", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "CashAccount" ], "query": null, "variable": null }, "description": "Creates a new cash account and links it to the provided locations.\n\n**Usage Notes:**\n\n- Any location links with an ID of zero are treated as new.\n- Used when administrators add accounts for payment routing.\n\n\n**Tags:**Finance, CashAccounts, Settings", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Cash Account", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/CashAccount/:cashAccountId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "CashAccount", ":cashAccountId" ], "query": null, "variable": [ { "key": "cashAccountId", "value": "\u003CcashAccountId\u003E", "type": "string" } ] }, "description": "Updates an existing cash account and syncs its location assignments to match the request payload.\n\n**Usage Notes:**\n\n- Removes stale location links and inserts new ones as needed.\n- Ensures updates are scoped to the requesting company.\n\n\n**Tags:**Finance, CashAccounts, Settings", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Contract Disclosures", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/ContractDisclosures", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "ContractDisclosures" ], "query": null, "variable": null }, "description": "Retrieves the contract disclosures configured at the company level.\n\n**Usage Notes:**\n\n- Used when editing company-wide disclosures that appear on contracts.\n- Data is projected directly to DTOs for efficient serialization.\n\n\n**Tags:**Disclosures, Contracts, Compliance", "auth": null, "body": null } }, { "name": "Create Contract Disclosure", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/ContractDisclosures", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "ContractDisclosures" ], "query": null, "variable": null }, "description": "Adds a new contract disclosure for the company using the provided DTO payload.\n\n**Usage Notes:**\n\n- Maps the DTO to the entity and automatically stamps the company ID.\n- Only adds a new record when the identifier is zero (i.e., not yet persisted).\n- Used when administrators compose new disclosure paragraphs.\n\n\n**Tags:**Disclosures, Contracts, Compliance", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Patch Contract Disclosure", "description": null, "item": null, "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/ContractDisclosures/:contractDisclosureId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "ContractDisclosures", ":contractDisclosureId" ], "query": null, "variable": [ { "key": "contractDisclosureId", "value": "\u003CcontractDisclosureId\u003E", "type": "string" } ] }, "description": "Applies a JSON Patch document to a company contract disclosure after enforcing access permissions.\n\n**Usage Notes:**\n\n- Validates company ownership before allowing edits.\n- Applies the patch to a DTO instance before mapping changes back to the entity.\n- Requires\u0060ManageDisclosures\u0060permission when a funeral home context is provided.\n\n\n**Tags:**Disclosures, Contracts, Compliance", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Disconnect Email", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/DisconnectEmail", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "DisconnectEmail" ], "query": null, "variable": null }, "description": "Clears stored email/SMTP configuration and email addresses for the company.\n\n**Tags:**Email, Integrations", "auth": null, "body": null } }, { "name": "Disconnect PayPal", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/DisconnectPayPal", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "DisconnectPayPal" ], "query": null, "variable": null }, "description": "Clears stored PayPal credentials and resets related configuration.\n\n**Tags:**PayPal, Integrations", "auth": null, "body": null } }, { "name": "Disconnect QuickBooks", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/DisconnectQuickbooks", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "DisconnectQuickbooks" ], "query": null, "variable": null }, "description": "Clears the saved QuickBooks tokens for the company.\n\n**Tags:**QuickBooks, Integrations", "auth": null, "body": null } }, { "name": "Disconnect Twilio", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/DisconnectTwilio", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "DisconnectTwilio" ], "query": null, "variable": null }, "description": "Clears stored Twilio credentials and phone numbers for the company.\n\n**Tags:**Twilio, Integrations", "auth": null, "body": null } }, { "name": "Add Email Address", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/EmailAddress", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "EmailAddress" ], "query": null, "variable": null }, "description": "Adds an email address to the company\u0027s email configuration.\n\n**Tags:**Email, Integrations", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Email Address", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/EmailAddress/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "EmailAddress", ":id" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "Removes an email address from the company\u0027s configuration.\n\n**Tags:**Email, Integrations", "auth": null, "body": null } }, { "name": "Update Email Address", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/EmailAddress/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "EmailAddress", ":id" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "Updates the display name of an email address.\n\n**Tags:**Email, Integrations", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Set Default Email Address", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/EmailAddress/:id/SetDefault", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "EmailAddress", ":id", "SetDefault" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "Sets the specified email address as the default for email sending.\n\n**Tags:**Email, Integrations", "auth": null, "body": null } }, { "name": "Get Email Addresses", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/EmailAddresses", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "EmailAddresses" ], "query": null, "variable": null }, "description": "Retrieves all configured email addresses for the company.\n\n**Tags:**Email, Integrations", "auth": null, "body": null } }, { "name": "Get Email Configuration", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/EmailConfig", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "EmailConfig" ], "query": null, "variable": null }, "description": "Retrieves the current email/SMTP configuration for the company.\n\n**Tags:**Email, Integrations", "auth": null, "body": null } }, { "name": "Search Events", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/Event/Search", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "Event", "Search" ], "query": null, "variable": null }, "description": "Executes the shared event search pipeline using the provided criteria and returns a paged result set.\n\n**Usage Notes:**\n\n- Delegates the heavy lifting to\u0060IEventService.SearchEvents\u0060.\n- Commonly used by the calendar and obituary management screens.\n\n\n**Tags:**Events, Search, Scheduling", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Event Classifications", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/EventClassifications", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "EventClassifications" ], "query": null, "variable": null }, "description": "Returns all event classifications available to the company for grouping event types.\n\n**Usage Notes:**\n\n- Used to populate drop-downs when assigning classifications to event types.\n- Orders results alphabetically for predictable UI presentation.\n\n\n**Tags:**Events, Classifications, GatheringTypes", "auth": null, "body": null } }, { "name": "Get Event Sections", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/EventSections", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "EventSections" ], "query": null, "variable": null }, "description": "Returns the ordered list of event sections a company can use to compose gathering templates.\n\n**Usage Notes:**\n\n- Used when configuring which sections appear inside an event type.\n- Projection keeps the payload lightweight for UI rendering.\n\n\n**Tags:**Events, Sections, GatheringTypes", "auth": null, "body": null } }, { "name": "Get Event Subtypes", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/EventSubTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "EventSubTypes" ], "query": null, "variable": null }, "description": "Returns all event subtypes configured for the company, including their parent event type relationships.\n\n**Usage Notes:**\n\n- Used to populate dropdowns when configuring Gathering Types.\n- Loads related entities via EF split queries for efficiency.\n\n\n**Tags:**Events, Subtypes, GatheringTypes", "auth": null, "body": null } }, { "name": "Create Event Subtype", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/EventSubTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "EventSubTypes" ], "query": null, "variable": null }, "description": "Creates a new event subtype for the specified company to be associated with a parent event type downstream.\n\n**Usage Notes:**\n\n- New records default to\u0060Active = true\u0060.\n- Relies on AutoMapper to map the saved entity back to a DTO.\n- Used when admins add subtype options in the Gathering Types UI.\n\n\n**Tags:**Events, Subtypes, GatheringTypes", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Event Subtype", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/EventSubTypes/:eventSubTypeId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "EventSubTypes", ":eventSubTypeId" ], "query": null, "variable": [ { "key": "eventSubTypeId", "value": "\u003CeventSubTypeId\u003E", "type": "string" } ] }, "description": "Updates the name, active state, and parent relationship for an existing event subtype.\n\n**Usage Notes:**\n\n- Throws\u0060SolutionCenterException\u0060when the subtype cannot be located.\n- Allows administrators to toggle subtype availability per event type.\n- Relies on AutoMapper for the response DTO.\n\n\n**Tags:**Events, Subtypes, GatheringTypes", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Upload Event Type Image", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/EventType/:eventTypeId/Image", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "EventType", ":eventTypeId", "Image" ], "query": null, "variable": [ { "key": "eventTypeId", "value": "\u003CeventTypeId\u003E", "type": "string" } ] }, "description": "Accepts an image file and stores it as the visual asset for the specified event type.\n\n**Usage Notes:**\n\n- Generates a new blob identifier via\u0060systemService.NewGuid()\u0060.\n- Uploads the content to the\u0060CompanyMedia\u0060container using\u0060IMediaService\u0060.\n- Used by administrators managing imagery for Gathering Types.\n\n\n**Tags:**Events, Media, GatheringTypes", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove Event Type Image", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/EventType/:eventTypeId/Image", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "EventType", ":eventTypeId", "Image" ], "query": null, "variable": [ { "key": "eventTypeId", "value": "\u003CeventTypeId\u003E", "type": "string" } ] }, "description": "Clears the stored image reference for an event type, effectively removing the associated media.\n\n**Usage Notes:**\n\n- Only clears the pointer stored in SQL; associated blob cleanup is handled separately.\n- Useful when administrators want to revert to the default event type imagery.\n- Ensures the event type being edited belongs to the requesting company.\n\n\n**Tags:**Events, Media, GatheringTypes", "auth": null, "body": null } }, { "name": "Get Event Types", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/EventTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "EventTypes" ], "query": null, "variable": null }, "description": "Retrieves all event types configured for a company, ensuring related description data exists and returning the results ordered by name.\n\n**Usage Notes:**\n\n- Automatically seeds\u0060MiscPageData\u0060records if a type is missing descriptive content.\n- Results are used throughout the Gathering Types administration experience.\n- Uses AutoMapper projections for efficient loading.\n\n\n**Tags:**Events, Settings, GatheringTypes", "auth": null, "body": null } }, { "name": "Create Event Type", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/EventTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "EventTypes" ], "query": null, "variable": null }, "description": "Creates a new event type along with its backing item, misc page data, sections, and location associations.\n\n**Usage Notes:**\n\n- Automatically creates an\u0060Item\u0060entry tied to the Gathering master item type.\n- Materializes related collections (sections, locations, misc page data) inside a single transaction.\n- Used by Settings \u003E Gathering Types when adding a new ceremony template.\n\n\n**Tags:**Events, Create, GatheringTypes", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Event Type", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/EventTypes/:eventTypeId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "EventTypes", ":eventTypeId" ], "query": null, "variable": [ { "key": "eventTypeId", "value": "\u003CeventTypeId\u003E", "type": "string" } ] }, "description": "Updates an existing event type, synchronizing its misc page data, sections, locations, and settings.\n\n**Usage Notes:**\n\n- Rebuilds event-section and location associations to match the incoming payload.\n- Ensures misc page data exists and reflects the current description.\n- Sets\u0060Active\u0060based on whether the type is available to any locations.\n\n\n**Tags:**Events, Update, GatheringTypes", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Fetch Phone Numbers from Twilio Account", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/FetchTwilioAccountPhoneNumbers", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "FetchTwilioAccountPhoneNumbers" ], "query": null, "variable": null }, "description": "Fetches available phone numbers from the Twilio account using the provided credentials.\n\n**Tags:**Twilio, Integrations", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create a new Funeral Home for the current company.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/FuneralHome", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "FuneralHome" ], "query": null, "variable": null }, "description": "Mirrors the V1 \u0022Add Location\u0022 workflow: inserts a FuneralHome row, copies the calling user\u0027s\n Headquarters roles to the new funeral home, inserts a companion AURORA.Location record, runs\n the company import stored procedure, and optionally copies settings from an existing funeral\n home. Permission cache is cleared on success so the new FH appears for the caller immediately.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Funeral Home", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/FuneralHome/:funeralHomeId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "FuneralHome", ":funeralHomeId" ], "query": null, "variable": [ { "key": "funeralHomeId", "value": "\u003CfuneralHomeId\u003E", "type": "string" } ] }, "description": "Retrieves detailed information for a specific funeral home, validating company and user permissions.\n\n**Usage Notes:**\n\n- Validates both company and funeral home permissions using the permission service.\n- Joins data from Advisor Master and client contexts for full location mapping.\n- Includes default report IDs (Contract/Addendum) if location-specific ones are missing.\n- Throws a\u0060SolutionCenterException\u0060if the funeral home ID is invalid.\n\n\n**Tags:**Funeral Homes, Companies, Details", "auth": null, "body": null } }, { "name": "Patch Funeral Home", "description": null, "item": null, "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/FuneralHome/:funeralHomeId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "FuneralHome", ":funeralHomeId" ], "query": null, "variable": [ { "key": "funeralHomeId", "value": "\u003CfuneralHomeId\u003E", "type": "string" } ] }, "description": "Applies JSON Patch updates to a specific funeral home record, synchronizing related contracts and addendum settings\n in the associated client database.\n\n**Usage Notes:**\n\n- Ensures the funeral home belongs to an accessible company.\n- Handles synchronization of related report mappings (Contract and Addendum).\n- Automatically removes or adds client-side\u0060LocationContracts\u0060and\u0060LocationInvoices\u0060as needed.\n- Performs validation after applying the patch to maintain data consistency.\n\n\n**Example Patch Document:**[\n { \u0022op\u0022: \u0022replace\u0022, \u0022path\u0022: \u0022/address\u0022, \u0022value\u0022: \u0022New Address\u0022 }\n ]\n\n**Tags:**Funeral Homes, Updates, Management", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Add Funeral Home Address", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/FuneralHome/:funeralHomeId/Address/:addressType", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "FuneralHome", ":funeralHomeId", "Address", ":addressType" ], "query": null, "variable": [ { "key": "funeralHomeId", "value": "\u003CfuneralHomeId\u003E", "type": "string" }, { "key": "addressType", "value": "\u003CaddressType\u003E", "type": "string" } ] }, "description": "Adds a new address to a funeral home, or links an existing address if it already exists.\n Updates both Advisor Master and client databases to keep address records synchronized.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Patch Funeral Home Address", "description": null, "item": null, "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/FuneralHome/:funeralHomeId/Address/:addressType", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "FuneralHome", ":funeralHomeId", "Address", ":addressType" ], "query": null, "variable": [ { "key": "funeralHomeId", "value": "\u003CfuneralHomeId\u003E", "type": "string" }, { "key": "addressType", "value": "\u003CaddressType\u003E", "type": "string" } ] }, "description": "Updates or creates an address for a funeral home using a JSON Patch document.\n Supports adding new addresses, updating existing ones, or reassigning address types.\n\n**Usage Notes:**\n\n- Handles three scenarios: creating a new address, updating an existing address, or linking an existing address ID.\n- Synchronizes changes with the client database to maintain consistency.\n- Automatically removes outdated address records if type assignments change.\n\n\n**Example Patch Document:**[\n { \u0022op\u0022: \u0022replace\u0022, \u0022path\u0022: \u0022/street\u0022, \u0022value\u0022: \u0022123 New St\u0022 }\n ]\n\n**Tags:**Funeral Homes, Addresses, Updates", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Funeral Home Case Number Settings", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/FuneralHome/:funeralHomeId/CaseNumberSettings", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "FuneralHome", ":funeralHomeId", "CaseNumberSettings" ], "query": null, "variable": [ { "key": "funeralHomeId", "value": "\u003CfuneralHomeId\u003E", "type": "string" } ] }, "description": "Retrieves case number settings scoped to a specific funeral home.\n\n**Usage Notes:**\n\n- Used for per-location overrides in the Case Number Settings UI.\n\n\n**Tags:**CaseNumbers, FuneralHomes, Settings", "auth": null, "body": null } }, { "name": "Patch Funeral Home Case Number Settings", "description": null, "item": null, "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/FuneralHome/:funeralHomeId/CaseNumberSettings", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "FuneralHome", ":funeralHomeId", "CaseNumberSettings" ], "query": null, "variable": [ { "key": "funeralHomeId", "value": "\u003CfuneralHomeId\u003E", "type": "string" } ] }, "description": "Applies case number setting changes for a specific funeral home using a JSON Patch document.\n\n**Usage Notes:**\n\n- Ensures the funeral home is active before applying updates.\n- Requires both company and funeral home permission checks.\n\n\n**Tags:**CaseNumbers, FuneralHomes, Settings", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Patch Funeral Home Disclosure", "description": null, "item": null, "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/FuneralHome/:funeralHomeId/Disclosure/:disclosureTypeId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "FuneralHome", ":funeralHomeId", "Disclosure", ":disclosureTypeId" ], "query": null, "variable": [ { "key": "funeralHomeId", "value": "\u003CfuneralHomeId\u003E", "type": "string" }, { "key": "disclosureTypeId", "value": "\u003CdisclosureTypeId\u003E", "type": "string" } ] }, "description": "Applies a JSON Patch document to a funeral home\u0027s disclosure, creating the disclosure record if it does not yet exist.\n\n**Usage Notes:**\n\n- Auto-creates the disclosure if it does not yet exist for the funeral home.\n- Validates the patched DTO before persisting changes.\n- Returns\u0060NoContent\u0060on success to align with PATCH semantics.\n\n\n**Tags:**Disclosures, FuneralHomes, Compliance", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Funeral Home Disclosures", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/FuneralHome/:funeralHomeId/Disclosures", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "FuneralHome", ":funeralHomeId", "Disclosures" ], "query": null, "variable": [ { "key": "funeralHomeId", "value": "\u003CfuneralHomeId\u003E", "type": "string" } ] }, "description": "Retrieves the disclosure configurations assigned to the specified funeral home.\n\n**Usage Notes:**\n\n- Requires both funeral home access and the ManageDisclosures permission.\n- Used in Settings when editing funeral home-specific disclosures.\n\n\n**Tags:**Disclosures, FuneralHomes, Compliance", "auth": null, "body": null } }, { "name": "Get Funeral Home Disclosure Types", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/FuneralHome/:funeralHomeId/DisclosureTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "FuneralHome", ":funeralHomeId", "DisclosureTypes" ], "query": null, "variable": [ { "key": "funeralHomeId", "value": "\u003CfuneralHomeId\u003E", "type": "string" } ] }, "description": "Returns the disclosure types available to the funeral home\u2019s company for contract and paperwork configuration.\n\n**Usage Notes:**\n\n- Derives the company ID from Advisor Master before querying the client database.\n- Used when configuring funeral home-specific disclosures in Settings.\n\n\n**Tags:**Disclosures, FuneralHomes, Compliance", "auth": null, "body": null } }, { "name": "Get Funeral Home Logo", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/FuneralHome/:funeralHomeId/Logo", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "FuneralHome", ":funeralHomeId", "Logo" ], "query": [ { "key": "width", "value": "\u003Cwidth\u003E", "description": "Optional target width for the returned image.", "disabled": true }, { "key": "height", "value": "\u003Cheight\u003E", "description": "Optional target height for the returned image.", "disabled": true }, { "key": "fit", "value": "\u003Cfit\u003E", "description": "Optional resize behavior used by the media service.", "disabled": true } ], "variable": [ { "key": "funeralHomeId", "value": "\u003CfuneralHomeId\u003E", "type": "string" } ] }, "description": "Downloads the stored logo image for the specified funeral home, with optional resizing parameters.\n\n**Usage Notes:**\n\n- Falls back to a blank PNG when no media GUID is stored.\n- Uses\u0060IMediaService\u0060to stream the blob from the logo container.\n- Caller must have funeral home-level access enforced via\u0060RequireFuneralHome\u0060.\n\n\n**Tags:**FuneralHomes, Media, Branding", "auth": null, "body": null } }, { "name": "Upload Funeral Home Logo", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/FuneralHome/:funeralHomeId/Logo", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "FuneralHome", ":funeralHomeId", "Logo" ], "query": null, "variable": [ { "key": "funeralHomeId", "value": "\u003CfuneralHomeId\u003E", "type": "string" } ] }, "description": "Uploads a new logo image for the specified funeral home after validating the file type.\n\n**Usage Notes:**\n\n- Validates MIME type using\u0060MimeTypes.GetMimeType\u0060.\n- Persists the GUID reference on the funeral home record and uploads the blob to the logo container.\n- Relies on\u0060RequirePermission(Permissions.ManageFuneralHomeLogo)\u0060for security.\n\n\n**Tags:**FuneralHomes, Media, Branding", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove Funeral Home Logo", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/FuneralHome/:funeralHomeId/Logo", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "FuneralHome", ":funeralHomeId", "Logo" ], "query": null, "variable": [ { "key": "funeralHomeId", "value": "\u003CfuneralHomeId\u003E", "type": "string" } ] }, "description": "Removes the logo reference for a funeral home, effectively reverting to the default branding asset.\n\n**Usage Notes:**\n\n- Only clears the GUID in Advisor Master; blob cleanup is handled separately.\n- Useful when an administrator wants to temporarily remove funeral home branding.\n\n\n**Tags:**FuneralHomes, Media, Branding", "auth": null, "body": null } }, { "name": "Patch Funeral Home Tags", "description": null, "item": null, "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/FuneralHome/:funeralHomeId/Tags", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "FuneralHome", ":funeralHomeId", "Tags" ], "query": null, "variable": [ { "key": "funeralHomeId", "value": "\u003CfuneralHomeId\u003E", "type": "string" } ] }, "description": "Applies partial updates to the tags associated with a specific funeral home using a JSON Patch document.\n Validates user permissions before applying modifications.\n\n**Usage Notes:**\n\n- Ensures the funeral home belongs to a company accessible by the current user.\n- Removes tags that no longer exist in the patch payload and adds new ones as needed.\n- Automatically creates new\u0060Tag\u0060records if they do not exist.\n\n\n**Example Patch Document:**[\n { \u0022op\u0022: \u0022add\u0022, \u0022path\u0022: \u0022/funeralHomeTags/-\u0022, \u0022value\u0022: \u0022NewTag\u0022 },\n { \u0022op\u0022: \u0022remove\u0022, \u0022path\u0022: \u0022/funeralHomeTags/0\u0022 }\n ]\n\n**Tags:**Funeral Homes, Tags, Metadata", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get active service centers available for assignment to a funeral home.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/FuneralHome/ServiceCenters", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "FuneralHome", "ServiceCenters" ], "query": null, "variable": null }, "description": "Used by the Settings \u2192 Company \u2192 Funeral Homes \u0022Add\u0022 dialog to populate the Service Center\n dropdown. Authorization is scoped to users who can manage funeral home locations, so it is\n usable from settings pages without elevating to the Zeus role required by the\n distributor-facing endpoint.", "auth": null, "body": null } }, { "name": "Get Funeral Home Tags", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/FuneralHome/Tags", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "FuneralHome", "Tags" ], "query": null, "variable": null }, "description": "Retrieves a distinct list of tags associated with all funeral homes belonging to the user\u2019s companies.\n Applies permission-based filtering if a funeral home ID is provided.\n\n**Usage Notes:**\n\n- Collects funeral home IDs from all companies the user can access.\n- Maps tag data from\u0060FuneralHomeTags\u0060and ensures uniqueness.\n- Applies permission filtering to limit tag visibility by funeral home.\n\n\n**Tags:**Funeral Homes, Tags, Permissions", "auth": null, "body": null } }, { "name": "Get Funeral Home Key", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/FuneralHomeKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "FuneralHomeKey" ], "query": [ { "key": "fhId", "value": "\u003CfhId\u003E", "description": "The unique identifier of the funeral home whose key should be retrieved.", "disabled": true } ], "variable": null }, "description": "Retrieves the unique key (GUID) for a specified funeral home by its ID.\n Returns null if no key is assigned or the funeral home does not exist.\n\n**Usage Notes:**\n\n- Used for linking external integrations or uniquely identifying funeral homes across systems.\n- Returns\u0060null\u0060for inactive or uninitialized records.\n- Does not perform company or permission validation (key-only retrieval).\n\n\n**Tags:**Funeral Homes, Keys, Management", "auth": null, "body": null } }, { "name": "Get Funeral Homes", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/FuneralHomes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "FuneralHomes" ], "query": null, "variable": null }, "description": "Retrieves a detailed list of funeral homes associated with the specified company,\n including related location, address, contract, and report information.\n\n**Usage Notes:**\n\n- Performs a joined lookup between Advisor Master and client databases.\n- Includes related data such as addresses, tags, service centers, and contracts.\n- Populates report IDs (Contract/Addendum) using company-level or master fallbacks.\n- Applies permission filtering per funeral home record.\n- Used by company administration and reporting configuration screens.\n\n\n**Tags:**Companies, Funeral Homes, Locations, Management", "auth": null, "body": null } }, { "name": "Get General Ledger Accounts", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/GeneralLedger", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "GeneralLedger" ], "query": null, "variable": null }, "description": "Returns all general ledger accounts configured for the company.\n\n**Usage Notes:**\n\n- Used on the Settings \u003E Finance screens to list GL accounts.\n- Projects entities directly into DTOs for serialization efficiency.\n\n\n**Tags:**Finance, GeneralLedger, Settings", "auth": null, "body": null } }, { "name": "Create General Ledger Account", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/GeneralLedger", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "GeneralLedger" ], "query": null, "variable": null }, "description": "Creates a new general ledger account and associates it with any requested locations.\n\n**Usage Notes:**\n\n- Maps DTOs into entities using AutoMapper before persisting.\n- Automatically links the account to new location records when their IDs are zero.\n- Used in Settings when finance admins add GL accounts.\n\n\n**Tags:**Finance, GeneralLedger, Settings", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update General Ledger Account", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/GeneralLedger/:generalLedgerId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "GeneralLedger", ":generalLedgerId" ], "query": null, "variable": [ { "key": "generalLedgerId", "value": "\u003CgeneralLedgerId\u003E", "type": "string" } ] }, "description": "Updates an existing general ledger account and reconciles its location assignments to match the supplied DTO.\n\n**Usage Notes:**\n\n- Removes orphaned location links and adds new ones where necessary.\n- Uses AutoMapper to map DTO changes onto the tracked entity.\n\n\n**Tags:**Finance, GeneralLedger, Settings", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Event Type Image", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/GetEventTypeImage", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "GetEventTypeImage" ], "query": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "description": "Company identifier that scopes the event type lookup.", "disabled": true }, { "key": "eventTypeId", "value": "\u003CeventTypeId\u003E", "description": "Unique identifier for the event type whose image should be returned.", "disabled": true }, { "key": "width", "value": "\u003Cwidth\u003E", "description": "Optional target width for the rendered image.", "disabled": true }, { "key": "height", "value": "\u003Cheight\u003E", "description": "Optional target height for the rendered image.", "disabled": true }, { "key": "fit", "value": "\u003Cfit\u003E", "description": "Optional resize mode describing how to fit the image within the requested dimensions.", "disabled": true } ], "variable": null }, "description": "Downloads the stored image for the requested event type and optionally resizes it for use in public experiences.\n\n**Usage Notes:**\n\n- Endpoint is anonymous to support family websites and other public views.\n- Delegates image retrieval and resizing to\u0060IMediaService\u0060.\n- Throws\u0060SolutionCenterException\u0060when the event type cannot be found.\n\n\n**Tags:**Events, Media, GatheringTypes", "auth": null, "body": null } }, { "name": "List Call-PayPal Invoice Links", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/GetExistingCallPayPalInvoiceLinks", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "GetExistingCallPayPalInvoiceLinks" ], "query": null, "variable": null }, "description": "Retrieves all call-to-PayPal invoice link records for the company.\n\n**Tags:**PayPal, Integrations", "auth": null, "body": null } }, { "name": "List Payment-PayPal Links", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/GetExistingPaymentPayPalPaymentLinks", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "GetExistingPaymentPayPalPaymentLinks" ], "query": null, "variable": null }, "description": "Returns all Payment-to-PayPal payment link records for the company.\n\n**Tags:**PayPal, Integrations", "auth": null, "body": null } }, { "name": "Get Interment Options", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/IntermentOption", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "IntermentOption" ], "query": null, "variable": null }, "description": "Retrieves the list of interment options configured for the company.\n\n**Usage Notes:**\n\n- Used in Settings screens that manage interment offerings.\n- Projection keeps payload lightweight.\n\n\n**Tags:**Interment, Settings", "auth": null, "body": null } }, { "name": "Create Interment Option", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/IntermentOption", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "IntermentOption" ], "query": null, "variable": null }, "description": "Creates a new interment option for the specified company using the provided DTO.\n\n**Usage Notes:**\n\n- Relies on AutoMapper to copy DTO data onto the entity.\n- Persisted in the client database tied to the header company.\n\n\n**Tags:**Interment, Create, Settings", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Patch Interment Option", "description": null, "item": null, "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/IntermentOption/:intermentOptionId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "IntermentOption", ":intermentOptionId" ], "query": null, "variable": [ { "key": "intermentOptionId", "value": "\u003CintermentOptionId\u003E", "type": "string" } ] }, "description": "Applies a JSON Patch document to an existing interment option.\n\n**Usage Notes:**\n\n- Maps the entity to DTO, applies patch, validates, then maps back.\n- Used by the interment options editor for partial updates.\n\n\n**Tags:**Interment, Update, Settings", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Link Call To PayPal Invoice", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/LinkCallToPayPalInvoice", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "LinkCallToPayPalInvoice" ], "query": null, "variable": null }, "description": "Associates a case call with a PayPal invoice for reference tracking.\n\n**Tags:**PayPal, Integrations", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Save Email Configuration", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/LinkEmail", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "LinkEmail" ], "query": null, "variable": null }, "description": "Saves email/SMTP configuration for the company.\n\n**Tags:**Email, Integrations", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Link Payment To PayPal Payment", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/LinkPaymentToPayPalPayment", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "LinkPaymentToPayPalPayment" ], "query": null, "variable": null }, "description": "Creates a link between a Solution Center payment and a PayPal payment identifier.\n\n**Tags:**PayPal, Integrations", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Link PayPal", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/LinkPayPal", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "LinkPayPal" ], "query": null, "variable": null }, "description": "Stores PayPal credentials and configuration after completing the OAuth handshake.\n\n**Tags:**PayPal, Integrations", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Link QuickBooks", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/LinkQuickbooks", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "LinkQuickbooks" ], "query": null, "variable": null }, "description": "Stores the QuickBooks token and company identifier after the OAuth flow completes.\n\n**Tags:**QuickBooks, Integrations", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Link Twilio", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/LinkTwilio", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "LinkTwilio" ], "query": null, "variable": null }, "description": "Saves Twilio credentials for the company.\n\n**Tags:**Twilio, Integrations", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create Location", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/Location", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "Location" ], "query": null, "variable": null }, "description": "Creates a new company location, persists the provided attributes, and returns the fully hydrated DTO for display.\n\n**Usage Notes:**\n\n- New records default to\u0060Active = true\u0060before being mapped from the incoming DTO.\n- Uses AutoMapper to keep DTO and entity models synchronized.\n- Returns the created record by re-querying to ensure all navigation properties are included.\n\n\n**Tags:**Locations, Create, Settings", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Location", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/Location/:locationId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "Location", ":locationId" ], "query": null, "variable": [ { "key": "locationId", "value": "\u003ClocationId\u003E", "type": "string" } ] }, "description": "Updates an existing location that belongs to the specified company using the fields supplied in the request body.\n\n**Usage Notes:**\n\n- Maps data with AutoMapper, so DTO validation should align with entity constraints.\n- Only locations belonging to the supplied company can be updated.\n- Used in the Settings \u003E Locations edit workflow.\n\n\n**Tags:**Locations, Update, Settings", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Upsert Location Memories Question", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/Location/:locationId/MemoriesQuestion/:memoriesQuestionId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "Location", ":locationId", "MemoriesQuestion", ":memoriesQuestionId" ], "query": null, "variable": [ { "key": "locationId", "value": "\u003ClocationId\u003E", "type": "string" }, { "key": "memoriesQuestionId", "value": "\u003CmemoriesQuestionId\u003E", "type": "string" } ] }, "description": "Creates or updates a location-specific configuration for a memories question.\n\n**Tags:**Memories, Locations, Settings", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Location Memories Question", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/Location/:locationId/MemoriesQuestion/:memoriesQuestionId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "Location", ":locationId", "MemoriesQuestion", ":memoriesQuestionId" ], "query": null, "variable": [ { "key": "locationId", "value": "\u003ClocationId\u003E", "type": "string" }, { "key": "memoriesQuestionId", "value": "\u003CmemoriesQuestionId\u003E", "type": "string" } ] }, "description": "Removes a location-specific memories question assignment.\n\n**Tags:**Memories, Locations, Settings", "auth": null, "body": null } }, { "name": "Get Location Memories Questions", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/Location/:locationId/MemoriesQuestions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "Location", ":locationId", "MemoriesQuestions" ], "query": null, "variable": [ { "key": "locationId", "value": "\u003ClocationId\u003E", "type": "string" } ] }, "description": "Retrieves the memories questions assigned to a specific location under the company.\n\n**Tags:**Memories, Locations, Settings", "auth": null, "body": null } }, { "name": "Sync Location Memories Questions", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/Location/:locationId/MemoriesQuestions/Sync/:destFhId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "Location", ":locationId", "MemoriesQuestions", "Sync", ":destFhId" ], "query": null, "variable": [ { "key": "locationId", "value": "\u003ClocationId\u003E", "type": "string" }, { "key": "destFhId", "value": "\u003CdestFhId\u003E", "type": "string" } ] }, "description": "Copies memories questions from the specified source location to a destination funeral home, syncing both company and location level data.\n\n**Tags:**Memories, Sync, Settings", "auth": null, "body": null } }, { "name": "Get Location Resources", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/Location/:locationId/Resources", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "Location", ":locationId", "Resources" ], "query": null, "variable": [ { "key": "locationId", "value": "\u003ClocationId\u003E", "type": "string" } ] }, "description": "Retrieves the active resources assigned to a specific location within the company for scheduling and staffing needs.\n\n**Usage Notes:**\n\n- Only resources flagged as active are included.\n- Used by the scheduling UI to populate staffing pickers per location.\n- Query leverages AutoMapper projection for performance.\n\n\n**Tags:**Locations, Resources, Scheduling", "auth": null, "body": null } }, { "name": "List Company Locations", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/Locations", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "Locations" ], "query": [ { "key": "locationTypeId", "value": "\u003ClocationTypeId\u003E", "description": "Optional location type master ID used to narrow the results to a single type.", "disabled": true } ], "variable": null }, "description": "Retrieves all locations that belong to the specified company, optionally filtering by location type\n and applying view permissions scoped to a selected funeral home.\n\n**Usage Notes:**\n\n- Each result includes physical, mailing, shipping, and billing addresses when available.\n- Use\u0060locationTypeId\u0060to drive dropdown filters inside Location Settings UI.\n- Permission enforcement is handled by\u0060permissionService.ApplyViewPermissions\u0060.\n\n\n**Tags:**Locations, Directory, Settings", "auth": null, "body": null } }, { "name": "Get Resources For Multiple Locations", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/Locations/Resources", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "Locations", "Resources" ], "query": null, "variable": null }, "description": "Returns active resources for a batch of location identifiers in a single request.\n\n**Usage Notes:**\n\n- Use when a UI needs to hydrate resources for several locations simultaneously.\n- Gracefully handles null/empty input by returning an empty list.\n- Resources are filtered to those whose underlying resource is marked active.\n\n\n**Tags:**Locations, Resources, Scheduling", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Search Company Locations", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/Locations/Search", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "Locations", "Search" ], "query": [ { "key": "name", "value": "\u003Cname\u003E", "description": "Optional search text that is matched against the location name using a \u0060Contains\u0060 filter.", "disabled": true }, { "key": "limit", "value": "\u003Climit\u003E", "description": "Maximum number of rows to return; defaults to 10 to keep lookups performant.", "disabled": true } ], "variable": null }, "description": "Performs a lightweight search across the company\u0027s locations by name, returning at most the specified number of matches.\n\n**Usage Notes:**\n\n- Intended for type-ahead UI scenarios in Settings and Scheduling flows.\n- When\u0060name\u0060is omitted the method returns the first\u0060limit\u0060records alphabetically.\n- Always orders by the location name before paging.\n\n\n**Tags:**Locations, Search, Settings", "auth": null, "body": null } }, { "name": "Get Company Logo", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/Logo", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "Logo" ], "query": [ { "key": "width", "value": "\u003Cwidth\u003E", "description": "Optional. Specifies the desired width of the returned image.", "disabled": true }, { "key": "height", "value": "\u003Cheight\u003E", "description": "Optional. Specifies the desired height of the returned image.", "disabled": true }, { "key": "fit", "value": "\u003Cfit\u003E", "description": "Optional. Determines how the image should fit within the specified dimensions.", "disabled": true } ], "variable": null }, "description": "Retrieves the logo image for a specified company, with optional resizing and fit parameters.\n\n**Usage Notes:**\n\n- Respects image fit and resize parameters via\u0060ImageResizeFit\u0060enum.\n- Downloads the image from configured blob storage using\u0060mediaService\u0060.\n- Commonly used in branding and header display components.\n\n\n**Tags:**Companies, Media, Branding", "auth": null, "body": null } }, { "name": "Upload Company Logo", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/Logo", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "Logo" ], "query": null, "variable": null }, "description": "Uploads a new logo image for the specified company, validating file type and permissions before saving.\n\n**Usage Notes:**\n\n- Validates MIME type to ensure only image formats are accepted.\n- Uploads image to the configured media container using\u0060mediaService.Upload\u0060.\n- Updates the\u0060LogoMediaGuid\u0060field in the company record.\n\n\n**Tags:**Companies, Media, Branding", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Company Logo", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/Logo", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "Logo" ], "query": null, "variable": null }, "description": "Deletes the current logo image associated with the specified company, ensuring permission validation.\n\n**Usage Notes:**\n\n- Removes the logo reference from the company record by clearing\u0060LogoMediaGuid\u0060.\n- Does not remove the underlying blob file (handled separately by media cleanup jobs).\n- Requires\u0060ManageCompanyLogo\u0060permission for execution.\n\n\n**Tags:**Companies, Media, Branding", "auth": null, "body": null } }, { "name": "Get Company Media", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/Media", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "Media" ], "query": [ { "key": "showInCaseManagement", "value": "\u003CshowInCaseManagement\u003E", "description": "Optional filter. When specified, only returns media items matching this ShowInCaseManagement value.", "disabled": true } ], "variable": null }, "description": "Retrieves a list of active media files associated with a specific company,\n including file metadata and fully qualified URLs.\n\n**Usage Notes:**\n\n- Filters active records (\u0060Active = true\u0060) from the\u0060CompanyMedia\u0060table.\n- Generates fully qualified URLs using\u0060Request.GetBaseUrl()\u0060.\n- Used by company management and content display pages.\n\n\n**Tags:**Companies, Media, Files", "auth": null, "body": null } }, { "name": "Upload Company Media", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/Media", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "Media" ], "query": null, "variable": null }, "description": "Uploads one or more media files for the specified company, validating file type, size,\n and count before storing them and recording metadata.\n\n**Usage Notes:**\n\n- Supports multiple file uploads (limited by\u0060MediaConstants.MaxFileUploadCount\u0060).\n- Automatically calculates image dimensions for supported image types.\n- Generates publicly accessible URLs for uploaded media.\n- Files are persisted in the designated blob storage container and referenced in SQL.\n\n\n**Tags:**Companies, Media, Uploads", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Company Medium", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/Media/:companyMediumId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "Media", ":companyMediumId" ], "query": [ { "key": "width", "value": "\u003Cwidth\u003E", "description": "Optional. The desired width of the returned image (if applicable).", "disabled": true }, { "key": "height", "value": "\u003Cheight\u003E", "description": "Optional. The desired height of the returned image (if applicable).", "disabled": true }, { "key": "fit", "value": "\u003Cfit\u003E", "description": "Optional. Determines how the image should scale within the provided dimensions.", "disabled": true } ], "variable": [ { "key": "companyMediumId", "value": "\u003CcompanyMediumId\u003E", "type": "string" } ] }, "description": "Retrieves a specific company media file (such as an image or document) by its unique identifier,\n with optional parameters for resizing and fit behavior.\n\n**Usage Notes:**\n\n- Supports on-the-fly image resizing using\u0060width\u0060,\u0060height\u0060, and\u0060fit\u0060parameters.\n- Response is cached on the client for 10 minutes for performance.\n- Allows anonymous access for public display scenarios.\n\n\n**Tags:**Companies, Media, Files", "auth": null, "body": null } }, { "name": "Delete Company Medium", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/Media/:companyMediumId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "Media", ":companyMediumId" ], "query": null, "variable": [ { "key": "companyMediumId", "value": "\u003CcompanyMediumId\u003E", "type": "string" } ] }, "description": "Marks a company media file as inactive, effectively removing it from the company\u2019s active media list,\n while retaining the file record for auditing.\n\n**Usage Notes:**\n\n- Performs soft deletion by setting\u0060Active = false\u0060.\n- Does not physically remove files from storage; retention is handled separately.\n- Validates ownership to prevent cross-company modifications.\n\n\n**Tags:**Companies, Media, Deletion", "auth": null, "body": null } }, { "name": "Patch Company Medium Show In Case Management", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/Media/:companyMediumId/ShowInCaseManagement", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "Media", ":companyMediumId", "ShowInCaseManagement" ], "query": null, "variable": [ { "key": "companyMediumId", "value": "\u003CcompanyMediumId\u003E", "type": "string" } ] }, "description": "Updates the ShowInCaseManagement flag on a company media item, controlling\n whether it appears in Case Management overview panels.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create Memories Question", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/MemoriesQuestion", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "MemoriesQuestion" ], "query": null, "variable": null }, "description": "Creates a new memories question for the company after enforcing the necessary permissions.\n\n**Tags:**Memories, Create, Settings", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Memories Question", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/MemoriesQuestion/:memoriesQuestionId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "MemoriesQuestion", ":memoriesQuestionId" ], "query": null, "variable": [ { "key": "memoriesQuestionId", "value": "\u003CmemoriesQuestionId\u003E", "type": "string" } ] }, "description": "Updates an existing memories question belonging to the company.\n\n**Tags:**Memories, Update, Settings", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Memories Questions", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/MemoriesQuestions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "MemoriesQuestions" ], "query": null, "variable": null }, "description": "Retrieves all memories questions configured for the specified company.\n\n**Usage Notes:**\n\n- Used to populate the Memories Question management UI.\n\n\n**Tags:**Memories, Settings", "auth": null, "body": null } }, { "name": "Get User Companies and Funeral Homes", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/MyCompaniesWithFuneralHomes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "MyCompaniesWithFuneralHomes" ], "query": null, "variable": null }, "description": "Retrieves a lightweight list of companies and their associated funeral homes for the logged-in user.\n This endpoint combines company and funeral home data in a single call for efficient loading.\n\n**Usage Notes:**\n\n- Returns only lightweight DTOs with minimal data (IDs and names only).\n- Performs company-level permission validation before retrieving data.\n- Applies view permissions to restrict funeral homes based on the user\u0027s roles.\n- Optimized for UI components that need to display company/funeral home selection.\n\n\n**Tags:**Companies, Funeral Homes, Permissions", "auth": null, "body": null } }, { "name": "Get User Funeral Homes", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/MyFuneralHomes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "MyFuneralHomes" ], "query": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "description": "Optional. Filters results to a single company if specified; otherwise returns funeral homes across all accessible companies.", "disabled": true } ], "variable": null }, "description": "Retrieves a list of funeral homes associated with the logged-in user\u0027s accessible companies.\n Optionally filters the results to a specific company if a Company ID is provided.\n\n**Usage Notes:**\n\n- Performs company-level permission validation before retrieving data.\n- Groups funeral homes by company to optimize client database queries.\n- Includes contract and addendum report mappings using location relationships.\n- Applies view permissions to restrict funeral homes based on the user\u2019s roles.\n\n\n**Tags:**Funeral Homes, Companies, Permissions", "auth": null, "body": null } }, { "name": "Get Obituary Fields Metadata", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/ObituaryFields", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "ObituaryFields" ], "query": null, "variable": null }, "description": "Retrieves the database field metadata used for obituary exports by executing the Aurora stored procedure.\n\n**Tags:**Obituaries, Metadata", "auth": null, "body": null } }, { "name": "Create Obituary Template", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/ObituaryTemplate", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "ObituaryTemplate" ], "query": null, "variable": null }, "description": "Creates a new obituary template for the company and returns the saved DTO.\n\n**Tags:**Obituaries, Templates, Create", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Obituary Templates", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/ObituaryTemplates", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "ObituaryTemplates" ], "query": null, "variable": null }, "description": "Returns the active obituary templates for the specified company, including mapped DTO metadata.\n\n**Tags:**Obituaries, Templates, Settings", "auth": null, "body": null } }, { "name": "Update Obituary Template", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/ObituaryTemplates/:obituaryTemplateId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "ObituaryTemplates", ":obituaryTemplateId" ], "query": null, "variable": [ { "key": "obituaryTemplateId", "value": "\u003CobituaryTemplateId\u003E", "type": "string" } ] }, "description": "Updates an existing obituary template after validating it belongs to the company and is active.\n\n**Tags:**Obituaries, Templates, Update", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Obituary Template", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/ObituaryTemplates/:ObituaryTemplateId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "ObituaryTemplates", ":ObituaryTemplateId" ], "query": null, "variable": [ { "key": "ObituaryTemplateId", "value": "\u003CObituaryTemplateId\u003E", "type": "string" } ] }, "description": "Soft deletes an obituary template by marking it inactive.\n\n**Tags:**Obituaries, Templates, Delete", "auth": null, "body": null } }, { "name": "Update QuickBooks Preferred Person Type", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/PostQuickbooksPreferredPersonType", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "PostQuickbooksPreferredPersonType" ], "query": null, "variable": null }, "description": "Persists the preferred person type used when syncing to QuickBooks.\n\n**Tags:**QuickBooks, Integrations", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Preference Settings Metadata", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/PreferenceSettings", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "PreferenceSettings" ], "query": null, "variable": null }, "description": "Retrieves the preference configuration model including available types, defaults, and current values for the company.\n\n**Usage Notes:**\n\n- Used to populate the comprehensive Preference Settings UI.\n- Combines shared Advisor Master metadata with client-specific values.\n\n\n**Tags:**Preferences, Settings", "auth": null, "body": null } }, { "name": "Update Preference Settings", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/PreferenceSettings", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "PreferenceSettings" ], "query": null, "variable": null }, "description": "Persists changes to the company\u2019s preference settings using the provided DTO collection.\n\n**Usage Notes:**\n\n- Creates new records when an AppSettingsId is not found.\n- Maps incoming DTO fields onto tracked entities to persist updates.\n\n\n**Tags:**Preferences, Settings", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Publish-Obituary Integration Configuration Status", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/PublishObituaryIntegrations", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "PublishObituaryIntegrations" ], "query": null, "variable": null }, "description": "Reports whether FuneralTech, CFS, Tukios, and DOMO are configured for the company\n so the workflow action picker can enable or disable the corresponding action types.\n Does NOT guarantee that any specific case will publish or sync successfully;\n credentials and per-funeral-home configuration are validated at runtime when the\n action fires. Despite the endpoint name, this also reports DOMO configuration status.", "auth": null, "body": null } }, { "name": "Get Security Roles", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/SecurityRoles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "SecurityRoles" ], "query": null, "variable": null }, "description": "Retrieves a list of available security roles for the specified company, including\n both company-specific and global roles.\n\n**Usage Notes:**\n\n- Includes both company-specific and shared (global) roles.\n- Excludes internal roles such as \u201CSystem Administrator\u201D (RoleId 6).\n- Results are sorted by company scope and role name.\n- Applies permission filtering via\u0060ApplyViewPermissions\u0060.\n\n\n**Tags:**Companies, Roles, Security", "auth": null, "body": null } }, { "name": "Send Test Email", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/SendTestEmail", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "SendTestEmail" ], "query": null, "variable": null }, "description": "Sends a test email using the company\u0027s SMTP configuration to verify it works correctly.\n\n**Tags:**Email, Integrations", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Send Test SMS", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/SendTestSms", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "SendTestSms" ], "query": null, "variable": null }, "description": "Sends a test SMS using the company\u0027s Twilio configuration to verify it works correctly.\n\n**Tags:**Twilio, Integrations", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Company Tags", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/Tags", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "Tags" ], "query": null, "variable": null }, "description": "Retrieves tags associated with the user\u2019s company or corporation, applying permission filtering\n based on the user\u2019s role and optional funeral home ID.\n\n**Usage Notes:**\n\n- Supports different tag scopes depending on role (Zeus, AuroraAdmin, CorporateManager, etc.).\n- For corporate users, retrieves tags across all subsidiary companies.\n- Applies permission filtering through\u0060ApplyViewPermissions\u0060.\n- Used to populate tag selectors and reporting filters throughout the platform.\n\n\n**Tags:**Tags, Companies, Roles", "auth": null, "body": null } }, { "name": "Patch Company Tags", "description": null, "item": null, "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/Tags", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "Tags" ], "query": null, "variable": null }, "description": "Applies partial updates to the tags associated with a company using a JSON Patch document.\n Ensures the user has permission to modify tags for the specified company.\n\n**Usage Notes:**\n\n- Ensures tag updates are only applied to companies the user can access.\n- Removes invalid or obsolete tags and adds new tags as specified in the patch document.\n- Automatically creates new\u0060Tag\u0060records when necessary.\n\n\n**Example Patch Document:**[\n { \u0022op\u0022: \u0022add\u0022, \u0022path\u0022: \u0022/companyTags/-\u0022, \u0022value\u0022: \u0022UpdatedTag\u0022 },\n { \u0022op\u0022: \u0022replace\u0022, \u0022path\u0022: \u0022/companyTags/0\u0022, \u0022value\u0022: \u0022ReplacedTag\u0022 }\n ]\n\n**Tags:**Tags, Companies, Metadata", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create Tax Rate", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/TaxRate", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "TaxRate" ], "query": null, "variable": null }, "description": "Creates a new tax rate for a company, including its details and applicable locations.\n\n**Usage Notes:**\n\n- Automatically assigns creation metadata and associates the rate with the company.\n- Calls\u0060UpdateTaxDetailAndLocations\u0060to apply detailed configurations.\n- Persists all changes to the client database via EF Core.\n\n\n**Tags:**Companies, Tax, Finance", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Tax Rate", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/TaxRate", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "TaxRate" ], "query": null, "variable": null }, "description": "Updates an existing tax rate record for a company using provided configuration data.\n\n**Usage Notes:**\n\n- Validates that the tax rate exists before applying updates.\n- Calls\u0060UpdateTaxDetailAndLocations\u0060to maintain linked configurations.\n- Used in tax rate edit forms and administrative settings.\n\n\n**Tags:**Companies, Tax, Finance", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Tax Rate", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/TaxRate/:taxRateId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "TaxRate", ":taxRateId" ], "query": null, "variable": [ { "key": "taxRateId", "value": "\u003CtaxRateId\u003E", "type": "string" } ] }, "description": "Retrieves detailed information about a single tax rate for the specified company.\n\n**Usage Notes:**\n\n- Retrieves associated rate details and location rates for comprehensive results.\n- Used in the tax management editor and rate validation routines.\n\n\n**Tags:**Companies, Tax, Finance", "auth": null, "body": null } }, { "name": "Get Tax Rates", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/TaxRates", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "TaxRates" ], "query": null, "variable": null }, "description": "Retrieves all active tax rates for the specified company, including related rate details,\n location rates, and tax rate types.\n\n**Usage Notes:**\n\n- Includes related entities (\u0060TaxRateDetails\u0060,\u0060LocationTaxRates\u0060,\u0060TaxRateType\u0060).\n- Uses split queries to improve performance and avoid Cartesian expansion.\n- Used for tax configuration management and reporting interfaces.\n\n\n**Tags:**Companies, Tax, Finance", "auth": null, "body": null } }, { "name": "Test Email Configuration", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/TestEmail", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "TestEmail" ], "query": null, "variable": null }, "description": "Tests SMTP configuration by attempting to connect to the server.\n\n**Tags:**Email, Integrations", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Test Twilio Credentials", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/TestTwilio", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "TestTwilio" ], "query": null, "variable": null }, "description": "Validates Twilio credentials by attempting to connect to the Twilio API.\n\n**Tags:**Twilio, Integrations", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Twilio Configuration", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/TwilioConfig", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "TwilioConfig" ], "query": null, "variable": null }, "description": "Retrieves the current Twilio integration configuration for the company.\n Auth token is masked for security.\n\n**Tags:**Twilio, Integrations", "auth": null, "body": null } }, { "name": "Add Twilio Phone Number", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/TwilioPhoneNumber", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "TwilioPhoneNumber" ], "query": null, "variable": null }, "description": "Adds a phone number to the company\u0027s Twilio configuration.\n\n**Tags:**Twilio, Integrations", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Twilio Phone Number", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/TwilioPhoneNumber/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "TwilioPhoneNumber", ":id" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "Removes a phone number from the company\u0027s Twilio configuration.\n\n**Tags:**Twilio, Integrations", "auth": null, "body": null } }, { "name": "Update Twilio Phone Number", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/TwilioPhoneNumber/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "TwilioPhoneNumber", ":id" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "Updates the friendly name of a Twilio phone number.\n\n**Tags:**Twilio, Integrations", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Set Default Twilio Phone Number", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/TwilioPhoneNumber/:id/SetDefault", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "TwilioPhoneNumber", ":id", "SetDefault" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "Sets the specified phone number as the default for SMS sending.\n\n**Tags:**Twilio, Integrations", "auth": null, "body": null } }, { "name": "Get Twilio Phone Numbers", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/TwilioPhoneNumbers", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "TwilioPhoneNumbers" ], "query": null, "variable": null }, "description": "Retrieves all configured Twilio phone numbers for the company.\n\n**Tags:**Twilio, Integrations", "auth": null, "body": null } }, { "name": "Update PayPal Partial Payment Allowance", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/UpdatePaypalPartialPaymentAllowance", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "UpdatePaypalPartialPaymentAllowance" ], "query": null, "variable": null }, "description": "Toggles whether partial payments are allowed for the company\u2019s PayPal integration.\n\n**Tags:**PayPal, Integrations", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update PayPal Term Limit", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Company/UpdatePaypalTermLimit", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Company", "UpdatePaypalTermLimit" ], "query": null, "variable": null }, "description": "Updates the PayPal term limit setting for the company.\n\n**Tags:**PayPal, Integrations", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } } ], "request": null }, { "name": "Company Settings", "description": null, "item": [ { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/CompanySettings/TaxPrepayment", "host": [ "{{baseUrl}}" ], "path": [ "v2", "CompanySettings", "TaxPrepayment" ], "query": null, "variable": null }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/CompanySettings/TaxPrepayment", "host": [ "{{baseUrl}}" ], "path": [ "v2", "CompanySettings", "TaxPrepayment" ], "query": null, "variable": null }, "description": "", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } } ], "request": null }, { "name": "Company: Data Export", "description": null, "item": [ { "name": "Get Previous Exports", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Export", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Export" ], "query": [ { "key": "startDate", "value": "\u003CstartDate\u003E", "description": "The start date of the range for which export data should be included.", "disabled": true }, { "key": "endDate", "value": "\u003CendDate\u003E", "description": "The end date of the range for which export data should be included.", "disabled": true } ], "variable": null }, "description": "Retrieves export information for the specified company and date range, including multiple export types such as\n contracts, addendums, payments, miscellaneous sales, miscellaneous sale payments, and cash receipts.\n Results are grouped by export date and location, aggregated across all databases accessible to the current user.\n\n**Usage Notes:**\n\n- Supports filtering by date range and permission scope.\n- Combines export data for all companies the user has access to.\n- Each record includes company name, location, and export counts.\n- Useful for reviewing export activity and verifying data integration.\n\n\n**Tags:**Data Export, Reports, Integration", "auth": null, "body": null } }, { "name": "Perform Export", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Export", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Export" ], "query": null, "variable": null }, "description": "Executes a data export operation for the specified export type, funeral homes, and date range.\n The endpoint runs the associated stored procedure and returns the exported results in Excel format.\n\n**Usage Notes:**\n\n- Dynamically selects the correct stored procedure based on export type and category.\n- Includes parameters for funeral homes, date range, and mark-as-exported option.\n- Supports multi-company aggregation by iterating through accessible databases.\n- Returns an Excel file generated via\u0060ExcelExportHelper.ExportExcel()\u0060.\n\n\n**Tags:**Data Export, Excel, Reporting", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Call Export Data", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Export/:callId/CallHistory", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Export", ":callId", "CallHistory" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Retrieves detailed export history for a specific call, including contracts, addendums, and payment records.\n This endpoint provides visibility into when and by whom each item was exported.\n\n**Usage Notes:**\n\n- Includes contract, addendum, and payment export records.\n- Each record includes the export date and exporting user.\n- Used to audit and troubleshoot data export history for specific calls.\n- Results are ordered chronologically by export date.\n\n\n**Tags:**Data Export, Case Management, Audit", "auth": null, "body": null } }, { "name": "Add QuickBooks Tax Code Mapping", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Export/AddQuickbooksTaxCodeMapping", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Export", "AddQuickbooksTaxCodeMapping" ], "query": null, "variable": null }, "description": "Associates a QuickBooks tax code with an existing tax rate in the system.\n Enables synchronization of tax configurations between the application and QuickBooks.\n\n**Usage Notes:**\n\n- Ensures one-to-one mapping between internal tax rates and QuickBooks tax codes.\n- Used during export to align financial data structures between systems.\n- Automatically persists the change in the local database.\n- Essential for accurate tax reporting in integrated environments.\n\n\n**Tags:**QuickBooks, Tax, Configuration", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Export Types", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Export/ExportTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Export", "ExportTypes" ], "query": null, "variable": null }, "description": "Retrieves all active export configurations from the master database,\n providing metadata about available export operations.\n\n**Usage Notes:**\n\n- Pulls data from the\u0060ExportConfigurations\u0060table where\u0060Active = 1\u0060.\n- Each record includes export type name, ID, and configuration metadata.\n- Used to populate export dropdowns or configuration lists in the UI.\n- Returns an empty list if no active configurations are found.\n\n\n**Tags:**Data Export, Configuration, Administration", "auth": null, "body": null } }, { "name": "Get Data for PayPal Invoice", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Export/GetDataForPayPalInvoice/:callId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Export", "GetDataForPayPalInvoice", ":callId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Generates PayPal invoice data for a specific case (call), combining purchaser, contract,\n and location details into a formatted invoice structure.\n\n**Usage Notes:**\n\n- Calculates total contract amounts and applicable taxes for PayPal billing.\n- Maps internal address and purchaser information to PayPal\uFFFDs invoice schema.\n- Automatically applies company-specific term limits for payment deadlines.\n- Used to generate external invoices for non-integrated payment workflows.\n\n\n**Tags:**PayPal, Invoicing, Integration", "auth": null, "body": null } }, { "name": "Get Existing Invoice Exports", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Export/GetExistingInvoiceExports", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Export", "GetExistingInvoiceExports" ], "query": null, "variable": null }, "description": "Retrieves all existing QuickBooks export audit records for the specified company.\n Includes details about each export, such as type, success status, and QuickBooks object ID.\n\n**Usage Notes:**\n\n- Includes export records regardless of success or failure status.\n- Each record contains audit metadata such as timestamps and error messages.\n- Used to verify export completion and assist in troubleshooting.\n- Supports financial reconciliation and duplicate export prevention.\n\n\n**Tags:**QuickBooks, Export Audit, Accounting", "auth": null, "body": null } }, { "name": "Get QuickBooks Invoice IDs", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Export/GetQuickbooksInvoiceId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Export", "GetQuickbooksInvoiceId" ], "query": null, "variable": null }, "description": "Retrieves a list of QuickBooks invoice IDs from successful QuickBooks export audit records\n associated with the specified company.\n\n**Usage Notes:**\n\n- Includes only records with non-null QuickBooks object IDs marked as successful.\n- Used to verify which invoices were successfully synchronized with QuickBooks.\n- Results are filtered by the current company context.\n- Supports downstream reconciliation and integration validation.\n\n\n**Tags:**QuickBooks, Accounting, Integration", "auth": null, "body": null } }, { "name": "Reset Exports", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Export/Reset", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Export", "Reset" ], "query": null, "variable": null }, "description": "Clears export data across one or more funeral homes for a specified export type and date.\n This process resets export flags to allow data to be re-exported.\n\n**Usage Notes:**\n\n- Clears\u0060DateExported\u0060and\u0060ExportedBy\u0060fields for matching records.\n- Supports export types: Contract, Addendum, Payment, MiscSale, MiscSalePayment, and CashReceipt.\n- Processes all accessible client databases associated with the user\u0027s companies.\n- Used for rollback and data reprocessing after export issues.\n\n\n**Tags:**Data Export, Rollback, Administration", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Reset Export Line", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Export/ResetCaseItem", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Export", "ResetCaseItem" ], "query": null, "variable": null }, "description": "Clears the export status for a specific exported record, such as a call, contract detail, or payment.\n This allows the record to be re-exported if needed.\n\n**Usage Notes:**\n\n- Supports resetting export flags for contracts, addendums, and payments.\n- Removes values from\u0060DateExported\u0060and\u0060ExportedBy\u0060fields.\n- Commonly used when correcting export errors or regenerating files.\n- Applies only to the specific record identified in the request.\n\n\n**Tags:**Data Export, Maintenance, Administration", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Search Addendums for Export", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Export/SearchAddendums", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Export", "SearchAddendums" ], "query": [ { "key": "locationId", "value": "\u003ClocationId\u003E", "description": null, "disabled": true }, { "key": "startDate", "value": "\u003CstartDate\u003E", "description": "The start date for filtering addendum creation or contract dates.", "disabled": true }, { "key": "endDate", "value": "\u003CendDate\u003E", "description": "The end date for filtering addendum creation or contract dates.", "disabled": true } ], "variable": null }, "description": "Retrieves addendum contract data eligible for export within a specified date range and list of locations.\n Each addendum includes associated contract details and pricing information.\n\n**Usage Notes:**\n\n- Filters addendums based on contract and creation dates.\n- Includes item details such as GL codes, cost, quantity, and taxability.\n- Used to build QuickBooks export files for addendum data.\n- Supports multi-contract scenarios and nested item detail resolution.\n\n\n**Tags:**QuickBooks, Addendum, Data Export", "auth": null, "body": null } }, { "name": "Search Contracts for Export", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Export/SearchExports", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Export", "SearchExports" ], "query": [ { "key": "locationId", "value": "\u003ClocationId\u003E", "description": null, "disabled": true }, { "key": "startDate", "value": "\u003CstartDate\u003E", "description": "The start date for filtering contract creation or modification dates.", "disabled": true }, { "key": "endDate", "value": "\u003CendDate\u003E", "description": "The end date for filtering contract creation or modification dates.", "disabled": true }, { "key": "exportType", "value": "\u003CexportType\u003E", "description": "The export type (e.g., Contract, Addendum) determining which records are returned.", "disabled": true } ], "variable": null }, "description": "Retrieves contract data ready for export to QuickBooks based on specified locations,\n date range, and export type. Includes contract details, tax mappings, and validation messages.\n\n**Usage Notes:**\n\n- Excludes already exported contracts and filters by export type.\n- Includes validation flags such as unmapped tax codes or missing preferred persons.\n- Supports item-level detail, GL code mapping, and tax information export.\n- Used to prepare contract data for QuickBooks synchronization.\n\n\n**Tags:**QuickBooks, Contracts, Data Export", "auth": null, "body": null } }, { "name": "Search Payments for Export", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Export/SearchPayments", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Export", "SearchPayments" ], "query": [ { "key": "locationId", "value": "\u003ClocationId\u003E", "description": null, "disabled": true }, { "key": "startDate", "value": "\u003CstartDate\u003E", "description": "The start date of the date range filter.", "disabled": true }, { "key": "endDate", "value": "\u003CendDate\u003E", "description": "The end date of the date range filter.", "disabled": true } ], "variable": null }, "description": "Searches for payments eligible for export to QuickBooks within a given date range and set of locations.\n Filters out payments that have already been exported.\n\n**Usage Notes:**\n\n- Filters payments by creation date and excludes already exported records.\n- Includes details such as case number, decedent name, location, and payment type.\n- Used to generate QuickBooks payment export batches.\n- Supports location-based financial reporting and export validation.\n\n\n**Tags:**QuickBooks, Payments, Export", "auth": null, "body": null } }, { "name": "Update Call Table", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Export/UpdateCallTable", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Export", "UpdateCallTable" ], "query": null, "variable": null }, "description": "Marks a case (call) as exported to QuickBooks by updating its DateExported\n and ExportedBy fields.\n\n**Usage Notes:**\n\n- Updates export metadata when synchronizing calls to QuickBooks.\n- Sets the export timestamp to\u0060UTC\u0060and tracks the user performing the export.\n- Does nothing if the specified call is not found.\n- Supports asynchronous export tracking for accounting integration.\n\n\n**Tags:**QuickBooks, Data Export, Integration", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update General Ledger Account", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Export/UpdateGeneralLedgerAccount", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Export", "UpdateGeneralLedgerAccount" ], "query": null, "variable": null }, "description": "Updates the general ledger (GL) code for a specified entity within QuickBooks-related tables.\n Supports updating GL codes for items, item types, location items, and package locations.\n\n**Usage Notes:**\n\n- Automatically clears dependent GL codes if a code is marked as invalid.\n- Supports update types: LocationItem, Item, ItemType, and PackageLocation.\n- Applies permission checks for each update type individually.\n- Used for financial integration and chart-of-accounts maintenance.\n\n\n**Tags:**QuickBooks, Finance, Configuration", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Payment Table", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Export/UpdatePaymentTable", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Export", "UpdatePaymentTable" ], "query": null, "variable": null }, "description": "Marks a payment as exported to QuickBooks by updating its DateExported\n and ExportedBy fields.\n\n**Usage Notes:**\n\n- Synchronizes payment records with QuickBooks export status.\n- Automatically sets the export timestamp and exporting user ID.\n- Ensures accurate financial audit trails across systems.\n- Does nothing if the specified payment does not exist.\n\n\n**Tags:**QuickBooks, Payments, Accounting", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update QuickBooks Export Audit", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Export/UpdateQuickbooksExportAuditTable", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Export", "UpdateQuickbooksExportAuditTable" ], "query": null, "variable": null }, "description": "Adds a new QuickBooks export audit record, linking exported data such as calls, contracts,\n contract details, and payments to their corresponding QuickBooks object identifiers.\n\n**Usage Notes:**\n\n- Supports export types: Contract, Payment, Addendum, MiscSale, MiscSalePayment, and CashReceipt.\n- Links related entities (Call, Contract, ContractDetail, Payment) where applicable.\n- Records export success or failure messages for traceability.\n- Transaction-protected to ensure consistency across multiple related entities.\n\n\n**Tags:**QuickBooks, Audit, Accounting", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } } ], "request": null }, { "name": "Connections: Guides", "description": null, "item": [ { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/:entityType/:entityId/ConnectionsGuide", "host": [ "{{baseUrl}}" ], "path": [ "v2", ":entityType", ":entityId", "ConnectionsGuide" ], "query": null, "variable": [ { "key": "entityType", "value": "\u003CentityType\u003E", "type": "string" }, { "key": "entityId", "value": "\u003CentityId\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ConnectionsGuide", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ConnectionsGuide" ], "query": [ { "key": "includeInactive", "value": "\u003CincludeInactive\u003E", "description": null, "disabled": true } ], "variable": null }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ConnectionsGuide", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ConnectionsGuide" ], "query": [ { "key": "corporationId", "value": "\u003CcorporationId\u003E", "description": null, "disabled": true } ], "variable": null }, "description": "", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ConnectionsGuide/:globalId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ConnectionsGuide", ":globalId" ], "query": null, "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ConnectionsGuide/:globalId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ConnectionsGuide", ":globalId" ], "query": null, "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ConnectionsGuide/:globalId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ConnectionsGuide", ":globalId" ], "query": null, "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ConnectionsGuide/:globalId/Duplicate", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ConnectionsGuide", ":globalId", "Duplicate" ], "query": [ { "key": "newName", "value": "\u003CnewName\u003E", "description": null, "disabled": true } ], "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ConnectionsGuide/:globalId/Export", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ConnectionsGuide", ":globalId", "Export" ], "query": null, "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ConnectionsGuide/:globalId/Media", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ConnectionsGuide", ":globalId", "Media" ], "query": null, "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ConnectionsGuide/:globalId/Media", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ConnectionsGuide", ":globalId", "Media" ], "query": null, "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ConnectionsGuide/:globalId/Media/:mediaId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ConnectionsGuide", ":globalId", "Media", ":mediaId" ], "query": [ { "key": "width", "value": "\u003Cwidth\u003E", "description": null, "disabled": true }, { "key": "height", "value": "\u003Cheight\u003E", "description": null, "disabled": true }, { "key": "fit", "value": "\u003Cfit\u003E", "description": null, "disabled": true } ], "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" }, { "key": "mediaId", "value": "\u003CmediaId\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ConnectionsGuide/:globalId/Media/:mediaId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ConnectionsGuide", ":globalId", "Media", ":mediaId" ], "query": null, "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" }, { "key": "mediaId", "value": "\u003CmediaId\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ConnectionsGuide/:globalId/Media/CopyFromLibrary", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ConnectionsGuide", ":globalId", "Media", "CopyFromLibrary" ], "query": null, "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ConnectionsGuide/Assignment", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ConnectionsGuide", "Assignment" ], "query": [ { "key": "entityType", "value": "\u003CentityType\u003E", "description": null, "disabled": true }, { "key": "entityId", "value": "\u003CentityId\u003E", "description": null, "disabled": true } ], "variable": null }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ConnectionsGuide/Assignment", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ConnectionsGuide", "Assignment" ], "query": null, "variable": null }, "description": "", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ConnectionsGuide/Assignment", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ConnectionsGuide", "Assignment" ], "query": [ { "key": "entityType", "value": "\u003CentityType\u003E", "description": null, "disabled": true }, { "key": "entityId", "value": "\u003CentityId\u003E", "description": null, "disabled": true } ], "variable": null }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ConnectionsGuide/Default", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ConnectionsGuide", "Default" ], "query": null, "variable": null }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ConnectionsGuide/Import", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ConnectionsGuide", "Import" ], "query": [ { "key": "corporationId", "value": "\u003CcorporationId\u003E", "description": null, "disabled": true }, { "key": "nameOverride", "value": "\u003CnameOverride\u003E", "description": null, "disabled": true }, { "key": "overrideGuideId", "value": "\u003CoverrideGuideId\u003E", "description": null, "disabled": true } ], "variable": null }, "description": "", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ConnectionsGuide/Import/Template/:templateName", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ConnectionsGuide", "Import", "Template", ":templateName" ], "query": null, "variable": [ { "key": "templateName", "value": "\u003CtemplateName\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ConnectionsGuide/Import/Templates", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ConnectionsGuide", "Import", "Templates" ], "query": null, "variable": null }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ConnectionsGuide/Import/Validate", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ConnectionsGuide", "Import", "Validate" ], "query": [ { "key": "overrideGuideId", "value": "\u003CoverrideGuideId\u003E", "description": null, "disabled": true } ], "variable": null }, "description": "", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } } ], "request": null }, { "name": "Connections: Internal", "description": null, "item": [ { "name": "Case (by Call Id)", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Advisor/Case/:CallId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Advisor", "Case", ":CallId" ], "query": null, "variable": [ { "key": "CallId", "value": "\u003CCallId\u003E", "type": "string" } ] }, "description": "Returns a Case that matches the Call Id specified in the request.", "auth": null, "body": null } }, { "name": "Create a Case (for a Call)", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Advisor/Case/:CallId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Advisor", "Case", ":CallId" ], "query": null, "variable": [ { "key": "CallId", "value": "\u003CCallId\u003E", "type": "string" } ] }, "description": "Creates a Case for Call Id specified in the request.", "auth": null, "body": null } }, { "name": "Cases", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Cases", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Cases" ], "query": null, "variable": null }, "description": "Returns list of Cases matching Company Id specified in request.", "auth": null, "body": null } }, { "name": "Leads", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Leads", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Leads" ], "query": null, "variable": null }, "description": "Returns list of Leads matching Company Id specified in request.", "auth": null, "body": null } }, { "name": "Add a Page Flow", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/PageFlow", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "PageFlow" ], "query": null, "variable": null }, "description": "Allows for adding a new Page Flow for the Company Id and Selected Funeral Home Id (for Permissions check) and Page Flow payload in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Retrieve page flow connections by ID", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/PageFlow/:pageFlowConnectionsId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "PageFlow", ":pageFlowConnectionsId" ], "query": null, "variable": [ { "key": "pageFlowConnectionsId", "value": "\u003CpageFlowConnectionsId\u003E", "type": "string" } ] }, "description": "Retrieves page flow connections based on the provided ID. Additionally, it fetches and includes related media information.", "auth": null, "body": null } }, { "name": "Update a Page Flow", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/PageFlow/:pageFlowConnectionsId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "PageFlow", ":pageFlowConnectionsId" ], "query": null, "variable": [ { "key": "pageFlowConnectionsId", "value": "\u003CpageFlowConnectionsId\u003E", "type": "string" } ] }, "description": "Allows for updating a Page Flow for the Company Id and Selected Funeral Home Id (for Permissions check) to match Page Flow payload in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a Page Flow", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/PageFlow/:pageFlowConnectionsId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "PageFlow", ":pageFlowConnectionsId" ], "query": null, "variable": [ { "key": "pageFlowConnectionsId", "value": "\u003CpageFlowConnectionsId\u003E", "type": "string" } ] }, "description": "Allows for deleting a Page Flow for the Company Id, Selected Funeral Home Id (for Permissions check) and Page Flow in request.", "auth": null, "body": null } }, { "name": "Adds Page Flow Media", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/PageFlow/:pageFlowConnectionsId/Media", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "PageFlow", ":pageFlowConnectionsId", "Media" ], "query": null, "variable": [ { "key": "pageFlowConnectionsId", "value": "\u003CpageFlowConnectionsId\u003E", "type": "string" } ] }, "description": "Allows for add of Page Flow Media for the Company Id and Page Flow Id in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Page Flow Media", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/PageFlow/:PageFlowConnectionsId/Media", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "PageFlow", ":PageFlowConnectionsId", "Media" ], "query": null, "variable": [ { "key": "PageFlowConnectionsId", "value": "\u003CPageFlowConnectionsId\u003E", "type": "string" } ] }, "description": "Returns Page Flow Media for the Company Id and Page Flow Id in request.", "auth": null, "body": null } }, { "name": "Delete a Page Flow Media", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/PageFlow/:pageFlowConnectionsId/Media/:pageFlowConnectionsMediumId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "PageFlow", ":pageFlowConnectionsId", "Media", ":pageFlowConnectionsMediumId" ], "query": null, "variable": [ { "key": "pageFlowConnectionsId", "value": "\u003CpageFlowConnectionsId\u003E", "type": "string" }, { "key": "pageFlowConnectionsMediumId", "value": "\u003CpageFlowConnectionsMediumId\u003E", "type": "string" } ] }, "description": "Allows for deletion of Page Flow Media for the Company Id and Page Flow/ Page Flow Media Ids in request.", "auth": null, "body": null } }, { "name": "Adds Page Flow Media Blobs", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/PageFlow/:PageFlowConnectionsId/Media/Blob", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "PageFlow", ":PageFlowConnectionsId", "Media", "Blob" ], "query": null, "variable": [ { "key": "PageFlowConnectionsId", "value": "\u003CPageFlowConnectionsId\u003E", "type": "string" } ] }, "description": "Allows for add of Page Flow Media for the Company Id and Page Flow Id in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Page Flow Media", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/PageFlow/Media/:pageFlowConnectionsMediumId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "PageFlow", "Media", ":pageFlowConnectionsMediumId" ], "query": [ { "key": "width", "value": "\u003Cwidth\u003E", "description": "Width", "disabled": true }, { "key": "height", "value": "\u003Cheight\u003E", "description": "Height", "disabled": true }, { "key": "fit", "value": "\u003Cfit\u003E", "description": "Resize Fit (Container or Cover)", "disabled": true } ], "variable": [ { "key": "pageFlowConnectionsMediumId", "value": "\u003CpageFlowConnectionsMediumId\u003E", "type": "string" } ] }, "description": "Returns Page Flow Media for the Company Id and Page Flow Id in request.", "auth": null, "body": null } }, { "name": "Page Flows", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/PageFlows", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "PageFlows" ], "query": null, "variable": null }, "description": "Allows for Updating Funeral Home Settings matching Company Id and Funeral Home Key specified in request.", "auth": null, "body": null } }, { "name": "Update Funeral Home Settings", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Settings", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Settings" ], "query": null, "variable": null }, "description": "Allows for Updating Funeral Home Settings matching Company Id and Funeral Home Key specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Retrieve setup settings for a specific funeral home", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Settings/:funeralHomeKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Settings", ":funeralHomeKey" ], "query": null, "variable": [ { "key": "funeralHomeKey", "value": "\u003CfuneralHomeKey\u003E", "type": "string" } ] }, "description": "Retrieves setup settings for a funeral home by its unique key. If settings do not exist, default settings are created from a master setting template.", "auth": null, "body": null } } ], "request": null }, { "name": "Connections: Public", "description": null, "item": [ { "name": "Retrieve the name and basic details of a funeral home by its key", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/:funeralHomeKey/FuneralHomeName", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", ":funeralHomeKey", "FuneralHomeName" ], "query": null, "variable": [ { "key": "funeralHomeKey", "value": "\u003CfuneralHomeKey\u003E", "type": "string" } ] }, "description": "Retrieves basic information about a funeral home using its unique key. Throws an exception if the funeral home key is invalid.", "auth": null, "body": null } }, { "name": "Retrieve the lead page configuration for a funeral home by its key.\n Resolves the Connections Guide via the assignment hierarchy and returns\n lead page customization fields, template type, and logo URL.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/:funeralHomeKey/LeadPage", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", ":funeralHomeKey", "LeadPage" ], "query": null, "variable": [ { "key": "funeralHomeKey", "value": "\u003CfuneralHomeKey\u003E", "type": "string" } ] }, "description": "Retrieve the lead page configuration for a funeral home by its key.\n Resolves the Connections Guide via the assignment hierarchy and returns\n lead page customization fields, template type, and logo URL.", "auth": null, "body": null } }, { "name": "Stream the funeral home logo by FuneralHomeKey for anonymous family viewers.\n Anonymous variant of keyed by\n the public-safe Guid the family already has from the Connections URL.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/:funeralHomeKey/Logo", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", ":funeralHomeKey", "Logo" ], "query": [ { "key": "width", "value": "\u003Cwidth\u003E", "description": null, "disabled": true }, { "key": "height", "value": "\u003Cheight\u003E", "description": null, "disabled": true }, { "key": "fit", "value": "\u003Cfit\u003E", "description": null, "disabled": true } ], "variable": [ { "key": "funeralHomeKey", "value": "\u003CfuneralHomeKey\u003E", "type": "string" } ] }, "description": "Stream the funeral home logo by FuneralHomeKey for anonymous family viewers.\n Anonymous variant of keyed by\n the public-safe Guid the family already has from the Connections URL.", "auth": null, "body": null } }, { "name": "Retrieve the effective Connections version for a funeral home by its key.\n This is an anonymous endpoint so the public Connections app can resolve versions.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/:funeralHomeKey/Version", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", ":funeralHomeKey", "Version" ], "query": null, "variable": [ { "key": "funeralHomeKey", "value": "\u003CfuneralHomeKey\u003E", "type": "string" } ] }, "description": "Retrieve the effective Connections version for a funeral home by its key.\n This is an anonymous endpoint so the public Connections app can resolve versions.", "auth": null, "body": null } }, { "name": "Create a Case", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case" ], "query": null, "variable": null }, "description": "Creates a new Case.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Case", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Returns details for a Case matching the supplied Token value.", "auth": null, "body": null } }, { "name": "Update a Case", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Updates a Case to match the Application State specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Case Album", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/Album", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "Album" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Returns List of Photos for Case matching Token in request.", "auth": null, "body": null } }, { "name": "Upload Photos to Case Album", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/Album", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "Album" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Allows for Upload of Photos to a Case Album matching token in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a Case Album Photo", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/Album/:filename", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "Album", ":filename" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" }, { "key": "filename", "value": "\u003Cfilename\u003E", "type": "string" } ] }, "description": "Allows for Delete of Photo in a Case Album matching Token and File Name in request.", "auth": null, "body": null } }, { "name": "Case Album File", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/Album/:fileName", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "Album", ":fileName" ], "query": [ { "key": "width", "value": "\u003Cwidth\u003E", "description": "Width", "disabled": true }, { "key": "height", "value": "\u003Cheight\u003E", "description": "Height", "disabled": true }, { "key": "fit", "value": "\u003Cfit\u003E", "description": "Image Resize Fit", "disabled": true } ], "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" }, { "key": "fileName", "value": "\u003CfileName\u003E", "type": "string" } ] }, "description": "Returns a Case Album File matching Token and File Name with the Height, Width and Resize Fit in the request.", "auth": null, "body": null } }, { "name": "Updates an existing person in AppState by matching their synthetic PersonId.\n Uses the same ID generation logic as GetCasePeople.", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/AppStatePerson/:personId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "AppStatePerson", ":personId" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" }, { "key": "personId", "value": "\u003CpersonId\u003E", "type": "string" } ] }, "description": "Updates an existing person in AppState by matching their synthetic PersonId.\n Uses the same ID generation logic as GetCasePeople.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Retrieves a single person from AppState by synthetic PersonId for editing.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/AppStatePerson/:personId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "AppStatePerson", ":personId" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" }, { "key": "personId", "value": "\u003CpersonId\u003E", "type": "string" } ] }, "description": "Retrieves a single person from AppState by synthetic PersonId for editing.", "auth": null, "body": null } }, { "name": "Adds a person to AppState under the specified role.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/AppStatePerson/:role", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "AppStatePerson", ":role" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" }, { "key": "role", "value": "\u003Crole\u003E", "type": "string" } ] }, "description": "Adds a person to AppState under the specified role.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Uploads an attachment to a Connections case that has a linked CallId.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/Attachment", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "Attachment" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Uploads an attachment to a Connections case that has a linked CallId.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Deletes an attachment from a Connections case that has a linked CallId.", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/Attachment/:attachmentId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "Attachment", ":attachmentId" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" }, { "key": "attachmentId", "value": "\u003CattachmentId\u003E", "type": "string" } ] }, "description": "Deletes an attachment from a Connections case that has a linked CallId.", "auth": null, "body": null } }, { "name": "Retrieves attachments for a Connections case that has a linked CallId.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/Attachments", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "Attachments" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Retrieves attachments for a Connections case that has a linked CallId.", "auth": null, "body": null } }, { "name": "Funeral Home Packages", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/AvailablePackages", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "AvailablePackages" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Returns a list of Packages for Funeral Home matching Funeral Home Key specified in request.", "auth": null, "body": null } }, { "name": "Get branding for a case via token.\n Returns the resolved branding (logo, colors, fonts) for the funeral home.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:Token/Branding", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":Token", "Branding" ], "query": null, "variable": [ { "key": "Token", "value": "\u003CToken\u003E", "type": "string" } ] }, "description": "Get branding for a case via token.\n Returns the resolved branding (logo, colors, fonts) for the funeral home.", "auth": null, "body": null } }, { "name": "Returns case role person types for a Connections case.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/CaseRoles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "CaseRoles" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Returns case role person types for a Connections case.", "auth": null, "body": null } }, { "name": "Retrieves catalog add-ons (panels, corners) for a Connections case.\n Anonymous equivalent of CatalogController.GetArrangementAddOns.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/CatalogAddOns", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "CatalogAddOns" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Retrieves catalog add-ons (panels, corners) for a Connections case.\n Anonymous equivalent of CatalogController.GetArrangementAddOns.", "auth": null, "body": null } }, { "name": "Retrieves catalog categories for a Connections case.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/CatalogCategories", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "CatalogCategories" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Retrieves catalog categories for a Connections case.", "auth": null, "body": null } }, { "name": "Retrieves catalog products for a Connections case.\n Uses the same product filtering as the Arranger 2.0 catalog but scoped to token-based access.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/CatalogProducts", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "CatalogProducts" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Retrieves catalog products for a Connections case.\n Uses the same product filtering as the Arranger 2.0 catalog but scoped to token-based access.", "auth": null, "body": null } }, { "name": "Retrieves countries list for a Connections case.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/Countries", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "Countries" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Retrieves countries list for a Connections case.", "auth": null, "body": null } }, { "name": "Retrieves the disposition for a Connections case.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/Disposition", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "Disposition" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Retrieves the disposition for a Connections case.", "auth": null, "body": null } }, { "name": "Updates the disposition for a Connections case.", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/Disposition", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "Disposition" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Updates the disposition for a Connections case.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Retrieves disposition categories for the funeral home associated with a Connections case.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/DispositionCategories", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "DispositionCategories" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Retrieves disposition categories for the funeral home associated with a Connections case.", "auth": null, "body": null } }, { "name": "Retrieves disposition types for the funeral home associated with a Connections case.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/DispositionTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "DispositionTypes" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Retrieves disposition types for the funeral home associated with a Connections case.", "auth": null, "body": null } }, { "name": "Retrieves available engraving packages for a Connections case.\n Anonymous equivalent of EngravingController.GetEngravingPackages.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/EngravingPackages", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "EngravingPackages" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Retrieves available engraving packages for a Connections case.\n Anonymous equivalent of EngravingController.GetEngravingPackages.", "auth": null, "body": null } }, { "name": "Retrieves scheduled gatherings/events for a Connections case that has a linked CallId.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/Events", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "Events" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Retrieves scheduled gatherings/events for a Connections case that has a linked CallId.", "auth": null, "body": null } }, { "name": "Mark Case As Finished", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/Finished", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "Finished" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Finalizes a Connections case identified by the token, sends any configured lead notification emails, and returns a flag indicating success.\n\n**Tags:**Connections, Public, Case", "auth": null, "body": null } }, { "name": "Resolve the Connections Guide for a case via token.\n Walks the hierarchy: FuneralHome \u003E Company \u003E Corporation \u003E Default.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:Token/Guide", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":Token", "Guide" ], "query": null, "variable": [ { "key": "Token", "value": "\u003CToken\u003E", "type": "string" } ] }, "description": "Resolve the Connections Guide for a case via token.\n Walks the hierarchy: FuneralHome \u003E Company \u003E Corporation \u003E Default.", "auth": null, "body": null } }, { "name": "Retrieve a specific vital page by token and page name", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/Page/:pageName", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "Page", ":pageName" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" }, { "key": "pageName", "value": "\u003CpageName\u003E", "type": "string" } ] }, "description": "Retrieves the vital page information based on the provided token and page name. This involves validating the token, fetching the associated funeral home and company details, and locating the requested page.", "auth": null, "body": null } }, { "name": "Page Flow", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:Token/PageFlow", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":Token", "PageFlow" ], "query": null, "variable": [ { "key": "Token", "value": "\u003CToken\u003E", "type": "string" } ] }, "description": "Returns Page Flow Connections matching Token specified in request.", "auth": null, "body": null } }, { "name": "Case Page Names", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/PageNames", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "PageNames" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Returns a list of Case Page Names matching Token specified in request.", "auth": null, "body": null } }, { "name": "Retrieves the list of people on a Connections case.\n If the case has a CallId, queries from the client database.\n Otherwise, returns people from AppState case data.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/PeopleOnCase", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "PeopleOnCase" ], "query": [ { "key": "source", "value": "\u003Csource\u003E", "description": "Arranger or Connections", "disabled": true } ], "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Retrieves the list of people on a Connections case.\n If the case has a CallId, queries from the client database.\n Otherwise, returns people from AppState case data.", "auth": null, "body": null } }, { "name": "Removes a person from AppState by matching their synthetic PersonId.\n Also handles DB-linked cases by removing from PersonPersonTypes.", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/Person/:personId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "Person", ":personId" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" }, { "key": "personId", "value": "\u003CpersonId\u003E", "type": "string" } ] }, "description": "Removes a person from AppState by matching their synthetic PersonId.\n Also handles DB-linked cases by removing from PersonPersonTypes.", "auth": null, "body": null } }, { "name": "Returns person suffix lookups for a Connections case.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/PersonSuffixes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "PersonSuffixes" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Returns person suffix lookups for a Connections case.", "auth": null, "body": null } }, { "name": "Returns person title lookups for a Connections case.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/PersonTitles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "PersonTitles" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Returns person title lookups for a Connections case.", "auth": null, "body": null } }, { "name": "Case Products", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/Products", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "Products" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Returns a list of Connection Products Case matching Token specified in request.", "auth": null, "body": null } }, { "name": "Re-establishes the server-side access code validation cache for an active session.\n Called by the Blazor client after a circuit reconnect or when the in-memory cache has expired.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/RefreshAccessCodeValidation", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "RefreshAccessCodeValidation" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Re-establishes the server-side access code validation cache for an active session.\n Called by the Blazor client after a circuit reconnect or when the in-memory cache has expired.", "auth": null, "body": null } }, { "name": "Case Relationship Types", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/RelationshipTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "RelationshipTypes" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Returns a list of applicable Relationship Types for Case matching Token specified in request.", "auth": null, "body": null } }, { "name": "Sets the informant role for a Connections V2 case.\n Updates the IsSelf flag on the case data.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/Role/:role", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "Role", ":role" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" }, { "key": "role", "value": "\u003Crole\u003E", "type": "string" } ] }, "description": "Sets the informant role for a Connections V2 case.\n Updates the IsSelf flag on the case data.", "auth": null, "body": null } }, { "name": "Case Selected Products", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/SelectedProducts", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "SelectedProducts" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Returns a list of Selected Products for a Case matching Token specified in request.", "auth": null, "body": null } }, { "name": "Retrieves a selection summary for a Connections case, computed from AppState data.\n Returns the same shape as ContractSummaryBreakdown for compatibility with RunningTotalComponent.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/SelectionSummary", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "SelectionSummary" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Retrieves a selection summary for a Connections case, computed from AppState data.\n Returns the same shape as ContractSummaryBreakdown for compatibility with RunningTotalComponent.", "auth": null, "body": null } }, { "name": "Retrieves states list for a Connections case.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/States", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "States" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Retrieves states list for a Connections case.", "auth": null, "body": null } }, { "name": "Submit a Connections V2 case.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/Submit", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "Submit" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Finalizes a Connections V2 case by marking it as submitted, sending notification emails\n to the funeral home and confirmation to the family, and returning a success indicator.", "auth": null, "body": null } }, { "name": "Get the template configuration for a case via token.\n Resolves the Connections Guide and returns the associated template, or null if none configured.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:Token/Template", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":Token", "Template" ], "query": null, "variable": [ { "key": "Token", "value": "\u003CToken\u003E", "type": "string" } ] }, "description": "Get the template configuration for a case via token.\n Resolves the Connections Guide and returns the associated template, or null if none configured.", "auth": null, "body": null } }, { "name": "Get the V2 page flow for a case via token.\n Returns the full page definitions (with components) from the resolved Connections Guide.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:Token/V2PageFlow", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":Token", "V2PageFlow" ], "query": null, "variable": [ { "key": "Token", "value": "\u003CToken\u003E", "type": "string" } ] }, "description": "Get the V2 page flow for a case via token.\n Returns the full page definitions (with components) from the resolved Connections Guide.", "auth": null, "body": null } }, { "name": "Validate Access Code", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/ValidateAccessCode", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "ValidateAccessCode" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Validates an access code against the case identified by the supplied token.\n Returns 200 with true if valid, 200 with false if invalid.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Retrieves the vital data for a Connections case from the AppState.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/Vital", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "Vital" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Retrieves the vital data for a Connections case from the AppState.", "auth": null, "body": null } }, { "name": "Updates vital fields on a Connections case using a JSON patch document.", "description": null, "item": null, "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/Case/:token/Vital", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "Case", ":token", "Vital" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Updates vital fields on a Connections case using a JSON patch document.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Funeral Home Page Flow", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/FuneralHome/:FuneralHomeKey/PageFlow", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "FuneralHome", ":FuneralHomeKey", "PageFlow" ], "query": null, "variable": [ { "key": "FuneralHomeKey", "value": "\u003CFuneralHomeKey\u003E", "type": "string" } ] }, "description": "Returns Page Flow Connections for Funeral Home matching Funeral Home Key in request.", "auth": null, "body": null } }, { "name": "Retrieve Selection Guide for Case", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Connections/SelectionGuide/:token", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Connections", "SelectionGuide", ":token" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Returns a comprehensive catalog of available products and items for a Connections case identified by token.\n The selection guide includes detailed product information, attributes, pricing, availability, and media URLs\n for display in the Connections interface. Out-of-stock items are filtered or marked based on company settings.\n\n**Usage Notes:**\n - This is an anonymous endpoint accessible without authentication.\n - Filters products based on location-specific visibility settings for Connections.\n - Excludes panels and corners from the selection guide.\n - Handles out-of-stock items according to company configuration (hidden vs. marked).\n - Retrieves item attributes via stored procedure \u0060PRODUCT.GetSelectionGuideValues\u0060.\n - Includes comprehensive product metadata: dimensions, materials, colors, engraving options, etc.\n - Automatically appends media URLs for product images.\n - Only returns active products with valid location item mappings.", "auth": null, "body": null } } ], "request": null }, { "name": "Connections: Templates", "description": null, "item": [ { "name": "Get connections template configuration for a connections guide.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ConnectionsTemplates/Guide/:guideId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ConnectionsTemplates", "Guide", ":guideId" ], "query": null, "variable": [ { "key": "guideId", "value": "\u003CguideId\u003E", "type": "string" } ] }, "description": "Get connections template configuration for a connections guide.", "auth": null, "body": null } }, { "name": "Create or update connections template configuration for a connections guide.", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ConnectionsTemplates/Guide/:guideId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ConnectionsTemplates", "Guide", ":guideId" ], "query": null, "variable": [ { "key": "guideId", "value": "\u003CguideId\u003E", "type": "string" } ] }, "description": "Create or update connections template configuration for a connections guide.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } } ], "request": null }, { "name": "Contract Detail", "description": null, "item": [ { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Contract/Detail/:contractDetailId/TaxReversalPreview", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Contract", "Detail", ":contractDetailId", "TaxReversalPreview" ], "query": null, "variable": [ { "key": "contractDetailId", "value": "\u003CcontractDetailId\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Contract/Detail/:contractDetailId/ToggleTaxPrepaid", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Contract", "Detail", ":contractDetailId", "ToggleTaxPrepaid" ], "query": null, "variable": [ { "key": "contractDetailId", "value": "\u003CcontractDetailId\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": null } } ], "request": null }, { "name": "Ditto", "description": null, "item": [ { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Ditto", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Ditto" ], "query": null, "variable": null }, "description": "", "auth": null, "body": null } } ], "request": null }, { "name": "Documents", "description": null, "item": [ { "name": "Get all favorite documents for the current user.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Documents/Favorites", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Documents", "Favorites" ], "query": null, "variable": null }, "description": "Get all favorite documents for the current user.", "auth": null, "body": null } }, { "name": "Remove a document from favorites.", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Documents/Favorites/:documentId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Documents", "Favorites", ":documentId" ], "query": null, "variable": [ { "key": "documentId", "value": "\u003CdocumentId\u003E", "type": "string" } ] }, "description": "Remove a document from favorites.", "auth": null, "body": null } }, { "name": "Reorder favorite documents.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Documents/Favorites/Reorder", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Documents", "Favorites", "Reorder" ], "query": null, "variable": null }, "description": "Reorder favorite documents.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Toggle the favorite status of a document.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Documents/Favorites/Toggle/:documentId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Documents", "Favorites", "Toggle", ":documentId" ], "query": null, "variable": [ { "key": "documentId", "value": "\u003CdocumentId\u003E", "type": "string" } ] }, "description": "Toggle the favorite status of a document.", "auth": null, "body": null } }, { "name": "Get most frequently used documents for the current user.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Documents/MostUsed", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Documents", "MostUsed" ], "query": [ { "key": "funeralHomeId", "value": "\u003CfuneralHomeId\u003E", "description": "Optional funeral home ID filter.", "disabled": true }, { "key": "limit", "value": "\u003Climit\u003E", "description": "Maximum number of results (default 10).", "disabled": true } ], "variable": null }, "description": "Get most frequently used documents for the current user.", "auth": null, "body": null } }, { "name": "Get the current user\u0027s document preferences (sort option, view mode).", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Documents/Preferences", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Documents", "Preferences" ], "query": null, "variable": null }, "description": "Get the current user\u0027s document preferences (sort option, view mode).", "auth": null, "body": null } }, { "name": "Save the current user\u0027s document preferences.", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Documents/Preferences", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Documents", "Preferences" ], "query": null, "variable": null }, "description": "Save the current user\u0027s document preferences.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get recently used documents for the current user.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Documents/RecentlyUsed", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Documents", "RecentlyUsed" ], "query": [ { "key": "funeralHomeId", "value": "\u003CfuneralHomeId\u003E", "description": "Optional funeral home ID filter.", "disabled": true }, { "key": "limit", "value": "\u003Climit\u003E", "description": "Maximum number of results (default 10).", "disabled": true } ], "variable": null }, "description": "Get recently used documents for the current user.", "auth": null, "body": null } }, { "name": "Clear all usage history for the current user.", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Documents/RecentlyUsed", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Documents", "RecentlyUsed" ], "query": [ { "key": "funeralHomeId", "value": "\u003CfuneralHomeId\u003E", "description": "Optional funeral home ID to clear only that location\u0027s history.", "disabled": true } ], "variable": null }, "description": "Clear all usage history for the current user.", "auth": null, "body": null } }, { "name": "Record that a document was used/generated.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Documents/Usage", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Documents", "Usage" ], "query": null, "variable": null }, "description": "Record that a document was used/generated.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } } ], "request": null }, { "name": "DOMO", "description": null, "item": [ { "name": "Get DOMO sync status for all configured companies (Zeus admin only)", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Domo/Admin/Status", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Domo", "Admin", "Status" ], "query": null, "variable": null }, "description": "Get DOMO sync status for all configured companies (Zeus admin only)", "auth": null, "body": null } }, { "name": "Get DOMO configuration for a company", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Domo/Configuration", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Domo", "Configuration" ], "query": null, "variable": null }, "description": "Returns the DOMO configuration for the specified company, creating a default if none exists.", "auth": null, "body": null } }, { "name": "Update DOMO configuration (enabled state and cron schedule) for a company", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Domo/Configuration", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Domo", "Configuration" ], "query": null, "variable": null }, "description": "Update DOMO configuration (enabled state and cron schedule) for a company", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Save DOMO API credentials for a company", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Domo/Configuration/Credentials", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Domo", "Configuration", "Credentials" ], "query": null, "variable": null }, "description": "Save DOMO API credentials for a company", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update a dataset configuration for a company", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Domo/Configuration/Dataset", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Domo", "Configuration", "Dataset" ], "query": null, "variable": null }, "description": "Update a dataset configuration for a company", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Auto-match source fields to DOMO columns", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Domo/Configuration/Dataset/:datasetName/AutoMatch", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Domo", "Configuration", "Dataset", ":datasetName", "AutoMatch" ], "query": null, "variable": [ { "key": "datasetName", "value": "\u003CdatasetName\u003E", "type": "string" } ] }, "description": "Auto-match source fields to DOMO columns", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create a new SCV2-managed dataset in DOMO (Stream API, APPEND mode)", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Domo/Configuration/Dataset/:datasetName/CreateNew", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Domo", "Configuration", "Dataset", ":datasetName", "CreateNew" ], "query": null, "variable": [ { "key": "datasetName", "value": "\u003CdatasetName\u003E", "type": "string" } ] }, "description": "Creates a brand-new Domo dataset \u002B stream owned by SCV2 for the named built-in dataset.\n Use this when the company has no pre-existing Domo dataset to link.", "auth": null, "body": null } }, { "name": "Get saved field mappings for a dataset", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Domo/Configuration/Dataset/:datasetName/Mapping", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Domo", "Configuration", "Dataset", ":datasetName", "Mapping" ], "query": null, "variable": [ { "key": "datasetName", "value": "\u003CdatasetName\u003E", "type": "string" } ] }, "description": "Get saved field mappings for a dataset", "auth": null, "body": null } }, { "name": "Save field mappings for a dataset", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Domo/Configuration/Dataset/:datasetName/Mapping", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Domo", "Configuration", "Dataset", ":datasetName", "Mapping" ], "query": null, "variable": [ { "key": "datasetName", "value": "\u003CdatasetName\u003E", "type": "string" } ] }, "description": "Save field mappings for a dataset", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Reset a dataset configuration \u2014 clears the linked Domo dataset, stream, watermark, and mappings", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Domo/Configuration/Dataset/:datasetName/Reset", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Domo", "Configuration", "Dataset", ":datasetName", "Reset" ], "query": null, "variable": [ { "key": "datasetName", "value": "\u003CdatasetName\u003E", "type": "string" } ] }, "description": "Reset a dataset configuration \u2014 clears the linked Domo dataset, stream, watermark, and mappings", "auth": null, "body": null } }, { "name": "Test DOMO API connection for a company", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Domo/Configuration/TestConnection", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Domo", "Configuration", "TestConnection" ], "query": null, "variable": null }, "description": "Test DOMO API connection for a company", "auth": null, "body": null } }, { "name": "List datasets from the company\u0027s DOMO instance", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Domo/Datasets", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Domo", "Datasets" ], "query": null, "variable": null }, "description": "List datasets from the company\u0027s DOMO instance", "auth": null, "body": null } }, { "name": "Get schema (columns \u002B types) for a DOMO dataset", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Domo/Datasets/:domoDatasetId/Schema", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Domo", "Datasets", ":domoDatasetId", "Schema" ], "query": null, "variable": [ { "key": "domoDatasetId", "value": "\u003CdomoDatasetId\u003E", "type": "string" } ] }, "description": "Returns an empty list when the dataset id is not found in Domo (orphaned link),\n letting the UI surface a \u0022linked dataset no longer exists\u0022 empty state without\n a 5xx response.", "auth": null, "body": null } }, { "name": "Generate sample CSV files for DOMO datasets", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Domo/GenerateSampleFiles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Domo", "GenerateSampleFiles" ], "query": null, "variable": null }, "description": "Queries the company\u0027s case data within the specified date range and generates\n CSV files matching the Halcyon column format for DOMO import.\n Returns a single CSV if one dataset is selected, or a ZIP if multiple are selected.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Trigger a manual DOMO sync for a company", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Domo/Sync", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Domo", "Sync" ], "query": null, "variable": null }, "description": "If a dataset name is specified, syncs only that dataset.\n If no dataset name is specified, triggers a full company sync via the scheduler.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get DOMO sync history for a company", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Domo/SyncHistory", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Domo", "SyncHistory" ], "query": [ { "key": "datasetName", "value": "\u003CdatasetName\u003E", "description": null, "disabled": true }, { "key": "from", "value": "\u003Cfrom\u003E", "description": null, "disabled": true }, { "key": "to", "value": "\u003Cto\u003E", "description": null, "disabled": true }, { "key": "take", "value": "\u003Ctake\u003E", "description": null, "disabled": true } ], "variable": null }, "description": "Get DOMO sync history for a company", "auth": null, "body": null } } ], "request": null }, { "name": "Engraving", "description": null, "item": [ { "name": "Get engraving information by ContractDetailId or OrderItemId.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Engraving", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Engraving" ], "query": [ { "key": "contractDetailId", "value": "\u003CcontractDetailId\u003E", "description": "The contract detail ID (for case management scenarios).", "disabled": true }, { "key": "orderItemId", "value": "\u003CorderItemId\u003E", "description": "The order item ID (for cart/merchandise scenarios).", "disabled": true } ], "variable": null }, "description": "Get engraving information by ContractDetailId or OrderItemId.", "auth": null, "body": null } }, { "name": "Create a new engraving record.\n For ContractDetailId: Creates both the engraving package ContractDetail AND EngravingInformation.\n For OrderItemId: Creates only the EngravingInformation record.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Engraving", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Engraving" ], "query": null, "variable": null }, "description": "Create a new engraving record.\n For ContractDetailId: Creates both the engraving package ContractDetail AND EngravingInformation.\n For OrderItemId: Creates only the EngravingInformation record.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get engraving information by ID.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Engraving/:engravingInformationId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Engraving", ":engravingInformationId" ], "query": null, "variable": [ { "key": "engravingInformationId", "value": "\u003CengravingInformationId\u003E", "type": "string" } ] }, "description": "Get engraving information by ID.", "auth": null, "body": null } }, { "name": "Update an existing engraving record.", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Engraving/:engravingInformationId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Engraving", ":engravingInformationId" ], "query": null, "variable": [ { "key": "engravingInformationId", "value": "\u003CengravingInformationId\u003E", "type": "string" } ] }, "description": "Update an existing engraving record.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete an engraving record.\n Also deletes the associated engraving package ContractDetail if one exists.", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Engraving/:engravingInformationId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Engraving", ":engravingInformationId" ], "query": null, "variable": [ { "key": "engravingInformationId", "value": "\u003CengravingInformationId\u003E", "type": "string" } ] }, "description": "Delete an engraving record.\n Also deletes the associated engraving package ContractDetail if one exists.", "auth": null, "body": null } }, { "name": "Get available clip art images.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Engraving/ClipArts", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Engraving", "ClipArts" ], "query": null, "variable": null }, "description": "Get available clip art images.", "auth": null, "body": null } }, { "name": "Get available engraving packages for a funeral home.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Engraving/Packages/:funeralHomeId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Engraving", "Packages", ":funeralHomeId" ], "query": null, "variable": [ { "key": "funeralHomeId", "value": "\u003CfuneralHomeId\u003E", "type": "string" } ] }, "description": "Get available engraving packages for a funeral home.", "auth": null, "body": null } }, { "name": "Generate a preview image for engraving.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Engraving/Preview", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Engraving", "Preview" ], "query": null, "variable": null }, "description": "Generate a preview image for engraving.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } } ], "request": null }, { "name": "EntityLogo", "description": null, "item": [ { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/EntityLogo/:entityType/:entityId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "EntityLogo", ":entityType", ":entityId" ], "query": null, "variable": [ { "key": "entityType", "value": "\u003CentityType\u003E", "type": "string" }, { "key": "entityId", "value": "\u003CentityId\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/EntityLogo/:entityType/:entityId/:logoKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "EntityLogo", ":entityType", ":entityId", ":logoKey" ], "query": null, "variable": [ { "key": "entityType", "value": "\u003CentityType\u003E", "type": "string" }, { "key": "entityId", "value": "\u003CentityId\u003E", "type": "string" }, { "key": "logoKey", "value": "\u003ClogoKey\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/EntityLogo/:entityType/:entityId/:logoKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "EntityLogo", ":entityType", ":entityId", ":logoKey" ], "query": null, "variable": [ { "key": "entityType", "value": "\u003CentityType\u003E", "type": "string" }, { "key": "entityId", "value": "\u003CentityId\u003E", "type": "string" }, { "key": "logoKey", "value": "\u003ClogoKey\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/EntityLogo/Resolve/:entityType/:entityId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "EntityLogo", "Resolve", ":entityType", ":entityId" ], "query": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "description": null, "disabled": true }, { "key": "corporationId", "value": "\u003CcorporationId\u003E", "description": null, "disabled": true } ], "variable": [ { "key": "entityType", "value": "\u003CentityType\u003E", "type": "string" }, { "key": "entityId", "value": "\u003CentityId\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/EntityLogo/Resolve/:entityType/:entityId/:logoKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "EntityLogo", "Resolve", ":entityType", ":entityId", ":logoKey" ], "query": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "description": null, "disabled": true }, { "key": "corporationId", "value": "\u003CcorporationId\u003E", "description": null, "disabled": true } ], "variable": [ { "key": "entityType", "value": "\u003CentityType\u003E", "type": "string" }, { "key": "entityId", "value": "\u003CentityId\u003E", "type": "string" }, { "key": "logoKey", "value": "\u003ClogoKey\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": null } } ], "request": null }, { "name": "Environment Persistence", "description": null, "item": [ { "name": "Get Backup Detail", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/EnvironmentPersistence/:backupId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "EnvironmentPersistence", ":backupId" ], "query": null, "variable": [ { "key": "backupId", "value": "\u003CbackupId\u003E", "type": "string" } ] }, "description": "Retrieves a specific backup including its full JSON data.", "auth": null, "body": null } }, { "name": "Update Backup", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/EnvironmentPersistence/:backupId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "EnvironmentPersistence", ":backupId" ], "query": null, "variable": [ { "key": "backupId", "value": "\u003CbackupId\u003E", "type": "string" } ] }, "description": "Updates the description or notes of an existing backup.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Backup", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/EnvironmentPersistence/:backupId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "EnvironmentPersistence", ":backupId" ], "query": null, "variable": [ { "key": "backupId", "value": "\u003CbackupId\u003E", "type": "string" } ] }, "description": "Soft deletes a backup (sets IsActive = false).", "auth": null, "body": null } }, { "name": "Restore Backup", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/EnvironmentPersistence/:backupId/Restore", "host": [ "{{baseUrl}}" ], "path": [ "v2", "EnvironmentPersistence", ":backupId", "Restore" ], "query": null, "variable": [ { "key": "backupId", "value": "\u003CbackupId\u003E", "type": "string" } ] }, "description": "Restores a workflow or webhook from a backup to the target company.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Validate Restore", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/EnvironmentPersistence/:backupId/Validate", "host": [ "{{baseUrl}}" ], "path": [ "v2", "EnvironmentPersistence", ":backupId", "Validate" ], "query": null, "variable": [ { "key": "backupId", "value": "\u003CbackupId\u003E", "type": "string" } ] }, "description": "Validates a backup before restore, checking for conflicts and missing dependencies.", "auth": null, "body": null } }, { "name": "Create Branding Kit Backups", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/EnvironmentPersistence/BrandingKit/:companyId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "EnvironmentPersistence", "BrandingKit", ":companyId" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" } ] }, "description": "Creates backups for one or more branding kits.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Company Backups", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/EnvironmentPersistence/Company/:companyId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "EnvironmentPersistence", "Company", ":companyId" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" } ] }, "description": "Retrieves all environment persistence backups for a specific company.", "auth": null, "body": null } }, { "name": "Get Corporation Backups", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/EnvironmentPersistence/Corporation/:corporationId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "EnvironmentPersistence", "Corporation", ":corporationId" ], "query": null, "variable": [ { "key": "corporationId", "value": "\u003CcorporationId\u003E", "type": "string" } ] }, "description": "Retrieves all environment persistence backups for a corporation, grouped by company.", "auth": null, "body": null } }, { "name": "Create Email Config Backup", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/EnvironmentPersistence/Email/:companyId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "EnvironmentPersistence", "Email", ":companyId" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" } ] }, "description": "Creates a backup of the company\u0027s email/SMTP configuration.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Restore History", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/EnvironmentPersistence/History", "host": [ "{{baseUrl}}" ], "path": [ "v2", "EnvironmentPersistence", "History" ], "query": [ { "key": "backupId", "value": "\u003CbackupId\u003E", "description": "Optional backup ID to filter by.", "disabled": true }, { "key": "companyId", "value": "\u003CcompanyId\u003E", "description": "Optional company ID to filter by.", "disabled": true } ], "variable": null }, "description": "Retrieves restore history for a backup or company.", "auth": null, "body": null } }, { "name": "Create SMS Config Backup", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/EnvironmentPersistence/Sms/:companyId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "EnvironmentPersistence", "Sms", ":companyId" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" } ] }, "description": "Creates a backup of the company\u0027s Twilio/SMS configuration.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create Webhook Backups", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/EnvironmentPersistence/Webhook/:companyId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "EnvironmentPersistence", "Webhook", ":companyId" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" } ] }, "description": "Creates backups for one or more webhook subscriptions.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create Workflow Backups", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/EnvironmentPersistence/Workflow/:companyId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "EnvironmentPersistence", "Workflow", ":companyId" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" } ] }, "description": "Creates backups for one or more workflow definitions.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } } ], "request": null }, { "name": "EnvironmentAccess", "description": null, "item": [ { "name": "Returns all allow-list entries.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/EnvironmentAccess/allowlist", "host": [ "{{baseUrl}}" ], "path": [ "v2", "EnvironmentAccess", "allowlist" ], "query": null, "variable": null }, "description": "Returns all allow-list entries.", "auth": null, "body": null } }, { "name": "Adds an entry to the allow-list, resolving the user by email address.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/EnvironmentAccess/allowlist", "host": [ "{{baseUrl}}" ], "path": [ "v2", "EnvironmentAccess", "allowlist" ], "query": null, "variable": null }, "description": "Adds an entry to the allow-list, resolving the user by email address.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Updates an existing allow-list entry.", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/EnvironmentAccess/allowlist/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "EnvironmentAccess", "allowlist", ":id" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "Updates an existing allow-list entry.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Removes an allow-list entry.", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/EnvironmentAccess/allowlist/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "EnvironmentAccess", "allowlist", ":id" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "Removes an allow-list entry.", "auth": null, "body": null } }, { "name": "Returns access requests, optionally filtered by status.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/EnvironmentAccess/requests", "host": [ "{{baseUrl}}" ], "path": [ "v2", "EnvironmentAccess", "requests" ], "query": [ { "key": "status", "value": "\u003Cstatus\u003E", "description": null, "disabled": true } ], "variable": null }, "description": "Returns access requests, optionally filtered by status.", "auth": null, "body": null } }, { "name": "Anonymous: blocked users submit a \u0022request access\u0022 form. The body\u0027s identity fields are\n untrusted \u2014 the service validates that AdvisorUserId resolves to a real user and\n overwrites DisplayName from the trusted AdvisorMaster row. Unknown IDs are dropped\n silently and the response is indistinguishable from a successful submission, so the\n endpoint cannot be used as a user-enumeration oracle.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/EnvironmentAccess/requests", "host": [ "{{baseUrl}}" ], "path": [ "v2", "EnvironmentAccess", "requests" ], "query": null, "variable": null }, "description": "Anonymous: blocked users submit a \u0022request access\u0022 form. The body\u0027s identity fields are\n untrusted \u2014 the service validates that AdvisorUserId resolves to a real user and\n overwrites DisplayName from the trusted AdvisorMaster row. Unknown IDs are dropped\n silently and the response is indistinguishable from a successful submission, so the\n endpoint cannot be used as a user-enumeration oracle.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Approves a pending access request.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/EnvironmentAccess/requests/:id/approve", "host": [ "{{baseUrl}}" ], "path": [ "v2", "EnvironmentAccess", "requests", ":id", "approve" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "Approves a pending access request.", "auth": null, "body": null } }, { "name": "Denies a pending access request.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/EnvironmentAccess/requests/:id/deny", "host": [ "{{baseUrl}}" ], "path": [ "v2", "EnvironmentAccess", "requests", ":id", "deny" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "Denies a pending access request.", "auth": null, "body": null } }, { "name": "Returns the current lockdown settings.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/EnvironmentAccess/settings", "host": [ "{{baseUrl}}" ], "path": [ "v2", "EnvironmentAccess", "settings" ], "query": null, "variable": null }, "description": "Returns the current lockdown settings.", "auth": null, "body": null } }, { "name": "Enables or disables the lockdown flag.", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/EnvironmentAccess/settings", "host": [ "{{baseUrl}}" ], "path": [ "v2", "EnvironmentAccess", "settings" ], "query": null, "variable": null }, "description": "Enables or disables the lockdown flag.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } } ], "request": null }, { "name": "Imports", "description": null, "item": [ { "name": "Check Service Name Duplicates", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Import/CheckDuplicates", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Import", "CheckDuplicates" ], "query": null, "variable": null }, "description": "Compares the provided imported service list against existing company items to detect duplicate names before import.\n\n**Usage Notes:**\n\n- Performs case-insensitive comparison against existing item names.\n- Intended to run prior to calling\u0060ImportServices\u0060to prevent duplicate records.\n\n\n**Tags:**Imports, Validation", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Import Services", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Import/ImportServices", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Import", "ImportServices" ], "query": null, "variable": null }, "description": "Imports new service items for the specified company, automatically associating them with the selected funeral home locations.\n Validates permissions, required fields, and duplicate locations before persisting.\n\n**Usage Notes:**\n\n- Skips services marked as duplicates or flagged not to import.\n- Creates location-specific pricing records for each selected funeral home.\n- Item types and disposition categories are resolved by name at import time.\n\n\n**Tags:**Imports, Services", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } } ], "request": null }, { "name": "Kiosk", "description": null, "item": [ { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Kiosk/Branding", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Kiosk", "Branding" ], "query": null, "variable": null }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Kiosk/Catalog", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Kiosk", "Catalog" ], "query": null, "variable": null }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Kiosk/Configuration", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Kiosk", "Configuration" ], "query": null, "variable": null }, "description": "", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Kiosk/Configuration/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Kiosk", "Configuration", ":id" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Kiosk/Configuration/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Kiosk", "Configuration", ":id" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Kiosk/Configuration/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Kiosk", "Configuration", ":id" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Kiosk/Configurations", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Kiosk", "Configurations" ], "query": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "description": null, "disabled": true } ], "variable": null }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Kiosk/Heartbeat", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Kiosk", "Heartbeat" ], "query": null, "variable": null }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Kiosk/Instance/:id/Revoke", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Kiosk", "Instance", ":id", "Revoke" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Kiosk/Instances", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Kiosk", "Instances" ], "query": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "description": null, "disabled": true } ], "variable": null }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Kiosk/Logo", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Kiosk", "Logo" ], "query": null, "variable": null }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Kiosk/Pair", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Kiosk", "Pair" ], "query": null, "variable": null }, "description": "", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Kiosk/Register", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Kiosk", "Register" ], "query": null, "variable": null }, "description": "", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Kiosk/Showroom/:showroomId/Items", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Kiosk", "Showroom", ":showroomId", "Items" ], "query": null, "variable": [ { "key": "showroomId", "value": "\u003CshowroomId\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Kiosk/Status", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Kiosk", "Status" ], "query": null, "variable": null }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Kiosk/Unpair", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Kiosk", "Unpair" ], "query": null, "variable": null }, "description": "", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Kiosk/Whiteboard", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Kiosk", "Whiteboard" ], "query": [ { "key": "layout", "value": "\u003Clayout\u003E", "description": null, "disabled": true } ], "variable": null }, "description": "", "auth": null, "body": null } } ], "request": null }, { "name": "Language", "description": null, "item": [ { "name": "Get default language terms (global terms without company overrides).", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Language/Defaults", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Language", "Defaults" ], "query": null, "variable": null }, "description": "Get default language terms (global terms without company overrides).", "auth": null, "body": null } }, { "name": "Invalidate the language cache for a company.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Language/InvalidateCache/:companyId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Language", "InvalidateCache", ":companyId" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" } ] }, "description": "Invalidate the language cache for a company.", "auth": null, "body": null } }, { "name": "Get all language terms for a company.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Language/Terms/:companyId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Language", "Terms", ":companyId" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" } ] }, "description": "Get all language terms for a company.", "auth": null, "body": null } }, { "name": "Update or create a language term for a company.", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Language/Terms/:companyId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Language", "Terms", ":companyId" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" } ] }, "description": "Update or create a language term for a company.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete all language term overrides for a company.", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Language/Terms/:companyId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Language", "Terms", ":companyId" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" } ] }, "description": "Delete all language term overrides for a company.", "auth": null, "body": null } }, { "name": "Delete a specific language term override for a company.", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Language/Terms/:companyId/:termKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Language", "Terms", ":companyId", ":termKey" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" }, { "key": "termKey", "value": "\u003CtermKey\u003E", "type": "string" } ] }, "description": "Delete a specific language term override for a company.", "auth": null, "body": null } }, { "name": "Get all language terms for an arranger guide (including inactive).\n Does not merge global defaults \u2014 guides are self-contained.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Language/Terms/Guide/:guideId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Language", "Terms", "Guide", ":guideId" ], "query": null, "variable": [ { "key": "guideId", "value": "\u003CguideId\u003E", "type": "string" } ] }, "description": "Get all language terms for an arranger guide (including inactive).\n Does not merge global defaults \u2014 guides are self-contained.", "auth": null, "body": null } }, { "name": "Update or create a language term for an arranger guide.", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Language/Terms/Guide/:guideId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Language", "Terms", "Guide", ":guideId" ], "query": null, "variable": [ { "key": "guideId", "value": "\u003CguideId\u003E", "type": "string" } ] }, "description": "Update or create a language term for an arranger guide.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete all language term overrides for an arranger guide.", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Language/Terms/Guide/:guideId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Language", "Terms", "Guide", ":guideId" ], "query": null, "variable": [ { "key": "guideId", "value": "\u003CguideId\u003E", "type": "string" } ] }, "description": "Delete all language term overrides for an arranger guide.", "auth": null, "body": null } }, { "name": "Delete a specific language term override for an arranger guide.", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Language/Terms/Guide/:guideId/:termKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Language", "Terms", "Guide", ":guideId", ":termKey" ], "query": null, "variable": [ { "key": "guideId", "value": "\u003CguideId\u003E", "type": "string" }, { "key": "termKey", "value": "\u003CtermKey\u003E", "type": "string" } ] }, "description": "Delete a specific language term override for an arranger guide.", "auth": null, "body": null } }, { "name": "Initialize a guide\u0027s language configuration by copying all global defaults.\n Returns 409 Conflict if the guide already has any terms configured.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Language/Terms/Guide/:guideId/InitializeDefaults", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Language", "Terms", "Guide", ":guideId", "InitializeDefaults" ], "query": null, "variable": [ { "key": "guideId", "value": "\u003CguideId\u003E", "type": "string" } ] }, "description": "Initialize a guide\u0027s language configuration by copying all global defaults.\n Returns 409 Conflict if the guide already has any terms configured.", "auth": null, "body": null } } ], "request": null }, { "name": "Lists: Key/Value", "description": null, "item": [ { "name": "Get App Data Type Light", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/AppDataTypeLight", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "AppDataTypeLight" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of app data types filtered by a predefined set of accepted types.\n The \u0060varchar\u0060 types are replaced with \u0060text\u0060 in the results. The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Arrangement Types", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/ArrangementTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "ArrangementTypes" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of arrangement types from the database by calling the \u0060GetLookups\u0060 method with \u0060LookupType.ArrangementType\u0060.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Facility Reasons by Call ID", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/Call/:callId/DeathFacilityReasons", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "Call", ":callId", "DeathFacilityReasons" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "This endpoint retrieves a list of facility reasons associated with a specific call by calling the \u0060GetDeathCertLookups\u0060 method.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Relatives by Call ID", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/Call/:callId/Relatives", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "Call", ":callId", "Relatives" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "This endpoint retrieves a list of relatives associated with a specific call by calling the \u0060GetPeopleList\u0060 method with the \u0060callId\u0060 parameter and the \u0060isRelative\u0060 flag set to \u0060true\u0060.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Call Status List", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/CallStatus", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "CallStatus" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of call statuses from the database based on the company\u0027s ID and active status.\n The results are represented as \u0060ListItemDto\u0060 objects, including the call status value and ID.", "auth": null, "body": null } }, { "name": "Get Call Types", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/CallTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "CallTypes" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of call types from the database by calling the \u0060GetLookups\u0060 method with \u0060LookupType.CallType\u0060.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Case Roles", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/CaseRoles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "CaseRoles" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of person types from the database that are marked as active and are associated with case roles or participant roles.\n The results are ordered by their sort order and represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get City, Village, or Township", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/CityVillageOrTownship", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "CityVillageOrTownship" ], "query": null, "variable": null }, "description": "This endpoint returns a static list of city, village, and township options.\n The results are represented as \u0060ListItemDto\u0060 objects with \u0060int\u0060 values.", "auth": null, "body": null } }, { "name": "Get College Levels", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/CollegeLevels", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "CollegeLevels" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of college levels from the database by calling the \u0060GetLookups\u0060 method with \u0060LookupType.College\u0060.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Couch Styles By Item Type", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/CouchStylesByItemType/:itemTypeId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "CouchStylesByItemType", ":itemTypeId" ], "query": null, "variable": [ { "key": "itemTypeId", "value": "\u003CitemTypeId\u003E", "type": "string" } ] }, "description": "This endpoint retrieves a list of couch styles from the database by calling the \u0060GetItemAttributeValues\u0060 method with \u0060MasterItemAttributes.ExteriorMaterial\u0060.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Counties", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/Counties", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "Counties" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of counties from the database by calling the \u0060GetLookups\u0060 method with \u0060LookupType.County\u0060.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Countries", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/Countries", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "Countries" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of countries from the database. Countries are ordered with the \u0022United States\u0022 appearing first, followed by the remaining countries in alphabetical order.\n Each country is represented as a \u0060ListItemDto\u0060 object.", "auth": null, "body": null } }, { "name": "Get Crematory Specialists", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/CrematorySpecialists", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "CrematorySpecialists" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of crematory specialists by calling the \u0060GetPeopleList\u0060 method with the \u0060PersonType.CrematorySpecialist\u0060 filter.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Disposition Categories List", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/DispositionCategories", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "DispositionCategories" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of disposition categories from the database based on the active status.\n The results are represented as \u0060ListItemDto\u0060 objects, including the category value and ID.", "auth": null, "body": null } }, { "name": "Get Disposition Type List", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/DispositionTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "DispositionTypes" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of disposition types from the database based on the company\u0027s ID and active status.\n The results are represented as \u0060ListItemDto\u0060 objects, including the disposition value and ID.", "auth": null, "body": null } }, { "name": "Get Education Levels", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/EducationLevels", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "EducationLevels" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of education levels from the database by calling the \u0060GetLookups\u0060 method with \u0060LookupType.Education\u0060.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Embalmers", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/Embalmers", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "Embalmers" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of embalmers by calling the \u0060GetPeopleList\u0060 method with the \u0060PersonType.Embalmer\u0060 filter.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Event Sub Types", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/EventType/:eventTypeId/EventSubTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "EventType", ":eventTypeId", "EventSubTypes" ], "query": null, "variable": [ { "key": "eventTypeId", "value": "\u003CeventTypeId\u003E", "type": "string" } ] }, "description": "This endpoint retrieves a list of event sub types from the database based on the company\u0027s ID, event type ID, and active status.\n The results are represented as \u0060ListItemDto\u0060 objects, including the sub type name and ID.", "auth": null, "body": null } }, { "name": "Get Event Types", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/EventTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "EventTypes" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of event types from the database based on the company\u0027s ID and active status.\n The results are represented as \u0060ListItemDto\u0060 objects, including the event type name and ID.", "auth": null, "body": null } }, { "name": "Get Exterior Materials", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/ExteriorMaterials", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "ExteriorMaterials" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of exterior materials from the database by calling the \u0060GetItemAttributeValues\u0060 method with \u0060MasterItemAttributes.ExteriorMaterial\u0060.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Exterior Materials By Item Type", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/ExteriorMaterialsByItemType/:itemTypeId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "ExteriorMaterialsByItemType", ":itemTypeId" ], "query": null, "variable": [ { "key": "itemTypeId", "value": "\u003CitemTypeId\u003E", "type": "string" } ] }, "description": "This endpoint retrieves a list of exterior materials from the database by calling the \u0060GetItemAttributeValues\u0060 method with \u0060MasterItemAttributes.ExteriorMaterial\u0060.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Family Care Advisors", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/FamilyCareAdvisors", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "FamilyCareAdvisors" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of family care advisors by calling the \u0060GetPeopleResources\u0060 method with the \u0060isFamilyCareAdvisor\u0060 flag set to \u0060true\u0060.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Organizations whose Type is Visible in Financials", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/FinancialsOrganizations", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "FinancialsOrganizations" ], "query": null, "variable": null }, "description": "Replaces the hardcoded Insurance \u002B Trust filter for Financials \u003E Payments by honoring\n the per-company CompanyOrganizationType.VisibleInFinancials flags.", "auth": null, "body": null } }, { "name": "Get Funeral Directors", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/FuneralDirectors", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "FuneralDirectors" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of funeral directors by calling the \u0060GetPeopleList\u0060 method with the \u0060PersonType.FuneralDirector\u0060 filter.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Funeral Home Locations", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/FuneralHomeLocations", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "FuneralHomeLocations" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of funeral home locations from the database that are active and have a non-null master FHID for the specified company.\n The results are ordered by the location name and represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Funeral Home People", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/FuneralHomePeople", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "FuneralHomePeople" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of funeral home people by calling the \u0060GetPeopleList\u0060 method with the \u0060isFuneralHomePerson\u0060 flag set to \u0060true\u0060.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Funeral Home Role Person Types", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/FuneralHomeRolePersonTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "FuneralHomeRolePersonTypes" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of person types from the database that are marked as active and are associated with funeral home roles.\n The results are ordered by their sort order and represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Genders", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/Genders", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "Genders" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of genders from the database by calling the \u0060GetLookups\u0060 method with \u0060LookupType.Gender\u0060.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Hispanic Origins", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/HispanicOrigins", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "HispanicOrigins" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of Hispanic origins from the database by calling the \u0060GetLookups\u0060 method with \u0060LookupType.HispanicOrigin\u0060.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Hospice Organization List", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/HospiceOrganizations", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "HospiceOrganizations" ], "query": null, "variable": null }, "description": "Get Hospice Organization List", "auth": null, "body": null } }, { "name": "Get Indian Tribes", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/IndianTribes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "IndianTribes" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of Indian tribes from the database by calling the \u0060GetLookups\u0060 method with \u0060LookupType.IndianTribe\u0060.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Insurance and Trust Organizations", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/InsuranceAndTrustOrganizations", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "InsuranceAndTrustOrganizations" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of insurance and trust organizations by calling the \u0060GetOrganizationList\u0060 method with \u0060OrganizationType.InsuranceCompany\u0060 and \u0060OrganizationType.Trust\u0060 as filters.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Item Statuses", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/ItemStatuses", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "ItemStatuses" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of item statuses from the database by calling the \u0060GetLookups\u0060 method with \u0060LookupType.ItemStatus\u0060.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Item Types", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/ItemTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "ItemTypes" ], "query": [ { "key": "isProduct", "value": "\u003CisProduct\u003E", "description": "Optional flag to filter item types by product status.", "disabled": true } ], "variable": null }, "description": "This endpoint retrieves a list of item types from the database for the specified company. If \u0060isProduct\u0060 is provided, it filters the item types by whether they are marked as products.\n The results are ordered by the item type name and represented as \u0060ListItemDto\u0060 objects. If the name is not provided, it defaults to \u0022No Name\u0022.", "auth": null, "body": null } }, { "name": "Get Language List", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/Languages", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "Languages" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of languages from the database based on the company\u0027s ID and active status.\n The results are represented as \u0060ListItemDto\u0060 objects, including the language name and ID.", "auth": null, "body": null } }, { "name": "Get License Types", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/LicenseTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "LicenseTypes" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of license types from the database by calling the \u0060GetLookups\u0060 method with \u0060LookupType.LicenseType\u0060.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Location List", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/Locations", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "Locations" ], "query": [ { "key": "type", "value": "\u003Ctype\u003E", "description": null, "disabled": true } ], "variable": null }, "description": "This endpoint retrieves a list of locations from the database based on the company\u0027s ID and optionally filters by location types.\n The results are represented as \u0060ListItemDto\u0060 objects, including the location name and ID.", "auth": null, "body": null } }, { "name": "Get Location Types", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/LocationTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "LocationTypes" ], "query": [ { "key": "type", "value": "\u003Ctype\u003E", "description": null, "disabled": true }, { "key": "RequirePermission", "value": "\u003CRequirePermission\u003E", "description": null, "disabled": true } ], "variable": null }, "description": "This endpoint retrieves a list of location types from the database based on the company\u0027s ID and optionally filters by location types.\n The results are represented as \u0060ListItemDto\u0060 objects, including the lookup value and ID.", "auth": null, "body": null } }, { "name": "Get Managed Roles", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/ManagedRoles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "ManagedRoles" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of person types from the database that are marked as active and are associated with case roles or participant roles.\n The results are ordered by their sort order and represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Manufacturers", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/Manufacturers", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "Manufacturers" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of manufacturers from the database that are marked as active for the specified company.\n The results are ordered by the manufacturer name and represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Marital Statuses", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/MaritalStatuses", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "MaritalStatuses" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of marital statuses from the database by calling the \u0060GetLookups\u0060 method with \u0060LookupType.MaritalStatus\u0060.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get My Funeral Home Locations", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/MyFuneralHomeLocations", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "MyFuneralHomeLocations" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of funeral home locations from the database that are active and have a non-null master FHID for the specified company and the user has access to.\n The results are ordered by the location name and represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Need Types", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/NeedTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "NeedTypes" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of need types from the database. Each need type is represented as a \u0060ListItemDto\u0060 object, ordered by the need type name.", "auth": null, "body": null } }, { "name": "Get All Need Types (unfiltered).", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/NeedTypes/All", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "NeedTypes", "All" ], "query": null, "variable": null }, "description": "Used by configuration screens (e.g. Gathering Types) where admins need to\n reference all possible need types, not just the ones currently enabled\n for case creation. Unlike\u0060Int32)\u0060, this endpoint does\n not filter out trade based on company settings or trade-firm location count.", "auth": null, "body": null } }, { "name": "Get Need Types w/Icons", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/NeedTypesWithIcon", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "NeedTypesWithIcon" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of need types from the database. Each need type is represented as a \u0060NeedTypeDto\u0060 object, ordered by the need type name.", "auth": null, "body": null } }, { "name": "Get Non-Person Resource Types", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/NonPersonResourceTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "NonPersonResourceTypes" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of non-person resource types from the database based on the company\u0027s ID.\n Resource names are pluralized if necessary. The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Obituary Template List", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/ObituaryTemplates", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "ObituaryTemplates" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of obituary templates from the database based on the company\u0027s ID and active status.\n The results are represented as \u0060ListItemDto\u0060 objects, including the template name and ID.", "auth": null, "body": null } }, { "name": "Get Organization List", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/Organizations", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "Organizations" ], "query": [ { "key": "type", "value": "\u003Ctype\u003E", "description": null, "disabled": true } ], "variable": null }, "description": "This endpoint retrieves a list of organizations from the database based on the company\u0027s ID and optionally filters by organization types.\n The results are represented as \u0060ListItemDto\u0060 objects, including the organization name and ID.", "auth": null, "body": null } }, { "name": "Get Organization Type List", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/OrganizationTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "OrganizationTypes" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of organization types from the database based on the active status.\n The results are represented as \u0060ListItemDto\u0060 objects, including the organization type name and ID.", "auth": null, "body": null } }, { "name": "Get Organization Types Visible in Financials", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/OrganizationTypes/Financials", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "OrganizationTypes", "Financials" ], "query": null, "variable": null }, "description": "Returns active organization types whose CompanyOrganizationType.VisibleInFinancials flag is true\n for the supplied company. Types with no override row are excluded.", "auth": null, "body": null } }, { "name": "Get Payment Types", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/PaymentTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "PaymentTypes" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of payment types from the database based on the company\u0027s ID.\n The results are represented as \u0060ListItemDto\u0060 objects, including the payment type name and ID.", "auth": null, "body": null } }, { "name": "Get Person Resource Types", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/PersonResourceTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "PersonResourceTypes" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of person resource types from the database based on the company\u0027s ID.\n The results are represented as \u0060ListItemDto\u0060 objects, including the resource type name and ID.", "auth": null, "body": null } }, { "name": "Get Person Suffixes", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/PersonSuffixes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "PersonSuffixes" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of person suffixes from the database. The suffixes are fetched by calling the \u0060GetLookups\u0060 method with \u0060LookupType.Suffix\u0060.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Person Titles", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/PersonTitles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "PersonTitles" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of person titles from the database. The titles are fetched by calling the \u0060GetLookups\u0060 method with \u0060LookupType.Title\u0060.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Person Types", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/PersonTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "PersonTypes" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of person types for a given company. Only active person types that are marked as relationships are returned.\n The results are ordered by their sort order and represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Pre Need Advisors", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/PreNeedAdvisors", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "PreNeedAdvisors" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of pre-need advisors by calling the \u0060GetPeopleResources\u0060 method with the \u0060isPreNeedAdvisor\u0060 flag set to \u0060true\u0060.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Product Categories", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/ProductCategories", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "ProductCategories" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of product categories from the database by calling the \u0060GetItemAttributeValues\u0060 method with \u0060MasterItemAttributes.ProductCategory\u0060.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Races", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/Races", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "Races" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of races from the database by calling the \u0060GetLookups\u0060 method with \u0060LookupType.Race\u0060.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Report Groups", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/ReportGroups", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "ReportGroups" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of report groups from the database based on the company\u0027s ID.\n The results are represented as \u0060ListItemDto\u0060 objects, including the report group name and ID.", "auth": null, "body": null } }, { "name": "Get Report Types", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/ReportTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "ReportTypes" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of report types from the database based on the company\u0027s ID.\n The results are represented as \u0060ListItemDto\u0060 objects, including the report type value and ID.", "auth": null, "body": null } }, { "name": "Get Sale Source List", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/SaleSources", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "SaleSources" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of sale sources from the database based on the company\u0027s ID and active status.\n The results are represented as \u0060ListItemDto\u0060 objects, including the sale source name and ID.", "auth": null, "body": null } }, { "name": "Get Service Type List", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/ServiceTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "ServiceTypes" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of service types from the database based on the company\u0027s ID and active status.\n The results are represented as \u0060ListItemDto\u0060 objects, including the service type name and ID.", "auth": null, "body": null } }, { "name": "Get Showrooms", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/Showrooms", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "Showrooms" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of showrooms from the database that are active and associated with the \u0060DisplayRoom\u0060 item attribute for the specified company.\n The results are ordered by the showroom name and represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Source Systems", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/SourceSystems", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "SourceSystems" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of source systems from the database based on the company\u0027s ID and active status.\n The results are represented as \u0060ListItemDto\u0060 objects, including the source system name and ID.", "auth": null, "body": null } }, { "name": "Get States", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/States", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "States" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of states from the database. Each state is represented as a \u0060ListItemDto\u0060 object, ordered by the state name.", "auth": null, "body": null } }, { "name": "Get Task Events", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/TaskEvents", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "TaskEvents" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of task events from the database based on the company\u0027s ID.\n The results are represented as \u0060ListItemDto\u0060 objects, including the task event name and ID.", "auth": null, "body": null } }, { "name": "Get Tax Rate Types", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/TaxRateTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "TaxRateTypes" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of tax rate types from the database for the specified company. The results are ordered by the text value and represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Tracking Locations", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/TrackingLocations", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "TrackingLocations" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of tracking locations from the database by calling the \u0060GetLookups\u0060 method with \u0060LookupType.TrackingLocation\u0060.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Trade Locations", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/TradeLocations", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "TradeLocations" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of trade locations by calling the \u0060GetLocationList\u0060 method with \u0060LocationType.TradeFirm\u0060 as a filter.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Trade Pricing Tiers", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/TradePricingTiers", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "TradePricingTiers" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of trade pricing tiers from the database by calling the \u0060GetLookups\u0060 method with \u0060LookupType.TradePricingTier\u0060.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Company Users", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/Users", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "Users" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of users for a given company. It ensures that the requester has the required permissions to access the company\u0027s data.\n The users are returned as a list of \u0060ListItemDto\u0060 objects, ordered by their display names.", "auth": null, "body": null } }, { "name": "Get Veteran Awards", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/VeteranAwards", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "VeteranAwards" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of veteran awards from the database by calling the \u0060GetLookups\u0060 method with \u0060LookupType.VeteranAward\u0060.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Veteran Branches of Service", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/VeteranBranchesOfService", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "VeteranBranchesOfService" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of veteran branches of service from the database by calling the \u0060GetLookups\u0060 method with \u0060LookupType.VeteranBranchOfService\u0060.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Veteran Conflicts", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/VeteranConflicts", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "VeteranConflicts" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of veteran conflicts from the database by calling the \u0060GetLookups\u0060 method with \u0060LookupType.VeteranConflict\u0060.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Veteran Discharge Types", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/VeteranDischargeTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "VeteranDischargeTypes" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of veteran discharge types from the database by calling the \u0060GetLookups\u0060 method with \u0060LookupType.VeteranDischargeType\u0060.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Veteran Emblems", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/VeteranEmblems", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "VeteranEmblems" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of active veteran emblems from the database where the description is not empty for the specified company.\n The results are ordered by the emblem description and represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Veteran Funeral Types", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/VeteranFuneralTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "VeteranFuneralTypes" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of veteran funeral types from the database by calling the \u0060GetLookups\u0060 method with \u0060LookupType.VeteranFuneralType\u0060.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Veteran Headstone Markers", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/VeteranHeadstoneMarkers", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "VeteranHeadstoneMarkers" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of veteran headstone markers from the database by calling the \u0060GetLookups\u0060 method with \u0060LookupType.VeteranHeadstoneMarker\u0060.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Veteran Ranks", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/VeteranRanks", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "VeteranRanks" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of veteran ranks from the database by calling the \u0060GetLookups\u0060 method with \u0060LookupType.VeteranRank\u0060.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get Veteran Release Conditions", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/List/VeteranReleaseConditions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "List", "VeteranReleaseConditions" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of veteran release conditions from the database by calling the \u0060GetLookups\u0060 method with \u0060LookupType.VeteranReleaseCondition\u0060.\n The results are represented as \u0060ListItemDto\u0060 objects.", "auth": null, "body": null } } ], "request": null }, { "name": "Lists: Managed", "description": null, "item": [ { "name": "Update Lookup", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/:lookupId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", ":lookupId" ], "query": null, "variable": [ { "key": "lookupId", "value": "\u003ClookupId\u003E", "type": "string" } ] }, "description": "This endpoint updates an existing lookup for the specified company.\n The lookup details are provided in the \u0060LookupDto\u0060 object.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Lookup Values for Type", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/:lookupTypeId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", ":lookupTypeId" ], "query": null, "variable": [ { "key": "lookupTypeId", "value": "\u003ClookupTypeId\u003E", "type": "string" } ] }, "description": "This endpoint retrieves a list of lookup values from the database based on the company\u0027s ID and lookup type ID.\n The results are represented as \u0060LookupDto\u0060 objects, including lookup value details.", "auth": null, "body": null } }, { "name": "Create Lookup", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/:lookupTypeId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", ":lookupTypeId" ], "query": null, "variable": [ { "key": "lookupTypeId", "value": "\u003ClookupTypeId\u003E", "type": "string" } ] }, "description": "This endpoint creates a new lookup for the specified company and lookup type.\n The lookup details are provided in the \u0060LookupDto\u0060 object.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Adjustment Types", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/AdjustmentType", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "AdjustmentType" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of adjustment types from the database based on the company\u0027s ID.\n The results are represented as \u0060AdjustmentTypeDto\u0060 objects, including adjustment type details.", "auth": null, "body": null } }, { "name": "Create Adjustment Type", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/AdjustmentType", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "AdjustmentType" ], "query": null, "variable": null }, "description": "This endpoint creates a new adjustment type for the specified company.\n The adjustment type details are provided in the \u0060AdjustmentTypeDto\u0060 object.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Adjustment Type", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/AdjustmentType/:adjustmentTypeId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "AdjustmentType", ":adjustmentTypeId" ], "query": null, "variable": [ { "key": "adjustmentTypeId", "value": "\u003CadjustmentTypeId\u003E", "type": "string" } ] }, "description": "This endpoint updates an existing adjustment type for the specified company.\n The adjustment type details are provided in the \u0060AdjustmentTypeDto\u0060 object.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update only the Glcode field on an Adjustment Type (lightweight version of PUT AdjustmentType).", "description": null, "item": null, "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/AdjustmentType/:adjustmentTypeId/Glcode", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "AdjustmentType", ":adjustmentTypeId", "Glcode" ], "query": [ { "key": "fqn", "value": "\u003Cfqn\u003E", "description": null, "disabled": true } ], "variable": [ { "key": "adjustmentTypeId", "value": "\u003CadjustmentTypeId\u003E", "type": "string" } ] }, "description": "Used by the QuickBooks Direct export validation grid to let the user assign a discount\n account inline without round-tripping the full AdjustmentTypeDto. Mirrors the experience\n of the existing GL Code dropdown for sales items. Sending an empty/null fqn clears the\n mapping. Permission required: ManageManagedLists (same as the full PUT).", "auth": null, "body": null } }, { "name": "Get Disposition Types", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/DispositionType", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "DispositionType" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of disposition types from the database based on the company\u0027s ID.\n The results are represented as \u0060DispositionTypeDto\u0060 objects, including disposition type details.", "auth": null, "body": null } }, { "name": "Create Disposition Type", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/DispositionType", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "DispositionType" ], "query": null, "variable": null }, "description": "This endpoint creates a new disposition type for the specified company.\n The disposition type details are provided in the \u0060DispositionTypeDto\u0060 object.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Disposition Type", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/DispositionType/:dispositionTypeId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "DispositionType", ":dispositionTypeId" ], "query": null, "variable": [ { "key": "dispositionTypeId", "value": "\u003CdispositionTypeId\u003E", "type": "string" } ] }, "description": "This endpoint updates an existing disposition type for the specified company.\n The disposition type details are provided in the \u0060DispositionTypeDto\u0060 object.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Hospice Organizations", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/HospiceOrganization", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "HospiceOrganization" ], "query": [ { "key": "includePending", "value": "\u003CincludePending\u003E", "description": "If true, return Pending and Rejected entries in addition to Active. Requires ManageManagedLists. Defaults to false (Active only).", "disabled": true } ], "variable": null }, "description": "Get Hospice Organizations", "auth": null, "body": null } }, { "name": "Create Hospice Organization", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/HospiceOrganization", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "HospiceOrganization" ], "query": null, "variable": null }, "description": "Users with ManageManagedLists create entries directly as Active. Other users (e.g. arrangers\n adding from the case-record typeahead) create entries as Pending; an admin must approve.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a single hospice organization by ID \u2014 used by the picker to render a label\n for a Pending/Rejected entry that isn\u0027t in the active list.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/HospiceOrganization/:hospiceOrganizationId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "HospiceOrganization", ":hospiceOrganizationId" ], "query": null, "variable": [ { "key": "hospiceOrganizationId", "value": "\u003ChospiceOrganizationId\u003E", "type": "string" } ] }, "description": "Get a single hospice organization by ID \u2014 used by the picker to render a label\n for a Pending/Rejected entry that isn\u0027t in the active list.", "auth": null, "body": null } }, { "name": "Update Hospice Organization", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/HospiceOrganization/:hospiceOrganizationId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "HospiceOrganization", ":hospiceOrganizationId" ], "query": null, "variable": [ { "key": "hospiceOrganizationId", "value": "\u003ChospiceOrganizationId\u003E", "type": "string" } ] }, "description": "Update Hospice Organization", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Approve a pending hospice organization", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/HospiceOrganization/:hospiceOrganizationId/Approve", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "HospiceOrganization", ":hospiceOrganizationId", "Approve" ], "query": null, "variable": [ { "key": "hospiceOrganizationId", "value": "\u003ChospiceOrganizationId\u003E", "type": "string" } ] }, "description": "Approve a pending hospice organization", "auth": null, "body": null } }, { "name": "Reject a pending hospice organization. Existing Call references are preserved as historical\n case state; rejected rows are filtered out of typeahead/active queries via Status checks.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/HospiceOrganization/:hospiceOrganizationId/Reject", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "HospiceOrganization", ":hospiceOrganizationId", "Reject" ], "query": null, "variable": [ { "key": "hospiceOrganizationId", "value": "\u003ChospiceOrganizationId\u003E", "type": "string" } ] }, "description": "Reject a pending hospice organization. Existing Call references are preserved as historical\n case state; rejected rows are filtered out of typeahead/active queries via Status checks.", "auth": null, "body": null } }, { "name": "Export hospice organizations to XLSX.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/HospiceOrganization/Export", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "HospiceOrganization", "Export" ], "query": null, "variable": null }, "description": "Export hospice organizations to XLSX.", "auth": null, "body": null } }, { "name": "Import hospice organizations from XLSX. Existing rows are matched by Name (case-insensitive)\n and updated; new rows are inserted as Active. Returns counts of inserted vs. updated rows.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/HospiceOrganization/Import", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "HospiceOrganization", "Import" ], "query": null, "variable": null }, "description": "Import hospice organizations from XLSX. Existing rows are matched by Name (case-insensitive)\n and updated; new rows are inserted as Active. Returns counts of inserted vs. updated rows.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Pending Hospice Organizations", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/HospiceOrganization/Pending", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "HospiceOrganization", "Pending" ], "query": null, "variable": null }, "description": "Get Pending Hospice Organizations", "auth": null, "body": null } }, { "name": "Create Location", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/Location", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "Location" ], "query": [ { "key": "requirePermission", "value": "\u003CrequirePermission\u003E", "description": "Optional boolean that allows users to query method without required permissions", "disabled": true } ], "variable": null }, "description": "This endpoint creates a new location for the specified company.\n The location details are provided in the \u0060LocationDto\u0060 object, including optional addresses for physical, shipping, billing, and mailing.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Location", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/Location/:locationId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "Location", ":locationId" ], "query": null, "variable": [ { "key": "locationId", "value": "\u003ClocationId\u003E", "type": "string" } ] }, "description": "This endpoint retrieves the details of a specific location based on the company\u0027s ID and the location ID.\n The result is represented as a \u0060LocationDto\u0060 object.", "auth": null, "body": null } }, { "name": "Update Location", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/Location/:locationId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "Location", ":locationId" ], "query": [ { "key": "requirePermission", "value": "\u003CrequirePermission\u003E", "description": "Optional boolean that allows method to be queried without permissions being required", "disabled": true } ], "variable": [ { "key": "locationId", "value": "\u003ClocationId\u003E", "type": "string" } ] }, "description": "This endpoint updates an existing location for the specified company.\n The location details are provided in the \u0060LocationDto\u0060 object, including optional addresses for physical, shipping, billing, and mailing.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Locations", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/Locations", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "Locations" ], "query": [ { "key": "type", "value": "\u003Ctype\u003E", "description": null, "disabled": true }, { "key": "active", "value": "\u003Cactive\u003E", "description": "A boolean to filter active/inactive locations (optional).", "disabled": true }, { "key": "searchText", "value": "\u003CsearchText\u003E", "description": "Text to search within location details (optional).", "disabled": true }, { "key": "skip", "value": "\u003Cskip\u003E", "description": "The number of locations to skip for pagination (optional).", "disabled": true }, { "key": "take", "value": "\u003Ctake\u003E", "description": "The number of locations to retrieve for pagination (optional).", "disabled": true }, { "key": "requirePermission", "value": "\u003CrequirePermission\u003E", "description": "Optional boolean that allows users to query endpoint without permissions", "disabled": true } ], "variable": null }, "description": "This endpoint retrieves a list of locations based on the company\u0027s ID and various optional filters such as location types, activity status, search text, and pagination parameters.\n The results are represented as \u0060LocationListDto\u0060 objects.", "auth": null, "body": null } }, { "name": "Get People", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/ManagedPeople", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "ManagedPeople" ], "query": [ { "key": "active", "value": "\u003Cactive\u003E", "description": "Filter by active status.", "disabled": true }, { "key": "searchText", "value": "\u003CsearchText\u003E", "description": "Filter by search text.", "disabled": true }, { "key": "personType", "value": "\u003CpersonType\u003E", "description": "Filter by person type.", "disabled": true }, { "key": "includeRoles", "value": "\u003CincludeRoles\u003E", "description": "Include roles in the response.", "disabled": true }, { "key": "skip", "value": "\u003Cskip\u003E", "description": "Number of records to skip.", "disabled": true }, { "key": "take", "value": "\u003Ctake\u003E", "description": "Number of records to take.", "disabled": true } ], "variable": null }, "description": "Retrieves a list of people for the specified company based on various filters and criteria.", "auth": null, "body": null } }, { "name": "Get Newspapers", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/Newspaper", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "Newspaper" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of newspapers from the database based on the company\u0027s ID.\n The results are represented as \u0060NewspaperDto\u0060 objects, including newspaper details.", "auth": null, "body": null } }, { "name": "Create Newspaper", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/Newspaper", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "Newspaper" ], "query": null, "variable": null }, "description": "This endpoint creates a new newspaper for the specified company.\n The newspaper details are provided in the \u0060NewspaperDto\u0060 object.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Newspaper", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/Newspaper/:newspaperId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "Newspaper", ":newspaperId" ], "query": null, "variable": [ { "key": "newspaperId", "value": "\u003CnewspaperId\u003E", "type": "string" } ] }, "description": "This endpoint updates an existing newspaper for the specified company.\n The newspaper details are provided in the \u0060NewspaperDto\u0060 object.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Organizations", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/Organization", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "Organization" ], "query": null, "variable": null }, "description": "Retrieves a list of third-party organizations for the specified company.", "auth": null, "body": null } }, { "name": "Create Organization", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/Organization", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "Organization" ], "query": null, "variable": null }, "description": "Creates a new third-party organization for the specified company.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Organization", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/Organization/:organizationId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "Organization", ":organizationId" ], "query": null, "variable": [ { "key": "organizationId", "value": "\u003CorganizationId\u003E", "type": "string" } ] }, "description": "Updates an existing third-party organization for the specified company.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Organization Types with company-level visibility settings.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/OrganizationType", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "OrganizationType" ], "query": null, "variable": null }, "description": "Returns every active OrganizationType with the VisibleInFinancials flag from the\n per-company override table (CompanyOrganizationType). Types with no override row\n default to VisibleInFinancials=false.", "auth": null, "body": null } }, { "name": "Set Organization Type visibility for the current company.", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/OrganizationType/:organizationTypeId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "OrganizationType", ":organizationTypeId" ], "query": null, "variable": [ { "key": "organizationTypeId", "value": "\u003CorganizationTypeId\u003E", "type": "string" } ] }, "description": "Upserts a row in CompanyOrganizationType for the supplied (CoID, OrganizationTypeID) pair.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get People", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/People", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "People" ], "query": [ { "key": "active", "value": "\u003Cactive\u003E", "description": "Filter by active status.", "disabled": true }, { "key": "searchText", "value": "\u003CsearchText\u003E", "description": "Filter by search text.", "disabled": true }, { "key": "personType", "value": "\u003CpersonType\u003E", "description": "Filter by person type.", "disabled": true }, { "key": "includeRoles", "value": "\u003CincludeRoles\u003E", "description": "Include roles in the response.", "disabled": true }, { "key": "includeRecentCases", "value": "\u003CincludeRecentCases\u003E", "description": "Number of recent cases to include.", "disabled": true }, { "key": "skip", "value": "\u003Cskip\u003E", "description": "Number of records to skip.", "disabled": true }, { "key": "take", "value": "\u003Ctake\u003E", "description": "Number of records to take.", "disabled": true } ], "variable": null }, "description": "Retrieves a list of people for the specified company based on various filters and criteria.", "auth": null, "body": null } }, { "name": "Create Person", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/Person", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "Person" ], "query": null, "variable": null }, "description": "Creates a new person for the specified company.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Retrieve person details by ID", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/Person/:personId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "Person", ":personId" ], "query": null, "variable": [ { "key": "personId", "value": "\u003CpersonId\u003E", "type": "string" } ] }, "description": "Retrieves the details of a person based on the provided person ID and company ID.\n The method uses the internal method \u0060GetPersonInternal\u0060 to fetch the data from the database.", "auth": null, "body": null } }, { "name": "Update Person", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/Person/:personId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "Person", ":personId" ], "query": null, "variable": [ { "key": "personId", "value": "\u003CpersonId\u003E", "type": "string" } ] }, "description": "Updates an existing person for the specified company.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Patch Person", "description": null, "item": null, "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/Person/:personId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "Person", ":personId" ], "query": null, "variable": [ { "key": "personId", "value": "\u003CpersonId\u003E", "type": "string" } ] }, "description": "Applies partial modifications to an existing person for the specified company.\n \n Sample Patch Document:\n {\n \u0022op\u0022: \u0022replace\u0022,\n \u0022path\u0022: \u0022/FirstName\u0022,\n \u0022value\u0022: \u0022NewFirstName\u0022\n }", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Patch Person Address", "description": null, "item": null, "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/Person/:personId/Address", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "Person", ":personId", "Address" ], "query": null, "variable": [ { "key": "personId", "value": "\u003CpersonId\u003E", "type": "string" } ] }, "description": "Applies partial modifications to the address of an existing person for the specified company.\n \n Sample Patch Document:\n {\n \u0022op\u0022: \u0022replace\u0022,\n \u0022path\u0022: \u0022/City\u0022,\n \u0022value\u0022: \u0022NewCity\u0022\n }", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Resource Types", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/ResourceType", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "ResourceType" ], "query": null, "variable": null }, "description": "Retrieves a list of resource types for the specified company.", "auth": null, "body": null } }, { "name": "Create Resource Type", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/ResourceType", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "ResourceType" ], "query": null, "variable": null }, "description": "Creates a new resource type for the specified company.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Resource Type", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/ResourceType/:resourceTypeId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "ResourceType", ":resourceTypeId" ], "query": null, "variable": [ { "key": "resourceTypeId", "value": "\u003CresourceTypeId\u003E", "type": "string" } ] }, "description": "Updates an existing resource type for the specified company.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Sale Source", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/SaleSource", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "SaleSource" ], "query": null, "variable": null }, "description": "Retrieves a list of sale sources for the specified company.", "auth": null, "body": null } }, { "name": "Create Sale Source", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/SaleSource", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "SaleSource" ], "query": null, "variable": null }, "description": "Creates a new sale source for the specified company.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Sale Source", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/SaleSource/:saleSourceId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "SaleSource", ":saleSourceId" ], "query": null, "variable": [ { "key": "saleSourceId", "value": "\u003CsaleSourceId\u003E", "type": "string" } ] }, "description": "Updates an existing sale source for the specified company.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Service Types", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/ServiceType", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "ServiceType" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of service types from the database based on the company\u0027s ID.\n The results are represented as \u0060ServiceTypeDto\u0060 objects, including service type details.", "auth": null, "body": null } }, { "name": "Create Service Type", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/ServiceType", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "ServiceType" ], "query": null, "variable": null }, "description": "This endpoint creates a new service type for the specified company.\n The service type details are provided in the \u0060ServiceTypeDto\u0060 object.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Service Type", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/ServiceType/:serviceTypeId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "ServiceType", ":serviceTypeId" ], "query": null, "variable": [ { "key": "serviceTypeId", "value": "\u003CserviceTypeId\u003E", "type": "string" } ] }, "description": "This endpoint updates an existing service type for the specified company.\n The service type details are provided in the \u0060ServiceTypeDto\u0060 object.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Source System", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/SourceSystem", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "SourceSystem" ], "query": null, "variable": null }, "description": "Retrieves a list of source systems for the specified company.", "auth": null, "body": null } }, { "name": "Create Source System", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/SourceSystem", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "SourceSystem" ], "query": null, "variable": null }, "description": "Creates a new source system for the specified company.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Source System", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/SourceSystem/:sourceSystemId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "SourceSystem", ":sourceSystemId" ], "query": null, "variable": [ { "key": "sourceSystemId", "value": "\u003CsourceSystemId\u003E", "type": "string" } ] }, "description": "Updates an existing source system for the specified company.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Tracking Location Lookups", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/TrackingLocations", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "TrackingLocations" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of tracking location lookups from the database based on the company\u0027s ID.\n The results are represented as \u0060TrackingLocationLookupDto\u0060 objects, including tracking location update fields.", "auth": null, "body": null } }, { "name": "Create Tracking Location Lookup", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/TrackingLocations", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "TrackingLocations" ], "query": null, "variable": null }, "description": "This endpoint creates a new lookup for the specified company and lookup type.\n The lookup details are provided in the \u0060LookupDto\u0060 object.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Tracking Location Lookup", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/TrackingLocations", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "TrackingLocations" ], "query": null, "variable": null }, "description": "This endpoint updates an existing lookup for the specified company.\n The lookup details are provided in the \u0060LookupDto\u0060 object.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Tracking Location Updateable Field Names", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/TrackingLocationUpdateFieldNames", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "TrackingLocationUpdateFieldNames" ], "query": null, "variable": null }, "description": "This endpoint retrieves a list of tracking location updateable field names that are configurable when\n specifying tracking location lookups.", "auth": null, "body": null } }, { "name": "Get Verse Sayings", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/VerseSaying", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "VerseSaying" ], "query": null, "variable": null }, "description": "Retrieves a list of verse sayings for the specified company.", "auth": null, "body": null } }, { "name": "Create Verse Saying", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/VerseSaying", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "VerseSaying" ], "query": null, "variable": null }, "description": "Creates a new verse saying for the specified company.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Verse Saying", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/ManagedList/VerseSaying/:verseId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ManagedList", "VerseSaying", ":verseId" ], "query": null, "variable": [ { "key": "verseId", "value": "\u003CverseId\u003E", "type": "string" } ] }, "description": "Updates an existing verse saying for the specified company.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } } ], "request": null }, { "name": "Manufacturers", "description": null, "item": [ { "name": "Post Manufacturer", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Manufacturer", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Manufacturer" ], "query": null, "variable": null }, "description": "Creates a new manufacturer with the provided details.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Manufacturer", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Manufacturer/:manufacturerId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Manufacturer", ":manufacturerId" ], "query": null, "variable": [ { "key": "manufacturerId", "value": "\u003CmanufacturerId\u003E", "type": "string" } ] }, "description": "Retrieves detailed information about a specific manufacturer for the specified company.", "auth": null, "body": null } }, { "name": "Put Manufacturer", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Manufacturer/:manufacturerId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Manufacturer", ":manufacturerId" ], "query": null, "variable": [ { "key": "manufacturerId", "value": "\u003CmanufacturerId\u003E", "type": "string" } ] }, "description": "Updates an existing manufacturer with the provided details.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Address", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Manufacturer/:manufacturerId/Address/:addressType", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Manufacturer", ":manufacturerId", "Address", ":addressType" ], "query": null, "variable": [ { "key": "manufacturerId", "value": "\u003CmanufacturerId\u003E", "type": "string" }, { "key": "addressType", "value": "\u003CaddressType\u003E", "type": "string" } ] }, "description": "Retrieves the address of a specified type for a manufacturer.", "auth": null, "body": null } }, { "name": "Put Address", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Manufacturer/:manufacturerId/Address/:addressType", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Manufacturer", ":manufacturerId", "Address", ":addressType" ], "query": null, "variable": [ { "key": "manufacturerId", "value": "\u003CmanufacturerId\u003E", "type": "string" }, { "key": "addressType", "value": "\u003CaddressType\u003E", "type": "string" } ] }, "description": "Updates or adds an address for a manufacturer. Ensures no duplicate active addresses of the same type exist.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Address", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Manufacturer/:manufacturerId/Address/:addressType", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Manufacturer", ":manufacturerId", "Address", ":addressType" ], "query": null, "variable": [ { "key": "manufacturerId", "value": "\u003CmanufacturerId\u003E", "type": "string" }, { "key": "addressType", "value": "\u003CaddressType\u003E", "type": "string" } ] }, "description": "Deletes the address of a specified type for a manufacturer.", "auth": null, "body": null } }, { "name": "Get Manufacturers", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Manufacturers", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Manufacturers" ], "query": null, "variable": null }, "description": "Retrieves a list of manufacturers, including their associated item types, for the specified company.", "auth": null, "body": null } } ], "request": null }, { "name": "Media Library", "description": null, "item": [ { "name": "Get Media Library", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Media/Library", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Media", "Library" ], "query": [ { "key": "type", "value": "\u003Ctype\u003E", "description": "Optional filter by type (image, video, document)", "disabled": true } ], "variable": null }, "description": "Returns all media items available for selection in the media library.\n Aggregates media from company uploads and branding assets.", "auth": null, "body": null } }, { "name": "Upload Media to Library", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Media/Library", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Media", "Library" ], "query": null, "variable": null }, "description": "Uploads one or more media files to the company media library.\n Supports images, videos, and documents.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Media from Library", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Media/Library/:mediaId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Media", "Library", ":mediaId" ], "query": null, "variable": [ { "key": "mediaId", "value": "\u003CmediaId\u003E", "type": "string" } ] }, "description": "Soft-deletes a media item from the library.", "auth": null, "body": null } } ], "request": null }, { "name": "Miscellaneous Sales", "description": null, "item": [ { "name": "Get Sales", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/MiscSale", "host": [ "{{baseUrl}}" ], "path": [ "v2", "MiscSale" ], "query": [ { "key": "startDate", "value": "\u003CstartDate\u003E", "description": "The start date for the sales records.", "disabled": true }, { "key": "endDate", "value": "\u003CendDate\u003E", "description": "The end date for the sales records.", "disabled": true } ], "variable": null }, "description": "Retrieves miscellaneous sales records for a company within the specified date range.\n Includes related call and contract details, and enriches the results with case number and decedent name if available.", "auth": null, "body": null } }, { "name": "Post Sale", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/MiscSale", "host": [ "{{baseUrl}}" ], "path": [ "v2", "MiscSale" ], "query": null, "variable": null }, "description": "Creates a new miscellaneous sale with the provided details and returns the created sale.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Sale", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/MiscSale/:miscSaleId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "MiscSale", ":miscSaleId" ], "query": null, "variable": [ { "key": "miscSaleId", "value": "\u003CmiscSaleId\u003E", "type": "string" } ] }, "description": "Retrieves the details of a specific miscellaneous sale, including related call and contract details.\n Enriches the result with case number and decedent name if available.", "auth": null, "body": null } }, { "name": "Cancel Sale", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/MiscSale/:miscSaleId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "MiscSale", ":miscSaleId" ], "query": null, "variable": [ { "key": "miscSaleId", "value": "\u003CmiscSaleId\u003E", "type": "string" } ] }, "description": "Marks the specified miscellaneous sale as inactive. The sale is logically deleted by setting its \u0060Active\u0060 flag to false.", "auth": null, "body": null } }, { "name": "Create Contract Detail", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/MiscSale/:miscSaleId/Contract/Detail", "host": [ "{{baseUrl}}" ], "path": [ "v2", "MiscSale", ":miscSaleId", "Contract", "Detail" ], "query": null, "variable": [ { "key": "miscSaleId", "value": "\u003CmiscSaleId\u003E", "type": "string" } ] }, "description": "This method creates a new contract detail and returns the details of the newly created contract detail.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Contract Detail", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/MiscSale/:miscSaleId/Contract/Detail/:contractDetailId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "MiscSale", ":miscSaleId", "Contract", "Detail", ":contractDetailId" ], "query": null, "variable": [ { "key": "miscSaleId", "value": "\u003CmiscSaleId\u003E", "type": "string" }, { "key": "contractDetailId", "value": "\u003CcontractDetailId\u003E", "type": "string" } ] }, "description": "This method updates an existing contract detail and returns the updated details.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Contract Detail", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/MiscSale/:miscSaleId/Contract/Detail/:contractDetailId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "MiscSale", ":miscSaleId", "Contract", "Detail", ":contractDetailId" ], "query": null, "variable": [ { "key": "miscSaleId", "value": "\u003CmiscSaleId\u003E", "type": "string" }, { "key": "contractDetailId", "value": "\u003CcontractDetailId\u003E", "type": "string" } ] }, "description": "This method deletes a contract detail and deactivates any associated ad hoc items if necessary.", "auth": null, "body": null } }, { "name": "Update Contract Detail Notes", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/MiscSale/:miscSaleId/Contract/Detail/:contractDetailId/Notes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "MiscSale", ":miscSaleId", "Contract", "Detail", ":contractDetailId", "Notes" ], "query": null, "variable": [ { "key": "miscSaleId", "value": "\u003CmiscSaleId\u003E", "type": "string" }, { "key": "contractDetailId", "value": "\u003CcontractDetailId\u003E", "type": "string" } ] }, "description": "This method updates the notes of a specific contract detail.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create Ad Hoc Contract Detail", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/MiscSale/:miscSaleId/Contract/Detail/AdHoc", "host": [ "{{baseUrl}}" ], "path": [ "v2", "MiscSale", ":miscSaleId", "Contract", "Detail", "AdHoc" ], "query": null, "variable": [ { "key": "miscSaleId", "value": "\u003CmiscSaleId\u003E", "type": "string" } ] }, "description": "This method creates an ad hoc contract detail and returns the details of the newly created ad hoc contract detail.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Contract Details", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/MiscSale/:miscSaleId/Contract/Details", "host": [ "{{baseUrl}}" ], "path": [ "v2", "MiscSale", ":miscSaleId", "Contract", "Details" ], "query": null, "variable": [ { "key": "miscSaleId", "value": "\u003CmiscSaleId\u003E", "type": "string" } ] }, "description": "Retrieves the contract details associated with a specific miscellaneous sale.", "auth": null, "body": null } }, { "name": "Delete Contract Package", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/MiscSale/:miscSaleId/Contract/Package/:packageLocationId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "MiscSale", ":miscSaleId", "Contract", "Package", ":packageLocationId" ], "query": null, "variable": [ { "key": "miscSaleId", "value": "\u003CmiscSaleId\u003E", "type": "string" }, { "key": "packageLocationId", "value": "\u003CpackageLocationId\u003E", "type": "string" } ] }, "description": "This method deletes contract details associated with a specific package location.", "auth": null, "body": null } }, { "name": "Update Contract Date", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/MiscSale/:miscSaleId/ContractDate", "host": [ "{{baseUrl}}" ], "path": [ "v2", "MiscSale", ":miscSaleId", "ContractDate" ], "query": null, "variable": [ { "key": "miscSaleId", "value": "\u003CmiscSaleId\u003E", "type": "string" } ] }, "description": "Updates the contract date for the specified miscellaneous sale.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Contract Summary Breakdown", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/MiscSale/:miscSaleId/ContractSummaryBreakdown", "host": [ "{{baseUrl}}" ], "path": [ "v2", "MiscSale", ":miscSaleId", "ContractSummaryBreakdown" ], "query": null, "variable": [ { "key": "miscSaleId", "value": "\u003CmiscSaleId\u003E", "type": "string" } ] }, "description": "Provides a detailed summary of the contract including subtotals, adjustments, taxes, payments, and balance.", "auth": null, "body": null } }, { "name": "Mark Sale Active", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/MiscSale/:miscSaleId/MarkActive", "host": [ "{{baseUrl}}" ], "path": [ "v2", "MiscSale", ":miscSaleId", "MarkActive" ], "query": null, "variable": [ { "key": "miscSaleId", "value": "\u003CmiscSaleId\u003E", "type": "string" } ] }, "description": "Marks the specified miscellaneous sale as active. The sale is reactivated by setting its \u0060Active\u0060 flag to true.", "auth": null, "body": null } }, { "name": "Mark Sale Posted", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/MiscSale/:miscSaleId/MarkPosted", "host": [ "{{baseUrl}}" ], "path": [ "v2", "MiscSale", ":miscSaleId", "MarkPosted" ], "query": null, "variable": [ { "key": "miscSaleId", "value": "\u003CmiscSaleId\u003E", "type": "string" } ] }, "description": "Marks the specified miscellaneous sale as posted.", "auth": null, "body": null } }, { "name": "Mark Sale Un-Posted", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/MiscSale/:miscSaleId/MarkUnPosted", "host": [ "{{baseUrl}}" ], "path": [ "v2", "MiscSale", ":miscSaleId", "MarkUnPosted" ], "query": null, "variable": [ { "key": "miscSaleId", "value": "\u003CmiscSaleId\u003E", "type": "string" } ] }, "description": "Marks the specified miscellaneous sale as unposted.", "auth": null, "body": null } }, { "name": "Get Payments", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/MiscSale/:miscSaleId/Payments", "host": [ "{{baseUrl}}" ], "path": [ "v2", "MiscSale", ":miscSaleId", "Payments" ], "query": null, "variable": [ { "key": "miscSaleId", "value": "\u003CmiscSaleId\u003E", "type": "string" } ] }, "description": "Retrieves all payments related to the specified miscellaneous sale, including details such as payment type and amounts.", "auth": null, "body": null } }, { "name": "Add Payment", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/MiscSale/:miscSaleId/Payments", "host": [ "{{baseUrl}}" ], "path": [ "v2", "MiscSale", ":miscSaleId", "Payments" ], "query": null, "variable": [ { "key": "miscSaleId", "value": "\u003CmiscSaleId\u003E", "type": "string" } ] }, "description": "This method adds a new payment to a miscellaneous sale and returns the ID of the newly created payment.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Payment", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/MiscSale/:miscSaleId/Payments/:paymentId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "MiscSale", ":miscSaleId", "Payments", ":paymentId" ], "query": [ { "key": "deleteReason", "value": "\u003CdeleteReason\u003E", "description": "The reason for deleting the payment.", "disabled": true } ], "variable": [ { "key": "miscSaleId", "value": "\u003CmiscSaleId\u003E", "type": "string" }, { "key": "paymentId", "value": "\u003CpaymentId\u003E", "type": "string" } ] }, "description": "This method marks a payment as inactive and logs the delete reason.", "auth": null, "body": null } }, { "name": "Get Call Service Selection", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/MiscSale/:miscSaleId/Selection/Services", "host": [ "{{baseUrl}}" ], "path": [ "v2", "MiscSale", ":miscSaleId", "Selection", "Services" ], "query": null, "variable": [ { "key": "miscSaleId", "value": "\u003CmiscSaleId\u003E", "type": "string" } ] }, "description": "Retrieves a list of service location items related to the specified miscellaneous sale.\n The list includes items associated with the sale\u0027s location and contract details if available.", "auth": null, "body": null } } ], "request": null }, { "name": "Miscellaneous Sales: Buyer", "description": null, "item": [ { "name": "Buyer for Edit", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/MiscSale/:saleId/Buyer/:personId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "MiscSale", ":saleId", "Buyer", ":personId" ], "query": null, "variable": [ { "key": "saleId", "value": "\u003CsaleId\u003E", "type": "string" }, { "key": "personId", "value": "\u003CpersonId\u003E", "type": "string" } ] }, "description": "Returns a Case Person for the Call Id and Person Id specified in request.", "auth": null, "body": null } }, { "name": "Update a Case Person", "description": null, "item": null, "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/MiscSale/:saleId/Buyer/:personId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "MiscSale", ":saleId", "Buyer", ":personId" ], "query": null, "variable": [ { "key": "saleId", "value": "\u003CsaleId\u003E", "type": "string" }, { "key": "personId", "value": "\u003CpersonId\u003E", "type": "string" } ] }, "description": "Updates a Case Person for the Sale Id and Person Id to Person patch payload specified in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } } ], "request": null }, { "name": "Page Builder", "description": null, "item": [ { "name": "Invalidate page cache", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Cache/Invalidate", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Cache", "Invalidate" ], "query": [ { "key": "pageId", "value": "\u003CpageId\u003E", "description": "Optional page ID to invalidate (null to invalidate all)", "disabled": true } ], "variable": null }, "description": "Invalidates cached page data. Zeus users only.", "auth": null, "body": null } }, { "name": "Get all component definitions", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Components", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Components" ], "query": null, "variable": null }, "description": "Retrieves all active component definitions that can be used to build pages.\n Components are defined in code via [PageBuilderComponent] attributes and discovered at startup.", "auth": null, "body": null } }, { "name": "Get component definition by type", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Components/:componentType", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Components", ":componentType" ], "query": null, "variable": [ { "key": "componentType", "value": "\u003CcomponentType\u003E", "type": "string" } ] }, "description": "Retrieves a specific component definition by its type identifier.", "auth": null, "body": null } }, { "name": "Get all component categories", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Components/Categories", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Components", "Categories" ], "query": null, "variable": null }, "description": "Retrieves all unique component categories for organizing the component palette.", "auth": null, "body": null } }, { "name": "Get component definitions by category", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Components/Category/:category", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Components", "Category", ":category" ], "query": null, "variable": [ { "key": "category", "value": "\u003Ccategory\u003E", "type": "string" } ] }, "description": "Retrieves component definitions filtered by category.", "auth": null, "body": null } }, { "name": "Export all company pages as a configuration file", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Config/Export", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Config", "Export" ], "query": [ { "key": "applicationType", "value": "\u003CapplicationType\u003E", "description": "The application type (Arranger, Connections)", "disabled": true } ], "variable": null }, "description": "Exports all active page definitions and their components for the specified company\n and application type. The export contains no internal IDs and can be imported into\n any company.", "auth": null, "body": null } }, { "name": "Import a configuration", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Config/Import", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Config", "Import" ], "query": [ { "key": "applicationType", "value": "\u003CapplicationType\u003E", "description": "The application type (Arranger, Connections)", "disabled": true }, { "key": "arrangerGuideId", "value": "\u003CarrangerGuideId\u003E", "description": "Optional arranger guide ID to assign imported pages to", "disabled": true }, { "key": "connectionsGuideId", "value": "\u003CconnectionsGuideId\u003E", "description": "Optional connections guide ID to assign imported pages to", "disabled": true } ], "variable": null }, "description": "Imports the provided configuration, creating new pages or overwriting existing pages\n with matching slugs. All pages are created as company-owned pages.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Validate a configuration import file", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Config/Import/Validate", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Config", "Import", "Validate" ], "query": [ { "key": "applicationType", "value": "\u003CapplicationType\u003E", "description": "The application type (Arranger, Connections)", "disabled": true } ], "variable": null }, "description": "Validates the provided configuration, checking schema version, component types,\n and identifying slug conflicts that would be overwritten during import.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get all page definitions", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages" ], "query": [ { "key": "applicationType", "value": "\u003CapplicationType\u003E", "description": "Optional filter by application type (Arranger, Connections)", "disabled": true }, { "key": "includeInactive", "value": "\u003CincludeInactive\u003E", "description": "Whether to include inactive pages", "disabled": true }, { "key": "arrangerGuideId", "value": "\u003CarrangerGuideId\u003E", "description": "Optional filter by arranger guide ID", "disabled": true }, { "key": "connectionsGuideId", "value": "\u003CconnectionsGuideId\u003E", "description": "Optional filter by connections guide ID", "disabled": true }, { "key": "includeComponents", "value": "\u003CincludeComponents\u003E", "description": "Whether to include page components", "disabled": true }, { "key": "needTypeId", "value": "\u003CneedTypeId\u003E", "description": "Optional filter by need type ID. When provided, returns only pages tagged with this need type plus untagged (universal) pages.", "disabled": true }, { "key": "dispositionCategoryId", "value": "\u003CdispositionCategoryId\u003E", "description": "Optional filter by disposition category ID. When provided, returns only pages tagged with this category plus untagged (universal) pages.", "disabled": true }, { "key": "dispositionTypeId", "value": "\u003CdispositionTypeId\u003E", "description": "Optional filter by disposition type ID. Used with dispositionCategoryId for more specific filtering.", "disabled": true } ], "variable": null }, "description": "Retrieves all page definitions visible to the user\u0027s company.\n Includes global pages (available to all) and company-specific pages.", "auth": null, "body": null } }, { "name": "Create a new page definition", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages" ], "query": null, "variable": null }, "description": "Creates a new page definition owned by the specified company.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a specific page definition", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/:globalId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", ":globalId" ], "query": [ { "key": "includeComponents", "value": "\u003CincludeComponents\u003E", "description": "Whether to include the page\u0027s components (default: true)", "disabled": true } ], "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" } ] }, "description": "Retrieves a single page definition by its global ID, including all components.", "auth": null, "body": null } }, { "name": "Update a page definition", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/:globalId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", ":globalId" ], "query": null, "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" } ] }, "description": "Updates an existing page definition. Only company-owned pages can be modified.\n Global pages cannot be edited except by Zeus users.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a page definition", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/:globalId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", ":globalId" ], "query": null, "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" } ] }, "description": "Soft deletes a page definition by setting it to inactive.\n Global pages cannot be deleted except by Zeus users.", "auth": null, "body": null } }, { "name": "Get disposition tags assigned to a page", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/:globalId/Dispositions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", ":globalId", "Dispositions" ], "query": null, "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" } ] }, "description": "Get disposition tags assigned to a page", "auth": null, "body": null } }, { "name": "Update disposition tags assigned to a page", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/:globalId/Dispositions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", ":globalId", "Dispositions" ], "query": null, "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" } ] }, "description": "Replaces all disposition associations for a page. An empty list means the page shows for all dispositions.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Duplicate a page definition", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/:globalId/Duplicate", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", ":globalId", "Duplicate" ], "query": [ { "key": "newName", "value": "\u003CnewName\u003E", "description": "The name for the new page", "disabled": true }, { "key": "newSlug", "value": "\u003CnewSlug\u003E", "description": "The slug for the new page", "disabled": true }, { "key": "arrangerGuideId", "value": "\u003CarrangerGuideId\u003E", "description": "Optional arranger guide to assign the new page to", "disabled": true }, { "key": "connectionsGuideId", "value": "\u003CconnectionsGuideId\u003E", "description": "Optional connections guide to assign the new page to", "disabled": true } ], "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" } ] }, "description": "Creates a copy of an existing page definition with a new name and slug.\n The new page will be owned by the user\u0027s company.", "auth": null, "body": null } }, { "name": "Duplicate a page definition as a global page", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/:globalId/DuplicateGlobal", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", ":globalId", "DuplicateGlobal" ], "query": [ { "key": "newName", "value": "\u003CnewName\u003E", "description": "The name for the new page", "disabled": true }, { "key": "newSlug", "value": "\u003CnewSlug\u003E", "description": "The slug for the new page", "disabled": true } ], "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" } ] }, "description": "Creates a copy of an existing page definition as a global page (CompanyId == null).\n Requires Zeus or AuroraAdmin role.", "auth": null, "body": null } }, { "name": "Get need types assigned to a page", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/:globalId/NeedTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", ":globalId", "NeedTypes" ], "query": null, "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" } ] }, "description": "Get need types assigned to a page", "auth": null, "body": null } }, { "name": "Update need types assigned to a page", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/:globalId/NeedTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", ":globalId", "NeedTypes" ], "query": null, "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" } ] }, "description": "Replaces all need-type associations for a page. An empty list means the page shows for all need types.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Add a component to a page", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/:pageId/Components", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", ":pageId", "Components" ], "query": null, "variable": [ { "key": "pageId", "value": "\u003CpageId\u003E", "type": "string" } ] }, "description": "Adds a new component to a page definition.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update a component", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/:pageId/Components/:componentId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", ":pageId", "Components", ":componentId" ], "query": null, "variable": [ { "key": "pageId", "value": "\u003CpageId\u003E", "type": "string" }, { "key": "componentId", "value": "\u003CcomponentId\u003E", "type": "string" } ] }, "description": "Updates an existing component on a page.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a component", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/:pageId/Components/:componentId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", ":pageId", "Components", ":componentId" ], "query": null, "variable": [ { "key": "pageId", "value": "\u003CpageId\u003E", "type": "string" }, { "key": "componentId", "value": "\u003CcomponentId\u003E", "type": "string" } ] }, "description": "Removes a component from a page.", "auth": null, "body": null } }, { "name": "Reorder components on a page", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/:pageId/Components/Reorder", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", ":pageId", "Components", "Reorder" ], "query": null, "variable": [ { "key": "pageId", "value": "\u003CpageId\u003E", "type": "string" } ] }, "description": "Updates the display order of components on a page.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create a template from an existing page", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/:pageId/CreateTemplate", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", ":pageId", "CreateTemplate" ], "query": [ { "key": "templateName", "value": "\u003CtemplateName\u003E", "description": "The name for the new template", "disabled": true } ], "variable": [ { "key": "pageId", "value": "\u003CpageId\u003E", "type": "string" } ] }, "description": "Creates a new template by capturing the current state of a page definition.", "auth": null, "body": null } }, { "name": "Get a preview of a page definition", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/:pageId/Preview", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", ":pageId", "Preview" ], "query": [ { "key": "device", "value": "\u003Cdevice\u003E", "description": "Optional device type for responsive preview (mobile, tablet, desktop)", "disabled": true } ], "variable": [ { "key": "pageId", "value": "\u003CpageId\u003E", "type": "string" } ] }, "description": "Generates an HTML preview of a page definition that can be rendered in an iframe.\n Shows component layout with configuration details.", "auth": null, "body": null } }, { "name": "Publish a page definition", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/:pageId/Publish", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", ":pageId", "Publish" ], "query": null, "variable": [ { "key": "pageId", "value": "\u003CpageId\u003E", "type": "string" } ] }, "description": "Creates a version snapshot and marks the page as published.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get publish history for a page", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/:pageId/PublishHistory", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", ":pageId", "PublishHistory" ], "query": [ { "key": "limit", "value": "\u003Climit\u003E", "description": "Maximum number of records to return (default: 50)", "disabled": true } ], "variable": [ { "key": "pageId", "value": "\u003CpageId\u003E", "type": "string" } ] }, "description": "Returns the publish/unpublish history for a page definition.", "auth": null, "body": null } }, { "name": "Rollback to a previous version", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/:pageId/Rollback/:versionNumber", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", ":pageId", "Rollback", ":versionNumber" ], "query": null, "variable": [ { "key": "pageId", "value": "\u003CpageId\u003E", "type": "string" }, { "key": "versionNumber", "value": "\u003CversionNumber\u003E", "type": "string" } ] }, "description": "Restores a page definition to a previous version.\n Creates a new version snapshot before rollback.", "auth": null, "body": null } }, { "name": "Unpublish a page definition", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/:pageId/Unpublish", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", ":pageId", "Unpublish" ], "query": null, "variable": [ { "key": "pageId", "value": "\u003CpageId\u003E", "type": "string" } ] }, "description": "Reverts a page to draft status, clearing the published version.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get page version history", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/:pageId/Versions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", ":pageId", "Versions" ], "query": [ { "key": "limit", "value": "\u003Climit\u003E", "description": "Maximum number of versions to return (default: 50)", "disabled": true } ], "variable": [ { "key": "pageId", "value": "\u003CpageId\u003E", "type": "string" } ] }, "description": "Retrieves the version history for a page definition.", "auth": null, "body": null } }, { "name": "Get a specific version\u0027s data as a page definition", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/:pageId/Versions/:versionNumber", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", ":pageId", "Versions", ":versionNumber" ], "query": null, "variable": [ { "key": "pageId", "value": "\u003CpageId\u003E", "type": "string" }, { "key": "versionNumber", "value": "\u003CversionNumber\u003E", "type": "string" } ] }, "description": "Returns a version\u0027s component data as a PageDefinitionDto for comparison purposes.\n Does not modify any data.", "auth": null, "body": null } }, { "name": "Remove all unpublished versions for a page", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/:pageId/Versions/Unpublished", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", ":pageId", "Versions", "Unpublished" ], "query": null, "variable": [ { "key": "pageId", "value": "\u003CpageId\u003E", "type": "string" } ] }, "description": "Remove all unpublished versions for a page", "auth": null, "body": null } }, { "name": "Assign pages to a guide", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/AssignToGuide", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", "AssignToGuide" ], "query": null, "variable": null }, "description": "Assigns the specified pages to a guide by setting the appropriate guide ID.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get page definitions for a corporation", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/Corporation/:corporationId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", "Corporation", ":corporationId" ], "query": [ { "key": "applicationType", "value": "\u003CapplicationType\u003E", "description": "Optional filter by application type (Arranger, Connections)", "disabled": true }, { "key": "includeInactive", "value": "\u003CincludeInactive\u003E", "description": "Whether to include inactive pages", "disabled": true } ], "variable": [ { "key": "corporationId", "value": "\u003CcorporationId\u003E", "type": "string" } ] }, "description": "Retrieves page definitions owned by the specified corporation.\n Requires Zeus or AuroraAdmin role.", "auth": null, "body": null } }, { "name": "Create a corporation page definition", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/Corporation/:corporationId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", "Corporation", ":corporationId" ], "query": null, "variable": [ { "key": "corporationId", "value": "\u003CcorporationId\u003E", "type": "string" } ] }, "description": "Creates a new page definition owned by the specified corporation.\n Requires Zeus or AuroraAdmin role.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create company pages from template pages", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/CreateFromTemplates", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", "CreateFromTemplates" ], "query": [ { "key": "applicationType", "value": "\u003CapplicationType\u003E", "description": "The application type (Arranger, Connections)", "disabled": true }, { "key": "arrangerGuideId", "value": "\u003CarrangerGuideId\u003E", "description": "Optional arranger guide ID to assign pages to", "disabled": true }, { "key": "connectionsGuideId", "value": "\u003CconnectionsGuideId\u003E", "description": "Optional connections guide ID to assign pages to", "disabled": true } ], "variable": null }, "description": "Creates company-specific pages by copying all global template pages for the application type.\n Skips any pages where the company already has a page with the same slug.", "auth": null, "body": null } }, { "name": "Generate a mermaid flow chart for a guide\u0027s page flow", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/FlowChart", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", "FlowChart" ], "query": [ { "key": "arrangerGuideId", "value": "\u003CarrangerGuideId\u003E", "description": "The arranger guide to generate the flow chart for", "disabled": true } ], "variable": null }, "description": "Generates mermaid markdown representing the page flow for a specific arranger guide.\n Universal pages (no tags) create linear nodes, while tagged pages create branches with labels.", "auth": null, "body": null } }, { "name": "Get all global page definitions", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/Global", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", "Global" ], "query": [ { "key": "applicationType", "value": "\u003CapplicationType\u003E", "description": "Optional filter by application type (Arranger, Connections)", "disabled": true }, { "key": "includeInactive", "value": "\u003CincludeInactive\u003E", "description": "Whether to include inactive pages", "disabled": true } ], "variable": null }, "description": "Retrieves all global page definitions (CompanyId == null).\n These are the default/template pages available to all companies.\n Requires Zeus or AuroraAdmin role.", "auth": null, "body": null } }, { "name": "Create a new global page definition", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/Global", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", "Global" ], "query": null, "variable": null }, "description": "Creates a new global page definition (CompanyId == null).\n Requires Zeus or AuroraAdmin role.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Reorder global page definitions", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/Global/Reorder", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", "Global", "Reorder" ], "query": null, "variable": null }, "description": "Updates the display order of global pages.\n Requires Zeus or AuroraAdmin role.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Generate a preview from a page definition DTO", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/Preview", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", "Preview" ], "query": [ { "key": "device", "value": "\u003Cdevice\u003E", "description": "Optional device type for responsive preview (mobile, tablet, desktop)", "disabled": true }, { "key": "templateType", "value": "\u003CtemplateType\u003E", "description": "Layout template type (Classic, Minimal, Sidebar, BottomNav)", "disabled": true }, { "key": "contentWidth", "value": "\u003CcontentWidth\u003E", "description": "Content width (boxed, wide, full)", "disabled": true }, { "key": "showContainer", "value": "\u003CshowContainer\u003E", "description": "Whether to show content in a container", "disabled": true } ], "variable": null }, "description": "Generates an HTML preview from a page definition DTO without saving.\n Useful for previewing unsaved changes in the page builder editor.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove all unassigned pages for a company", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/RemoveUnassigned", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", "RemoveUnassigned" ], "query": [ { "key": "applicationType", "value": "\u003CapplicationType\u003E", "description": null, "disabled": true } ], "variable": null }, "description": "Deactivates all active company pages that are not assigned to any guide for the given application type.", "auth": null, "body": null } }, { "name": "Reorder page definitions", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/Reorder", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", "Reorder" ], "query": [ { "key": "arrangerGuideId", "value": "\u003CarrangerGuideId\u003E", "description": "Optional arranger guide to scope the reorder to. When supplied, pages are matched by guide rather than by company, allowing corporation-owned pages to be reordered.", "disabled": true }, { "key": "connectionsGuideId", "value": "\u003CconnectionsGuideId\u003E", "description": "Optional connections guide to scope the reorder to. When supplied, pages are matched by guide rather than by company.", "disabled": true } ], "variable": null }, "description": "Updates the display order of multiple pages at once.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a page definition by slug", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/Slug/:slug", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", "Slug", ":slug" ], "query": [ { "key": "applicationType", "value": "\u003CapplicationType\u003E", "description": "The application type (Arranger, Connections)", "disabled": true } ], "variable": [ { "key": "slug", "value": "\u003Cslug\u003E", "type": "string" } ] }, "description": "Retrieves a page definition by its URL slug and application type.\n Company-specific pages take precedence over global pages.", "auth": null, "body": null } }, { "name": "Get unassigned pages for a company", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Pages/Unassigned", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Pages", "Unassigned" ], "query": [ { "key": "applicationType", "value": "\u003CapplicationType\u003E", "description": null, "disabled": true } ], "variable": null }, "description": "Returns active company pages that are not assigned to any guide for the given application type.", "auth": null, "body": null } }, { "name": "Get all page templates", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Templates", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Templates" ], "query": [ { "key": "applicationType", "value": "\u003CapplicationType\u003E", "description": "Optional filter by application type", "disabled": true } ], "variable": null }, "description": "Retrieves all page templates visible to the user\u0027s company.\n Includes global templates (available to all) and company-specific templates.", "auth": null, "body": null } }, { "name": "Create a new page template", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Templates", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Templates" ], "query": null, "variable": null }, "description": "Creates a new page template owned by the specified company.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a specific page template", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Templates/:globalId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Templates", ":globalId" ], "query": null, "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" } ] }, "description": "Retrieves a single page template by its global ID.", "auth": null, "body": null } }, { "name": "Delete a page template", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Templates/:globalId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Templates", ":globalId" ], "query": null, "variable": [ { "key": "globalId", "value": "\u003CglobalId\u003E", "type": "string" } ] }, "description": "Deletes a page template. Built-in templates cannot be deleted.", "auth": null, "body": null } }, { "name": "Apply a template to create a new page", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/PageBuilder/Templates/:templateId/Apply", "host": [ "{{baseUrl}}" ], "path": [ "v2", "PageBuilder", "Templates", ":templateId", "Apply" ], "query": [ { "key": "pageName", "value": "\u003CpageName\u003E", "description": "The name for the new page", "disabled": true }, { "key": "pageSlug", "value": "\u003CpageSlug\u003E", "description": "The slug for the new page", "disabled": true } ], "variable": [ { "key": "templateId", "value": "\u003CtemplateId\u003E", "type": "string" } ] }, "description": "Creates a new page definition from a template.", "auth": null, "body": null } } ], "request": null }, { "name": "Page Flows", "description": null, "item": [ { "name": "Add a Page Flow", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/PageFlow", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "PageFlow" ], "query": null, "variable": null }, "description": "Adds a Page Flow using Page Flow payload in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Retrieve page flow details by ID", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/PageFlow/:pageFlowId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "PageFlow", ":pageFlowId" ], "query": null, "variable": [ { "key": "pageFlowId", "value": "\u003CpageFlowId\u003E", "type": "string" } ] }, "description": "Retrieves the page flow based on the provided page flow ID and company ID.\n The method projects the data into a DTO, manually maps additional properties, and includes associated media details.", "auth": null, "body": null } }, { "name": "Update a Page Flow", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/PageFlow/:pageFlowId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "PageFlow", ":pageFlowId" ], "query": null, "variable": [ { "key": "pageFlowId", "value": "\u003CpageFlowId\u003E", "type": "string" } ] }, "description": "Updates a Page Flow matching Page Flow Id using Page Flow payload in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a Page Flow", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/PageFlow/:pageFlowId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "PageFlow", ":pageFlowId" ], "query": null, "variable": [ { "key": "pageFlowId", "value": "\u003CpageFlowId\u003E", "type": "string" } ] }, "description": "Deletes a Page Flow matching Page Flow Id in request.", "auth": null, "body": null } }, { "name": "Page Flow Media", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/PageFlow/:pageFlowId/Media", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "PageFlow", ":pageFlowId", "Media" ], "query": null, "variable": [ { "key": "pageFlowId", "value": "\u003CpageFlowId\u003E", "type": "string" } ] }, "description": "Returns Page Flow Media matching Page Flow Id in request.", "auth": null, "body": null } }, { "name": "Adds Page Flow Media", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/PageFlow/:pageFlowId/Media", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "PageFlow", ":pageFlowId", "Media" ], "query": null, "variable": [ { "key": "pageFlowId", "value": "\u003CpageFlowId\u003E", "type": "string" } ] }, "description": "Adds Page Flow Media for Page Flow Id and using Files form fields in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Deletes Page Flow Medium", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/PageFlow/:pageFlowId/Media/:pageFlowMediumId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "PageFlow", ":pageFlowId", "Media", ":pageFlowMediumId" ], "query": null, "variable": [ { "key": "pageFlowId", "value": "\u003CpageFlowId\u003E", "type": "string" }, { "key": "pageFlowMediumId", "value": "\u003CpageFlowMediumId\u003E", "type": "string" } ] }, "description": "Deletes Page Flow Media for Page Flow Medium Id in request.", "auth": null, "body": null } }, { "name": "Adds Page Flow Medium contents only", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/PageFlow/:pageFlowId/Media/Blob", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "PageFlow", ":pageFlowId", "Media", "Blob" ], "query": null, "variable": [ { "key": "pageFlowId", "value": "\u003CpageFlowId\u003E", "type": "string" } ] }, "description": "Adds Page Flow Media contents only for Page Flow Id and using Files form fields in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Page Flow for Call", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/PageFlow/Call/:callId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "PageFlow", "Call", ":callId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Returns Page Flow for Case matching Call Id in request.", "auth": null, "body": null } }, { "name": "Page Flow Media Contents", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/PageFlow/Media/:pageFlowMediumId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "PageFlow", "Media", ":pageFlowMediumId" ], "query": [ { "key": "width", "value": "\u003Cwidth\u003E", "description": "Width", "disabled": true }, { "key": "height", "value": "\u003Cheight\u003E", "description": "Height", "disabled": true }, { "key": "fit", "value": "\u003Cfit\u003E", "description": "Fit", "disabled": true } ], "variable": [ { "key": "pageFlowMediumId", "value": "\u003CpageFlowMediumId\u003E", "type": "string" } ] }, "description": "Returns Page Flow Media contents matching Page Flow Id using Width, Height and Fit in request.", "auth": null, "body": null } }, { "name": "Page Flows", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/PageFlows", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "PageFlows" ], "query": null, "variable": null }, "description": "Returns list of Page Flows.", "auth": null, "body": null } }, { "name": "Add a Page Flow", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/AdvisorV2/PageFlow", "host": [ "{{baseUrl}}" ], "path": [ "v2", "AdvisorV2", "PageFlow" ], "query": null, "variable": null }, "description": "Adds a Page Flow using Page Flow payload in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Retrieve page flow details by ID", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/AdvisorV2/PageFlow/:pageFlowId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "AdvisorV2", "PageFlow", ":pageFlowId" ], "query": null, "variable": [ { "key": "pageFlowId", "value": "\u003CpageFlowId\u003E", "type": "string" } ] }, "description": "Retrieves the page flow based on the provided page flow ID and company ID.\n The method projects the data into a DTO, manually maps additional properties, and includes associated media details.", "auth": null, "body": null } }, { "name": "Update a Page Flow", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/AdvisorV2/PageFlow/:pageFlowId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "AdvisorV2", "PageFlow", ":pageFlowId" ], "query": null, "variable": [ { "key": "pageFlowId", "value": "\u003CpageFlowId\u003E", "type": "string" } ] }, "description": "Updates a Page Flow matching Page Flow Id using Page Flow payload in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a Page Flow", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/AdvisorV2/PageFlow/:pageFlowId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "AdvisorV2", "PageFlow", ":pageFlowId" ], "query": null, "variable": [ { "key": "pageFlowId", "value": "\u003CpageFlowId\u003E", "type": "string" } ] }, "description": "Deletes a Page Flow matching Page Flow Id in request.", "auth": null, "body": null } }, { "name": "Page Flow Media", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/AdvisorV2/PageFlow/:pageFlowId/Media", "host": [ "{{baseUrl}}" ], "path": [ "v2", "AdvisorV2", "PageFlow", ":pageFlowId", "Media" ], "query": null, "variable": [ { "key": "pageFlowId", "value": "\u003CpageFlowId\u003E", "type": "string" } ] }, "description": "Returns Page Flow Media matching Page Flow Id in request.", "auth": null, "body": null } }, { "name": "Adds Page Flow Media", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/AdvisorV2/PageFlow/:pageFlowId/Media", "host": [ "{{baseUrl}}" ], "path": [ "v2", "AdvisorV2", "PageFlow", ":pageFlowId", "Media" ], "query": null, "variable": [ { "key": "pageFlowId", "value": "\u003CpageFlowId\u003E", "type": "string" } ] }, "description": "Adds Page Flow Media for Page Flow Id and using Files form fields in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Deletes Page Flow Medium", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/AdvisorV2/PageFlow/:pageFlowId/Media/:pageFlowMediumId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "AdvisorV2", "PageFlow", ":pageFlowId", "Media", ":pageFlowMediumId" ], "query": null, "variable": [ { "key": "pageFlowId", "value": "\u003CpageFlowId\u003E", "type": "string" }, { "key": "pageFlowMediumId", "value": "\u003CpageFlowMediumId\u003E", "type": "string" } ] }, "description": "Deletes Page Flow Media for Page Flow Medium Id in request.", "auth": null, "body": null } }, { "name": "Adds Page Flow Medium contents only", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/AdvisorV2/PageFlow/:pageFlowId/Media/Blob", "host": [ "{{baseUrl}}" ], "path": [ "v2", "AdvisorV2", "PageFlow", ":pageFlowId", "Media", "Blob" ], "query": null, "variable": [ { "key": "pageFlowId", "value": "\u003CpageFlowId\u003E", "type": "string" } ] }, "description": "Adds Page Flow Media contents only for Page Flow Id and using Files form fields in request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Page Flow for Call", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/AdvisorV2/PageFlow/Call/:callId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "AdvisorV2", "PageFlow", "Call", ":callId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Returns Page Flow for Case matching Call Id in request.", "auth": null, "body": null } }, { "name": "Page Flow Media Contents", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/AdvisorV2/PageFlow/Media/:pageFlowMediumId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "AdvisorV2", "PageFlow", "Media", ":pageFlowMediumId" ], "query": [ { "key": "width", "value": "\u003Cwidth\u003E", "description": "Width", "disabled": true }, { "key": "height", "value": "\u003Cheight\u003E", "description": "Height", "disabled": true }, { "key": "fit", "value": "\u003Cfit\u003E", "description": "Fit", "disabled": true } ], "variable": [ { "key": "pageFlowMediumId", "value": "\u003CpageFlowMediumId\u003E", "type": "string" } ] }, "description": "Returns Page Flow Media contents matching Page Flow Id using Width, Height and Fit in request.", "auth": null, "body": null } }, { "name": "Page Flows", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/AdvisorV2/PageFlows", "host": [ "{{baseUrl}}" ], "path": [ "v2", "AdvisorV2", "PageFlows" ], "query": null, "variable": null }, "description": "Returns list of Page Flows.", "auth": null, "body": null } } ], "request": null }, { "name": "People", "description": null, "item": [ { "name": "Get Person Data Requirements Configuration", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/PersonRequirement", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "PersonRequirement" ], "query": null, "variable": null }, "description": "Retrieves the company\u0027s configuration for which person fields are required during case data entry. This allows\n companies to customize which demographic and biographical fields must be completed for decedents, next-of-kin,\n and other people involved in cases. Used by the UI to enforce data validation rules.\n\n**Usage Notes:**\n\n- Returns company-specific person field requirement rules.\n- Each requirement specifies which form field is required for which person roles.\n- Used by the UI to display required field indicators and enforce validation.\n- Common required fields: name, SSN, date of birth, address, phone, email.\n- Different requirements can apply to different person types (decedent vs. next-of-kin).\n- Empty list means only system default required fields apply.\n- Configuration is stored per company in the PersonRequirements table.\n\n\n**Tags:**Settings, Person Requirements, Data Validation, Configuration", "auth": null, "body": null } }, { "name": "Save Person Data Requirements Configuration", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/PersonRequirement", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "PersonRequirement" ], "query": null, "variable": null }, "description": "Updates the company\u0027s configuration for which person fields are required during case data entry. This endpoint\n performs a full replacement - it removes requirements that are no longer in the list and adds new requirements.\n Used by administrators to customize required person data fields for their company.\n\n**Usage Notes:**\n\n- This is a full replacement operation - not a patch/merge.\n- Existing requirements not in the new list are deleted from the database.\n- New requirements (PersonRequirementId = 0) are inserted as new records.\n- Each requirement specifies PersonTypeId and ColumnName (field identifier).\n- CoId is automatically set from the header parameter.\n- Changes take effect immediately for data entry validation.\n- Uses PersonRequirementDtoComparer to identify deleted requirements.\n\n\n**Tags:**Settings, Person Requirements, Configuration, Data Validation", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Available Fields for Person Requirements", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/PersonRequirement/AvailableFields", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "PersonRequirement", "AvailableFields" ], "query": null, "variable": null }, "description": "Retrieves the list of person form fields that can be configured as required fields. Returns all visible fields\n from the person form (FormId = 51) excluding certain system fields. This endpoint provides the available options\n when configuring which person fields should be required for data entry.\n\n**Usage Notes:**\n\n- Returns fields from the person form (FormId = 51) in AdvisorGlobal.\n- Only includes visible fields (IsVisible = true).\n- Excludes specific system fields: 754, 762, 763, 764, 1694, 745, 747.\n- Used to populate dropdown/selection UI when configuring person requirements.\n- Administrators use this to determine which fields can be marked as required.\n- Available fields include demographic, contact, biographical, and identification fields.\n- Field list is consistent across all companies (from global configuration).\n\n\n**Tags:**Settings, Person Requirements, Form Fields, Configuration", "auth": null, "body": null } }, { "name": "Create Third-Party Organization", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/ThirdPartyOrganization", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "ThirdPartyOrganization" ], "query": null, "variable": null }, "description": "Creates a new third-party organization entity such as an insurance company, cemetery, church, or other external\n organization that may be involved with cases. Third-party organizations can be associated with payments, services,\n or other case activities.\n\n**Usage Notes:**\n\n- Creates a new entry in the ThirdPartyOrganizations table.\n- CoId is automatically set to the company from the header.\n- Common types: insurance companies, cemeteries, churches, funeral homes, crematoriums.\n- Organizations can be selected as payers for anticipated payments.\n- Can be associated with service locations, disposition facilities, etc.\n- Typically includes contact information for coordination and billing.\n- The created organization is available immediately for use in cases.\n\n\n**Tags:**Third-Party Organizations, Insurance, Cemeteries, External Entities", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create Person", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Person", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Person" ], "query": null, "variable": null }, "description": "Creates a new person record and returns the newly created person. Requires appropriate permissions.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Person", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Person/:personId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Person", ":personId" ], "query": null, "variable": [ { "key": "personId", "value": "\u003CpersonId\u003E", "type": "string" } ] }, "description": "Retrieves a person based on the provided person ID and company ID. Applies view permissions if necessary.", "auth": null, "body": null } }, { "name": "Update Person", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Person/:personId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Person", ":personId" ], "query": null, "variable": [ { "key": "personId", "value": "\u003CpersonId\u003E", "type": "string" } ] }, "description": "Updates the details of an existing person based on the provided ID and data.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Person", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Person/:personId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Person", ":personId" ], "query": null, "variable": [ { "key": "personId", "value": "\u003CpersonId\u003E", "type": "string" } ] }, "description": "Soft deletes a person by setting the \u0027Active\u0027 flag to false.", "auth": null, "body": null } }, { "name": "Create License", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Person/:personId/License", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Person", ":personId", "License" ], "query": null, "variable": [ { "key": "personId", "value": "\u003CpersonId\u003E", "type": "string" } ] }, "description": "Creates a new license record for a person and returns the newly created license.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Updates License", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Person/:personId/License/:licenseId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Person", ":personId", "License", ":licenseId" ], "query": null, "variable": [ { "key": "personId", "value": "\u003CpersonId\u003E", "type": "string" }, { "key": "licenseId", "value": "\u003ClicenseId\u003E", "type": "string" } ] }, "description": "Updates the details of an existing license based on the provided license ID and data.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete License", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Person/:personId/License/:licenseId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Person", ":personId", "License", ":licenseId" ], "query": null, "variable": [ { "key": "personId", "value": "\u003CpersonId\u003E", "type": "string" }, { "key": "licenseId", "value": "\u003ClicenseId\u003E", "type": "string" } ] }, "description": "Soft deletes a license by setting the \u0027Active\u0027 flag to false.", "auth": null, "body": null } }, { "name": "Get Licenses", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Person/:personId/Licenses", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Person", ":personId", "Licenses" ], "query": null, "variable": [ { "key": "personId", "value": "\u003CpersonId\u003E", "type": "string" } ] }, "description": "Retrieves a list of licenses associated with a person based on the provided person ID and company ID.", "auth": null, "body": null } } ], "request": null }, { "name": "Placeholders", "description": null, "item": [ { "name": "Returns all placeholders visible to the requesting scope.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Placeholders", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Placeholders" ], "query": [ { "key": "scope", "value": "\u003Cscope\u003E", "description": "Optional scope filter. Accepts a single value (\u0060Workflow\u0060, \u0060Arranger\u0060,\r\n\u0060Connections\u0060, \u0060Email\u0060, \u0060Sms\u0060, \u0060All\u0060) or omitted for all.", "disabled": true } ], "variable": null }, "description": "Returns all placeholders visible to the requesting scope.", "auth": null, "body": null } } ], "request": null }, { "name": "Public", "description": null, "item": [ { "name": "Submits a contact form request from the public website.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Public/contact", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Public", "contact" ], "query": null, "variable": null }, "description": "Submits a contact form request from the public website.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Gets all contact submissions.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Public/contact/submissions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Public", "contact", "submissions" ], "query": [ { "key": "unprocessedOnly", "value": "\u003CunprocessedOnly\u003E", "description": null, "disabled": true } ], "variable": null }, "description": "Gets all contact submissions.", "auth": null, "body": null } }, { "name": "Marks a contact submission as processed.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Public/contact/submissions/:id/process", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Public", "contact", "submissions", ":id", "process" ], "query": [ { "key": "processedBy", "value": "\u003CprocessedBy\u003E", "description": "The user who processed the submission.", "disabled": true }, { "key": "notes", "value": "\u003Cnotes\u003E", "description": "Optional notes about the processing.", "disabled": true } ], "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "Marks a contact submission as processed.", "auth": null, "body": null } } ], "request": null }, { "name": "Public: QR", "description": null, "item": [ { "name": "Adds a person to the case associated with the QR token.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/public/qr/:token/person", "host": [ "{{baseUrl}}" ], "path": [ "v2", "public", "qr", ":token", "person" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Adds a person to the case associated with the QR token.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Returns person types (relationships) available for the case\u0027s company.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/public/qr/:token/person-types", "host": [ "{{baseUrl}}" ], "path": [ "v2", "public", "qr", ":token", "person-types" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Returns person types (relationships) available for the case\u0027s company.", "auth": null, "body": null } }, { "name": "Validates a QR token and returns case context (funeral home name, deceased name).", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/public/qr/:token/validate", "host": [ "{{baseUrl}}" ], "path": [ "v2", "public", "qr", ":token", "validate" ], "query": null, "variable": [ { "key": "token", "value": "\u003Ctoken\u003E", "type": "string" } ] }, "description": "Validates a QR token and returns case context (funeral home name, deceased name).", "auth": null, "body": null } } ], "request": null }, { "name": "Reports", "description": null, "item": [ { "name": "Get Form Field Mappings for PDF Form Population", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Advisor/FormFieldMaps", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Advisor", "FormFieldMaps" ], "query": null, "variable": null }, "description": "Retrieves all available form field mappings that define how case data maps to PDF form fields via XPath expressions.\n Includes both standard system mappings and dynamically generated mappings for company-specific custom fields. These\n mappings are used to automatically populate PDF forms with case data during document generation.\n\n**Usage Notes:**\n\n- Returns system-defined mappings from AdvisorMaster.FormFieldMaps.\n- Dynamically generates additional mappings for each active custom field.\n- Custom field mappings use format: \u0022custom_Field{CustomFieldId}\u0022 for PdfFieldName.\n- Custom field XPath: //call/CustomFieldData/CustomField[@CustomDataFieldId=\u0022{id}\u0022]/Value\n- Custom field mappings are assigned auto-incremented IDs above the max system mapping ID.\n- Used by PDF form filling service to map case XML data to PDF form fields.\n- IsMultiValued flag indicates if the field can contain multiple values.\n- Note field provides human-readable description of what the field contains.\n\n\n**Tags:**Forms, PDF Forms, Field Mapping, Export, Custom Fields", "auth": null, "body": null } }, { "name": "Get Reports", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Report", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Report" ], "query": [ { "key": "lastViewed", "value": "\u003ClastViewed\u003E", "description": "A flag to indicate if last viewed information should be included (default is false).", "disabled": true } ], "variable": null }, "description": "Retrieves a list of reports for the specified company, optionally including last viewed information.", "auth": null, "body": null } }, { "name": "Post Report", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Report", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Report" ], "query": null, "variable": null }, "description": "Creates a new report based on the provided report data.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Patch Report", "description": null, "item": null, "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Report/:reportId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Report", ":reportId" ], "query": null, "variable": [ { "key": "reportId", "value": "\u003CreportId\u003E", "type": "string" } ] }, "description": "Updates the specified report based on the provided patch document.\n For \u0060HttpPatch\u0060 methods, include a sample patch document in the remarks.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Arranger Reports", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Report/ArrangerReports", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Report", "ArrangerReports" ], "query": [ { "key": "callId", "value": "\u003CcallId\u003E", "description": "Optional call ID to filter state-specific reports based on the case\u0027s location state.", "disabled": true }, { "key": "locationId", "value": "\u003ClocationId\u003E", "description": "Optional location ID to filter state-specific reports based on the location\u0027s state (alternative to callId).", "disabled": true } ], "variable": null }, "description": "Retrieves a list of arranger reports for the specified company.\n When callId or locationId is provided, state-specific reports are filtered to show only those matching the location\u0027s state.\n Reports that are not state-specific are always included.", "auth": null, "body": null } }, { "name": "Get Business Reports", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Report/BusinessReports", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Report", "BusinessReports" ], "query": null, "variable": null }, "description": "Retrieves a list of business reports for the specified company.", "auth": null, "body": null } }, { "name": "Get Call Report By Id", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Report/CallReportById", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Report", "CallReportById" ], "query": [ { "key": "reportId", "value": "\u003CreportId\u003E", "description": "The ID of the report to retrieve.", "disabled": true } ], "variable": null }, "description": "Retrieves a single call report based on the provided report ID.", "auth": null, "body": null } }, { "name": "Get Call Reports", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Report/CallReports", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Report", "CallReports" ], "query": [ { "key": "callId", "value": "\u003CcallId\u003E", "description": "Optional call ID to filter state-specific reports based on the case\u0027s location state.", "disabled": true }, { "key": "locationId", "value": "\u003ClocationId\u003E", "description": "Optional location ID to filter state-specific reports based on the location\u0027s state (alternative to callId).", "disabled": true } ], "variable": null }, "description": "Retrieves a list of call reports for the specified company.\n When callId or locationId is provided, state-specific reports are filtered to show only those matching the location\u0027s state.\n Reports that are not state-specific are always included.", "auth": null, "body": null } }, { "name": "Get Corporate Reports", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Report/CorporateReports", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Report", "CorporateReports" ], "query": null, "variable": null }, "description": "Retrieves a list of corporate reports based on the user\u0027s roles and permissions.", "auth": null, "body": null } }, { "name": "Get Report Bits", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Report/FormData/:reportId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Report", "FormData", ":reportId" ], "query": null, "variable": [ { "key": "reportId", "value": "\u003CreportId\u003E", "type": "string" } ] }, "description": "Retrieves the form data for the specified report ID, including handling blob storage.", "auth": null, "body": null } }, { "name": "Get Preview Image", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Report/PreviewImage/:reportName", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Report", "PreviewImage", ":reportName" ], "query": null, "variable": [ { "key": "reportName", "value": "\u003CreportName\u003E", "type": "string" } ] }, "description": "Retrieves the preview image for the specified report.", "auth": null, "body": null } }, { "name": "Get SSRS Reports", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Report/SSRS", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Report", "SSRS" ], "query": null, "variable": null }, "description": "Retrieves a list of SSRS reports with their details.", "auth": null, "body": null } }, { "name": "Get Client Database Name", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Report/SSRS/:companyId/DatabaseName", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Report", "SSRS", ":companyId", "DatabaseName" ], "query": null, "variable": [ { "key": "companyId", "value": "\u003CcompanyId\u003E", "type": "string" } ] }, "description": "Returns the SQL database name backing the specified company\u2019s client context. Intended for SSRS configuration scenarios where the database needs to be referenced explicitly.\n\n**Usage Notes:**\n\n- Parses the connection string from the resolved client DbContext.\n- Useful when constructing SSRS data sources dynamically.\n\n\n**Tags:**Forms, Reports, SSRS", "auth": null, "body": null } }, { "name": "Get SSRS Report Parameters", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Report/SSRS/Parameters", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Report", "SSRS", "Parameters" ], "query": [ { "key": "reportPath", "value": "\u003CreportPath\u003E", "description": "The path of the SSRS report.", "disabled": true } ], "variable": null }, "description": "Retrieves parameters for the specified SSRS report.", "auth": null, "body": null } } ], "request": null }, { "name": "Reports: Packages", "description": null, "item": [ { "name": "Get Report Packages", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Report/Packages", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Report", "Packages" ], "query": null, "variable": null }, "description": "Retrieves a list of report packages for the specified company.", "auth": null, "body": null } }, { "name": "Post Report Package", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Report/Packages", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Report", "Packages" ], "query": null, "variable": null }, "description": "Creates a new report package based on the provided report package data.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Patch Report Package", "description": null, "item": null, "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Report/Packages/:reportPackageId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Report", "Packages", ":reportPackageId" ], "query": null, "variable": [ { "key": "reportPackageId", "value": "\u003CreportPackageId\u003E", "type": "string" } ] }, "description": "Updates the specified report package based on the provided patch document.\n For \u0060HttpPatch\u0060 methods, include a sample patch document in the remarks.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Report Package", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Report/Packages/:reportPackageId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Report", "Packages", ":reportPackageId" ], "query": null, "variable": [ { "key": "reportPackageId", "value": "\u003CreportPackageId\u003E", "type": "string" } ] }, "description": "Deletes the specified report package and its associated reports.", "auth": null, "body": null } } ], "request": null }, { "name": "Reports: Tracking", "description": null, "item": [ { "name": "Track Report", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Report/TrackReport", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Report", "TrackReport" ], "query": null, "variable": null }, "description": "Tracks the report based on the provided report data, updating the last viewed time.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Track Report with Call ID", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Report/TrackReport/:callId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Report", "TrackReport", ":callId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Tracks the report based on the provided report data and optional call ID, updating the last viewed time.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } } ], "request": null }, { "name": "Resources", "description": null, "item": [ { "name": "Create Resource", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Resource", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Resource" ], "query": null, "variable": null }, "description": "Creates a new resource in the specified company. Requires permission to manage resources.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Resource", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Resource/:resourceId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Resource", ":resourceId" ], "query": null, "variable": [ { "key": "resourceId", "value": "\u003CresourceId\u003E", "type": "string" } ] }, "description": "Marks the specified resource as inactive in the given company. Requires permission to manage resources.", "auth": null, "body": null } }, { "name": "Update Resource", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Resource/:resourceId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Resource", ":resourceId" ], "query": null, "variable": [ { "key": "resourceId", "value": "\u003CresourceId\u003E", "type": "string" } ] }, "description": "Updates the details of the specified resource. Requires permission to manage resources.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Resource Locations", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Resource/:resourceId/Locations", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Resource", ":resourceId", "Locations" ], "query": null, "variable": [ { "key": "resourceId", "value": "\u003CresourceId\u003E", "type": "string" } ] }, "description": "Retrieves a list of location resources associated with a specific resource for the given company.", "auth": null, "body": null } }, { "name": "Update Resource Locations", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Resource/:resourceId/Locations", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Resource", ":resourceId", "Locations" ], "query": null, "variable": [ { "key": "resourceId", "value": "\u003CresourceId\u003E", "type": "string" } ] }, "description": "Updates the locations associated with the specified resource. Requires permission to manage resources.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Locations", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Resource/Locations", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Resource", "Locations" ], "query": null, "variable": null }, "description": "Retrieves a list of location resources for the specified company.", "auth": null, "body": null } }, { "name": "Get Person Resources", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Resource/People", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Resource", "People" ], "query": null, "variable": null }, "description": "Retrieves a list of resources classified as person resources for the specified company.", "auth": null, "body": null } }, { "name": "Get Resources By Type", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Resource/Type/:resourceTypeId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Resource", "Type", ":resourceTypeId" ], "query": null, "variable": [ { "key": "resourceTypeId", "value": "\u003CresourceTypeId\u003E", "type": "string" } ] }, "description": "Retrieves a list of resources for the specified type within the given company.", "auth": null, "body": null } }, { "name": "Get Person Users", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Resource/Users", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Resource", "Users" ], "query": null, "variable": null }, "description": "Retrieves a list of users who are advisors for the specified company.", "auth": null, "body": null } } ], "request": null }, { "name": "Search", "description": null, "item": [ { "name": "Search Companies", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Search/Companies", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Search", "Companies" ], "query": [ { "key": "query", "value": "\u003Cquery\u003E", "description": "The search query to filter company names.", "disabled": true } ], "variable": null }, "description": "Searches for companies based on the query. The results are filtered based on the user\u0027s role.\n Zeus and AuroraAdmin roles have access to all initialized companies. CorporateManager role has access to companies within the user\u0027s corporation.", "auth": null, "body": null } }, { "name": "Search Funeral Homes", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Search/FuneralHomes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Search", "FuneralHomes" ], "query": [ { "key": "query", "value": "\u003Cquery\u003E", "description": "The search query to filter funeral home names or Matthews account numbers.", "disabled": true }, { "key": "searchAllCompanies", "value": "\u003CsearchAllCompanies\u003E", "description": "Whether to search across all companies within the user\u0027s corporation (optional).", "disabled": true } ], "variable": null }, "description": "Searches for funeral homes based on the query. If \u0060searchAllCompanies\u0060 is true, it searches across all companies in the user\u0027s corporation.\n The results are filtered based on the user\u0027s role. Zeus and AuroraAdmin roles can search all companies, while CorporateManager role searches within their corporation.", "auth": null, "body": null } } ], "request": null }, { "name": "Security Roles", "description": null, "item": [ { "name": "Create Security Role", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/SecurityRole", "host": [ "{{baseUrl}}" ], "path": [ "v2", "SecurityRole" ], "query": null, "variable": null }, "description": "Creates a new security role within the specified company. Requires permission to manage security roles.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Security Role", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/SecurityRole/:securityRoleId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "SecurityRole", ":securityRoleId" ], "query": null, "variable": [ { "key": "securityRoleId", "value": "\u003CsecurityRoleId\u003E", "type": "string" } ] }, "description": "Retrieves a specific security role by its ID for the specified company. Returns an error if the role is not found.", "auth": null, "body": null } }, { "name": "Add Permission to Security Role", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/SecurityRole/:securityRoleId/Permission/:permissionId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "SecurityRole", ":securityRoleId", "Permission", ":permissionId" ], "query": null, "variable": [ { "key": "securityRoleId", "value": "\u003CsecurityRoleId\u003E", "type": "string" }, { "key": "permissionId", "value": "\u003CpermissionId\u003E", "type": "string" } ] }, "description": "Adds a permission to a specified security role within the given company. Requires proper permissions to manage roles and permissions.", "auth": null, "body": null } }, { "name": "Remove Permission from Security Role", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/SecurityRole/:securityRoleId/Permission/:permissionId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "SecurityRole", ":securityRoleId", "Permission", ":permissionId" ], "query": null, "variable": [ { "key": "securityRoleId", "value": "\u003CsecurityRoleId\u003E", "type": "string" }, { "key": "permissionId", "value": "\u003CpermissionId\u003E", "type": "string" } ] }, "description": "Removes a permission from a specified security role within the given company. Requires proper permissions to manage roles and permissions.", "auth": null, "body": null } }, { "name": "Get Permissions for Security Role", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/SecurityRole/:securityRoleId/Permissions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "SecurityRole", ":securityRoleId", "Permissions" ], "query": null, "variable": [ { "key": "securityRoleId", "value": "\u003CsecurityRoleId\u003E", "type": "string" } ] }, "description": "Retrieves a list of permissions associated with the specified security role for the given company.", "auth": null, "body": null } }, { "name": "Get Security Roles", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/SecurityRoles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "SecurityRoles" ], "query": null, "variable": null }, "description": "Retrieves security roles for the specified company. Roles are filtered to exclude the role with ID 6.", "auth": null, "body": null } } ], "request": null }, { "name": "Sync", "description": null, "item": [ { "name": "Update Catalog Call Type Codes", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Sync/CatalogCallTypeCodes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Sync", "CatalogCallTypeCodes" ], "query": null, "variable": null }, "description": "This method updates call type codes for item types in multiple target companies based on source company data.\n It handles addition and modification of codes and logs each update action.\n Sample patch document for HttpPatch methods is not applicable here.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Configurations", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Sync/Configurations", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Sync", "Configurations" ], "query": null, "variable": null }, "description": "Retrieves the list of sync configurations. The user must have the appropriate permissions to view this information.", "auth": null, "body": null } }, { "name": "Update Vendors", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Sync/CustomFields", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Sync", "CustomFields" ], "query": null, "variable": null }, "description": "Updates or inserts vendor information across target companies based on the provided source vendor data. Changes are committed within a transaction.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Effective Date", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Sync/DisclosureEffectiveDate", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Sync", "DisclosureEffectiveDate" ], "query": null, "variable": null }, "description": "Updates the disclosure effective date for multiple target locations based on the source location. Changes are committed within a transaction.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Field Selection", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Sync/FieldSelection", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Sync", "FieldSelection" ], "query": null, "variable": null }, "description": "This method updates field selection data for multiple target companies based on the source company\u2019s flow data.\n It handles insertion or updating of records and logs each update action.\n Sample patch document for HttpPatch methods is not applicable here.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Execution History", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Sync/History", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Sync", "History" ], "query": null, "variable": null }, "description": "Retrieves the execution history of sync operations for a specific company. User information is included in the results where available.", "auth": null, "body": null } }, { "name": "Update Lookups", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Sync/Lookup", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Sync", "Lookup" ], "query": null, "variable": null }, "description": "This method updates lookup values for multiple target companies based on source company data.\n It handles creation of new lookup records and logs each update action.\n Sample patch document for HttpPatch methods is not applicable here.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Packages", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Sync/Packages", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Sync", "Packages" ], "query": null, "variable": null }, "description": "Updates packages for the specified company and target funeral homes. If a package already exists, it will be updated if \u0060OverrideIfExists\u0060 is true, otherwise, it will be ignored. The method performs database operations within a transaction, ensuring consistency in updates.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Permissions", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Sync/Permissions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Sync", "Permissions" ], "query": null, "variable": null }, "description": "This method synchronizes permissions from a source company to multiple target companies.\n It overrides existing permissions and logs each update action.\n Sample patch document for HttpPatch methods is not applicable here.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Product Disclaimers", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Sync/ProductDisclaimers", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Sync", "ProductDisclaimers" ], "query": null, "variable": null }, "description": "Updates product disclaimers based on the provided source and target IDs. Changes are made to the target disclaimers and updates are returned.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Product Pricing", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Sync/ProductPricing", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Sync", "ProductPricing" ], "query": null, "variable": null }, "description": "Updates product pricing across target locations based on source location data. Changes are committed within a transaction.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Product Visibility", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Sync/ProductVisibility", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Sync", "ProductVisibility" ], "query": null, "variable": null }, "description": "Updates visibility settings for products in target locations based on source location data. Changes are committed within a transaction.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Product Wholesale", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Sync/ProductWholesale", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Sync", "ProductWholesale" ], "query": null, "variable": null }, "description": "Updates wholesale pricing for products across target locations based on source location data. Changes are committed within a transaction.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Showrooms", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Sync/Showrooms", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Sync", "Showrooms" ], "query": null, "variable": null }, "description": "Updates showrooms for the specified company and target funeral homes. If a showroom already exists, it will be updated if \u0060OverrideIfExists\u0060 is true, otherwise, it will be ignored. The method performs database operations within a transaction, ensuring consistency in updates.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Tax Rates", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Sync/TaxRates", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Sync", "TaxRates" ], "query": null, "variable": null }, "description": "Updates tax rates for the specified company and target funeral homes. If a tax rate already exists, it will be updated if \u0060OverrideIfExists\u0060 is true, otherwise, it will be ignored. The method performs database operations within a transaction, ensuring consistency in updates.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Validate Catalog Call Type Codes", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Sync/Validate/CatalogCallTypeCodes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Sync", "Validate", "CatalogCallTypeCodes" ], "query": null, "variable": null }, "description": "This method validates if catalog items and call types in the source company exist in the target companies.\n It checks for the presence of the catalog and call types, reporting any discrepancies.\n Sample patch document for HttpPatch methods is not applicable here.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Validate Packages", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Sync/Validate/Packages", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Sync", "Validate", "Packages" ], "query": null, "variable": null }, "description": "This method validates if packages and associated items in the source company exist and are correctly configured in the target companies.\n It checks for missing item codes and item types, depending on the provided options.\n Sample patch document for HttpPatch methods is not applicable here.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Validate Showrooms", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Sync/Validate/Showrooms", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Sync", "Validate", "Showrooms" ], "query": null, "variable": null }, "description": "This method validates if showrooms and associated items in the source company exist and are correctly configured in the target companies.\n It returns validation results with any discrepancies found, including missing item codes.\n Sample patch document for HttpPatch methods is not applicable here.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Validate Tax Rates", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Sync/Validate/TaxRates", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Sync", "Validate", "TaxRates" ], "query": null, "variable": null }, "description": "This method validates if item types related to tax rates in the source company exist in the target companies.\n It returns validation results with any discrepancies found.\n Sample patch document for HttpPatch methods is not applicable here.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Vendors", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Sync/Vendors", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Sync", "Vendors" ], "query": null, "variable": null }, "description": "Updates or inserts vendor information across target companies based on the provided source vendor data. Changes are committed within a transaction.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } } ], "request": null }, { "name": "Task Management", "description": null, "item": [ { "name": "Create Task", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Task", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Task" ], "query": null, "variable": null }, "description": "This method creates a new task based on the provided details and assigns it to the specified resource if applicable.\n It performs permission checks to ensure the requesting user has the necessary rights to create tasks.\n If assigned, a task assignment email may be sent to the resource.\n Sample patch document for HttpPatch methods is not applicable here.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Task", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Task/:taskId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Task", ":taskId" ], "query": null, "variable": [ { "key": "taskId", "value": "\u003CtaskId\u003E", "type": "string" } ] }, "description": "This method retrieves a specific task based on the provided task ID and company ID.\n It performs permission checks to ensure the requesting user has the necessary rights to view the task.\n Sample patch document for HttpPatch methods is not applicable here.", "auth": null, "body": null } }, { "name": "Update Task", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Task/:taskId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Task", ":taskId" ], "query": null, "variable": [ { "key": "taskId", "value": "\u003CtaskId\u003E", "type": "string" } ] }, "description": "This method updates an existing task based on the provided details and performs validation to ensure the specified call and task are valid.\n It handles task assignment changes and may send a task assignment email if required.\n Sample patch document for HttpPatch methods is not applicable here.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Complete Task", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Task/:taskId/Completed/:isCompleted", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Task", ":taskId", "Completed", ":isCompleted" ], "query": null, "variable": [ { "key": "taskId", "value": "\u003CtaskId\u003E", "type": "string" }, { "key": "isCompleted", "value": "\u003CisCompleted\u003E", "type": "string" } ] }, "description": "This method updates the completion status of a task based on the provided flag.\n It updates the completion date and person responsible, and clears non-applicable date fields if marking the task as complete or incomplete.\n Sample patch document for HttpPatch methods is not applicable here.", "auth": null, "body": null } }, { "name": "Create Automated Task", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Task/AutomatedTask", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Task", "AutomatedTask" ], "query": null, "variable": null }, "description": "This method creates a new automated task with the provided details and assigns task events as specified.\n It performs permission checks to ensure the requesting user has the necessary rights to manage workflow.\n Sample patch document for HttpPatch methods is not applicable here.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Automated Task", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Task/AutomatedTask/:taskGroupId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Task", "AutomatedTask", ":taskGroupId" ], "query": null, "variable": [ { "key": "taskGroupId", "value": "\u003CtaskGroupId\u003E", "type": "string" } ] }, "description": "This method retrieves details of a specific automated task, including its tasks and related events.\n It requires permission to view workflow and returns an error if the automated task is not found.\n Sample patch document for HttpPatch methods is not applicable here.", "auth": null, "body": null } }, { "name": "Update Automated Task", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Task/AutomatedTask/:taskGroupId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Task", "AutomatedTask", ":taskGroupId" ], "query": null, "variable": [ { "key": "taskGroupId", "value": "\u003CtaskGroupId\u003E", "type": "string" } ] }, "description": "This method updates an existing automated task based on the provided details, including task names and call types.\n It removes outdated task events and adds new ones as necessary, and performs permission checks to ensure the requesting user has the right to manage workflow.\n Sample patch document for HttpPatch methods is not applicable here.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Automated Task", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Task/AutomatedTask/:taskGroupId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Task", "AutomatedTask", ":taskGroupId" ], "query": null, "variable": [ { "key": "taskGroupId", "value": "\u003CtaskGroupId\u003E", "type": "string" } ] }, "description": "This method marks an automated task as inactive instead of physically deleting it from the database.\n It performs permission checks to ensure the requesting user has the necessary rights to manage workflow.\n Sample patch document for HttpPatch methods is not applicable here.", "auth": null, "body": null } }, { "name": "Get Automated Tasks", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Task/AutomatedTasks", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Task", "AutomatedTasks" ], "query": null, "variable": null }, "description": "This method retrieves a list of active automated tasks for a given company, subject to the required permissions.\n The automated tasks are projected to the \u0060TaskGroupDto\u0060 format for the response.\n Sample patch document for HttpPatch methods is not applicable here.", "auth": null, "body": null } }, { "name": "Get Person Resources", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Task/PersonResources", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Task", "PersonResources" ], "query": null, "variable": null }, "description": "This method retrieves a list of active resources that are categorized as person resources for a given company.\n It includes details about each resource\u0027s associated person and updates the person profile information based on user profiles.\n Sample patch document for HttpPatch methods is not applicable here.", "auth": null, "body": null } }, { "name": "Search Tasks", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Task/Search", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Task", "Search" ], "query": [ { "key": "masterFhId", "value": "\u003CmasterFhId\u003E", "description": "Optional. The master FH ID to filter tasks by.", "disabled": true }, { "key": "callId", "value": "\u003CcallId\u003E", "description": "Optional. The call ID to filter tasks by.", "disabled": true }, { "key": "completed", "value": "\u003Ccompleted\u003E", "description": "Optional. Flag to filter tasks by their completion status.", "disabled": true }, { "key": "completedFrom", "value": "\u003CcompletedFrom\u003E", "description": "Optional. Start date to filter tasks by completion date.", "disabled": true }, { "key": "completedTo", "value": "\u003CcompletedTo\u003E", "description": "Optional. End date to filter tasks by completion date.", "disabled": true }, { "key": "take", "value": "\u003Ctake\u003E", "description": "Optional. The number of tasks to retrieve.", "disabled": true } ], "variable": null }, "description": "This method searches for tasks based on various filtering criteria, including master FH ID, call ID, completion status, and date ranges.\n It performs permission checks based on the presence of the call ID and the provided filters.\n Sample patch document for HttpPatch methods is not applicable here.", "auth": null, "body": null } }, { "name": "Toggle Task Complete", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Task/ToggleComplete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Task", "ToggleComplete" ], "query": null, "variable": null }, "description": "This method toggles the completion status of a task based on the provided details.\n It sets the completion date and person responsible based on the completion status and updates the task record accordingly.\n Sample patch document for HttpPatch methods is not applicable here.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } } ], "request": null }, { "name": "Test Accounts", "description": null, "item": [ { "name": "Get All Test Accounts", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/TestAccounts", "host": [ "{{baseUrl}}" ], "path": [ "v2", "TestAccounts" ], "query": null, "variable": null }, "description": "Retrieves all lower-environment test accounts configured for the specified company.\n This allows administrators to manage non-production user accounts used for testing\n or training purposes within a given organization.\n\n**Usage Notes:**\n\n- Intended for administrative use in lower environments.\n- Results include test account details such as email and creation metadata.\n- Each record is retrieved from the\u0060TestAccount.usp_ListUsers\u0060stored procedure.\n- This endpoint helps identify available test users for QA validation.\n\n\n**Tags:**Test Accounts, User Management, Administration", "auth": null, "body": null } }, { "name": "Create Test Account", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/TestAccounts", "host": [ "{{baseUrl}}" ], "path": [ "v2", "TestAccounts" ], "query": null, "variable": null }, "description": "Creates a new lower-environment test account for the specified company.\n This operation allows administrators to generate sandbox user profiles used for\n internal testing or demonstration purposes.\n\n**Usage Notes:**\n\n- Accounts are created using the\u0060TestAccount.usp_CreateUser\u0060stored procedure.\n- Passwords are stored as hashes and should not be transmitted in plaintext.\n- Existing test accounts cannot be duplicated using the same email address.\n- Used primarily for QA and training user provisioning.\n\n\n**Tags:**Test Accounts, User Creation, Administration", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Test Account", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/TestAccounts/:email", "host": [ "{{baseUrl}}" ], "path": [ "v2", "TestAccounts", ":email" ], "query": null, "variable": [ { "key": "email", "value": "\u003Cemail\u003E", "type": "string" } ] }, "description": "Permanently removes a test account from the system by its email address.\n\n**Usage Notes:**\n\n- Executes\u0060TestAccount.usp_DeleteUser\u0060to remove the user from the database.\n- Cannot be undone; ensure the account is safe to remove.\n- Commonly used for cleanup after testing cycles.\n- Audit logs capture all delete operations for accountability.\n\n\n**Tags:**Test Accounts, Deletion, Administration", "auth": null, "body": null } }, { "name": "Get Assigned Roles", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/TestAccounts/:testAccountId/roles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "TestAccounts", ":testAccountId", "roles" ], "query": null, "variable": [ { "key": "testAccountId", "value": "\u003CtestAccountId\u003E", "type": "string" } ] }, "description": "Retrieves all roles currently assigned to the specified test account within a company.\n\n**Usage Notes:**\n\n- Executes\u0060TestAccount.usp_ListRolesByUser\u0060to retrieve role data.\n- Includes both company and funeral home-level roles.\n- Used to review test user role configurations.\n- Results are read-only and ordered by context.\n\n\n**Tags:**Test Accounts, Roles, Permissions", "auth": null, "body": null } }, { "name": "Remove Role Assignment", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/TestAccounts/:testAccountId/roles/:fhId/:roleId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "TestAccounts", ":testAccountId", "roles", ":fhId", ":roleId" ], "query": null, "variable": [ { "key": "testAccountId", "value": "\u003CtestAccountId\u003E", "type": "string" }, { "key": "fhId", "value": "\u003CfhId\u003E", "type": "string" }, { "key": "roleId", "value": "\u003CroleId\u003E", "type": "string" } ] }, "description": "Removes a previously assigned role from a test account for a specific funeral home or company context.\n\n**Usage Notes:**\n\n- Uses\u0060TestAccount.usp_RemoveRole\u0060to revoke access.\n- Removes both role and funeral home linkage if applicable.\n- Commonly used for test cleanup or environment reset operations.\n- Audit logs record all role removal actions.\n\n\n**Tags:**Test Accounts, Roles, Permissions", "auth": null, "body": null } }, { "name": "Get All Test Accounts for Corporation", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/TestAccounts/corporation/:corporationId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "TestAccounts", "corporation", ":corporationId" ], "query": null, "variable": [ { "key": "corporationId", "value": "\u003CcorporationId\u003E", "type": "string" } ] }, "description": "Retrieves all lower-environment test accounts for all companies within a corporation.\n This provides a consolidated view of test accounts across the entire corporate structure.\n\n**Usage Notes:**\n\n- Intended for corporate-level administration in lower environments.\n- Results include test account details with company name for identification.\n- Aggregates results from all companies in the corporation.\n\n\n**Tags:**Test Accounts, Corporate, Administration", "auth": null, "body": null } }, { "name": "Check If Test Account Email Exists", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/TestAccounts/email-exists/:email", "host": [ "{{baseUrl}}" ], "path": [ "v2", "TestAccounts", "email-exists", ":email" ], "query": null, "variable": [ { "key": "email", "value": "\u003Cemail\u003E", "type": "string" } ] }, "description": "Checks whether a test account with the specified email address exists across all companies.\n\n**Usage Notes:**\n\n- Queries all test accounts across all companies.\n- Useful for validation before creating new test accounts to prevent duplicates.\n- Returns\u0060false\u0060if no matching test account is found.\n\n\n**Tags:**Test Accounts, Validation, Administration", "auth": null, "body": null } }, { "name": "Check If User Exists", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/TestAccounts/exists/:email", "host": [ "{{baseUrl}}" ], "path": [ "v2", "TestAccounts", "exists", ":email" ], "query": null, "variable": [ { "key": "email", "value": "\u003Cemail\u003E", "type": "string" } ] }, "description": "Checks whether a test account exists for the specified email address within a company.\n\n**Usage Notes:**\n\n- Queries the AdvisorUsers table to check for an existing username match.\n- Useful for validation before creating new test accounts.\n- Returns\u0060false\u0060if no matching user is found.\n- Lightweight endpoint for existence checks only.\n\n\n**Tags:**Test Accounts, Validation, Administration", "auth": null, "body": null } }, { "name": "Update Test Account Password", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/TestAccounts/password", "host": [ "{{baseUrl}}" ], "path": [ "v2", "TestAccounts", "password" ], "query": null, "variable": null }, "description": "Updates the password for an existing test account using the provided email address.\n The password is securely stored in hashed form.\n\n**Usage Notes:**\n\n- Executes\u0060TestAccount.usp_UpdatePassword\u0060to persist the change.\n- Passwords must be pre-hashed before submission.\n- Commonly used when resetting or rotating credentials for test users.\n- Available only in non-production environments.\n\n\n**Tags:**Test Accounts, Password Management, Security", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Add Role Assignment", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/TestAccounts/roles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "TestAccounts", "roles" ], "query": null, "variable": null }, "description": "Assigns a new role to the specified test account within the given funeral home or company context.\n\n**Usage Notes:**\n\n- Uses\u0060TestAccount.usp_AddRole\u0060stored procedure to persist the assignment.\n- Allows multiple funeral home contexts per test user.\n- Audit records are generated for all role additions.\n- Applicable only in non-production environments.\n\n\n**Tags:**Test Accounts, Roles, Permissions", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } } ], "request": null }, { "name": "Tukios Integration", "description": null, "item": [ { "name": "List candidate family members for the case who can be invited to Tukios.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Tukios/:callId/Candidates", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Tukios", ":callId", "Candidates" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Sources from\u0060PersonPersonType\u0060filtered to\u0060IsRelationship\u0060entries with\n usable email addresses, deduped by person, with each candidate marked as already-invited\n when they appear on the case\u0027s active Tukios sync record.", "auth": null, "body": null } }, { "name": "Get Cached Donations", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Tukios/:callId/Donations", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Tukios", ":callId", "Donations" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Get Cached Donations", "auth": null, "body": null } }, { "name": "Refresh Donations from Tukios", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Tukios/:callId/Donations/Refresh", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Tukios", ":callId", "Donations", "Refresh" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Refresh Donations from Tukios", "auth": null, "body": null } }, { "name": "Get Sync History", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Tukios/:callId/History", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Tukios", ":callId", "History" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Get Sync History", "auth": null, "body": null } }, { "name": "Publish or Unpublish Obituary on Tukios", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Tukios/:callId/Publish", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Tukios", ":callId", "Publish" ], "query": [ { "key": "publish", "value": "\u003Cpublish\u003E", "description": "True to publish, false to unpublish.", "disabled": true } ], "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Publish or Unpublish Obituary on Tukios", "auth": null, "body": null } }, { "name": "Get Sync Status", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Tukios/:callId/Status", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Tukios", ":callId", "Status" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Get Sync Status", "auth": null, "body": null } }, { "name": "Sync Obituary to Tukios", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Tukios/:callId/Sync", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Tukios", ":callId", "Sync" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Sync Obituary to Tukios", "auth": null, "body": null } }, { "name": "Get syncable photos for the case (used to populate the Sync Photos picker dialog).", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Tukios/:callId/SyncablePhotos", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Tukios", ":callId", "SyncablePhotos" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Get syncable photos for the case (used to populate the Sync Photos picker dialog).", "auth": null, "body": null } }, { "name": "Sync Family Members to Tukios", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Tukios/:callId/SyncFamily", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Tukios", ":callId", "SyncFamily" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Sync Family Members to Tukios", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Sync Photos to Tukios", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Tukios/:callId/SyncPhotos", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Tukios", ":callId", "SyncPhotos" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Sync Photos to Tukios", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Fetch Tukios Branches for a given organization. Body-only credential transport so\n the API key doesn\u0027t show up in URLs.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Tukios/Config/Branches", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Tukios", "Config", "Branches" ], "query": null, "variable": null }, "description": "Fetch Tukios Branches for a given organization. Body-only credential transport so\n the API key doesn\u0027t show up in URLs.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Fetch Tukios Cover Photos. Body-only credential transport.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Tukios/Config/CoverPhotos", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Tukios", "Config", "CoverPhotos" ], "query": null, "variable": null }, "description": "Fetch Tukios Cover Photos. Body-only credential transport.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Fetch Tukios Emblems. Body-only credential transport.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Tukios/Config/Emblems", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Tukios", "Config", "Emblems" ], "query": null, "variable": null }, "description": "Fetch Tukios Emblems. Body-only credential transport.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Test Tukios Connection. The Tukios API key travels in the request body so it isn\u0027t\n captured in URL-keyed log pipelines (reverse-proxy access logs, App Insights URL trace,\n browser history, shared URLs).", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Tukios/Config/Test", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Tukios", "Config", "Test" ], "query": null, "variable": null }, "description": "Test Tukios Connection. The Tukios API key travels in the request body so it isn\u0027t\n captured in URL-keyed log pipelines (reverse-proxy access logs, App Insights URL trace,\n browser history, shared URLs).", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } } ], "request": null }, { "name": "Users", "description": null, "item": [ { "name": "Post User", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/User", "host": [ "{{baseUrl}}" ], "path": [ "v2", "User" ], "query": null, "variable": null }, "description": "This method creates a new user with the provided details and handles associated records in multiple databases.\n It performs comprehensive validation, including checking for existing usernames and emails, and rolls back any changes if an error occurs.\n Sample patch document for HttpPatch methods is not applicable here.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get User", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/User/:advisorUserId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "User", ":advisorUserId" ], "query": null, "variable": [ { "key": "advisorUserId", "value": "\u003CadvisorUserId\u003E", "type": "string" } ] }, "description": "This method retrieves detailed information about a specific user, including associated advisor user data and optional corporate status.\n It performs permission checks to ensure the requesting user has the right to view the requested user details.\n Sample patch document for HttpPatch methods is not applicable here.", "auth": null, "body": null } }, { "name": "Update User", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/User/:advisorUserId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "User", ":advisorUserId" ], "query": null, "variable": [ { "key": "advisorUserId", "value": "\u003CadvisorUserId\u003E", "type": "string" } ] }, "description": "Updates the details of a user including username, email, and roles. If the username or email is being changed, it checks for uniqueness.\n If the password is provided, it validates and updates the password for the user. This method also handles changes to user roles and company assignments.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get User Funeral Homes", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/User/:advisorUserId/FuneralHomes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "User", ":advisorUserId", "FuneralHomes" ], "query": null, "variable": [ { "key": "advisorUserId", "value": "\u003CadvisorUserId\u003E", "type": "string" } ] }, "description": "Retrieves a list of funeral homes associated with the user. This includes roles the user has within each funeral home.", "auth": null, "body": null } }, { "name": "Check if User Has Security Roles", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/User/:advisorUserId/HasSecurityRoles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "User", ":advisorUserId", "HasSecurityRoles" ], "query": null, "variable": [ { "key": "advisorUserId", "value": "\u003CadvisorUserId\u003E", "type": "string" } ] }, "description": "This method checks if a user has any security roles assigned. Used to validate that new users have required security roles.", "auth": null, "body": null } }, { "name": "Get Image", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/User/:advisorUserId/Image", "host": [ "{{baseUrl}}" ], "path": [ "v2", "User", ":advisorUserId", "Image" ], "query": null, "variable": [ { "key": "advisorUserId", "value": "\u003CadvisorUserId\u003E", "type": "string" } ] }, "description": "Retrieves the profile image for a user. Checks if the user exists and has the necessary permissions before fetching the image. Returns a 404 if no image is found.", "auth": null, "body": null } }, { "name": "Post Image", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/User/:advisorUserId/Image", "host": [ "{{baseUrl}}" ], "path": [ "v2", "User", ":advisorUserId", "Image" ], "query": null, "variable": [ { "key": "advisorUserId", "value": "\u003CadvisorUserId\u003E", "type": "string" } ] }, "description": "Updates the profile image for a user. Validates the file size and type before updating the user\u0027s profile image in the database.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Image", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/User/:advisorUserId/Image", "host": [ "{{baseUrl}}" ], "path": [ "v2", "User", ":advisorUserId", "Image" ], "query": null, "variable": [ { "key": "advisorUserId", "value": "\u003CadvisorUserId\u003E", "type": "string" } ] }, "description": "Deletes the profile image for a user. Ensures that the user exists and has the necessary permissions before performing the deletion.", "auth": null, "body": null } }, { "name": "Post Person Type", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/User/:advisorUserId/PersonType/:personTypeId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "User", ":advisorUserId", "PersonType", ":personTypeId" ], "query": null, "variable": [ { "key": "advisorUserId", "value": "\u003CadvisorUserId\u003E", "type": "string" }, { "key": "personTypeId", "value": "\u003CpersonTypeId\u003E", "type": "string" } ] }, "description": "Adds a person type to a user\u0027s list of person types. Ensures that the user exists and has the required permissions before performing the update.", "auth": null, "body": null } }, { "name": "Delete Person Type", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/User/:advisorUserId/PersonType/:personTypeId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "User", ":advisorUserId", "PersonType", ":personTypeId" ], "query": null, "variable": [ { "key": "advisorUserId", "value": "\u003CadvisorUserId\u003E", "type": "string" }, { "key": "personTypeId", "value": "\u003CpersonTypeId\u003E", "type": "string" } ] }, "description": "Removes a specific person type from a user\u0027s list of person types. The method verifies user existence and permissions before executing the deletion.", "auth": null, "body": null } }, { "name": "Get Person Types", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/User/:advisorUserId/PersonTypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "User", ":advisorUserId", "PersonTypes" ], "query": null, "variable": [ { "key": "advisorUserId", "value": "\u003CadvisorUserId\u003E", "type": "string" } ] }, "description": "Retrieves a list of person types for a user. This method checks if the user exists and has the necessary permissions before fetching the data.", "auth": null, "body": null } }, { "name": "Toggle User Status", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/User/:advisorUserId/toggle-status", "host": [ "{{baseUrl}}" ], "path": [ "v2", "User", ":advisorUserId", "toggle-status" ], "query": null, "variable": [ { "key": "advisorUserId", "value": "\u003CadvisorUserId\u003E", "type": "string" } ] }, "description": "Enables or disables a user account by toggling both the Advisor Master record and the linked client person entry.\n Requires ManageUsers unless the caller is modifying their own account.\n\n**Usage Notes:**\n\n- If the target user equals the caller, the request is allowed without extra permissions.\n- Updates the linked\u0060Person\u0060record\u2019s\u0060Active\u0060flag to stay in sync with the disabled state.\n- Persists changes in the client, master, and global databases.\n\n\n**Tags:**User Management, Administration", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update User Role", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/User/:advisorUserId/update-role", "host": [ "{{baseUrl}}" ], "path": [ "v2", "User", ":advisorUserId", "update-role" ], "query": null, "variable": [ { "key": "advisorUserId", "value": "\u003CadvisorUserId\u003E", "type": "string" } ] }, "description": "Internal endpoint that updates an advisor user\u2019s role identifier after enforcing appropriate permissions.\n\n**Usage Notes:**\n\n- Restricted via\u0060[CorporateMethod]\u0060to corporate managers and system administrators.\n- Requires\u0060ManageUsers\u0060unless the caller is updating themselves.\n- Corporate managers cannot assign administrative roles (Zeus, AuroraAdmin, etc.).\n- Corporate managers can only manage users in companies they have access to.\n\n\n**Tags:**User Management, Administration", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Post Last Login Date", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/User/LastLoginDate", "host": [ "{{baseUrl}}" ], "path": [ "v2", "User", "LastLoginDate" ], "query": null, "variable": null }, "description": "This method updates the last login date for the currently authenticated user.\n Sample patch document for HttpPatch methods is not applicable here.", "auth": null, "body": null } }, { "name": "Get Current User Info", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/User/Me", "host": [ "{{baseUrl}}" ], "path": [ "v2", "User", "Me" ], "query": null, "variable": null }, "description": "Returns lightweight, user-scoped flags loaded once during Blazor app bootstrap so feature gates\n (cart, order history, distributor-only views) can read them synchronously from UserState.\n Does not include permissions or roles \u2014 those flow through claims and PermissionService.", "auth": null, "body": null } }, { "name": "Get Notification Preferences for Current User", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/User/NotificationPreferences", "host": [ "{{baseUrl}}" ], "path": [ "v2", "User", "NotificationPreferences" ], "query": null, "variable": null }, "description": "Retrieves the current user\u0027s notification preferences for web/browser notifications.\n If no preferences exist, returns default preferences (General and Marketing enabled).", "auth": null, "body": null } }, { "name": "Update Notification Preferences for Current User", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/User/NotificationPreferences", "host": [ "{{baseUrl}}" ], "path": [ "v2", "User", "NotificationPreferences" ], "query": null, "variable": null }, "description": "Updates the current user\u0027s notification preferences for web/browser notifications.\n Creates new preference records if they don\u0027t exist, or updates existing ones.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Person Types for multiple users in a single request.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/User/PersonTypes/Batch", "host": [ "{{baseUrl}}" ], "path": [ "v2", "User", "PersonTypes", "Batch" ], "query": null, "variable": null }, "description": "Get Person Types for multiple users in a single request.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update User", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/User/UAM/:advisorUserId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "User", "UAM", ":advisorUserId" ], "query": null, "variable": [ { "key": "advisorUserId", "value": "\u003CadvisorUserId\u003E", "type": "string" } ] }, "description": "Updates the details of a user including username, email, and roles. If the username or email is being changed, it checks for uniqueness.\n If the password is provided, it validates and updates the password for the user. This method also handles changes to user roles and company assignments.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Users", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Users", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Users" ], "query": [ { "key": "includeSecurityRoles", "value": "\u003CincludeSecurityRoles\u003E", "description": "Indicates whether to include security roles in the response.", "disabled": true } ], "variable": null }, "description": "This method retrieves a list of users for a specified company. The result may include security roles based on the \u0060includeSecurityRoles\u0060 parameter.\n Sample patch document for HttpPatch methods is not applicable here.", "auth": null, "body": null } }, { "name": "Get All Users", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Users/All", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Users", "All" ], "query": [ { "key": "includeSecurityRoles", "value": "\u003CincludeSecurityRoles\u003E", "description": "Indicates whether to include security roles in the response.", "disabled": true } ], "variable": null }, "description": "This method retrieves a list of all users. The result may include security roles based on the \u0060includeSecurityRoles\u0060 parameter.\n If the requesting user has special roles like Zeus or AuroraAdmin, they will see all users; otherwise, the users are filtered by company.\n Sample patch document for HttpPatch methods is not applicable here.", "auth": null, "body": null } }, { "name": "Get Users for Corporation", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Users/Corporation", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Users", "Corporation" ], "query": [ { "key": "includeSecurityRoles", "value": "\u003CincludeSecurityRoles\u003E", "description": "Indicates whether to include security roles in the response.", "disabled": true } ], "variable": null }, "description": "This method retrieves a list of users associated with the corporation based on the permissions of the requesting user.\n The result may include security roles depending on the \u0060includeSecurityRoles\u0060 parameter.\n Sample patch document for HttpPatch methods is not applicable here.", "auth": null, "body": null } } ], "request": null }, { "name": "Users: Edition Permissions", "description": null, "item": [ { "name": "Get all edition-permission mappings (Zeus only)", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/EditionPermissions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "EditionPermissions" ], "query": null, "variable": null }, "description": "Get all edition-permission mappings (Zeus only)", "auth": null, "body": null } }, { "name": "Batch update edition-permission mappings (Zeus only)", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/EditionPermissions/Batch", "host": [ "{{baseUrl}}" ], "path": [ "v2", "EditionPermissions", "Batch" ], "query": null, "variable": null }, "description": "Batch update edition-permission mappings (Zeus only)", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } } ], "request": null }, { "name": "Users: Permissions", "description": null, "item": [ { "name": "Get Permissions", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Permissions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Permissions" ], "query": [ { "key": "editionId", "value": "\u003CeditionId\u003E", "description": "Optional edition ID to filter permissions by. Permissions with no edition assignments pass through (fail-open).", "disabled": true } ], "variable": null }, "description": "Retrieves a list of permissions, sets \u0060IsInternalOnly\u0060 for application permissions based on certain criteria,\n and returns the permissions sorted by group, type, and display name.\n When editionId is provided, permissions that have edition assignments but NOT for the given editionId are excluded.\n Permissions with no edition assignments are always included (fail-open).", "auth": null, "body": null } }, { "name": "Post Permission", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/User/:advisorUserId/Permission/:permissionId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "User", ":advisorUserId", "Permission", ":permissionId" ], "query": null, "variable": [ { "key": "advisorUserId", "value": "\u003CadvisorUserId\u003E", "type": "string" }, { "key": "permissionId", "value": "\u003CpermissionId\u003E", "type": "string" } ] }, "description": "Adds a new permission to a user\u0027s list of permissions. Validates user permissions and ensures that the specified permission is manageable before adding it.", "auth": null, "body": null } }, { "name": "Delete Permission", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/User/:advisorUserId/Permission/:permissionId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "User", ":advisorUserId", "Permission", ":permissionId" ], "query": null, "variable": [ { "key": "advisorUserId", "value": "\u003CadvisorUserId\u003E", "type": "string" }, { "key": "permissionId", "value": "\u003CpermissionId\u003E", "type": "string" } ] }, "description": "Deletes a specific permission from a user\u0027s list of permissions. The method checks if the permission exists and the user has the necessary permissions to perform the deletion.", "auth": null, "body": null } }, { "name": "Get Permissions", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/User/:advisorUserId/Permissions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "User", ":advisorUserId", "Permissions" ], "query": null, "variable": [ { "key": "advisorUserId", "value": "\u003CadvisorUserId\u003E", "type": "string" } ] }, "description": "Retrieves all permissions assigned to a user, including those tied to their roles and security roles. Checks user permissions and company associations before fetching data.", "auth": null, "body": null } }, { "name": "Get Effective Permissions", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/User/:advisorUserId/Permissions/Effective", "host": [ "{{baseUrl}}" ], "path": [ "v2", "User", ":advisorUserId", "Permissions", "Effective" ], "query": null, "variable": [ { "key": "advisorUserId", "value": "\u003CadvisorUserId\u003E", "type": "string" } ] }, "description": "Retrieves a list of effective permissions for a user, considering their roles and security roles. This method provides the permissions currently applied to the user, factoring in role-based and security role-based permissions.", "auth": null, "body": null } }, { "name": "Get User Roles", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/User/:advisorUserId/Roles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "User", ":advisorUserId", "Roles" ], "query": null, "variable": [ { "key": "advisorUserId", "value": "\u003CadvisorUserId\u003E", "type": "string" } ] }, "description": "Retrieves the roles assigned to the user. The roles include permissions and are ordered by name.", "auth": null, "body": null } }, { "name": "Assign Security Role to User", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/User/:advisorUserId/SecurityRole/:securityRoleId/FuneralHome/:funeralHomeId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "User", ":advisorUserId", "SecurityRole", ":securityRoleId", "FuneralHome", ":funeralHomeId" ], "query": null, "variable": [ { "key": "advisorUserId", "value": "\u003CadvisorUserId\u003E", "type": "string" }, { "key": "securityRoleId", "value": "\u003CsecurityRoleId\u003E", "type": "string" }, { "key": "funeralHomeId", "value": "\u003CfuneralHomeId\u003E", "type": "string" } ] }, "description": "Assigns a security role to a user for a specific funeral home. This method ensures the user has the appropriate permissions and that the role assignment is valid.", "auth": null, "body": null } }, { "name": "Delete Funeral Home Security Role", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/User/:advisorUserId/SecurityRole/:securityRoleId/FuneralHome/:funeralHomeId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "User", ":advisorUserId", "SecurityRole", ":securityRoleId", "FuneralHome", ":funeralHomeId" ], "query": null, "variable": [ { "key": "advisorUserId", "value": "\u003CadvisorUserId\u003E", "type": "string" }, { "key": "securityRoleId", "value": "\u003CsecurityRoleId\u003E", "type": "string" }, { "key": "funeralHomeId", "value": "\u003CfuneralHomeId\u003E", "type": "string" } ] }, "description": "Deletes a specific security role assigned to a user for a particular funeral home. The method first checks if the user exists and has the required permissions.\n If the role is found, it is removed from the database.", "auth": null, "body": null } }, { "name": "Get User Security Roles", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/User/:advisorUserId/SecurityRoles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "User", ":advisorUserId", "SecurityRoles" ], "query": null, "variable": [ { "key": "advisorUserId", "value": "\u003CadvisorUserId\u003E", "type": "string" } ] }, "description": "Retrieves the security roles assigned to the user for each funeral home. Security roles are specific to the user\uFFFDs permissions within the funeral home.", "auth": null, "body": null } } ], "request": null }, { "name": "UserSession", "description": null, "item": [ { "name": "Zeus-only: returns every active session in the system.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/UserSession", "host": [ "{{baseUrl}}" ], "path": [ "v2", "UserSession" ], "query": null, "variable": null }, "description": "Zeus-only: returns every active session in the system.", "auth": null, "body": null } }, { "name": "Soft-kill a session. The caller may always kill their own sessions; killing\n someone else\u0027s session requires the Zeus role.", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/UserSession/:sessionId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "UserSession", ":sessionId" ], "query": null, "variable": [ { "key": "sessionId", "value": "\u003CsessionId\u003E", "type": "string" } ] }, "description": "Soft-kill a session. The caller may always kill their own sessions; killing\n someone else\u0027s session requires the Zeus role.", "auth": null, "body": null } }, { "name": "Returns the current caller\u0027s active sessions.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/UserSession/Mine", "host": [ "{{baseUrl}}" ], "path": [ "v2", "UserSession", "Mine" ], "query": null, "variable": null }, "description": "Returns the current caller\u0027s active sessions.", "auth": null, "body": null } } ], "request": null }, { "name": "Webhooks", "description": null, "item": [ { "name": "Get Webhook Subscriptions", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Webhooks", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Webhooks" ], "query": null, "variable": null }, "description": "Retrieves all webhook subscriptions configured for the specified company.\n Each subscription defines an endpoint that receives event notifications when specific actions occur in the system.\n\n**Usage Notes:**\n\n- Returns all webhook subscriptions regardless of active status.\n- Each subscription includes endpoint URL, event types, and authentication settings.\n- Used to manage and monitor webhook integrations in the system.\n- Supports filtering by company to ensure proper data isolation.\n\n\n**Tags:**Webhooks, Integration, Events", "auth": null, "body": null } }, { "name": "Create Webhook Subscription", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Webhooks", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Webhooks" ], "query": null, "variable": null }, "description": "Creates a new webhook subscription for the specified company.\n The subscription will receive event notifications at the configured endpoint URL when subscribed events occur.\n\n**Usage Notes:**\n\n- Webhook name and endpoint URL are required fields.\n- The endpoint URL must be a valid HTTPS URL for security.\n- Subscription is created with the current user as the creator.\n- Used to integrate external systems with Solution Center events.\n\n\n**Tags:**Webhooks, Integration, Configuration", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Webhook Subscription", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Webhooks/:webhookSubscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Webhooks", ":webhookSubscriptionId" ], "query": null, "variable": [ { "key": "webhookSubscriptionId", "value": "\u003CwebhookSubscriptionId\u003E", "type": "string" } ] }, "description": "Retrieves detailed information about a specific webhook subscription by its unique identifier.\n Includes configuration details such as endpoint URL, subscribed events, and security settings.\n\n**Usage Notes:**\n\n- Returns full subscription details including event subscriptions and authentication configuration.\n- Used for viewing and editing webhook subscription settings.\n- Subscription ID must be a valid GUID format.\n- Supports audit and troubleshooting of webhook configurations.\n\n\n**Tags:**Webhooks, Integration, Configuration", "auth": null, "body": null } }, { "name": "Update Webhook Subscription", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Webhooks/:webhookSubscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Webhooks", ":webhookSubscriptionId" ], "query": null, "variable": [ { "key": "webhookSubscriptionId", "value": "\u003CwebhookSubscriptionId\u003E", "type": "string" } ] }, "description": "Updates an existing webhook subscription with new configuration settings.\n Allows modification of endpoint URL, subscribed events, and other subscription properties.\n\n**Usage Notes:**\n\n- The subscription ID in the URL must match the ID in the request body.\n- Tracks the user who performed the update in the modification metadata.\n- Changes take effect immediately for future webhook deliveries.\n- Used to adjust webhook configurations without recreating subscriptions.\n\n\n**Tags:**Webhooks, Integration, Configuration", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Webhook Subscription", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Webhooks/:webhookSubscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Webhooks", ":webhookSubscriptionId" ], "query": null, "variable": [ { "key": "webhookSubscriptionId", "value": "\u003CwebhookSubscriptionId\u003E", "type": "string" } ] }, "description": "Permanently deletes a webhook subscription from the system.\n The subscription will no longer receive event notifications.\n\n**Usage Notes:**\n\n- Deletion is permanent and cannot be undone.\n- All associated delivery history may be retained for audit purposes.\n- Subscription will stop receiving events immediately upon deletion.\n- Used to remove outdated or unused webhook integrations.\n\n\n**Tags:**Webhooks, Integration, Configuration", "auth": null, "body": null } }, { "name": "Send Test Webhook", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Webhooks/:webhookSubscriptionId/Test", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Webhooks", ":webhookSubscriptionId", "Test" ], "query": null, "variable": [ { "key": "webhookSubscriptionId", "value": "\u003CwebhookSubscriptionId\u003E", "type": "string" } ] }, "description": "Sends a test webhook event to the subscription\u0027s endpoint URL to verify the configuration is working correctly.\n The test event includes sample data and allows verification of endpoint accessibility and authentication.\n\n**Usage Notes:**\n\n- Sends a test event named \u0022Webhook.Test\u0022 with sample payload data.\n- Logs the test delivery for verification and troubleshooting.\n- Used to validate webhook endpoint configuration before going live.\n- Test payloads are delivered asynchronously by the webhook delivery service.\n\n\n**Tags:**Webhooks, Testing, Integration", "auth": null, "body": null } }, { "name": "Update Webhook Event Definition", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Webhooks/EventDefinitions/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Webhooks", "EventDefinitions", ":id" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "Updates an existing webhook event definition with new configuration or metadata.\n Allows modification of event properties such as active status, description, and implementation details.\n\n**Usage Notes:**\n\n- Requires webhook management permissions to modify event definitions.\n- Changes affect all subscriptions using this event type.\n- Tracks the user who performed the update for audit purposes.\n- Used to maintain and configure available webhook events in the system.\n\n\n**Tags:**Webhooks, Events, Configuration", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Webhook Event Definitions", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Webhooks/Events", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Webhooks", "Events" ], "query": [ { "key": "onlyActive", "value": "\u003ConlyActive\u003E", "description": "Optional filter to return only active event definitions. Defaults to \u0060true\u0060.", "disabled": true }, { "key": "onlyImplemented", "value": "\u003ConlyImplemented\u003E", "description": "Optional filter to return only implemented event definitions. If \u0060null\u0060, returns all events regardless of implementation status.", "disabled": true } ], "variable": null }, "description": "Retrieves all available webhook event definitions in the system.\n Event definitions describe the types of events that webhooks can subscribe to, including payload structure and metadata.\n\n**Usage Notes:**\n\n- Returns event definitions with names, descriptions, and payload examples.\n- Used to discover available events when configuring webhook subscriptions.\n- Supports filtering by active and implementation status for relevant events.\n- Event definitions include sample payloads for integration development.\n\n\n**Tags:**Webhooks, Events, Integration", "auth": null, "body": null } }, { "name": "Get Webhook Delivery History", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Webhooks/Subscriptions/:subscriptionId/History", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Webhooks", "Subscriptions", ":subscriptionId", "History" ], "query": null, "variable": [ { "key": "subscriptionId", "value": "\u003CsubscriptionId\u003E", "type": "string" } ] }, "description": "Retrieves the delivery history for a specific webhook subscription, including success/failure status,\n timestamps, retry attempts, and response details for each webhook delivery.\n\n**Usage Notes:**\n\n- Returns detailed delivery logs including timestamps, status codes, and error messages.\n- Used for monitoring webhook delivery success rates and troubleshooting failures.\n- Includes retry attempt information for failed deliveries.\n- Supports audit and compliance tracking of webhook event notifications.\n\n\n**Tags:**Webhooks, Audit, Monitoring", "auth": null, "body": null } }, { "name": "Send Test Webhook Event", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Webhooks/Test/:subscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Webhooks", "Test", ":subscriptionId" ], "query": null, "variable": [ { "key": "subscriptionId", "value": "\u003CsubscriptionId\u003E", "type": "string" } ] }, "description": "Sends a test webhook event to a specific subscription\u0027s endpoint to verify connectivity and configuration.\n Returns detailed delivery results including HTTP status codes and response information.\n\n**Usage Notes:**\n\n- Sends a \u0022Webhook.Test\u0022 event with sample payload data.\n- Returns detailed delivery information including status codes and timing.\n- Used to verify webhook endpoint is reachable and configured correctly.\n- Test delivery happens synchronously for immediate feedback.\n\n\n**Tags:**Webhooks, Testing, Integration", "auth": null, "body": null } }, { "name": "Send Custom Test Webhook", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Webhooks/TestCustom", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Webhooks", "TestCustom" ], "query": null, "variable": null }, "description": "Sends a custom test webhook to a specified URL with a selected event type and payload.\n Allows testing webhook delivery to any endpoint without creating a subscription.\n\n**Usage Notes:**\n\n- Allows testing webhooks without creating a formal subscription.\n- Uses the event definition\u0027s payload example for the test.\n- Supports custom target URLs for development and testing environments.\n- Returns detailed delivery information for troubleshooting.\n\n\n**Tags:**Webhooks, Testing, Integration", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } } ], "request": null }, { "name": "Whiteboard", "description": null, "item": [ { "name": "Get Whiteboard", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Whiteboard", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Whiteboard" ], "query": [ { "key": "startDate", "value": "\u003CstartDate\u003E", "description": "The start date for filtering data.", "disabled": true }, { "key": "endDate", "value": "\u003CendDate\u003E", "description": "The end date for filtering data.", "disabled": true } ], "variable": null }, "description": "Retrieves whiteboard data including calls, events, and tasks within a specified date range.\n Each call includes associated events and tasks, and profile pictures are included if available.", "auth": null, "body": null } }, { "name": "Get Resource Whiteboard", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Whiteboard/Resources", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Whiteboard", "Resources" ], "query": [ { "key": "startDate", "value": "\u003CstartDate\u003E", "description": "The start date for filtering data.", "disabled": true }, { "key": "endDate", "value": "\u003CendDate\u003E", "description": "The end date for filtering data.", "disabled": true } ], "variable": null }, "description": "Retrieves resource whiteboard data including resources associated with events and tasks within a specified date range.\n Each resource includes associated events and tasks.", "auth": null, "body": null } } ], "request": null }, { "name": "Workflow", "description": null, "item": [ { "name": "Get all workflow instances for a case (active, completed, and cancelled).", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/case/:caseId/all", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "case", ":caseId", "all" ], "query": null, "variable": [ { "key": "caseId", "value": "\u003CcaseId\u003E", "type": "string" } ] }, "description": "Returns all workflow instances associated with a case, including their status and progress.\n Useful for cases that may have multiple workflows or to view cancelled/completed workflow history.", "auth": null, "body": null } }, { "name": "Cancel an active workflow for a case.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/case/:caseId/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "case", ":caseId", "cancel" ], "query": null, "variable": [ { "key": "caseId", "value": "\u003CcaseId\u003E", "type": "string" } ] }, "description": "Sets the workflow status to Cancelled, clears the case step, and logs the cancellation reason.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get the current workflow status for a case.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/case/:caseId/current", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "case", ":caseId", "current" ], "query": null, "variable": [ { "key": "caseId", "value": "\u003CcaseId\u003E", "type": "string" } ] }, "description": "Returns rich status information including current step, available transitions, and workflow progress.", "auth": null, "body": null } }, { "name": "Get the workflow history/audit trail for a case.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/case/:caseId/history", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "case", ":caseId", "history" ], "query": null, "variable": [ { "key": "caseId", "value": "\u003CcaseId\u003E", "type": "string" } ] }, "description": "Returns all workflow log entries showing step transitions, actions executed, and status changes.", "auth": null, "body": null } }, { "name": "Move a case to the next workflow step via a transition.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/case/:caseId/move", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "case", ":caseId", "move" ], "query": null, "variable": [ { "key": "caseId", "value": "\u003CcaseId\u003E", "type": "string" } ] }, "description": "Validates the transition, executes exit/entry actions, and updates the case step.\n The transition condition must be satisfied.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Restart an active workflow for a case.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/case/:caseId/restart", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "case", ":caseId", "restart" ], "query": null, "variable": [ { "key": "caseId", "value": "\u003CcaseId\u003E", "type": "string" } ] }, "description": "Resets the workflow instance back to the first step while maintaining the same instance.\n This is useful when you need to restart a workflow from the beginning.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Start a new workflow instance for a case.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/case/:caseId/start", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "case", ":caseId", "start" ], "query": null, "variable": [ { "key": "caseId", "value": "\u003CcaseId\u003E", "type": "string" } ] }, "description": "Creates a WorkflowInstance, sets the case to the first step, and queues entry actions.\n The case must not already have an active workflow.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/definition/:id/validate", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "definition", ":id", "validate" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": null } }, { "name": "Get workflow history/audit trail for a specific workflow instance.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/instance/:instanceId/history", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "instance", ":instanceId", "history" ], "query": null, "variable": [ { "key": "instanceId", "value": "\u003CinstanceId\u003E", "type": "string" } ] }, "description": "Returns all log entries (transitions, actions, status changes) for the specified workflow instance.", "auth": null, "body": null } }, { "name": "Move a workflow instance to a specific step (manual override).", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/instance/:workflowInstanceId/move-to-step/:stepId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "instance", ":workflowInstanceId", "move-to-step", ":stepId" ], "query": null, "variable": [ { "key": "workflowInstanceId", "value": "\u003CworkflowInstanceId\u003E", "type": "string" }, { "key": "stepId", "value": "\u003CstepId\u003E", "type": "string" } ] }, "description": "Allows administrators to manually override the current step of a workflow instance.\n This is useful for correcting workflow state or skipping problematic steps.\n The step must belong to the same workflow definition.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Pause an active workflow instance.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/instance/:workflowInstanceId/pause", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "instance", ":workflowInstanceId", "pause" ], "query": null, "variable": [ { "key": "workflowInstanceId", "value": "\u003CworkflowInstanceId\u003E", "type": "string" } ] }, "description": "Pauses an active workflow instance, preventing any further actions from executing\n until the workflow is resumed. Useful for temporarily halting workflow processing.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Resume a paused or cancelled workflow instance.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/instance/:workflowInstanceId/resume", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "instance", ":workflowInstanceId", "resume" ], "query": null, "variable": [ { "key": "workflowInstanceId", "value": "\u003CworkflowInstanceId\u003E", "type": "string" } ] }, "description": "Reactivates a paused or cancelled workflow instance, allowing it to continue from where it was stopped.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Force retry a failed or pending workflow action.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/log/:logId/retry", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "log", ":logId", "retry" ], "query": [ { "key": "resetRetryCount", "value": "\u003CresetRetryCount\u003E", "description": "If true, resets the retry count to 0.", "disabled": true } ], "variable": [ { "key": "logId", "value": "\u003ClogId\u003E", "type": "string" } ] }, "description": "Resets the action status to Pending so the background worker will retry execution.\n Optionally resets the retry count to allow more attempts.", "auth": null, "body": null } }, { "name": "", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/transition/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "transition", ":id" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "", "auth": null, "body": null } }, { "name": "Executes a workflow transition for a specific case.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/transition/:transitionId/execute", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "transition", ":transitionId", "execute" ], "query": null, "variable": [ { "key": "transitionId", "value": "\u003CtransitionId\u003E", "type": "string" } ] }, "description": "Manually triggers a transition to move a case from its current step to the next step.\n The transition condition will be evaluated, and the transition will only execute if the condition is met.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } } ], "request": null }, { "name": "Workflow: Actions", "description": null, "item": [ { "name": "Retrieves details for a specific workflow action.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/action/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "action", ":id" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "Returns the configuration and metadata of a single workflow action, including\n its parent step and workflow definition. Requires permission.\n\n**Usage Notes:**\n - Validates ownership by checking linked step and definition.\n - Useful for detailed action inspection or editing.", "auth": null, "body": null } }, { "name": "Updates an existing workflow action.", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/action/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "action", ":id" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "Modifies the configuration or metadata of a workflow action.\n Requires permission.\n\n**Usage Notes:**\n - Updates \u0060LastModified\u0060 to \u0060UtcNow\u0060.\n - Returns \u0060404\u0060 if not found or mismatched ownership context.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Deletes a specific workflow action.", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/action/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "action", ":id" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "Deletes a specific workflow action.", "auth": null, "body": null } }, { "name": "Retrieves all available workflow action types.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/actiontypes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "actiontypes" ], "query": null, "variable": null }, "description": "Returns a list of action type definitions that can be assigned to workflow steps.\n These represent reusable behaviors or operations (e.g., send email, assign user, update status).\n\n**Usage Notes:**\n - Does not require a company context since action types are global.\n - Used for populating dropdowns or selectors in workflow builders.", "auth": null, "body": null } }, { "name": "Retrieves all workflow actions belonging to a specific workflow definition.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/definition/:WorkflowDefinitionId/actions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "definition", ":WorkflowDefinitionId", "actions" ], "query": null, "variable": [ { "key": "WorkflowDefinitionId", "value": "\u003CWorkflowDefinitionId\u003E", "type": "string" } ] }, "description": "Returns a list of actions across all steps within a given workflow definition.\n Useful for workflow-wide configuration or debugging.\n\n**Usage Notes:**\n - Performs ownership validation for all steps under the definition.\n - Returns empty list if no actions exist.", "auth": null, "body": null } }, { "name": "Creates a new workflow action under a specific step.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/step/:stepId/action", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "step", ":stepId", "action" ], "query": null, "variable": [ { "key": "stepId", "value": "\u003CstepId\u003E", "type": "string" } ] }, "description": "Adds a new action to a workflow step. Actions define the operations performed\n when a workflow reaches or passes through a given step.\n\n**Usage Notes:**\n - Automatically assigns \u0060WorkflowActionId\u0060.\n - Sets \u0060Active = true\u0060 and \u0060DateCreated = UtcNow\u0060.\n - Returns via \u0060CreatedAtAction\u0060 referencing\u0060Int32)\u0060.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Retrieves all workflow actions for a given step.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/step/:stepId/actions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "step", ":stepId", "actions" ], "query": null, "variable": [ { "key": "stepId", "value": "\u003CstepId\u003E", "type": "string" } ] }, "description": "Returns a list of actions associated with the specified workflow step.\n Each action defines a specific behavior that occurs during workflow execution.\n Requires permission.\n\n**Usage Notes:**\n - Includes ownership validation for the step and company.\n - Returns active and inactive actions.", "auth": null, "body": null } } ], "request": null }, { "name": "Workflow: Case Steps", "description": null, "item": [ { "name": "Updates a case to a specific workflow step.", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/CaseStep/:callId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "CaseStep", ":callId" ], "query": [ { "key": "workflowStepId", "value": "\u003CworkflowStepId\u003E", "description": "The ID of the workflow step to assign.", "disabled": true } ], "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Assigns a workflow step to a case, tracking the case\u0027s current position in an active workflow.\n The workflow step must exist and be active in the AdvisorMaster database.\n\n**Usage Notes:**\n - Validates that the workflow step exists and is active before assignment.\n - Updates the Call.CaseStepId field in the client database.\n - Requires\u0060ManageWorkflow\u0060permission.", "auth": null, "body": null } }, { "name": "Retrieves the current case step details for a case.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/CaseStep/:callId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "CaseStep", ":callId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Returns information about a case\u0027s current position in a workflow, including\n the step name, workflow name, display order, and whether the step is terminal.\n\n**Usage Notes:**\n - Returns null (204 No Content) if the case is not assigned to a workflow.\n - Requires\u0060ViewWorkflow\u0060permission.\n - Includes workflow definition details for context.", "auth": null, "body": null } }, { "name": "Removes a case from its workflow (clears the case step).", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/CaseStep/:callId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "CaseStep", ":callId" ], "query": null, "variable": [ { "key": "callId", "value": "\u003CcallId\u003E", "type": "string" } ] }, "description": "Clears the workflow step assignment for a case, effectively removing it from\n the active workflow. The case itself remains in the system.\n\n**Usage Notes:**\n - Sets Call.CaseStepId to null in the client database.\n - Does not fail if the case is not found; logs a warning instead.\n - Requires\u0060ManageWorkflow\u0060permission.", "auth": null, "body": null } }, { "name": "Retrieves all cases currently at a specific workflow step.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/CaseStep/step/:workflowStepId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "CaseStep", "step", ":workflowStepId" ], "query": null, "variable": [ { "key": "workflowStepId", "value": "\u003CworkflowStepId\u003E", "type": "string" } ] }, "description": "Returns a list of case IDs for all cases currently assigned to the specified\n workflow step. Useful for reporting and workflow management.\n\n**Usage Notes:**\n - Returns an empty list if no cases are at the specified step.\n - Requires\u0060ViewWorkflow\u0060permission.\n - Does not validate if the workflow step exists; returns empty list for invalid steps.", "auth": null, "body": null } }, { "name": "Gets the current workflow step status for all cases in the company.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/case-steps", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "case-steps" ], "query": null, "variable": null }, "description": "This lightweight endpoint returns the current workflow step name and status for all\n cases that have workflow instances. Used by the Advisor Overview to display case\n workflow progress without requiring full workflow view permissions.\n\n**Usage Notes:**\n - This endpoint does NOT require ViewWorkflow permission.\n - Returns only CallId, CurrentStepName, and Status - no sensitive workflow details.", "auth": null, "body": null } }, { "name": "Checks if the company has any active workflow definitions.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/case-steps/has-active", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "case-steps", "has-active" ], "query": null, "variable": null }, "description": "This lightweight endpoint allows any authenticated user to check if their company has\n active workflows configured. Used by the Advisor Overview to determine whether to\n display the workflow step column.\n\n**Usage Notes:**\n - This endpoint does NOT require ViewWorkflow permission.\n - Returns only a boolean, no workflow configuration details are exposed.", "auth": null, "body": null } } ], "request": null }, { "name": "Workflow: Definitions", "description": null, "item": [ { "name": "Creates a new workflow definition for the specified company.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/definition", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "definition" ], "query": null, "variable": null }, "description": "This endpoint allows authorized users to create a new workflow definition. The newly\n created definition will be assigned a new GUID and activated by default.\n\n**Usage Notes:**\n - Automatically assigns a new \u0060WorkflowDefinitionId\u0060.\n - Sets \u0060Active = true\u0060 and \u0060DateCreated = UtcNow\u0060.\n - Returns the created definition via \u0060CreatedAtAction\u0060.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Retrieves a single workflow definition by its unique identifier.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/definition/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "definition", ":id" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "This endpoint returns details for a specific workflow definition, including its metadata,\n type, and version. The definition must belong to the specified company.\n\n**Usage Notes:**\n - The definition is searched within the given company context.\n - Returns \u0060404 Not Found\u0060 if the workflow definition is missing or belongs to another company.", "auth": null, "body": null } }, { "name": "Updates an existing workflow definition.", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/definition/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "definition", ":id" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "Allows authorized users to update metadata and properties of an existing workflow\n definition belonging to the specified company.\n\n**Usage Notes:**\n - Updates \u0060LastModified\u0060 automatically to \u0060UtcNow\u0060.\n - If the record is not found, returns \u0060404 Not Found\u0060.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Deletes a workflow definition and all related entities.", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/definition/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "definition", ":id" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "This endpoint permanently deletes a workflow definition along with all its steps,\n actions, triggers, transitions, required fields, and role assignments.\n\n**Usage Notes:**\n - This operation permanently removes the workflow and all related data.\n - Workflows with active instances cannot be deleted.", "auth": null, "body": null } }, { "name": "Checks if a workflow definition can be deleted and returns instance counts.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/definition/:id/delete-check", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "definition", ":id", "delete-check" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "Checks if a workflow definition can be deleted and returns instance counts.", "auth": null, "body": null } }, { "name": "Retrieves all workflow definitions for the specified company.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/definitions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "definitions" ], "query": null, "variable": null }, "description": "This endpoint returns a list of workflow definitions associated with the given company.\n Each definition includes its metadata and current active status. Only users with the\n permission may access this endpoint.\n\n**Usage Notes:**\n - Requires a valid company context (\u0060companyId\u0060 header).\n - Returns inactive definitions as well; consumers can filter client-side if needed.", "auth": null, "body": null } } ], "request": null }, { "name": "Workflow: Entities", "description": null, "item": [ { "name": "Retrieves a list of attachable entities from the client database.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/AttachableEntities", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "AttachableEntities" ], "query": null, "variable": null }, "description": "This endpoint scans the current client database model to identify all attachable\n entities (tables) that can be associated with workflows or metadata.\n Returns schema and table names for each entity discovered.\n\n**Usage Notes:**\n - This endpoint is marked with\u0060InternalMethodAttribute\u0060, indicating it is restricted to internal system usage.\n - Entities are filtered to include only public, non-abstract CLR types.", "auth": null, "body": null } }, { "name": "Retrieves all entity metadata definitions from AdvisorMaster.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/EntityMetadata", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "EntityMetadata" ], "query": null, "variable": null }, "description": "Returns a collection of entity metadata records that define how entities are displayed\n and managed within the workflow system.\n This endpoint is internal and requires elevated privileges.\n\n**Usage Notes:**\n - Use this endpoint for administrative dashboards or entity manager pages.\n - Includes schema name, display name, and UI visibility flag.", "auth": null, "body": null } }, { "name": "Creates a new entity metadata record.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/EntityMetadata", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "EntityMetadata" ], "query": null, "variable": null }, "description": "Allows internal systems or administrative users to define metadata for a new entity,\n including schema, description, and UI visibility.\n\n**Usage Notes:**\n - The new record is added to \u0060AdvisorMaster.dbo.EntityMetadata\u0060.\n - Returns via \u0060CreatedAtAction\u0060 referencing\u0060Int32)\u0060.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Retrieves a single entity metadata record by its identifier.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/EntityMetadata/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "EntityMetadata", ":id" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "Returns details for a specific entity metadata entry, including schema, name,\n description, and whether it is shown in the UI.\n\n**Usage Notes:**\n - Commonly used by the Entity Manager component to display and edit metadata.", "auth": null, "body": null } }, { "name": "Updates an existing entity metadata record.", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/EntityMetadata/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "EntityMetadata", ":id" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "Allows modification of an entity metadata\uFFFDs description and UI visibility settings.\n The record is identified by its unique ID.\n\n**Usage Notes:**\n - Only \u0060Description\u0060 and \u0060ShowInUI\u0060 fields are updatable.\n - Does not modify schema or entity name to preserve data integrity.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Deletes an existing entity metadata record.", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/EntityMetadata/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "EntityMetadata", ":id" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "Permanently removes a metadata record from the AdvisorMaster database.\n Intended for internal administrative use only.\n\n**Usage Notes:**\n - This operation is permanent; use with caution.\n - Typically invoked from internal management tools.", "auth": null, "body": null } } ], "request": null }, { "name": "Workflow: Instances", "description": null, "item": [ { "name": "Get a specific workflow instance by ID.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/instance/:instanceId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "instance", ":instanceId" ], "query": null, "variable": [ { "key": "instanceId", "value": "\u003CinstanceId\u003E", "type": "string" } ] }, "description": "Returns detailed information about a specific workflow instance including current step,\n available transitions, and case information.", "auth": null, "body": null } }, { "name": "Get all workflow instances for a company with optional filters.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/instances", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "instances" ], "query": [ { "key": "status", "value": "\u003Cstatus\u003E", "description": "Optional status filter (Active, Completed, Cancelled).", "disabled": true }, { "key": "workflowDefinitionId", "value": "\u003CworkflowDefinitionId\u003E", "description": "Optional workflow definition ID filter.", "disabled": true } ], "variable": null }, "description": "Returns a list of workflow instances for the company, with optional filtering by status or workflow definition.\n Includes enriched information such as case number, current step, and available transitions.", "auth": null, "body": null } } ], "request": null }, { "name": "Workflow: Step Required Fields", "description": null, "item": [ { "name": "Updates a required field configuration.", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/requiredField/:fieldId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "requiredField", ":fieldId" ], "query": null, "variable": [ { "key": "fieldId", "value": "\u003CfieldId\u003E", "type": "string" } ] }, "description": "Updates a required field configuration.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Removes a required field configuration from a workflow step.", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/requiredField/:fieldId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "requiredField", ":fieldId" ], "query": null, "variable": [ { "key": "fieldId", "value": "\u003CfieldId\u003E", "type": "string" } ] }, "description": "Removes a required field configuration from a workflow step.", "auth": null, "body": null } }, { "name": "Adds a required field configuration to a workflow step.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/step/:stepId/requiredField", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "step", ":stepId", "requiredField" ], "query": null, "variable": [ { "key": "stepId", "value": "\u003CstepId\u003E", "type": "string" } ] }, "description": "Adds a required field configuration to a workflow step.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Retrieves all required field configurations for a workflow step.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/step/:stepId/requiredFields", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "step", ":stepId", "requiredFields" ], "query": null, "variable": [ { "key": "stepId", "value": "\u003CstepId\u003E", "type": "string" } ] }, "description": "Retrieves all required field configurations for a workflow step.", "auth": null, "body": null } } ], "request": null }, { "name": "Workflow: Step Roles", "description": null, "item": [ { "name": "Removes a role assignment from a workflow step.", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/role/:roleId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "role", ":roleId" ], "query": null, "variable": [ { "key": "roleId", "value": "\u003CroleId\u003E", "type": "string" } ] }, "description": "Removes a role assignment from a workflow step.", "auth": null, "body": null } }, { "name": "Assigns a role to a workflow step.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/step/:stepId/role", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "step", ":stepId", "role" ], "query": null, "variable": [ { "key": "stepId", "value": "\u003CstepId\u003E", "type": "string" } ] }, "description": "Assigns a role to a workflow step.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Retrieves all roles assigned to a specific workflow step.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/step/:stepId/roles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "step", ":stepId", "roles" ], "query": null, "variable": [ { "key": "stepId", "value": "\u003CstepId\u003E", "type": "string" } ] }, "description": "Retrieves all roles assigned to a specific workflow step.", "auth": null, "body": null } } ], "request": null }, { "name": "Workflow: Steps", "description": null, "item": [ { "name": "Creates a new workflow step under a specific workflow definition.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/definition/:definitionId/step", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "definition", ":definitionId", "step" ], "query": null, "variable": [ { "key": "definitionId", "value": "\u003CdefinitionId\u003E", "type": "string" } ] }, "description": "Allows an authorized user to add a new step to an existing workflow definition.\n The step is created as active and automatically assigned a display order if applicable.\n\n**Usage Notes:**\n - Sets \u0060Active = true\u0060 and \u0060DateCreated = UtcNow\u0060.\n - Automatically assigns a new \u0060WorkflowStepId\u0060.\n - Returns the created step via \u0060CreatedAtAction\u0060.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Retrieves all workflow steps belonging to a specific workflow definition.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/definition/:definitionId/steps", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "definition", ":definitionId", "steps" ], "query": null, "variable": [ { "key": "definitionId", "value": "\u003CdefinitionId\u003E", "type": "string" } ] }, "description": "Returns a list of workflow steps for a given workflow definition.\n Each step includes its display order, actions, and triggers if applicable.\n Requires the permission.\n\n**Usage Notes:**\n - Steps are ordered by \u0060DisplayOrder\u0060.\n - Returns \u0060404\u0060 if the workflow definition cannot be found under the provided \u0060companyId\u0060.", "auth": null, "body": null } }, { "name": "Retrieves a single workflow step by its ID.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/step/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "step", ":id" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "Fetches detailed information about a single workflow step, including\n its parent definition reference. Requires the permission.\n\n**Usage Notes:**\n - Includes the related workflow definition for validation.\n - Returns \u0060404\u0060 if not found or mismatched company context.", "auth": null, "body": null } }, { "name": "Updates an existing workflow step.", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/step/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "step", ":id" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "Allows authorized users to modify an existing workflow step, including its name,\n display order, and description. The step must belong to a workflow definition\n under the specified company.\n\n**Usage Notes:**\n - Updates \u0060LastModified\u0060 automatically to \u0060UtcNow\u0060.\n - Returns \u0060404\u0060 if the specified step cannot be found in the provided company context.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Deletes a workflow step permanently.", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/step/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "step", ":id" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "Removes a workflow step from its definition. This operation permanently deletes\n the record and all associated triggers and actions linked to the step.\n\n**Usage Notes:**\n - This is a hard delete operation.\n - Related triggers and actions should be cascaded by the database or EF configuration.\n - Steps with active workflow instances cannot be deleted until those instances are moved or completed.", "auth": null, "body": null } } ], "request": null }, { "name": "Workflow: Templates", "description": null, "item": [ { "name": "Retrieves a single workflow template by its unique identifier.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/template/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "template", ":id" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "This endpoint returns details for a specific workflow template, including its\n template data (JSON structure of the workflow).", "auth": null, "body": null } }, { "name": "Retrieves all workflow templates.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/templates", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "templates" ], "query": null, "variable": null }, "description": "This endpoint returns a list of all available workflow templates that users can select\n when creating new workflows. Templates provide pre-configured workflow structures.", "auth": null, "body": null } } ], "request": null }, { "name": "Workflow: Transitions", "description": null, "item": [ { "name": "Creates a new workflow transition from a specific step.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/step/:stepId/transition", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "step", ":stepId", "transition" ], "query": null, "variable": [ { "key": "stepId", "value": "\u003CstepId\u003E", "type": "string" } ] }, "description": "Defines a transition linking one step to another within a workflow.\n Transitions are activated by triggers or user actions defined elsewhere in the workflow.\n\n**Usage Notes:**\n - Automatically assigns \u0060WorkflowTransitionId\u0060 and sets \u0060Active = true\u0060.\n - Sets \u0060DateCreated\u0060 to \u0060UtcNow\u0060.\n - Returns via \u0060CreatedAtAction\u0060 referencing\u0060Int32)\u0060.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Retrieves all workflow transitions originating from a specific step.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/step/:stepId/transitions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "step", ":stepId", "transitions" ], "query": null, "variable": [ { "key": "stepId", "value": "\u003CstepId\u003E", "type": "string" } ] }, "description": "Returns a list of transitions that start from the specified workflow step.\n Each transition defines how a workflow moves from one step to another when triggered.\n\n**Usage Notes:**\n - Validates that the step belongs to the current company context.\n - Returns all transitions, ordered by their creation sequence.", "auth": null, "body": null } }, { "name": "Retrieves details for a specific workflow transition.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/transition/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "transition", ":id" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "Returns metadata for a workflow transition, including source and destination steps.\n Requires permission.\n\n**Usage Notes:**\n - Includes the linked step and workflow definition for ownership validation.\n - Useful for reviewing or editing transition properties in UI editors.", "auth": null, "body": null } }, { "name": "Updates an existing workflow transition.", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/transition/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "transition", ":id" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "Allows modification of a workflow transition, such as its destination step or label.\n Requires permission.\n\n**Usage Notes:**\n - Updates the transition\uFFFDs \u0060LastModified\u0060 timestamp to \u0060UtcNow\u0060.\n - Returns \u0060404\u0060 if ownership validation fails.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } } ], "request": null }, { "name": "Workflow: Triggers", "description": null, "item": [ { "name": "Retrieves all workflow triggers defined within a specific workflow definition.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/definition/:WorkflowDefinitionId/triggers", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "definition", ":WorkflowDefinitionId", "triggers" ], "query": null, "variable": [ { "key": "WorkflowDefinitionId", "value": "\u003CWorkflowDefinitionId\u003E", "type": "string" } ] }, "description": "Returns a list of all triggers associated with any steps under the specified workflow definition.\n This is a convenience endpoint for administrators needing to review all trigger configurations\n at the workflow definition level.\n\n**Usage Notes:**\n - Useful for bulk analysis of triggers across all steps within a workflow.\n - Returns an empty list if no triggers exist.", "auth": null, "body": null } }, { "name": "Creates a new workflow trigger for a specific step.", "description": null, "item": null, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/step/:stepId/trigger", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "step", ":stepId", "trigger" ], "query": null, "variable": [ { "key": "stepId", "value": "\u003CstepId\u003E", "type": "string" } ] }, "description": "Adds a new trigger to a workflow step. Triggers are used to define the events or\n conditions that start transitions or actions within a workflow.\n\n**Usage Notes:**\n - Assigns a new \u0060WorkflowTriggerId\u0060.\n - Sets \u0060Active = true\u0060 and \u0060DateCreated = UtcNow\u0060.\n - Returns via \u0060CreatedAtAction\u0060 referencing\u0060Int32)\u0060.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Retrieves all workflow triggers belonging to a specific workflow step.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/step/:stepId/triggers", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "step", ":stepId", "triggers" ], "query": null, "variable": [ { "key": "stepId", "value": "\u003CstepId\u003E", "type": "string" } ] }, "description": "Returns a list of workflow triggers for the given step within a workflow definition.\n Each trigger defines a condition or event that can initiate a workflow transition or action.\n Requires the permission.\n\n**Usage Notes:**\n - Includes a validation step ensuring the step belongs to the provided company.\n - Returns all active and inactive triggers for the step.", "auth": null, "body": null } }, { "name": "Retrieves details for a specific workflow trigger.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/trigger/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "trigger", ":id" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "Returns the properties and configuration of a single workflow trigger, including its\n associated step and workflow definition. Requires the permission.\n\n**Usage Notes:**\n - Includes linked step and definition to validate company ownership.", "auth": null, "body": null } }, { "name": "Updates an existing workflow trigger.", "description": null, "item": null, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "description": null }, { "key": "Content-Type", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/trigger/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "trigger", ":id" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "Modifies the configuration of a workflow trigger, such as its condition,\n type, or related metadata. Requires the permission.\n\n**Usage Notes:**\n - Updates \u0060LastModified\u0060 automatically to \u0060UtcNow\u0060.\n - Returns \u0060404\u0060 if the trigger cannot be located under the specified company context.", "auth": null, "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Deletes a workflow trigger.", "description": null, "item": null, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/trigger/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "trigger", ":id" ], "query": null, "variable": [ { "key": "id", "value": "\u003Cid\u003E", "type": "string" } ] }, "description": "Deletes a workflow trigger.", "auth": null, "body": null } } ], "request": null }, { "name": "Workflow: Types", "description": null, "item": [ { "name": "Retrieves all available workflow trigger types.", "description": null, "item": null, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "description": null } ], "url": { "raw": "{{baseUrl}}/v2/Workflow/trigger/types", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Workflow", "trigger", "types" ], "query": null, "variable": null }, "description": "Returns a list of trigger type definitions, describing how triggers can initiate\n workflow actions (e.g., \uFFFDOn Case Posted\uFFFD, \uFFFDOn Status Change\uFFFD).\n Requires permission.\n\n**Usage Notes:**\n - Active trigger types appear before inactive ones.\n - Used for trigger configuration when defining workflow behavior.\n - Each record includes a display name, description, and internal identifier.", "auth": null, "body": null } } ], "request": null } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.mysolutioncenter.com", "type": "string" }, { "key": "bearerToken", "value": "", "type": "string" } ] }