using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.DayOfMonth.GetSettingsDayOfMonthAsync("dom_281b2c3d4e5f4a6b8c7d9e0f1a2b3c4d");
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.dayOfMonth.getSettingsDayOfMonth(
'dom_281b2c3d4e5f4a6b8c7d9e0f1a2b3c4d',
);
print(response.map);
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.DayOfMonth.GetSettingsDayOfMonthAsync("dom_281b2c3d4e5f4a6b8c7d9e0f1a2b3c4d");
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.dayOfMonth.getSettingsDayOfMonth(
'dom_281b2c3d4e5f4a6b8c7d9e0f1a2b3c4d',
);
print(response.map);
The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"Exsited API \u0026 SDK","colors":{"primary":"#f47521","light":"#f79a5c","dark":"#c85a12"},"logo":{"light":"https://mintcdn.com/exsited/f8dy8cAsXRr_bCjg/logo/exsited-light.svg?fit=max\u0026auto=format\u0026n=f8dy8cAsXRr_bCjg\u0026q=85\u0026s=00e42469502d2d52d31217087ba23648","dark":"https://mintcdn.com/exsited/f8dy8cAsXRr_bCjg/logo/exsited-dark.svg?fit=max\u0026auto=format\u0026n=f8dy8cAsXRr_bCjg\u0026q=85\u0026s=fbfbe5cb3829cb34e5cb8f59f186563a"},"favicon":"https://mintcdn.com/exsited/f8dy8cAsXRr_bCjg/favicon.svg?fit=max\u0026auto=format\u0026n=f8dy8cAsXRr_bCjg\u0026q=85\u0026s=601344ea0cc7163466abf3707628011c","api":{"openapi":"api-reference/openapi.json","playground":{"display":"interactive","proxy":true},"examples":{"prefill":true,"autogenerate":false}},"navbar":{"primary":{"type":"button","label":"Get started","href":"/introduction"}},"footer":{"socials":{}},"interaction":{"drilldown":false},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"exsited","hasAudioNarration":false,"actualSubdomain":"exsited","customDomains":[],"gitSource":{"type":"github","owner":"shuvo-webalive","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ae9720db0992260e3fc51c6","collectionId":"1263aaf4-c562-481b-8a72-d8a8e9eeb768","liveDeploymentHistoryId":"6ae9720db0992260e3fc51c6","schemaVersion":"v3"},"entitlements":{},"buildId":"6ae9720db0992260e3fc51c6","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"API reference","count":967},{"language":"default","tag":"Sales","count":178},{"language":"default","tag":"Items and fulfilment","count":169},{"language":"default","tag":"Settings","count":168},{"language":"default","tag":"Accounts","count":148},{"language":"default","tag":"Purchasing","count":99},{"language":"default","tag":"Instance settings","count":87},{"language":"default","tag":"Workflows, approvals and alerts","count":85},{"language":"default","tag":"Work and people","count":78},{"language":"default","tag":"Customisation","count":64}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@media (min-width: 1280px){#content-container{padding-left:3.5rem!important;padding-right:3.5rem!important}#content-container>div{max-width:none!important;margin-left:0!important;margin-right:0!important}}@media (min-width: 1536px){#content-side-layout:has(.code-group){max-width:36rem!important;width:36rem!important;flex:0 0 36rem!important}#content-side-layout:has(.code-group)>div{width:100%!important}}#content-area table{font-size:0.9rem}#content-area th{white-space:nowrap}#sidebar-content .method-nav-pill{width:2.7rem!important;justify-content:flex-start}#sidebar-content .method-nav-pill>span{display:inline-flex;align-items:center;justify-content:center;width:100%;height:1.2rem;padding:0!important;border:1px solid transparent;border-radius:0.3rem;font-family:ui-monospace, SFMono-Regular, Menlo, Consolas, monospace;font-size:0.6rem!important;font-weight:700;letter-spacing:0.04em;line-height:1!important}#sidebar-content .method-nav-pill>span[class*=\"bg-green\"]{background-color:#ecfdf3!important;border-color:#abefc6;color:#067647!important}#sidebar-content .method-nav-pill>span[class*=\"bg-blue\"]{background-color:#eff8ff!important;border-color:#b2ddff;color:#175cd3!important}#sidebar-content .method-nav-pill>span[class*=\"bg-yellow\"]{background-color:#fffaeb!important;border-color:#fedf89;color:#b54708!important}#sidebar-content .method-nav-pill>span[class*=\"bg-red\"]{background-color:#fef3f2!important;border-color:#fecdca;color:#b42318!important}#sidebar-content .method-nav-pill>span[class*=\"bg-purple\"]{background-color:#f4f3ff!important;border-color:#d9d6fe;color:#5925dc!important}.dark #sidebar-content .method-nav-pill>span[class*=\"bg-green\"]{background-color:rgba(71, 205, 137, 0.12)!important;border-color:rgba(71, 205, 137, 0.4);color:#75e0a7!important}.dark #sidebar-content .method-nav-pill>span[class*=\"bg-blue\"]{background-color:rgba(83, 177, 253, 0.12)!important;border-color:rgba(83, 177, 253, 0.4);color:#84caff!important}.dark #sidebar-content .method-nav-pill>span[class*=\"bg-yellow\"]{background-color:rgba(253, 176, 34, 0.12)!important;border-color:rgba(253, 176, 34, 0.4);color:#fec84b!important}.dark #sidebar-content .method-nav-pill>span[class*=\"bg-red\"]{background-color:rgba(249, 112, 102, 0.12)!important;border-color:rgba(249, 112, 102, 0.4);color:#fda29b!important}.dark #sidebar-content .method-nav-pill>span[class*=\"bg-purple\"]{background-color:rgba(155, 138, 251, 0.12)!important;border-color:rgba(155, 138, 251, 0.4);color:#bdb4fe!important}#sidebar-content a[aria-current] .method-nav-pill>span[class*=\"bg-green\"]{background-color:#079455!important;border-color:#079455;color:#ffffff!important}#sidebar-content a[aria-current] .method-nav-pill>span[class*=\"bg-blue\"]{background-color:#1570ef!important;border-color:#1570ef;color:#ffffff!important}#sidebar-content a[aria-current] .method-nav-pill>span[class*=\"bg-yellow\"]{background-color:#dc6803!important;border-color:#dc6803;color:#ffffff!important}#sidebar-content a[aria-current] .method-nav-pill>span[class*=\"bg-red\"]{background-color:#d92d20!important;border-color:#d92d20;color:#ffffff!important}#sidebar-content ul:has(.method-nav-pill)>li>a:not(:has(.method-nav-pill)){column-gap:0.6rem!important}#sidebar-content ul:has(.method-nav-pill)>li>a:not(:has(.method-nav-pill))::before{content:\"\";flex:0 0 2.7rem;height:1.2rem;margin-top:0.08rem;border:1px solid #d0d5dd;border-radius:0.3rem;background:#f2f4f7 url(\"data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20viewBox%3D%220%200%2024%2024%22%20fill%3D%22none%22%20stroke%3D%22%23475467%22%20stroke-width%3D%222.2%22%20stroke-linecap%3D%22round%22%20stroke-linejoin%3D%22round%22%3E%3Cpath%20d%3D%22M2%204h6a4%204%200%200%201%204%204v12a3%203%200%200%200-3-3H2z%22/%3E%3Cpath%20d%3D%22M22%204h-6a4%204%200%200%200-4%204v12a3%203%200%200%201%203-3h7z%22/%3E%3C/svg%3E\") center / 0.8rem no-repeat}.dark #sidebar-content ul:has(.method-nav-pill)>li>a:not(:has(.method-nav-pill))::before{border-color:rgba(152, 162, 179, 0.45);background:rgba(152, 162, 179, 0.14) url(\"data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20viewBox%3D%220%200%2024%2024%22%20fill%3D%22none%22%20stroke%3D%22%23d0d5dd%22%20stroke-width%3D%222.2%22%20stroke-linecap%3D%22round%22%20stroke-linejoin%3D%22round%22%3E%3Cpath%20d%3D%22M2%204h6a4%204%200%200%201%204%204v12a3%203%200%200%200-3-3H2z%22/%3E%3Cpath%20d%3D%22M22%204h-6a4%204%200%200%200-4%204v12a3%203%200%200%201%203-3h7z%22/%3E%3C/svg%3E\") center / 0.8rem no-repeat}#sidebar-content ul:has(.method-nav-pill)>li>a[aria-current]:not(:has(.method-nav-pill))::before{border-color:#475467;background:#475467 url(\"data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20viewBox%3D%220%200%2024%2024%22%20fill%3D%22none%22%20stroke%3D%22%23ffffff%22%20stroke-width%3D%222.2%22%20stroke-linecap%3D%22round%22%20stroke-linejoin%3D%22round%22%3E%3Cpath%20d%3D%22M2%204h6a4%204%200%200%201%204%204v12a3%203%200%200%200-3-3H2z%22/%3E%3Cpath%20d%3D%22M22%204h-6a4%204%200%200%200-4%204v12a3%203%200%200%201%203-3h7z%22/%3E%3C/svg%3E\") center / 0.8rem no-repeat}.dark #sidebar-content ul:has(.method-nav-pill)>li>a[aria-current]:not(:has(.method-nav-pill))::before{border-color:#98a2b3;background:#98a2b3 url(\"data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20viewBox%3D%220%200%2024%2024%22%20fill%3D%22none%22%20stroke%3D%22%23101828%22%20stroke-width%3D%222.2%22%20stroke-linecap%3D%22round%22%20stroke-linejoin%3D%22round%22%3E%3Cpath%20d%3D%22M2%204h6a4%204%200%200%201%204%204v12a3%203%200%200%200-3-3H2z%22/%3E%3Cpath%20d%3D%22M22%204h-6a4%204%200%200%200-4%204v12a3%203%200%200%201%203-3h7z%22/%3E%3C/svg%3E\") center / 0.8rem no-repeat}#sidebar-content ul ul a[style*=\"padding-left:2.5rem\"],#sidebar-content ul ul a[style*=\"padding-left: 2.5rem\"]{padding-left:1.75rem!important;column-gap:0.6rem!important}#sidebar-content ul ul a[style*=\"padding-left:4rem\"],#sidebar-content ul ul a[style*=\"padding-left: 4rem\"]{padding-left:3rem!important;column-gap:0.6rem!important}#sidebar-content .method-nav-pill>span[class*=\"bg-orange\"]{background-color:#fff6ed!important;border-color:#f9dbaf;color:#b93815!important}#sidebar-content .method-nav-pill>span[class*=\"bg-cyan\"]{background-color:#f2f4f7!important;border-color:#d0d5dd;color:#344054!important}.dark #sidebar-content .method-nav-pill>span[class*=\"bg-orange\"]{background-color:rgba(247, 144, 9, 0.12)!important;border-color:rgba(247, 144, 9, 0.4);color:#fdb022!important}.dark #sidebar-content .method-nav-pill>span[class*=\"bg-cyan\"]{background-color:rgba(152, 162, 179, 0.14)!important;border-color:rgba(152, 162, 179, 0.45);color:#d0d5dd!important}#sidebar-content a[aria-current] .method-nav-pill>span[class*=\"bg-orange\"]{background-color:#e04f16!important;border-color:#e04f16;color:#ffffff!important}#sidebar-content a[aria-current] .method-nav-pill>span[class*=\"bg-cyan\"]{background-color:#475467!important;border-color:#475467;color:#ffffff!important}#content-area td code{white-space:nowrap}#content-side-layout .font-mono.whitespace-pre{white-space:pre-wrap!important;flex:1 1 auto!important;min-width:0!important}#content-side-layout pre.shiki,#content-side-layout pre.shiki code{white-space:pre-wrap!important;overflow-wrap:anywhere;width:auto!important;min-width:0!important;max-width:100%!important}.card code{white-space:nowrap;font-size:0.8em}"}],"page":{"pagePath":"api-reference/days-of-the-month/retrieve-a-day-of-the-month","slug":"/api-reference/days-of-the-month/retrieve-a-day-of-the-month","pageMetadata":{"title":"Retrieve a day of the month","description":"Returns one day of the month by its `dom_` `id`, under `day_of_month`.","openapi":"GET /settings/day_of_month/{day_of_month_id}","href":"/api-reference/days-of-the-month/retrieve-a-day-of-the-month"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Returns one day of the month by its \", _jsx(_components.code, {\n children: \"dom_\"\n }), \" \", _jsx(_components.code, {\n children: \"id\"\n }), \", under \", _jsx(_components.code, {\n children: \"day_of_month\"\n }), \".\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Note}=_components;if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Reads the day of the month with this `,_jsx(_components.code,{children:`dom_`}),` `,_jsx(_components.code,{children:`id`}),`.`]}),`\n`,_jsxs(Note,{children:[`The SDK samples get their client from credentials your app registers once when it starts, as shown in `,_jsx(_components.a,{href:`/authentication#set-up-a-client`,children:`Authentication`}),`. To try the call here, click `,_jsx(_components.strong,{children:`Try it`}),`, set `,_jsx(_components.code,{children:`host`}),` to your Exsited API host name and paste an access token from `,_jsx(_components.a,{href:`/api-reference/authentication/get-an-access-token`,children:`Get an access token`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Retrieve a day of the month","description":"Returns one day of the month by its `dom_` `id`, under `day_of_month`.","openapi":"GET /settings/day_of_month/{day_of_month_id}","href":"/api-reference/days-of-the-month/retrieve-a-day-of-the-month"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Days of the month"],"summary":"Retrieve a day of the month","operationId":"day_of_month_get_settings_day_of_month","description":"Returns one day of the month by its `dom_` `id`, under `day_of_month`.","parameters":["10647dec-df53-41a9-86ab-1b9d63b1fcd3"],"responses":{"200":"552de2ff-e850-495b-b171-efb739b035e8"},"x-codeSamples":[{"lang":"bash","label":"cURL","source":"curl -X GET \"$EXSITED_BASE_URL/api/v4/settings/day_of_month/dom_281b2c3d4e5f4a6b8c7d9e0f1a2b3c4d\" \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\""},{"lang":"python","label":"Python","source":"from exsited import build_client\n\nclient = build_client()\n\nresponse = client.day_of_month.get_settings_day_of_month(\n \"dom_281b2c3d4e5f4a6b8c7d9e0f1a2b3c4d\"\n)\nprint(response.data)\n"},{"lang":"javascript","label":"JavaScript","source":"import {buildClient} from 'exsited';\n\nconst client = await buildClient();\n\nconst response = await client.dayOfMonth.getSettingsDayOfMonth('dom_281b2c3d4e5f4a6b8c7d9e0f1a2b3c4d');\nconsole.log(response.data);\n"},{"lang":"php","label":"PHP","source":"use Exsited\\Client\\ClientRegistry;\n\n$client = ClientRegistry::buildClient();\n\n$response = $client->dayOfMonth->getSettingsDayOfMonth('dom_281b2c3d4e5f4a6b8c7d9e0f1a2b3c4d');\nprint_r($response->data);\n"},{"lang":"java","label":"Java","source":"import com.exsited.client.ApiResponse;\nimport com.exsited.client.ClientRegistry;\nimport com.exsited.client.ExsitedClient;\nimport com.exsited.resources.day_of_month.day_of_month_dto.DayOfMonthDto.SettingsDayOfMonth;\n\nExsitedClient client = ClientRegistry.buildClient();\n\nApiResponse\u003cSettingsDayOfMonth> response = client.dayOfMonth().getSettingsDayOfMonth(\n \"dom_281b2c3d4e5f4a6b8c7d9e0f1a2b3c4d\");\nSystem.out.println(response.getMap());\n"},{"lang":"csharp","label":".NET","source":"using Exsited.Client;\n\nawait using var client = ExsitedClient.BuildClient();\n\nvar response = await client.DayOfMonth.GetSettingsDayOfMonthAsync(\"dom_281b2c3d4e5f4a6b8c7d9e0f1a2b3c4d\");\n\nConsole.WriteLine(response.Json);\n"},{"lang":"dart","label":"Dart","source":"import 'package:exsited/exsited.dart';\n\nfinal client = buildClient();\n\nfinal response = await client.dayOfMonth.getSettingsDayOfMonth(\n 'dom_281b2c3d4e5f4a6b8c7d9e0f1a2b3c4d',\n);\nprint(response.map);\n"},{"lang":"go","label":"Go","source":"import (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\n\texsited \"github.com/exsited/exsited-sdk-go/v4\"\n)\n\nclient, err := exsited.BuildClient(nil)\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer client.Close()\n\nresponse, err := client.DayOfMonth().GetSettingsDayOfMonth(context.Background(), \"dom_281b2c3d4e5f4a6b8c7d9e0f1a2b3c4d\", nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n"}],"method":"get","type":"path","servers":["1cd2e17a-4ab2-4ccf-9145-ff49ad09919f"],"security":["d27e5a3c-ed44-4ee1-ba0a-ce5b6a4a9fee"],"path":"/settings/day_of_month/{day_of_month_id}","baseUrlOptions":["https://{host}/api/v4"],"title":"Retrieve a day of the month","codeSamples":[{"label":"cURL","lang":"bash","source":"curl -X GET \"$EXSITED_BASE_URL/api/v4/settings/day_of_month/dom_281b2c3d4e5f4a6b8c7d9e0f1a2b3c4d\" \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\""},{"label":"Python","lang":"python","source":"from exsited import build_client\n\nclient = build_client()\n\nresponse = client.day_of_month.get_settings_day_of_month(\n \"dom_281b2c3d4e5f4a6b8c7d9e0f1a2b3c4d\"\n)\nprint(response.data)\n"},{"label":"JavaScript","lang":"javascript","source":"import {buildClient} from 'exsited';\n\nconst client = await buildClient();\n\nconst response = await client.dayOfMonth.getSettingsDayOfMonth('dom_281b2c3d4e5f4a6b8c7d9e0f1a2b3c4d');\nconsole.log(response.data);\n"},{"label":"PHP","lang":"php","source":"use Exsited\\Client\\ClientRegistry;\n\n$client = ClientRegistry::buildClient();\n\n$response = $client->dayOfMonth->getSettingsDayOfMonth('dom_281b2c3d4e5f4a6b8c7d9e0f1a2b3c4d');\nprint_r($response->data);\n"},{"label":"Java","lang":"java","source":"import com.exsited.client.ApiResponse;\nimport com.exsited.client.ClientRegistry;\nimport com.exsited.client.ExsitedClient;\nimport com.exsited.resources.day_of_month.day_of_month_dto.DayOfMonthDto.SettingsDayOfMonth;\n\nExsitedClient client = ClientRegistry.buildClient();\n\nApiResponse\u003cSettingsDayOfMonth> response = client.dayOfMonth().getSettingsDayOfMonth(\n \"dom_281b2c3d4e5f4a6b8c7d9e0f1a2b3c4d\");\nSystem.out.println(response.getMap());\n"},{"label":".NET","lang":"csharp","source":"using Exsited.Client;\n\nawait using var client = ExsitedClient.BuildClient();\n\nvar response = await client.DayOfMonth.GetSettingsDayOfMonthAsync(\"dom_281b2c3d4e5f4a6b8c7d9e0f1a2b3c4d\");\n\nConsole.WriteLine(response.Json);\n"},{"label":"Dart","lang":"dart","source":"import 'package:exsited/exsited.dart';\n\nfinal client = buildClient();\n\nfinal response = await client.dayOfMonth.getSettingsDayOfMonth(\n 'dom_281b2c3d4e5f4a6b8c7d9e0f1a2b3c4d',\n);\nprint(response.map);\n"},{"label":"Go","lang":"go","source":"import (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\n\texsited \"github.com/exsited/exsited-sdk-go/v4\"\n)\n\nclient, err := exsited.BuildClient(nil)\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer client.Close()\n\nresponse, err := client.DayOfMonth().GetSettingsDayOfMonth(context.Background(), \"dom_281b2c3d4e5f4a6b8c7d9e0f1a2b3c4d\", nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n"}],"requiredOnlyExamples":false,"disableCodeSampleGeneration":true,"requestExampleType":"codeSamples","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[]},"dependencies":{"parameters":{"10647dec-df53-41a9-86ab-1b9d63b1fcd3":{"name":"day_of_month_id","in":"path","required":true,"description":"The day of the month's `dom_` `id`, as the listing returns it.","schema":{"type":"string","isRequired":true,"description":"The day of the month's `dom_` `id`, as the listing returns it.","uniqueKey":"","typeLabel":"string"}}},"responses":{"552de2ff-e850-495b-b171-efb739b035e8":{"description":"The day of the month, under `day_of_month`.","content":{"application/json":{"schema":{"type":"object","properties":{"day_of_month":{"type":"object","properties":{"created_by":{"description":"Can be null.","uniqueKey":"day_of_month.created_by","typeLabel":"any"},"created_on":{"type":"string","uniqueKey":"day_of_month.created_on","typeLabel":"string"},"day":{"type":"integer","uniqueKey":"day_of_month.day","typeLabel":"integer"},"description":{"description":"Can be null.","uniqueKey":"day_of_month.description","typeLabel":"any"},"display_name":{"type":"string","uniqueKey":"day_of_month.display_name","typeLabel":"string"},"href":{"type":"string","uniqueKey":"day_of_month.href","typeLabel":"string"},"id":{"type":"string","uniqueKey":"day_of_month.id","typeLabel":"string"},"last_updated_by":{"description":"Can be null.","uniqueKey":"day_of_month.last_updated_by","typeLabel":"any"},"last_updated_on":{"type":"string","uniqueKey":"day_of_month.last_updated_on","typeLabel":"string"},"name":{"type":"string","uniqueKey":"day_of_month.name","typeLabel":"string"},"object":{"type":"string","uniqueKey":"day_of_month.object","typeLabel":"string"},"status":{"type":"string","uniqueKey":"day_of_month.status","typeLabel":"string"}},"uniqueKey":"day_of_month","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"day_of_month":{"created_by":"\u003cunknown>","created_on":"\u003cstring>","day":123,"description":"\u003cunknown>","display_name":"\u003cstring>","href":"\u003cstring>","id":"\u003cstring>","last_updated_by":"\u003cunknown>","last_updated_on":"\u003cstring>","name":"\u003cstring>","object":"\u003cstring>","status":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"d27e5a3c-ed44-4ee1-ba0a-ce5b6a4a9fee":{"bearerAuth":{"type":"http","scheme":"bearer","description":"An access token from `POST /api/v4/oauth2/token`. The SDKs get and renew it for you.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"1cd2e17a-4ab2-4ccf-9145-ff49ad09919f":{"url":"https://{host}/api/v4","variables":{"host":{"default":"your-api-host.example.com","description":"Your Exsited API host name, without https://."}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"An access token from `POST /api/v4/oauth2/token`. The SDKs get and renew it for you.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An access token from `POST /api/v4/oauth2/token`. The SDKs get and renew it for you.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"exsited","siteName":"Exsited API \u0026 SDK","title":"Retrieve a day of the month - Exsited API \u0026 SDK","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-04T04:24:13.090Z","originalFileLocation":"api-reference/days-of-the-month/retrieve-a-day-of-the-month.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns one day of the month by its dom_ id, under day_of_month.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Exsited API \u0026amp; SDK\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/exsited/kNn2H0ToBVgvzWJg/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/exsited/kNn2H0ToBVgvzWJg/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/exsited/kNn2H0ToBVgvzWJg/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/exsited/kNn2H0ToBVgvzWJg/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/exsited/kNn2H0ToBVgvzWJg/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/exsited/kNn2H0ToBVgvzWJg/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/exsited/kNn2H0ToBVgvzWJg/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/exsited/kNn2H0ToBVgvzWJg/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/exsited/kNn2H0ToBVgvzWJg/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve a day of the month - Exsited API \u0026amp; SDK\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns one day of the month by its dom_ id, under day_of_month.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Exsited API \u0026amp; SDK\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://exsited.mintlify.app/api-reference/days-of-the-month/retrieve-a-day-of-the-month\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://exsited.mintlify.site/_mintlify/api/og/v2?division=Days+of+the+month\u0026amp;title=Retrieve+a+day+of+the+month\u0026amp;description=Returns+one+day+of+the+month+by+its+%60dom_%60+%60id%60%2C+under+%60day_of_month%60.\u0026amp;theme=df8737826c422c4512373ba9\u0026amp;signature=7db6689f80758243b20c5df69e0c68d25a3f15e8f109c70a1deb43da12f510a7\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Retrieve a day of the month - Exsited API \u0026amp; SDK\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns one day of the month by its dom_ id, under day_of_month.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://exsited.mintlify.site/_mintlify/api/og/v2?division=Days+of+the+month\u0026amp;title=Retrieve+a+day+of+the+month\u0026amp;description=Returns+one+day+of+the+month+by+its+%60dom_%60+%60id%60%2C+under+%60day_of_month%60.\u0026amp;theme=df8737826c422c4512373ba9\u0026amp;signature=7db6689f80758243b20c5df69e0c68d25a3f15e8f109c70a1deb43da12f510a7\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/exsited/kNn2H0ToBVgvzWJg/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Exsited API \u0026amp; SDK\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#f47521\">\u003clink data-mint-head rel=\"canonical\" href=\"https://exsited.mintlify.app/api-reference/days-of-the-month/retrieve-a-day-of-the-month\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/days-of-the-month/retrieve-a-day-of-the-month.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://exsited.mintlify.app/#organization\",\"name\":\"Exsited API \u0026 SDK\",\"url\":\"https://exsited.mintlify.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/exsited/f8dy8cAsXRr_bCjg/logo/exsited-light.svg?fit=max\u0026auto=format\u0026n=f8dy8cAsXRr_bCjg\u0026q=85\u0026s=00e42469502d2d52d31217087ba23648\"}},{\"@type\":\"WebSite\",\"@id\":\"https://exsited.mintlify.app#website\",\"name\":\"Exsited API \u0026 SDK\",\"url\":\"https://exsited.mintlify.app\",\"publisher\":{\"@id\":\"https://exsited.mintlify.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://exsited.mintlify.app/api-reference/days-of-the-month/retrieve-a-day-of-the-month#webpage\",\"url\":\"https://exsited.mintlify.app/api-reference/days-of-the-month/retrieve-a-day-of-the-month\",\"name\":\"Retrieve a day of the month\",\"description\":\"Returns one day of the month by its dom_ id, under day_of_month.\",\"dateModified\":\"2026-10-04T04:24:13.090Z\",\"isPartOf\":{\"@id\":\"https://exsited.mintlify.app#website\"},\"breadcrumb\":{\"@id\":\"https://exsited.mintlify.app/api-reference/days-of-the-month/retrieve-a-day-of-the-month#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://exsited.mintlify.app/api-reference/days-of-the-month/retrieve-a-day-of-the-month#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://exsited.mintlify.app/api-reference/authentication/get-an-access-token\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Settings\",\"item\":\"https://exsited.mintlify.app/instance-settings\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Days of the month\",\"item\":\"https://exsited.mintlify.app/days-of-the-month\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Retrieve a day of the month\",\"item\":\"https://exsited.mintlify.app/api-reference/days-of-the-month/retrieve-a-day-of-the-month\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://exsited.mintlify.app/api-reference/days-of-the-month/retrieve-a-day-of-the-month#apireference\",\"headline\":\"Retrieve a day of the month\",\"name\":\"Retrieve a day of the month\",\"description\":\"Returns one day of the month by its dom_ id, under day_of_month.\",\"url\":\"https://exsited.mintlify.app/api-reference/days-of-the-month/retrieve-a-day-of-the-month\",\"mainEntityOfPage\":{\"@id\":\"https://exsited.mintlify.app/api-reference/days-of-the-month/retrieve-a-day-of-the-month#webpage\"},\"dateModified\":\"2026-10-04T04:24:13.090Z\",\"publisher\":{\"@id\":\"https://exsited.mintlify.app/#organization\"},\"isPartOf\":{\"@id\":\"https://exsited.mintlify.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Exsited API \u0026 SDK\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Exsited API \u0026 SDK","nav":{"global":null,"groups":[{"group":"Guides","pages":[{"group":"Get started","icon":"rocket","expanded":true,"pages":[{"title":"Introduction","href":"/introduction"},{"title":"Installation","href":"/installation"},{"title":"Authentication","href":"/authentication"}]}]},{"group":"API reference","pages":[{"group":"Authentication","icon":"key","expanded":false,"pages":[{"title":"Get an access token","openapi":"POST /oauth2/token","href":"/api-reference/authentication/get-an-access-token"}]},{"group":"Accounts","icon":"users","expanded":false,"pages":[{"group":"Accounts","expanded":false,"pages":[{"title":"Accounts","sidebarTitle":"Overview","href":"/accounts"},{"title":"List accounts","openapi":"GET /accounts","href":"/api-reference/accounts/list-accounts"},{"title":"Retrieve an account","openapi":"GET /accounts/{account_id}","href":"/api-reference/accounts/retrieve-an-account"},{"title":"Retrieve an account's information","openapi":"GET /accounts/{account_id}/information","href":"/api-reference/accounts/retrieve-an-accounts-information"},{"title":"Retrieve an account's image","openapi":"GET /accounts/{account_id}/image","href":"/api-reference/accounts/retrieve-an-accounts-image"},{"title":"List an account's contacts","openapi":"GET /accounts/{account_id}/contacts","href":"/api-reference/accounts/list-an-accounts-contacts"},{"title":"Retrieve a contact by slot","openapi":"GET /accounts/{account_id}/contacts/{contact_type}","href":"/api-reference/accounts/retrieve-a-contact-by-slot"},{"title":"List an account's addresses","openapi":"GET /accounts/{account_id}/addresses","href":"/api-reference/accounts/list-an-accounts-addresses"},{"title":"Retrieve an address","openapi":"GET /accounts/{account_id}/addresses/{address_id}","href":"/api-reference/accounts/retrieve-an-address"},{"title":"Retrieve an account's billing preferences","openapi":"GET /accounts/{account_id}/billing_preferences","href":"/api-reference/accounts/retrieve-an-accounts-billing-preferences"},{"title":"List an account's payment methods","openapi":"GET /accounts/{account_id}/payment_methods","href":"/api-reference/accounts/list-an-accounts-payment-methods"},{"title":"Retrieve a payment method","openapi":"GET /accounts/{account_id}/payment_methods/{payment_method_id}","href":"/api-reference/accounts/retrieve-a-payment-method"},{"title":"List an account's notes","openapi":"GET /accounts/{account_id}/notes","href":"/api-reference/accounts/list-an-accounts-notes"},{"title":"Retrieve a note","openapi":"GET /accounts/{account_id}/notes/{note_id}","href":"/api-reference/accounts/retrieve-a-note"},{"title":"List an account note's files","openapi":"GET /accounts/{account_id}/notes/{note_id}/files","href":"/api-reference/accounts/list-an-account-notes-files"},{"title":"Retrieve an account note file","openapi":"GET /accounts/{account_id}/notes/{note_id}/files/{file_id}","href":"/api-reference/accounts/retrieve-an-account-note-file"},{"title":"List an account's emails","openapi":"GET /accounts/{account_id}/communications/emails","href":"/api-reference/accounts/list-an-accounts-emails"},{"title":"Retrieve an email","openapi":"GET /accounts/{account_id}/communications/emails/{email_id}","href":"/api-reference/accounts/retrieve-an-email"},{"title":"List an account's orders","openapi":"GET /accounts/{account_id}/orders","href":"/api-reference/accounts/list-an-accounts-orders"},{"title":"List an account's invoices","openapi":"GET /accounts/{account_id}/invoices","href":"/api-reference/accounts/list-an-accounts-invoices"},{"title":"List an account's payments","openapi":"GET /accounts/{account_id}/payments","href":"/api-reference/accounts/list-an-accounts-payments"},{"title":"List an account's refunds","openapi":"GET /accounts/{account_id}/refunds","href":"/api-reference/accounts/list-an-accounts-refunds"},{"title":"List an account's credit notes","openapi":"GET /accounts/{account_id}/credit_notes","href":"/api-reference/accounts/list-an-accounts-credit-notes"},{"title":"List an account's purchase orders","openapi":"GET /accounts/{account_id}/purchase_orders","href":"/api-reference/accounts/list-an-accounts-purchase-orders"},{"title":"List an account's purchase invoices","openapi":"GET /accounts/{account_id}/purchase_invoices","href":"/api-reference/accounts/list-an-accounts-purchase-invoices"},{"title":"List an account's purchase payments","openapi":"GET /accounts/{account_id}/purchase_payments","href":"/api-reference/accounts/list-an-accounts-purchase-payments"},{"title":"List an account's purchase refunds","openapi":"GET /accounts/{account_id}/purchase_refunds","href":"/api-reference/accounts/list-an-accounts-purchase-refunds"},{"title":"List custom objects for accounts","openapi":"GET /accounts/{account_id}/custom_objects","href":"/api-reference/accounts/list-custom-objects-for-accounts"},{"title":"List an account's inventories","openapi":"GET /accounts/{account_id}/inventories","href":"/api-reference/accounts/list-an-accounts-inventories"},{"title":"List an account's partial invoices from quotes","openapi":"GET /accounts/{account_id}/quote_partial_invoices","href":"/api-reference/accounts/list-an-accounts-partial-invoices-from-quotes"},{"title":"Create an account","openapi":"POST /accounts","href":"/api-reference/accounts/create-an-account"},{"title":"Replace an account","openapi":"PUT /accounts/{account_id}","href":"/api-reference/accounts/replace-an-account"},{"title":"Cancel an account","openapi":"POST /accounts/{account_id}/cancel","href":"/api-reference/accounts/cancel-an-account"},{"title":"Reactivate an account","openapi":"POST /accounts/{account_id}/reactivate","href":"/api-reference/accounts/reactivate-an-account"},{"title":"Set an account's portal password","openapi":"POST /accounts/{account_id}/set-password","href":"/api-reference/accounts/set-an-accounts-portal-password"},{"title":"Update an account's information","openapi":"PATCH /accounts/{account_id}/information","href":"/api-reference/accounts/update-an-accounts-information"},{"title":"Add contacts to an account","openapi":"POST /accounts/{account_id}/contacts","href":"/api-reference/accounts/add-contacts-to-an-account"},{"title":"Add addresses to an account","openapi":"POST /accounts/{account_id}/addresses","href":"/api-reference/accounts/add-addresses-to-an-account"},{"title":"Update an address","openapi":"PATCH /accounts/{account_id}/addresses/{address_id}","href":"/api-reference/accounts/update-an-address"},{"title":"Replace an address","openapi":"PUT /accounts/{account_id}/addresses/{address_id}","href":"/api-reference/accounts/replace-an-address"},{"title":"Update a contact","openapi":"PATCH /accounts/{account_id}/contacts/{contact_id}","href":"/api-reference/accounts/update-a-contact"},{"title":"Replace a contact","openapi":"PUT /accounts/{account_id}/contacts/{contact_id}","href":"/api-reference/accounts/replace-a-contact"},{"title":"Replace an account's billing preferences","openapi":"PUT /accounts/{account_id}/billing_preferences","href":"/api-reference/accounts/replace-an-accounts-billing-preferences"},{"title":"Add a payment method","openapi":"POST /accounts/{account_id}/payment_methods","href":"/api-reference/accounts/add-a-payment-method"},{"title":"Update a payment method","openapi":"PATCH /accounts/{account_id}/payment_methods/{payment_method_id}","href":"/api-reference/accounts/update-a-payment-method"},{"title":"Replace a payment method","openapi":"PUT /accounts/{account_id}/payment_methods/{payment_method_id}","href":"/api-reference/accounts/replace-a-payment-method"},{"title":"Create a note","openapi":"POST /accounts/{account_id}/notes","href":"/api-reference/accounts/create-a-note"},{"title":"Update a note","openapi":"PATCH /accounts/{account_id}/notes/{note_id}","href":"/api-reference/accounts/update-a-note"},{"title":"Upload an account's image","openapi":"POST /accounts/{account_id}/image","href":"/api-reference/accounts/upload-an-accounts-image"},{"title":"Create a custom object instance","openapi":"POST /accounts/{account_id}/custom_objects/{custom_object_id}","href":"/api-reference/accounts/create-a-custom-object-instance"},{"title":"Update a custom object instance","openapi":"PATCH /accounts/{account_id}/custom_objects_instances/{custom_object_instance_id}","href":"/api-reference/accounts/update-a-custom-object-instance"},{"title":"Send and log an email","openapi":"POST /accounts/{account_id}/communications/emails","href":"/api-reference/accounts/send-and-log-an-email"},{"title":"Purge an account","openapi":"POST /accounts/{account_id}/purge","href":"/api-reference/accounts/purge-an-account"},{"title":"Delete an account","openapi":"DELETE /accounts/{account_id}","href":"/api-reference/accounts/delete-an-account"},{"title":"Delete a contact","openapi":"DELETE /accounts/{account_id}/contacts/{contact_id}","href":"/api-reference/accounts/delete-a-contact"},{"title":"Delete an address","openapi":"DELETE /accounts/{account_id}/addresses/{address_id}","href":"/api-reference/accounts/delete-an-address"},{"title":"Delete a payment method","openapi":"DELETE /accounts/{account_id}/payment_methods/{payment_method_id}","href":"/api-reference/accounts/delete-a-payment-method"},{"title":"Delete a note","openapi":"DELETE /accounts/{account_id}/notes/{note_id}","href":"/api-reference/accounts/delete-a-note"},{"title":"Delete an account's image","openapi":"DELETE /accounts/{account_id}/image","href":"/api-reference/accounts/delete-an-accounts-image"},{"title":"Retrieve an account's KPIs","openapi":"GET /accounts/{account_id}/kpis","href":"/api-reference/accounts/retrieve-an-accounts-kpis"},{"title":"Retrieve an account's financial summary","openapi":"GET /accounts/{account_id}/financial_summary","href":"/api-reference/accounts/retrieve-an-accounts-financial-summary"},{"title":"Retrieve a custom object with its instances","openapi":"GET /accounts/{account_id}/custom_objects/{custom_object_id}","href":"/api-reference/accounts/retrieve-a-custom-object-with-its-instances"},{"title":"Retrieve a custom object instance","openapi":"GET /accounts/{account_id}/custom_objects/{custom_object_id}/instances/{custom_object_instance_id}","href":"/api-reference/accounts/retrieve-a-custom-object-instance"},{"title":"List an account's component objects","openapi":"GET /accounts/{account_id}/component/{component_id}","href":"/api-reference/accounts/list-an-accounts-component-objects"},{"title":"Retrieve an account's component object","openapi":"GET /accounts/{account_id}/component/{component_id}/{component_object_id}","href":"/api-reference/accounts/retrieve-an-accounts-component-object"},{"title":"Delete an account note file","openapi":"DELETE /accounts/{account_id}/notes/{note_id}/files/{file_id}","href":"/api-reference/accounts/delete-an-account-note-file"}]},{"group":"Account emails","expanded":false,"pages":[{"title":"Account emails","sidebarTitle":"Overview","href":"/account-emails"},{"title":"Delete an account email","openapi":"DELETE /accounts/{account_id}/communications/emails/{email_uuid}","href":"/api-reference/account-emails/delete-an-account-email"}]},{"group":"Account groups","expanded":false,"pages":[{"title":"Account groups","sidebarTitle":"Overview","href":"/account-groups"},{"title":"List account groups","openapi":"GET /settings/account_groups","href":"/api-reference/account-groups/list-account-groups"},{"title":"Create an account group","openapi":"POST /settings/account_groups","href":"/api-reference/account-groups/create-an-account-group"},{"title":"Retrieve an account group","openapi":"GET /settings/account_groups/{account_group_id}","href":"/api-reference/account-groups/retrieve-an-account-group"},{"title":"Update an account group","openapi":"PATCH /settings/account_groups/{account_group_id}","href":"/api-reference/account-groups/update-an-account-group"},{"title":"Delete an account group","openapi":"DELETE /settings/account_groups/{account_group_id}","href":"/api-reference/account-groups/delete-an-account-group"}]},{"group":"Communications","expanded":false,"pages":[{"title":"Communications","sidebarTitle":"Overview","href":"/communications"},{"title":"Email a document","openapi":"POST /communications/send_email","href":"/api-reference/communications/email-a-document"}]},{"group":"Communication profiles","expanded":false,"pages":[{"title":"Communication profiles","sidebarTitle":"Overview","href":"/communication-profiles"},{"title":"List communication profiles","openapi":"GET /settings/communication_profiles","href":"/api-reference/communication-profiles/list-communication-profiles"},{"title":"Create a communication profile","openapi":"POST /settings/communication_profiles","href":"/api-reference/communication-profiles/create-a-communication-profile"},{"title":"Retrieve a communication profile","openapi":"GET /settings/communication_profiles/{communication_profile_id}","href":"/api-reference/communication-profiles/retrieve-a-communication-profile"},{"title":"Update a communication profile","openapi":"PATCH /settings/communication_profiles/{communication_profile_id}","href":"/api-reference/communication-profiles/update-a-communication-profile"},{"title":"Delete a communication profile","openapi":"DELETE /settings/communication_profiles/{communication_profile_id}","href":"/api-reference/communication-profiles/delete-a-communication-profile"}]}]},{"group":"Sales","icon":"cart-shopping","expanded":false,"pages":[{"group":"Orders","expanded":false,"pages":[{"title":"Orders","sidebarTitle":"Overview","href":"/orders"},{"title":"List orders","openapi":"GET /orders","href":"/api-reference/orders/list-orders"},{"title":"Create an order","openapi":"POST /orders","href":"/api-reference/orders/create-an-order"},{"title":"Retrieve an order","openapi":"GET /orders/{order_id}","href":"/api-reference/orders/retrieve-an-order"},{"title":"Delete an order","openapi":"DELETE /orders/{order_id}","href":"/api-reference/orders/delete-an-order"},{"title":"Activate an order","openapi":"POST /orders/{order_id}/activate","href":"/api-reference/orders/activate-an-order"},{"title":"Activate a draft order","openapi":"POST /orders/{order_id}/activate_draft","href":"/api-reference/orders/activate-a-draft-order"},{"title":"Retrieve an order's billing preferences","openapi":"GET /orders/{order_id}/billing_preferences","href":"/api-reference/orders/retrieve-an-orders-billing-preferences"},{"title":"Update an order's billing preferences","openapi":"PATCH /orders/{order_id}/billing_preferences","href":"/api-reference/orders/update-an-orders-billing-preferences"},{"title":"Replace an order's billing preferences","openapi":"PUT /orders/{order_id}/billing_preferences","href":"/api-reference/orders/replace-an-orders-billing-preferences"},{"title":"Cancel an order","openapi":"POST /orders/{order_id}/cancel","href":"/api-reference/orders/cancel-an-order"},{"title":"Change an order's lines","openapi":"POST /orders/{order_id}/change","href":"/api-reference/orders/change-an-orders-lines"},{"title":"Convert a quote to an order","openapi":"POST /orders/{order_id}/convert_to_order","href":"/api-reference/orders/convert-a-quote-to-an-order"},{"title":"List an order's custom objects","openapi":"GET /orders/{order_id}/custom_objects","href":"/api-reference/orders/list-an-orders-custom-objects"},{"title":"List an order's custom objects (instances path)","openapi":"GET /orders/{order_id}/custom_objects_instances","href":"/api-reference/orders/list-an-orders-custom-objects-instances-path"},{"title":"Discard a draft order","openapi":"POST /orders/{order_id}/discard_draft","href":"/api-reference/orders/discard-a-draft-order"},{"title":"Extend an order's trial","openapi":"POST /orders/{order_id}/extend_trial","href":"/api-reference/orders/extend-an-orders-trial"},{"title":"Retrieve an order's information","openapi":"GET /orders/{order_id}/information","href":"/api-reference/orders/retrieve-an-orders-information"},{"title":"Update an order's information","openapi":"PATCH /orders/{order_id}/information","href":"/api-reference/orders/update-an-orders-information"},{"title":"List an order's fulfillments","openapi":"GET /orders/{order_id}/item_fulfillments","href":"/api-reference/orders/list-an-orders-fulfillments"},{"title":"List an order's lines","openapi":"GET /orders/{order_id}/lines","href":"/api-reference/orders/list-an-orders-lines"},{"title":"List an order's notes","openapi":"GET /orders/{order_id}/notes","href":"/api-reference/orders/list-an-orders-notes"},{"title":"Create an order note","openapi":"POST /orders/{order_id}/notes","href":"/api-reference/orders/create-an-order-note"},{"title":"List an order's payment methods","openapi":"GET /orders/{order_id}/payment_methods","href":"/api-reference/orders/list-an-orders-payment-methods"},{"title":"Retrieve an order's PDF","openapi":"GET /orders/{order_id}/pdf","href":"/api-reference/orders/retrieve-an-orders-pdf"},{"title":"Reactivate an order","openapi":"POST /orders/{order_id}/reactivate","href":"/api-reference/orders/reactivate-an-order"},{"title":"Relinquish an order","openapi":"POST /orders/{order_id}/relinquish","href":"/api-reference/orders/relinquish-an-order"},{"title":"Update an order line","openapi":"PATCH /orders/{order_id}/lines/{line_uuid}","href":"/api-reference/orders/update-an-order-line"},{"title":"Retrieve an order line","openapi":"GET /orders/{order_id}/lines/{line_uuid}","href":"/api-reference/orders/retrieve-an-order-line"},{"title":"Delete an order note","openapi":"DELETE /orders/{order_id}/notes/{order_note_id}","href":"/api-reference/orders/delete-an-order-note"},{"title":"Retrieve an order note","openapi":"GET /orders/{order_id}/notes/{order_note_id}","href":"/api-reference/orders/retrieve-an-order-note"},{"title":"Update an order note","openapi":"PATCH /orders/{order_id}/notes/{order_note_id}","href":"/api-reference/orders/update-an-order-note"},{"title":"Retrieve an order's payment method","openapi":"GET /orders/{order_id}/payment_methods/{payment_method_ref}","href":"/api-reference/orders/retrieve-an-orders-payment-method"},{"title":"Update an order line's billing preferences","openapi":"PATCH /orders/{order_id}/lines/{line_uuid}/billing_preferences","href":"/api-reference/orders/update-an-order-lines-billing-preferences"},{"title":"Replace an order line's billing preferences","openapi":"PUT /orders/{order_id}/lines/{line_uuid}/billing_preferences","href":"/api-reference/orders/replace-an-order-lines-billing-preferences"},{"title":"List an order note's files","openapi":"GET /orders/{order_id}/notes/{order_note_id}/files","href":"/api-reference/orders/list-an-order-notes-files"},{"title":"Retrieve an order note file","openapi":"GET /orders/{order_id}/notes/{order_note_id}/files/{order_file_id}","href":"/api-reference/orders/retrieve-an-order-note-file"},{"title":"List notes across all orders","openapi":"GET /orders/notes","href":"/api-reference/orders/list-notes-across-all-orders"},{"title":"Preview an order","openapi":"POST /orders/preview","href":"/api-reference/orders/preview-an-order"},{"title":"Create an order through the express path","openapi":"POST /orders/express","href":"/api-reference/orders/create-an-order-through-the-express-path"},{"title":"Accept an order","openapi":"POST /orders/{order_id}/accept","href":"/api-reference/orders/accept-an-order"},{"title":"Activate a dormant invoice","openapi":"POST /orders/{order_id}/activate_invoice_from_dormant/{invoice_uuid}","href":"/api-reference/orders/activate-a-dormant-invoice"},{"title":"Preview an order change","openapi":"POST /orders/{order_id}/change/preview","href":"/api-reference/orders/preview-an-order-change"},{"title":"Change an order's workflow status","openapi":"POST /orders/{order_id}/change_status","href":"/api-reference/orders/change-an-orders-workflow-status"},{"title":"Adjust an order's contract","openapi":"POST /orders/{order_id}/contract_adjustment","href":"/api-reference/orders/adjust-an-orders-contract"},{"title":"Preview a contract adjustment","openapi":"POST /orders/{order_id}/contract_adjustment/preview","href":"/api-reference/orders/preview-a-contract-adjustment"},{"title":"Downgrade an order","openapi":"POST /orders/{order_id}/downgrade","href":"/api-reference/orders/downgrade-an-order"},{"title":"Preview an order downgrade","openapi":"POST /orders/{order_id}/downgrade/preview","href":"/api-reference/orders/preview-an-order-downgrade"},{"title":"Upgrade an order","openapi":"POST /orders/{order_id}/upgrade","href":"/api-reference/orders/upgrade-an-order"},{"title":"Preview an order upgrade","openapi":"POST /orders/{order_id}/upgrade/preview","href":"/api-reference/orders/preview-an-order-upgrade"},{"title":"End an order's trial","openapi":"POST /orders/{order_id}/terminate_trial","href":"/api-reference/orders/end-an-orders-trial"},{"title":"Delete an order note file","openapi":"DELETE /orders/{order_id}/notes/{order_note_id}/files/{order_file_id}","href":"/api-reference/orders/delete-an-order-note-file"},{"title":"Retrieve an order's custom object","openapi":"GET /orders/{order_id}/custom_objects/{custom_object_id}","href":"/api-reference/orders/retrieve-an-orders-custom-object"},{"title":"Retrieve an order's custom object instance","openapi":"GET /orders/{order_id}/custom_objects/{custom_object_id}/instances/{instance_id}","href":"/api-reference/orders/retrieve-an-orders-custom-object-instance"},{"title":"Retrieve an order's custom object (instances path)","openapi":"GET /orders/{order_id}/custom_objects_instances/{custom_object_id}","href":"/api-reference/orders/retrieve-an-orders-custom-object-instances-path"},{"title":"Retrieve an order's custom object instance (instances path)","openapi":"GET /orders/{order_id}/custom_objects_instances/{custom_object_id}/instances/{instance_id}","href":"/api-reference/orders/retrieve-an-orders-custom-object-instance-instances-path"},{"title":"Retrieve an order fulfillment","openapi":"GET /orders/{order_id}/item_fulfillments/{fulfillment_id}","href":"/api-reference/orders/retrieve-an-order-fulfillment"},{"title":"Retrieve an order's KPIs","openapi":"GET /orders/{order_id}/kpis","href":"/api-reference/orders/retrieve-an-orders-kpis"},{"title":"Retrieve an order payment","openapi":"GET /orders/{order_id}/payments/{payment_id}","href":"/api-reference/orders/retrieve-an-order-payment"},{"title":"List a quote's partial invoices","openapi":"GET /orders/{order_id}/quote_partial_invoices","href":"/api-reference/orders/list-a-quotes-partial-invoices"},{"title":"Retrieve a shipping line's PDF","openapi":"GET /orders/{order_id}/shipping_pdf/{shipping_line_id}","href":"/api-reference/orders/retrieve-a-shipping-lines-pdf"}]},{"group":"Quote orders","expanded":false,"pages":[{"title":"Quote orders","sidebarTitle":"Overview","href":"/quote-orders"},{"title":"List a quote's invoices","openapi":"GET /quote_orders/{quote_order_id}/invoices","href":"/api-reference/quote-orders/list-a-quotes-invoices"}]},{"group":"Express","expanded":false,"pages":[{"title":"Express","sidebarTitle":"Overview","href":"/express"},{"title":"Create an order with its invoice","openapi":"POST /express","href":"/api-reference/express/create-an-order-with-its-invoice"}]},{"group":"Usages","expanded":false,"pages":[{"title":"Usages","sidebarTitle":"Overview","href":"/usages"},{"title":"List usages","openapi":"GET /usages","href":"/api-reference/usages/list-usages"},{"title":"Create usages","openapi":"POST /usages","href":"/api-reference/usages/create-usages"},{"title":"Retrieve a usage","openapi":"GET /usages/{usage_id}","href":"/api-reference/usages/retrieve-a-usage"},{"title":"Delete a usage","openapi":"DELETE /usages/{usage_id}","href":"/api-reference/usages/delete-a-usage"},{"title":"Update a usage","openapi":"PATCH /usages/{usage_id}","href":"/api-reference/usages/update-a-usage"},{"title":"Replace a usage","openapi":"PUT /usages/{usage_id}","href":"/api-reference/usages/replace-a-usage"}]},{"group":"Sales reps","expanded":false,"pages":[{"title":"Sales reps","sidebarTitle":"Overview","href":"/sales-reps"},{"title":"List sales reps","openapi":"GET /settings/sales_reps","href":"/api-reference/sales-reps/list-sales-reps"},{"title":"Create a sales rep","openapi":"POST /settings/sales_reps","href":"/api-reference/sales-reps/create-a-sales-rep"},{"title":"Retrieve a sales rep","openapi":"GET /settings/sales_reps/{sales_rep_id}","href":"/api-reference/sales-reps/retrieve-a-sales-rep"},{"title":"Update a sales rep","openapi":"PATCH /settings/sales_reps/{sales_rep_id}","href":"/api-reference/sales-reps/update-a-sales-rep"},{"title":"Delete a sales rep","openapi":"DELETE /settings/sales_reps/{sales_rep_id}","href":"/api-reference/sales-reps/delete-a-sales-rep"}]},{"group":"Gift certificates","expanded":false,"pages":[{"title":"Gift certificates","sidebarTitle":"Overview","href":"/gift-certificates"},{"title":"List gift certificates","openapi":"GET /gift_certificates","href":"/api-reference/gift-certificates/list-gift-certificates"},{"title":"Create a gift certificate","openapi":"POST /gift_certificates","href":"/api-reference/gift-certificates/create-a-gift-certificate"},{"title":"Delete a gift certificate","openapi":"DELETE /gift_certificates/{gc_id}","href":"/api-reference/gift-certificates/delete-a-gift-certificate"},{"title":"Retrieve a gift certificate","openapi":"GET /gift_certificates/{gc_id}","href":"/api-reference/gift-certificates/retrieve-a-gift-certificate"},{"title":"Update a gift certificate","openapi":"PATCH /gift_certificates/{gc_id}","href":"/api-reference/gift-certificates/update-a-gift-certificate"},{"title":"List a gift certificate's allocations","openapi":"GET /gift_certificates/{gc_id}/allocations","href":"/api-reference/gift-certificates/list-a-gift-certificates-allocations"},{"title":"List a gift certificate's transactions","openapi":"GET /gift_certificates/{gc_id}/transactions","href":"/api-reference/gift-certificates/list-a-gift-certificates-transactions"},{"title":"Amend a gift certificate's balance","openapi":"POST /gift_certificates/{gc_id}/amend","href":"/api-reference/gift-certificates/amend-a-gift-certificates-balance"},{"title":"Allocate a gift certificate to an account","openapi":"POST /gift_certificates/{gc_id}/allocations","href":"/api-reference/gift-certificates/allocate-a-gift-certificate-to-an-account"},{"title":"Deallocate a gift certificate from an account","openapi":"POST /gift_certificates/{gc_id}/deallocations","href":"/api-reference/gift-certificates/deallocate-a-gift-certificate-from-an-account"},{"title":"Retrieve a gift certificate allocation","openapi":"GET /gift_certificates/{gc_id}/allocations/{allocation_id}","href":"/api-reference/gift-certificates/retrieve-a-gift-certificate-allocation"},{"title":"Retrieve a gift certificate transaction","openapi":"GET /gift_certificates/{gc_id}/transactions/{transaction_id}","href":"/api-reference/gift-certificates/retrieve-a-gift-certificate-transaction"}]},{"group":"Invoices","expanded":false,"pages":[{"title":"Invoices","sidebarTitle":"Overview","href":"/invoices"},{"title":"List invoices","openapi":"GET /invoices","href":"/api-reference/invoices/list-invoices"},{"title":"Retrieve an invoice","openapi":"GET /invoices/{invoice_id}","href":"/api-reference/invoices/retrieve-an-invoice"},{"title":"Retrieve an invoice's information","openapi":"GET /invoices/{invoice_id}/information","href":"/api-reference/invoices/retrieve-an-invoices-information"},{"title":"Retrieve an invoice's PDF links","openapi":"GET /invoices/{invoice_id}/pdf","href":"/api-reference/invoices/retrieve-an-invoices-pdf-links"},{"title":"Create an invoice","openapi":"POST /invoices","href":"/api-reference/invoices/create-an-invoice"},{"title":"Update an invoice's information","openapi":"PATCH /invoices/{invoice_id}/information","href":"/api-reference/invoices/update-an-invoices-information"},{"title":"Amend an invoice","openapi":"POST /invoices/{invoice_id}/amend","href":"/api-reference/invoices/amend-an-invoice"},{"title":"Cancel an invoice","openapi":"POST /invoices/{invoice_id}/cancel","href":"/api-reference/invoices/cancel-an-invoice"},{"title":"Reactivate an invoice","openapi":"POST /invoices/{invoice_id}/reactivate","href":"/api-reference/invoices/reactivate-an-invoice"},{"title":"Delete an invoice","openapi":"DELETE /invoices/{invoice_id}","href":"/api-reference/invoices/delete-an-invoice"},{"title":"List an invoice's item fulfillments","openapi":"GET /invoices/{invoice_id}/item_fulfillments","href":"/api-reference/invoices/list-an-invoices-item-fulfillments"},{"title":"Retrieve an invoice's item fulfillment","openapi":"GET /invoices/{invoice_id}/item_fulfillments/{fulfillment_id}","href":"/api-reference/invoices/retrieve-an-invoices-item-fulfillment"},{"title":"List an invoice's return merchandise authorisations","openapi":"GET /invoices/{invoice_id}/return_merchandise_authorisations","href":"/api-reference/invoices/list-an-invoices-return-merchandise-authorisations"},{"title":"Retrieve an invoice's return merchandise authorisation","openapi":"GET /invoices/{invoice_id}/return_merchandise_authorisations/{rma_id}","href":"/api-reference/invoices/retrieve-an-invoices-return-merchandise-authorisation"},{"title":"List an invoice's notes","openapi":"GET /invoices/{invoice_id}/notes","href":"/api-reference/invoices/list-an-invoices-notes"},{"title":"Retrieve an invoice note","openapi":"GET /invoices/{invoice_id}/notes/{note_id}","href":"/api-reference/invoices/retrieve-an-invoice-note"},{"title":"Create an invoice note","openapi":"POST /invoices/{invoice_id}/notes","href":"/api-reference/invoices/create-an-invoice-note"},{"title":"Delete an invoice note","openapi":"DELETE /invoices/{invoice_id}/notes/{note_id}","href":"/api-reference/invoices/delete-an-invoice-note"},{"title":"List an invoice note's files","openapi":"GET /invoices/{invoice_id}/notes/{note_id}/files","href":"/api-reference/invoices/list-an-invoice-notes-files"},{"title":"Retrieve an invoice note file","openapi":"GET /invoices/{invoice_id}/notes/{note_id}/files/{file_id}","href":"/api-reference/invoices/retrieve-an-invoice-note-file"},{"title":"List an order's invoices","openapi":"GET /orders/{order_id}/invoices","href":"/api-reference/invoices/list-an-orders-invoices"},{"title":"Create an invoice for an order","openapi":"POST /orders/{order_id}/invoices","href":"/api-reference/invoices/create-an-invoice-for-an-order"},{"title":"Retrieve an invoice's KPIs","openapi":"GET /invoices/{invoice_id}/kpis","href":"/api-reference/invoices/retrieve-an-invoices-kpis"},{"title":"List an invoice's lines","openapi":"GET /invoices/{invoice_id}/lines","href":"/api-reference/invoices/list-an-invoices-lines"},{"title":"Retrieve an invoice line","openapi":"GET /invoices/{invoice_id}/lines/{line_id}","href":"/api-reference/invoices/retrieve-an-invoice-line"},{"title":"Retrieve a credit note application through an invoice","openapi":"GET /invoices/{invoice_id}/credit_note_applications/{credit_note_application_id}","href":"/api-reference/invoices/retrieve-a-credit-note-application-through-an-invoice"},{"title":"List an invoice's custom objects","openapi":"GET /invoices/{invoice_id}/custom_objects","href":"/api-reference/invoices/list-an-invoices-custom-objects"},{"title":"Retrieve an invoice's custom object","openapi":"GET /invoices/{invoice_id}/custom_objects/{custom_object_id}","href":"/api-reference/invoices/retrieve-an-invoices-custom-object"},{"title":"Retrieve an invoice's custom object instance","openapi":"GET /invoices/{invoice_id}/custom_objects/{custom_object_id}/instances/{instance_id}","href":"/api-reference/invoices/retrieve-an-invoices-custom-object-instance"},{"title":"Delete an invoice note file","openapi":"DELETE /invoices/{invoice_id}/notes/{note_id}/files/{file_id}","href":"/api-reference/invoices/delete-an-invoice-note-file"}]},{"group":"Pro-forma invoices","expanded":false,"pages":[{"title":"Pro-forma invoices","sidebarTitle":"Overview","href":"/pro-forma-invoices"},{"title":"List pro-forma invoices","openapi":"GET /proforma_invoices","href":"/api-reference/pro-forma-invoices/list-pro-forma-invoices"},{"title":"Retrieve a pro-forma invoice","openapi":"GET /proforma_invoices/{proforma_id}","href":"/api-reference/pro-forma-invoices/retrieve-a-pro-forma-invoice"},{"title":"Delete a pro-forma invoice","openapi":"DELETE /proforma_invoices/{proforma_id}","href":"/api-reference/pro-forma-invoices/delete-a-pro-forma-invoice"},{"title":"Pay a pro-forma invoice","openapi":"POST /proforma_invoices/{proforma_id}/payments","href":"/api-reference/pro-forma-invoices/pay-a-pro-forma-invoice"}]},{"group":"Payments","expanded":false,"pages":[{"title":"Payments","sidebarTitle":"Overview","href":"/payments"},{"title":"List payments","openapi":"GET /payments","href":"/api-reference/payments/list-payments"},{"title":"Create a payment","openapi":"POST /payments","href":"/api-reference/payments/create-a-payment"},{"title":"List notes across all payments","openapi":"GET /payments/notes","href":"/api-reference/payments/list-notes-across-all-payments"},{"title":"Delete a payment","openapi":"DELETE /payments/{payment_id}","href":"/api-reference/payments/delete-a-payment"},{"title":"Update a payment","openapi":"PATCH /payments/{payment_id}","href":"/api-reference/payments/update-a-payment"},{"title":"Retrieve a payment","openapi":"GET /payments/{payment_id}","href":"/api-reference/payments/retrieve-a-payment"},{"title":"List an invoice's payments","openapi":"GET /invoices/{invoice_id}/payments","href":"/api-reference/payments/list-an-invoices-payments"},{"title":"List an order's payments","openapi":"GET /orders/{order_id}/payments","href":"/api-reference/payments/list-an-orders-payments"},{"title":"List a payment's notes","openapi":"GET /payments/{payment_id}/notes","href":"/api-reference/payments/list-a-payments-notes"},{"title":"Create a payment note","openapi":"POST /payments/{payment_id}/notes","href":"/api-reference/payments/create-a-payment-note"},{"title":"Retrieve a payment note","openapi":"GET /payments/{payment_id}/notes/{payment_note_id}","href":"/api-reference/payments/retrieve-a-payment-note"},{"title":"Delete a payment note","openapi":"DELETE /payments/{payment_id}/notes/{payment_note_id}","href":"/api-reference/payments/delete-a-payment-note"},{"title":"Retrieve a payment note file","openapi":"GET /payments/{payment_id}/notes/{payment_note_id}/files/{payment_file_id}","href":"/api-reference/payments/retrieve-a-payment-note-file"},{"title":"Retrieve a payment through an invoice","openapi":"GET /invoices/{invoice_id}/payments/{payment_id}","href":"/api-reference/payments/retrieve-a-payment-through-an-invoice"},{"title":"List a payment note's files","openapi":"GET /payments/{payment_id}/notes/{payment_note_id}/files","href":"/api-reference/payments/list-a-payment-notes-files"}]},{"group":"Refunds","expanded":false,"pages":[{"title":"Refunds","sidebarTitle":"Overview","href":"/refunds"},{"title":"List refunds","openapi":"GET /refunds","href":"/api-reference/refunds/list-refunds"},{"title":"Delete a refund","openapi":"DELETE /refunds/{refund_id}","href":"/api-reference/refunds/delete-a-refund"},{"title":"Retrieve a refund","openapi":"GET /refunds/{refund_id}","href":"/api-reference/refunds/retrieve-a-refund"},{"title":"Update a refund","openapi":"PATCH /refunds/{refund_id}","href":"/api-reference/refunds/update-a-refund"},{"title":"Create a refund from a credit note","openapi":"POST /credit_notes/{credit_note_id}/refunds","href":"/api-reference/refunds/create-a-refund-from-a-credit-note"},{"title":"List a refund's notes","openapi":"GET /refunds/{refund_id}/notes","href":"/api-reference/refunds/list-a-refunds-notes"},{"title":"Retrieve a refund note","openapi":"GET /refunds/{refund_id}/notes/{note_id}","href":"/api-reference/refunds/retrieve-a-refund-note"},{"title":"Create a refund note","openapi":"POST /refunds/{refund_id}/notes","href":"/api-reference/refunds/create-a-refund-note"},{"title":"Delete a refund note","openapi":"DELETE /refunds/{refund_id}/notes/{note_id}","href":"/api-reference/refunds/delete-a-refund-note"},{"title":"List a refund note's files","openapi":"GET /refunds/{refund_id}/notes/{note_id}/files","href":"/api-reference/refunds/list-a-refund-notes-files"},{"title":"Retrieve a refund note file","openapi":"GET /refunds/{refund_id}/notes/{note_id}/files/{file_id}","href":"/api-reference/refunds/retrieve-a-refund-note-file"},{"title":"Delete a refund note file","openapi":"DELETE /refunds/{refund_id}/notes/{note_id}/files/{file_id}","href":"/api-reference/refunds/delete-a-refund-note-file"}]},{"group":"Credit notes","expanded":false,"pages":[{"title":"Credit notes","sidebarTitle":"Overview","href":"/credit-notes"},{"title":"List credit notes","openapi":"GET /credit_notes","href":"/api-reference/credit-notes/list-credit-notes"},{"title":"Retrieve a credit note","openapi":"GET /credit_notes/{credit_note_id}","href":"/api-reference/credit-notes/retrieve-a-credit-note"},{"title":"Update a credit note","openapi":"PATCH /credit_notes/{credit_note_id}","href":"/api-reference/credit-notes/update-a-credit-note"},{"title":"Create a credit note","openapi":"POST /credit_notes","href":"/api-reference/credit-notes/create-a-credit-note"},{"title":"Delete a credit note","openapi":"DELETE /credit_notes/{credit_note_id}","href":"/api-reference/credit-notes/delete-a-credit-note"},{"title":"Apply a credit note to invoices","openapi":"POST /credit_notes/{credit_note_id}/apply","href":"/api-reference/credit-notes/apply-a-credit-note-to-invoices"},{"title":"Retrieve a credit note's balance items","openapi":"GET /credit_notes/{credit_note_id}/items","href":"/api-reference/credit-notes/retrieve-a-credit-notes-balance-items"},{"title":"List a credit note's applications","openapi":"GET /credit_notes/{credit_note_id}/credit_note_applications","href":"/api-reference/credit-notes/list-a-credit-notes-applications"},{"title":"List a credit note's notes","openapi":"GET /credit_notes/{credit_note_id}/notes","href":"/api-reference/credit-notes/list-a-credit-notes-notes"},{"title":"Retrieve a note on a credit note","openapi":"GET /credit_notes/{credit_note_id}/notes/{note_id}","href":"/api-reference/credit-notes/retrieve-a-note-on-a-credit-note"},{"title":"Add a note to a credit note","openapi":"POST /credit_notes/{credit_note_id}/notes","href":"/api-reference/credit-notes/add-a-note-to-a-credit-note"},{"title":"Delete a note from a credit note","openapi":"DELETE /credit_notes/{credit_note_id}/notes/{note_id}","href":"/api-reference/credit-notes/delete-a-note-from-a-credit-note"},{"title":"List the files on a credit note's note","openapi":"GET /credit_notes/{credit_note_id}/notes/{note_id}/files","href":"/api-reference/credit-notes/list-the-files-on-a-credit-notes-note"},{"title":"Retrieve a file on a credit note's note","openapi":"GET /credit_notes/{credit_note_id}/notes/{note_id}/files/{file_id}","href":"/api-reference/credit-notes/retrieve-a-file-on-a-credit-notes-note"}]},{"group":"Credit note applications","expanded":false,"pages":[{"title":"Credit note applications","sidebarTitle":"Overview","href":"/credit-note-applications"},{"title":"List credit note applications","openapi":"GET /credit_note_applications","href":"/api-reference/credit-note-applications/list-credit-note-applications"},{"title":"Retrieve a credit note application","openapi":"GET /credit_note_applications/{credit_note_application_id}","href":"/api-reference/credit-note-applications/retrieve-a-credit-note-application"},{"title":"List an invoice's credit note applications","openapi":"GET /invoices/{invoice_id}/credit_note_applications","href":"/api-reference/credit-note-applications/list-an-invoices-credit-note-applications"}]},{"group":"Reconciliations","expanded":false,"pages":[{"title":"Reconciliations","sidebarTitle":"Overview","href":"/reconciliations"},{"title":"List a reconciliation's payments","openapi":"GET /reconciliations/{reconciliation_id}/sale_payments","href":"/api-reference/reconciliations/list-a-reconciliations-payments"},{"title":"List a reconciliation's refunds","openapi":"GET /reconciliations/{reconciliation_id}/sale_refunds","href":"/api-reference/reconciliations/list-a-reconciliations-refunds"}]}]},{"group":"Items and fulfilment","icon":"boxes-stacked","expanded":false,"pages":[{"group":"Items","expanded":false,"pages":[{"title":"Items","sidebarTitle":"Overview","href":"/items"},{"title":"List items","openapi":"GET /items","href":"/api-reference/items/list-items"},{"title":"Retrieve an item","openapi":"GET /items/{item_id}","href":"/api-reference/items/retrieve-an-item"},{"title":"Retrieve an item's information","openapi":"GET /items/{item_id}/information","href":"/api-reference/items/retrieve-an-items-information"},{"title":"Create an item","openapi":"POST /items","href":"/api-reference/items/create-an-item"},{"title":"Update an item's information","openapi":"PATCH /items/{item_id}/information","href":"/api-reference/items/update-an-items-information"},{"title":"Deactivate an item","openapi":"POST /items/{item_id}/deactivate","href":"/api-reference/items/deactivate-an-item"},{"title":"Reactivate an item","openapi":"POST /items/{item_id}/reactivate","href":"/api-reference/items/reactivate-an-item"},{"title":"Delete an item","openapi":"DELETE /items/{item_id}","href":"/api-reference/items/delete-an-item"},{"title":"Upload an item's image","openapi":"POST /items/{item_id}/image","href":"/api-reference/items/upload-an-items-image"},{"title":"Retrieve an item's sale settings","openapi":"GET /items/{item_id}/sale","href":"/api-reference/items/retrieve-an-items-sale-settings"},{"title":"Create an item's sale settings","openapi":"POST /items/{item_id}/sale","href":"/api-reference/items/create-an-items-sale-settings"},{"title":"Update an item's sale settings","openapi":"PATCH /items/{item_id}/sale","href":"/api-reference/items/update-an-items-sale-settings"},{"title":"Retrieve an item's purchase settings","openapi":"GET /items/{item_id}/purchase","href":"/api-reference/items/retrieve-an-items-purchase-settings"},{"title":"Create an item's purchase settings","openapi":"POST /items/{item_id}/purchase","href":"/api-reference/items/create-an-items-purchase-settings"},{"title":"Update an item's purchase settings","openapi":"PATCH /items/{item_id}/purchase","href":"/api-reference/items/update-an-items-purchase-settings"},{"title":"Retrieve an item's inventory settings and stock","openapi":"GET /items/{item_id}/inventories","href":"/api-reference/items/retrieve-an-items-inventory-settings-and-stock"},{"title":"Update an item's inventory settings","openapi":"PATCH /items/{item_id}/inventories","href":"/api-reference/items/update-an-items-inventory-settings"},{"title":"Add warehouse stock","openapi":"POST /items/{item_id}/inventory/add","href":"/api-reference/items/add-warehouse-stock"},{"title":"List an item's inventory adjustments","openapi":"GET /items/{item_id}/inventory_adjustments","href":"/api-reference/items/list-an-items-inventory-adjustments"},{"title":"Retrieve an item's stock in one warehouse","openapi":"GET /items/{item_id}/warehouses/{warehouse_name}/inventories","href":"/api-reference/items/retrieve-an-items-stock-in-one-warehouse"},{"title":"Update a bundle's components","openapi":"PATCH /items/{item_id}/bundle_details","href":"/api-reference/items/update-a-bundles-components"},{"title":"Configure an item's variations","openapi":"PATCH /items/{item_id}/variations","href":"/api-reference/items/configure-an-items-variations"},{"title":"List an item family's members","openapi":"GET /items/{item_id}/family_details","href":"/api-reference/items/list-an-item-familys-members"},{"title":"Add or remove family members","openapi":"POST /items/{item_id}/family_details","href":"/api-reference/items/add-or-remove-family-members"},{"title":"List an item's packages","openapi":"GET /items/{item_id}/package_details","href":"/api-reference/items/list-an-items-packages"},{"title":"Retrieve an item package","openapi":"GET /items/{item_id}/package_details/{package_detail_id}","href":"/api-reference/items/retrieve-an-item-package"},{"title":"Create an item package","openapi":"POST /items/{item_id}/package_details","href":"/api-reference/items/create-an-item-package"},{"title":"Delete an item package","openapi":"DELETE /items/{item_id}/package_details/{package_detail_id}","href":"/api-reference/items/delete-an-item-package"},{"title":"List an item's notes","openapi":"GET /items/{item_id}/notes","href":"/api-reference/items/list-an-items-notes"},{"title":"Retrieve an item note","openapi":"GET /items/{item_id}/notes/{note_id}","href":"/api-reference/items/retrieve-an-item-note"},{"title":"Create an item note","openapi":"POST /items/{item_id}/notes","href":"/api-reference/items/create-an-item-note"},{"title":"Update an item note","openapi":"PATCH /items/{item_id}/notes/{note_id}","href":"/api-reference/items/update-an-item-note"},{"title":"Delete an item note","openapi":"DELETE /items/{item_id}/notes/{note_id}","href":"/api-reference/items/delete-an-item-note"},{"title":"List a note's files","openapi":"GET /items/{item_id}/notes/{note_id}/files","href":"/api-reference/items/list-a-notes-files"},{"title":"Retrieve a note file","openapi":"GET /items/{item_id}/notes/{note_id}/files/{file_id}","href":"/api-reference/items/retrieve-a-note-file"},{"title":"Create an item's inventory settings","openapi":"POST /items/{item_id}/inventories","href":"/api-reference/items/create-an-items-inventory-settings"},{"title":"Add warehouse stock (inventories path)","openapi":"POST /items/{item_id}/inventories/add","href":"/api-reference/items/add-warehouse-stock-inventories-path"},{"title":"Create an item's inventory settings (inventory path)","openapi":"POST /items/{item_id}/inventory","href":"/api-reference/items/create-an-items-inventory-settings-inventory-path"},{"title":"Delete a note file","openapi":"DELETE /items/{item_id}/notes/{note_id}/files/{file_id}","href":"/api-reference/items/delete-a-note-file"},{"title":"Update an item package","openapi":"PATCH /items/{item_id}/package_details/{package_detail_id}","href":"/api-reference/items/update-an-item-package"},{"title":"Retrieve an item's KPIs","openapi":"GET /items/{item_id}/kpis","href":"/api-reference/items/retrieve-an-items-kpis"}]},{"group":"Inventory adjustments","expanded":false,"pages":[{"title":"Inventory adjustments","sidebarTitle":"Overview","href":"/inventory-adjustments"},{"title":"List inventory adjustments","openapi":"GET /inventory_adjustments","href":"/api-reference/inventory-adjustments/list-inventory-adjustments"},{"title":"Retrieve an inventory adjustment","openapi":"GET /inventory_adjustments/{inventory_adjustment_id}","href":"/api-reference/inventory-adjustments/retrieve-an-inventory-adjustment"}]},{"group":"Units of measurement","expanded":false,"pages":[{"title":"Units of measurement","sidebarTitle":"Overview","href":"/units-of-measurement"},{"title":"List units of measurement","openapi":"GET /settings/uom","href":"/api-reference/units-of-measurement/list-units-of-measurement"},{"title":"Create a unit of measurement","openapi":"POST /settings/uom","href":"/api-reference/units-of-measurement/create-a-unit-of-measurement"},{"title":"Retrieve a unit of measurement","openapi":"GET /settings/uom/{uom_id}","href":"/api-reference/units-of-measurement/retrieve-a-unit-of-measurement"},{"title":"Delete a unit of measurement","openapi":"DELETE /settings/uom/{uom_id}","href":"/api-reference/units-of-measurement/delete-a-unit-of-measurement"},{"title":"Update a unit of measurement","openapi":"PATCH /settings/uom/{uom_id}","href":"/api-reference/units-of-measurement/update-a-unit-of-measurement"}]},{"group":"Zones","expanded":false,"pages":[{"title":"Zones","sidebarTitle":"Overview","href":"/zones"},{"title":"List zones","openapi":"GET /settings/zones","href":"/api-reference/zones/list-zones"},{"title":"Create a zone","openapi":"POST /settings/zones","href":"/api-reference/zones/create-a-zone"},{"title":"Retrieve a zone","openapi":"GET /settings/zones/{zone_id}","href":"/api-reference/zones/retrieve-a-zone"},{"title":"Delete a zone","openapi":"DELETE /settings/zones/{zone_id}","href":"/api-reference/zones/delete-a-zone"},{"title":"Update a zone","openapi":"PATCH /settings/zones/{zone_id}","href":"/api-reference/zones/update-a-zone"}]},{"group":"Shipping packages","expanded":false,"pages":[{"title":"Shipping packages","sidebarTitle":"Overview","href":"/shipping-packages"},{"title":"List shipping packages","openapi":"GET /settings/shipping_packages","href":"/api-reference/shipping-packages/list-shipping-packages"},{"title":"Create a shipping package","openapi":"POST /settings/shipping_packages","href":"/api-reference/shipping-packages/create-a-shipping-package"},{"title":"Retrieve a shipping package","openapi":"GET /settings/shipping_packages/{shipping_package_id}","href":"/api-reference/shipping-packages/retrieve-a-shipping-package"},{"title":"Delete a shipping package","openapi":"DELETE /settings/shipping_packages/{shipping_package_id}","href":"/api-reference/shipping-packages/delete-a-shipping-package"},{"title":"Update a shipping package","openapi":"PATCH /settings/shipping_packages/{shipping_package_id}","href":"/api-reference/shipping-packages/update-a-shipping-package"}]},{"group":"Shipping rules","expanded":false,"pages":[{"title":"Shipping rules","sidebarTitle":"Overview","href":"/shipping-rules"},{"title":"List shipping rules","openapi":"GET /settings/shipping_rules","href":"/api-reference/shipping-rules/list-shipping-rules"},{"title":"Create a shipping rule","openapi":"POST /settings/shipping_rules","href":"/api-reference/shipping-rules/create-a-shipping-rule"},{"title":"Retrieve a shipping rule","openapi":"GET /settings/shipping_rules/{shipping_rule_id}","href":"/api-reference/shipping-rules/retrieve-a-shipping-rule"},{"title":"Delete a shipping rule","openapi":"DELETE /settings/shipping_rules/{shipping_rule_id}","href":"/api-reference/shipping-rules/delete-a-shipping-rule"},{"title":"Update a shipping rule","openapi":"PATCH /settings/shipping_rules/{shipping_rule_id}","href":"/api-reference/shipping-rules/update-a-shipping-rule"},{"title":"Set a shipping rule's configuration","openapi":"POST /settings/shipping_rules/{shipping_rule_id}/configuration","href":"/api-reference/shipping-rules/set-a-shipping-rules-configuration"}]},{"group":"Fulfillment profiles","expanded":false,"pages":[{"title":"Fulfillment profiles","sidebarTitle":"Overview","href":"/fulfillment-profiles"},{"title":"List fulfillment profiles","openapi":"GET /settings/fulfillment_profiles","href":"/api-reference/fulfillment-profiles/list-fulfillment-profiles"},{"title":"Create a fulfillment profile","openapi":"POST /settings/fulfillment_profiles","href":"/api-reference/fulfillment-profiles/create-a-fulfillment-profile"},{"title":"Retrieve a fulfillment profile","openapi":"GET /settings/fulfillment_profiles/{fulfillment_profile_id}","href":"/api-reference/fulfillment-profiles/retrieve-a-fulfillment-profile"},{"title":"Delete a fulfillment profile","openapi":"DELETE /settings/fulfillment_profiles/{fulfillment_profile_id}","href":"/api-reference/fulfillment-profiles/delete-a-fulfillment-profile"},{"title":"Update a fulfillment profile","openapi":"PATCH /settings/fulfillment_profiles/{fulfillment_profile_id}","href":"/api-reference/fulfillment-profiles/update-a-fulfillment-profile"}]},{"group":"Fulfillment terms","expanded":false,"pages":[{"title":"Fulfillment terms","sidebarTitle":"Overview","href":"/fulfillment-terms"},{"title":"List fulfillment terms","openapi":"GET /settings/fulfillment_terms","href":"/api-reference/fulfillment-terms/list-fulfillment-terms"},{"title":"Create a fulfillment term","openapi":"POST /settings/fulfillment_terms","href":"/api-reference/fulfillment-terms/create-a-fulfillment-term"},{"title":"Retrieve a fulfillment term","openapi":"GET /settings/fulfillment_terms/{fulfillment_term_id}","href":"/api-reference/fulfillment-terms/retrieve-a-fulfillment-term"},{"title":"Delete a fulfillment term","openapi":"DELETE /settings/fulfillment_terms/{fulfillment_term_id}","href":"/api-reference/fulfillment-terms/delete-a-fulfillment-term"},{"title":"Update a fulfillment term","openapi":"PATCH /settings/fulfillment_terms/{fulfillment_term_id}","href":"/api-reference/fulfillment-terms/update-a-fulfillment-term"}]},{"group":"Item fulfillments","expanded":false,"pages":[{"title":"Item fulfillments","sidebarTitle":"Overview","href":"/item-fulfillments"},{"title":"List item fulfillments","openapi":"GET /item_fulfillments","href":"/api-reference/item-fulfillments/list-item-fulfillments"},{"title":"Create an item fulfillment","openapi":"POST /item_fulfillments","href":"/api-reference/item-fulfillments/create-an-item-fulfillment"},{"title":"Retrieve an item fulfillment","openapi":"GET /item_fulfillments/{fulfillment_id}","href":"/api-reference/item-fulfillments/retrieve-an-item-fulfillment"},{"title":"Update an item fulfillment","openapi":"PATCH /item_fulfillments/{fulfillment_id}","href":"/api-reference/item-fulfillments/update-an-item-fulfillment"},{"title":"Create an item fulfillment note","openapi":"POST /item_fulfillments/{fulfillment_id}/notes","href":"/api-reference/item-fulfillments/create-an-item-fulfillment-note"},{"title":"Delete an item fulfillment","openapi":"DELETE /item_fulfillments/{fulfillment_id}","href":"/api-reference/item-fulfillments/delete-an-item-fulfillment"},{"title":"Delete an item fulfillment note","openapi":"DELETE /item_fulfillments/{fulfillment_id}/notes/{note_id}","href":"/api-reference/item-fulfillments/delete-an-item-fulfillment-note"},{"title":"List an item fulfillment's notes","openapi":"GET /item_fulfillments/{fulfillment_id}/notes","href":"/api-reference/item-fulfillments/list-an-item-fulfillments-notes"},{"title":"Retrieve an item fulfillment note","openapi":"GET /item_fulfillments/{fulfillment_id}/notes/{note_id}","href":"/api-reference/item-fulfillments/retrieve-an-item-fulfillment-note"}]},{"group":"Item receipts","expanded":false,"pages":[{"title":"Item receipts","sidebarTitle":"Overview","href":"/item-receipts"},{"title":"List item receipts","openapi":"GET /item_receipts","href":"/api-reference/item-receipts/list-item-receipts"},{"title":"Create an item receipt","openapi":"POST /item_receipts","href":"/api-reference/item-receipts/create-an-item-receipt"},{"title":"Update an item receipt","openapi":"PATCH /item_receipts/{item_receipt_id}","href":"/api-reference/item-receipts/update-an-item-receipt"},{"title":"Retrieve an item receipt","openapi":"GET /item_receipts/{item_receipt_id}","href":"/api-reference/item-receipts/retrieve-an-item-receipt"},{"title":"List a purchase order's item receipts","openapi":"GET /purchase_orders/{purchase_order_id}/item_receipts","href":"/api-reference/item-receipts/list-a-purchase-orders-item-receipts"},{"title":"Delete an item receipt","openapi":"DELETE /item_receipts/{item_receipt_id}","href":"/api-reference/item-receipts/delete-an-item-receipt"},{"title":"Delete an item receipt note","openapi":"DELETE /item_receipts/{item_receipt_id}/notes/{note_id}","href":"/api-reference/item-receipts/delete-an-item-receipt-note"}]},{"group":"Bookings","expanded":false,"pages":[{"title":"Bookings","sidebarTitle":"Overview","href":"/bookings"},{"title":"List bookings","openapi":"GET /booking","href":"/api-reference/bookings/list-bookings"},{"title":"Retrieve a booking","openapi":"GET /booking/{booking_id}","href":"/api-reference/bookings/retrieve-a-booking"},{"title":"Create a booking","openapi":"POST /booking","href":"/api-reference/bookings/create-a-booking"},{"title":"Preview a booking","openapi":"POST /booking/preview","href":"/api-reference/bookings/preview-a-booking"},{"title":"Delete a booking","openapi":"DELETE /booking/{booking_id}","href":"/api-reference/bookings/delete-a-booking"},{"title":"List booking notes","openapi":"GET /booking/notes","href":"/api-reference/bookings/list-booking-notes"},{"title":"Retrieve a booking's billing preferences","openapi":"GET /booking/{booking_id}/billing_preferences","href":"/api-reference/bookings/retrieve-a-bookings-billing-preferences"},{"title":"Update a booking's billing preferences","openapi":"PATCH /booking/{booking_id}/billing_preferences","href":"/api-reference/bookings/update-a-bookings-billing-preferences"},{"title":"Change a booking","openapi":"POST /booking/{booking_id}/change","href":"/api-reference/bookings/change-a-booking"},{"title":"Preview a booking change","openapi":"POST /booking/{booking_id}/change/preview","href":"/api-reference/bookings/preview-a-booking-change"},{"title":"Retrieve a booking's information","openapi":"GET /booking/{booking_id}/information","href":"/api-reference/bookings/retrieve-a-bookings-information"},{"title":"Update a booking's information","openapi":"PATCH /booking/{booking_id}/information","href":"/api-reference/bookings/update-a-bookings-information"},{"title":"Retrieve a booking's lines","openapi":"GET /booking/{booking_id}/lines","href":"/api-reference/bookings/retrieve-a-bookings-lines"},{"title":"Retrieve a booking line","openapi":"GET /booking/{booking_id}/lines/{line_uuid}","href":"/api-reference/bookings/retrieve-a-booking-line"},{"title":"Update a booking line","openapi":"PATCH /booking/{booking_id}/lines/{line_uuid}","href":"/api-reference/bookings/update-a-booking-line"},{"title":"Update a booking line's billing preferences","openapi":"PATCH /booking/{booking_id}/lines/{line_uuid}/billing_preferences","href":"/api-reference/bookings/update-a-booking-lines-billing-preferences"},{"title":"List a booking's custom objects","openapi":"GET /booking/{booking_id}/custom_objects","href":"/api-reference/bookings/list-a-bookings-custom-objects"},{"title":"Retrieve a booking custom object","openapi":"GET /booking/{booking_id}/custom_objects/{custom_object_id}","href":"/api-reference/bookings/retrieve-a-booking-custom-object"},{"title":"Retrieve a booking custom object instance","openapi":"GET /booking/{booking_id}/custom_objects/{custom_object_id}/instances/{instance_id}","href":"/api-reference/bookings/retrieve-a-booking-custom-object-instance"},{"title":"List a booking's custom objects (alternate path)","openapi":"GET /booking/{booking_id}/custom_objects_instances","href":"/api-reference/bookings/list-a-bookings-custom-objects-alternate-path"},{"title":"Retrieve a booking custom object (alternate path)","openapi":"GET /booking/{booking_id}/custom_objects_instances/{custom_object_id}","href":"/api-reference/bookings/retrieve-a-booking-custom-object-alternate-path"},{"title":"Retrieve a booking custom object instance (alternate path)","openapi":"GET /booking/{booking_id}/custom_objects_instances/{custom_object_id}/instances/{instance_id}","href":"/api-reference/bookings/retrieve-a-booking-custom-object-instance-alternate-path"},{"title":"List a booking's invoices","openapi":"GET /booking/{booking_id}/invoices","href":"/api-reference/bookings/list-a-bookings-invoices"},{"title":"List a booking's item fulfillments","openapi":"GET /booking/{booking_id}/item_fulfillments","href":"/api-reference/bookings/list-a-bookings-item-fulfillments"},{"title":"Retrieve a booking item fulfillment","openapi":"GET /booking/{booking_id}/item_fulfillments/{fulfillment_id}","href":"/api-reference/bookings/retrieve-a-booking-item-fulfillment"},{"title":"Retrieve a booking's KPIs","openapi":"GET /booking/{booking_id}/kpis","href":"/api-reference/bookings/retrieve-a-bookings-kpis"},{"title":"List a booking's payment methods","openapi":"GET /booking/{booking_id}/payment_methods","href":"/api-reference/bookings/list-a-bookings-payment-methods"},{"title":"Retrieve a booking payment method","openapi":"GET /booking/{booking_id}/payment_methods/{payment_method_ref}","href":"/api-reference/bookings/retrieve-a-booking-payment-method"},{"title":"List a booking's payments","openapi":"GET /booking/{booking_id}/payments","href":"/api-reference/bookings/list-a-bookings-payments"},{"title":"Retrieve a booking payment","openapi":"GET /booking/{booking_id}/payments/{payment_id}","href":"/api-reference/bookings/retrieve-a-booking-payment"},{"title":"Retrieve a booking's PDF links","openapi":"GET /booking/{booking_id}/pdf","href":"/api-reference/bookings/retrieve-a-bookings-pdf-links"},{"title":"List a booking's quote partial invoices","openapi":"GET /booking/{booking_id}/quote_partial_invoices","href":"/api-reference/bookings/list-a-bookings-quote-partial-invoices"},{"title":"Retrieve a booking shipping line PDF","openapi":"GET /booking/{booking_id}/shipping_pdf/{shipping_line_id}","href":"/api-reference/bookings/retrieve-a-booking-shipping-line-pdf"}]},{"group":"Rental assets","expanded":false,"pages":[{"title":"Rental assets","sidebarTitle":"Overview","href":"/rental-assets"},{"title":"List rental asset availability","openapi":"GET /rental_asset_availability","href":"/api-reference/rental-assets/list-rental-asset-availability"},{"title":"Update rental asset availability","openapi":"PATCH /rental_asset_availability","href":"/api-reference/rental-assets/update-rental-asset-availability"},{"title":"List rental asset profiles","openapi":"GET /rental_asset_profiles","href":"/api-reference/rental-assets/list-rental-asset-profiles"},{"title":"Create a rental asset profile","openapi":"POST /rental_asset_profiles","href":"/api-reference/rental-assets/create-a-rental-asset-profile"},{"title":"List rental assets","openapi":"GET /rental_assets","href":"/api-reference/rental-assets/list-rental-assets"},{"title":"Create a rental asset","openapi":"POST /rental_assets","href":"/api-reference/rental-assets/create-a-rental-asset"},{"title":"Retrieve a rental asset profile","openapi":"GET /rental_asset_profiles/{rental_asset_profile_id}","href":"/api-reference/rental-assets/retrieve-a-rental-asset-profile"},{"title":"Update a rental asset profile","openapi":"PATCH /rental_asset_profiles/{rental_asset_profile_id}","href":"/api-reference/rental-assets/update-a-rental-asset-profile"},{"title":"Delete a rental asset profile","openapi":"DELETE /rental_asset_profiles/{rental_asset_profile_id}","href":"/api-reference/rental-assets/delete-a-rental-asset-profile"},{"title":"Update a rental asset","openapi":"PATCH /rental_assets/{rental_asset_uuid}","href":"/api-reference/rental-assets/update-a-rental-asset"},{"title":"Delete a rental asset","openapi":"DELETE /rental_assets/{rental_asset_uuid}","href":"/api-reference/rental-assets/delete-a-rental-asset"},{"title":"Retrieve a rental asset","openapi":"GET /rental_assets/{rental_asset_uuid}","href":"/api-reference/rental-assets/retrieve-a-rental-asset"},{"title":"Cancel a rental asset","openapi":"POST /rental_assets/{rental_asset_id}/cancel","href":"/api-reference/rental-assets/cancel-a-rental-asset"},{"title":"Reactivate a rental asset","openapi":"POST /rental_assets/{rental_asset_id}/reactivate","href":"/api-reference/rental-assets/reactivate-a-rental-asset"}]},{"group":"Return merchandise authorisations","expanded":false,"pages":[{"title":"Return merchandise authorisations","sidebarTitle":"Overview","href":"/return-merchandise-authorisations"},{"title":"List RMAs","openapi":"GET /return_merchandise_authorisations","href":"/api-reference/return-merchandise-authorisations/list-rmas"},{"title":"Create an RMA","openapi":"POST /return_merchandise_authorisations","href":"/api-reference/return-merchandise-authorisations/create-an-rma"},{"title":"Retrieve an RMA","openapi":"GET /return_merchandise_authorisations/{rma_id}","href":"/api-reference/return-merchandise-authorisations/retrieve-an-rma"},{"title":"List an RMA's receipts through its invoice","openapi":"GET /invoices/{invoice_id}/return_merchandise_authorisations/{rma_code}/receive","href":"/api-reference/return-merchandise-authorisations/list-an-rmas-receipts-through-its-invoice"},{"title":"Retrieve an RMA receipt through its invoice","openapi":"GET /invoices/{invoice_id}/return_merchandise_authorisations/{rma_code}/receive/{receive_uuid}","href":"/api-reference/return-merchandise-authorisations/retrieve-an-rma-receipt-through-its-invoice"},{"title":"Create an RMA note","openapi":"POST /return_merchandise_authorisations/{rma_id}/notes","href":"/api-reference/return-merchandise-authorisations/create-an-rma-note"},{"title":"Receive returned stock for an RMA","openapi":"POST /return_merchandise_authorisations/{rma_id}/receive","href":"/api-reference/return-merchandise-authorisations/receive-returned-stock-for-an-rma"},{"title":"Delete an RMA","openapi":"DELETE /return_merchandise_authorisations/{rma_id}","href":"/api-reference/return-merchandise-authorisations/delete-an-rma"},{"title":"Update an RMA","openapi":"PATCH /return_merchandise_authorisations/{rma_id}","href":"/api-reference/return-merchandise-authorisations/update-an-rma"},{"title":"Approve an RMA","openapi":"POST /return_merchandise_authorisations/{rma_id}/approve","href":"/api-reference/return-merchandise-authorisations/approve-an-rma"},{"title":"Delete an RMA note","openapi":"DELETE /return_merchandise_authorisations/{rma_id}/notes/{note_id}","href":"/api-reference/return-merchandise-authorisations/delete-an-rma-note"},{"title":"Delete an RMA note file","openapi":"DELETE /return_merchandise_authorisations/{rma_id}/notes/{note_id}/files/{file_id}","href":"/api-reference/return-merchandise-authorisations/delete-an-rma-note-file"},{"title":"Reject an RMA","openapi":"POST /return_merchandise_authorisations/{rma_id}/reject","href":"/api-reference/return-merchandise-authorisations/reject-an-rma"},{"title":"List RMA notes","openapi":"GET /return_merchandise_authorisations/{rma_code}/notes","href":"/api-reference/return-merchandise-authorisations/list-rma-notes"},{"title":"Retrieve an RMA note","openapi":"GET /return_merchandise_authorisations/{rma_code}/notes/{note_id}","href":"/api-reference/return-merchandise-authorisations/retrieve-an-rma-note"},{"title":"List RMA note files","openapi":"GET /return_merchandise_authorisations/{rma_code}/notes/{note_id}/files","href":"/api-reference/return-merchandise-authorisations/list-rma-note-files"},{"title":"Retrieve an RMA note file","openapi":"GET /return_merchandise_authorisations/{rma_code}/notes/{note_id}/files/{file_id}","href":"/api-reference/return-merchandise-authorisations/retrieve-an-rma-note-file"},{"title":"List an RMA's receipts","openapi":"GET /return_merchandise_authorisations/{rma_code}/receive","href":"/api-reference/return-merchandise-authorisations/list-an-rmas-receipts"},{"title":"Retrieve an RMA receipt","openapi":"GET /return_merchandise_authorisations/{rma_code}/receive/{receive_uuid}","href":"/api-reference/return-merchandise-authorisations/retrieve-an-rma-receipt"}]}]},{"group":"Purchasing","icon":"truck","expanded":false,"pages":[{"group":"Purchase orders","expanded":false,"pages":[{"title":"Purchase orders","sidebarTitle":"Overview","href":"/purchase-orders"},{"title":"List purchase orders","openapi":"GET /purchase_orders","href":"/api-reference/purchase-orders/list-purchase-orders"},{"title":"Create a purchase order","openapi":"POST /purchase_orders","href":"/api-reference/purchase-orders/create-a-purchase-order"},{"title":"List notes across purchase orders","openapi":"GET /purchase_orders/notes","href":"/api-reference/purchase-orders/list-notes-across-purchase-orders"},{"title":"Delete a purchase order","openapi":"DELETE /purchase_orders/{purchase_order_id}","href":"/api-reference/purchase-orders/delete-a-purchase-order"},{"title":"Update a purchase order","openapi":"PATCH /purchase_orders/{purchase_order_id}","href":"/api-reference/purchase-orders/update-a-purchase-order"},{"title":"Retrieve a purchase order","openapi":"GET /purchase_orders/{purchase_order_id}","href":"/api-reference/purchase-orders/retrieve-a-purchase-order"},{"title":"Cancel a purchase order","openapi":"POST /purchase_orders/{purchase_order_id}/cancel","href":"/api-reference/purchase-orders/cancel-a-purchase-order"},{"title":"Change a purchase order's lines","openapi":"POST /purchase_orders/{purchase_order_id}/change","href":"/api-reference/purchase-orders/change-a-purchase-orders-lines"},{"title":"Retrieve a purchase order's information","openapi":"GET /purchase_orders/{purchase_order_id}/information","href":"/api-reference/purchase-orders/retrieve-a-purchase-orders-information"},{"title":"List a purchase order's lines","openapi":"GET /purchase_orders/{purchase_order_id}/lines","href":"/api-reference/purchase-orders/list-a-purchase-orders-lines"},{"title":"List a purchase order's notes","openapi":"GET /purchase_orders/{purchase_order_id}/notes","href":"/api-reference/purchase-orders/list-a-purchase-orders-notes"},{"title":"Create a purchase order note","openapi":"POST /purchase_orders/{purchase_order_id}/notes","href":"/api-reference/purchase-orders/create-a-purchase-order-note"},{"title":"Create a purchase invoice from a purchase order","openapi":"POST /purchase_orders/{purchase_order_id}/purchase_invoices","href":"/api-reference/purchase-orders/create-a-purchase-invoice-from-a-purchase-order"},{"title":"List a purchase order's purchase invoices","openapi":"GET /purchase_orders/{purchase_order_id}/purchase_invoices","href":"/api-reference/purchase-orders/list-a-purchase-orders-purchase-invoices"},{"title":"List a purchase order's purchase payments","openapi":"GET /purchase_orders/{purchase_order_id}/purchase_payments","href":"/api-reference/purchase-orders/list-a-purchase-orders-purchase-payments"},{"title":"Reactivate a purchase order","openapi":"POST /purchase_orders/{purchase_order_id}/reactivate","href":"/api-reference/purchase-orders/reactivate-a-purchase-order"},{"title":"Retrieve a purchase order line","openapi":"GET /purchase_orders/{purchase_order_id}/lines/{purchase_order_line_uuid}","href":"/api-reference/purchase-orders/retrieve-a-purchase-order-line"},{"title":"Delete a purchase order note","openapi":"DELETE /purchase_orders/{purchase_order_id}/notes/{purchase_order_note_id}","href":"/api-reference/purchase-orders/delete-a-purchase-order-note"},{"title":"Retrieve a purchase order note","openapi":"GET /purchase_orders/{purchase_order_id}/notes/{purchase_order_note_id}","href":"/api-reference/purchase-orders/retrieve-a-purchase-order-note"},{"title":"List a purchase order note's files","openapi":"GET /purchase_orders/{purchase_order_id}/notes/{purchase_order_note_id}/files","href":"/api-reference/purchase-orders/list-a-purchase-order-notes-files"},{"title":"Retrieve a purchase order note file","openapi":"GET /purchase_orders/{purchase_order_id}/notes/{purchase_order_note_id}/files/{purchase_order_file_id}","href":"/api-reference/purchase-orders/retrieve-a-purchase-order-note-file"},{"title":"Retrieve a purchase order's KPIs","openapi":"GET /purchase_orders/{purchase_order_id}/kpis","href":"/api-reference/purchase-orders/retrieve-a-purchase-orders-kpis"},{"title":"Delete a purchase order note file","openapi":"DELETE /purchase_orders/{purchase_order_id}/notes/{purchase_order_note_id}/files/{purchase_order_file_id}","href":"/api-reference/purchase-orders/delete-a-purchase-order-note-file"}]},{"group":"Purchase invoices","expanded":false,"pages":[{"title":"Purchase invoices","sidebarTitle":"Overview","href":"/purchase-invoices"},{"title":"List purchase invoices","openapi":"GET /purchase_invoices","href":"/api-reference/purchase-invoices/list-purchase-invoices"},{"title":"Create a purchase invoice","openapi":"POST /purchase_invoices","href":"/api-reference/purchase-invoices/create-a-purchase-invoice"},{"title":"List notes across purchase invoices","openapi":"GET /purchase_invoices/notes","href":"/api-reference/purchase-invoices/list-notes-across-purchase-invoices"},{"title":"Delete a purchase invoice","openapi":"DELETE /purchase_invoices/{purchase_invoice_id}","href":"/api-reference/purchase-invoices/delete-a-purchase-invoice"},{"title":"Retrieve a purchase invoice","openapi":"GET /purchase_invoices/{purchase_invoice_id}","href":"/api-reference/purchase-invoices/retrieve-a-purchase-invoice"},{"title":"Amend a purchase invoice's lines","openapi":"POST /purchase_invoices/{purchase_invoice_id}/amend","href":"/api-reference/purchase-invoices/amend-a-purchase-invoices-lines"},{"title":"Cancel a purchase invoice","openapi":"POST /purchase_invoices/{purchase_invoice_id}/cancel","href":"/api-reference/purchase-invoices/cancel-a-purchase-invoice"},{"title":"Retrieve a purchase invoice's information","openapi":"GET /purchase_invoices/{purchase_invoice_id}/information","href":"/api-reference/purchase-invoices/retrieve-a-purchase-invoices-information"},{"title":"Update a purchase invoice's information","openapi":"PATCH /purchase_invoices/{purchase_invoice_id}/information","href":"/api-reference/purchase-invoices/update-a-purchase-invoices-information"},{"title":"List a purchase invoice's lines","openapi":"GET /purchase_invoices/{purchase_invoice_id}/lines","href":"/api-reference/purchase-invoices/list-a-purchase-invoices-lines"},{"title":"List a purchase invoice's notes","openapi":"GET /purchase_invoices/{purchase_invoice_id}/notes","href":"/api-reference/purchase-invoices/list-a-purchase-invoices-notes"},{"title":"Create a purchase invoice note","openapi":"POST /purchase_invoices/{purchase_invoice_id}/notes","href":"/api-reference/purchase-invoices/create-a-purchase-invoice-note"},{"title":"List a purchase invoice's credit note applications","openapi":"GET /purchase_invoices/{purchase_invoice_id}/purchase_credit_note_applications","href":"/api-reference/purchase-invoices/list-a-purchase-invoices-credit-note-applications"},{"title":"List a purchase invoice's purchase payments","openapi":"GET /purchase_invoices/{purchase_invoice_id}/purchase_payments","href":"/api-reference/purchase-invoices/list-a-purchase-invoices-purchase-payments"},{"title":"Reactivate a purchase invoice","openapi":"POST /purchase_invoices/{purchase_invoice_id}/reactivate","href":"/api-reference/purchase-invoices/reactivate-a-purchase-invoice"},{"title":"Retrieve a purchase invoice line","openapi":"GET /purchase_invoices/{purchase_invoice_id}/lines/{purchase_invoice_line_uuid}","href":"/api-reference/purchase-invoices/retrieve-a-purchase-invoice-line"},{"title":"Update a purchase invoice note","openapi":"PATCH /purchase_invoices/{purchase_invoice_id}/notes/{note_id}","href":"/api-reference/purchase-invoices/update-a-purchase-invoice-note"},{"title":"Retrieve a purchase invoice note","openapi":"GET /purchase_invoices/{purchase_invoice_id}/notes/{note_id}","href":"/api-reference/purchase-invoices/retrieve-a-purchase-invoice-note"},{"title":"Delete a purchase invoice note","openapi":"DELETE /purchase_invoices/{purchase_invoice_id}/notes/{note_id}","href":"/api-reference/purchase-invoices/delete-a-purchase-invoice-note"},{"title":"List a purchase invoice note's files","openapi":"GET /purchase_invoices/{purchase_invoice_id}/notes/{note_id}/files","href":"/api-reference/purchase-invoices/list-a-purchase-invoice-notes-files"},{"title":"Retrieve a purchase invoice note file","openapi":"GET /purchase_invoices/{purchase_invoice_id}/notes/{note_id}/files/{file_id}","href":"/api-reference/purchase-invoices/retrieve-a-purchase-invoice-note-file"},{"title":"Retrieve a purchase invoice's credit note application","openapi":"GET /purchase_invoices/{purchase_invoice_id}/purchase_credit_note_applications/{application_id}","href":"/api-reference/purchase-invoices/retrieve-a-purchase-invoices-credit-note-application"}]},{"group":"Purchase payments","expanded":false,"pages":[{"title":"Purchase payments","sidebarTitle":"Overview","href":"/purchase-payments"},{"title":"List purchase payments","openapi":"GET /purchase_payments","href":"/api-reference/purchase-payments/list-purchase-payments"},{"title":"Create a purchase payment","openapi":"POST /purchase_payments","href":"/api-reference/purchase-payments/create-a-purchase-payment"},{"title":"Delete a purchase payment","openapi":"DELETE /purchase_payments/{purchase_payment_id}","href":"/api-reference/purchase-payments/delete-a-purchase-payment"},{"title":"Retrieve a purchase payment","openapi":"GET /purchase_payments/{purchase_payment_id}","href":"/api-reference/purchase-payments/retrieve-a-purchase-payment"},{"title":"Update a purchase payment","openapi":"PATCH /purchase_payments/{purchase_payment_id}","href":"/api-reference/purchase-payments/update-a-purchase-payment"},{"title":"Create a purchase payment for a purchase invoice","openapi":"POST /purchase_invoices/{purchase_invoice_id}/purchase_payments","href":"/api-reference/purchase-payments/create-a-purchase-payment-for-a-purchase-invoice"},{"title":"List a purchase payment's notes","openapi":"GET /purchase_payments/{purchase_payment_id}/notes","href":"/api-reference/purchase-payments/list-a-purchase-payments-notes"},{"title":"Create a purchase payment note","openapi":"POST /purchase_payments/{purchase_payment_id}/notes","href":"/api-reference/purchase-payments/create-a-purchase-payment-note"},{"title":"Retrieve a purchase payment note","openapi":"GET /purchase_payments/{purchase_payment_id}/notes/{pp_note_id}","href":"/api-reference/purchase-payments/retrieve-a-purchase-payment-note"},{"title":"Delete a purchase payment note","openapi":"DELETE /purchase_payments/{purchase_payment_id}/notes/{pp_note_id}","href":"/api-reference/purchase-payments/delete-a-purchase-payment-note"},{"title":"List a purchase payment note's files","openapi":"GET /purchase_payments/{purchase_payment_id}/notes/{pp_note_id}/files","href":"/api-reference/purchase-payments/list-a-purchase-payment-notes-files"},{"title":"Retrieve a purchase payment note file","openapi":"GET /purchase_payments/{purchase_payment_id}/notes/{pp_note_id}/files/{file_id}","href":"/api-reference/purchase-payments/retrieve-a-purchase-payment-note-file"},{"title":"List a purchase payment's purchase credit notes","openapi":"GET /purchase_payments/{purchase_payment_id}/purchase_credit_notes","href":"/api-reference/purchase-payments/list-a-purchase-payments-purchase-credit-notes"},{"title":"Update a purchase payment note","openapi":"PATCH /purchase_payments/{purchase_payment_id}/notes/{pp_note_id}","href":"/api-reference/purchase-payments/update-a-purchase-payment-note"},{"title":"Delete a purchase payment note file","openapi":"DELETE /purchase_payments/{purchase_payment_id}/notes/{pp_note_id}/files/{file_id}","href":"/api-reference/purchase-payments/delete-a-purchase-payment-note-file"}]},{"group":"Purchase refunds","expanded":false,"pages":[{"title":"Purchase refunds","sidebarTitle":"Overview","href":"/purchase-refunds"},{"title":"List purchase refunds","openapi":"GET /purchase_refunds","href":"/api-reference/purchase-refunds/list-purchase-refunds"},{"title":"Retrieve a purchase refund","openapi":"GET /purchase_refunds/{purchase_refund_id}","href":"/api-reference/purchase-refunds/retrieve-a-purchase-refund"},{"title":"Create a purchase refund from a purchase credit note","openapi":"POST /purchase_credit_notes/{purchase_credit_note_id}/purchase_refunds","href":"/api-reference/purchase-refunds/create-a-purchase-refund-from-a-purchase-credit-note"},{"title":"Update a purchase refund","openapi":"PATCH /purchase_refunds/{purchase_refund_id}","href":"/api-reference/purchase-refunds/update-a-purchase-refund"},{"title":"Delete a purchase refund","openapi":"DELETE /purchase_refunds/{purchase_refund_id}","href":"/api-reference/purchase-refunds/delete-a-purchase-refund"}]},{"group":"Purchase credit notes","expanded":false,"pages":[{"title":"Purchase credit notes","sidebarTitle":"Overview","href":"/purchase-credit-notes"},{"title":"List purchase credit notes","openapi":"GET /purchase_credit_notes","href":"/api-reference/purchase-credit-notes/list-purchase-credit-notes"},{"title":"Retrieve a purchase credit note","openapi":"GET /purchase_credit_notes/{purchase_credit_note_id}","href":"/api-reference/purchase-credit-notes/retrieve-a-purchase-credit-note"},{"title":"Update a purchase credit note","openapi":"PATCH /purchase_credit_notes/{purchase_credit_note_id}","href":"/api-reference/purchase-credit-notes/update-a-purchase-credit-note"},{"title":"Create a purchase credit note","openapi":"POST /purchase_credit_notes","href":"/api-reference/purchase-credit-notes/create-a-purchase-credit-note"},{"title":"Delete a purchase credit note","openapi":"DELETE /purchase_credit_notes/{purchase_credit_note_id}","href":"/api-reference/purchase-credit-notes/delete-a-purchase-credit-note"},{"title":"Apply a purchase credit note to purchase invoices","openapi":"POST /purchase_credit_notes/{purchase_credit_note_id}/apply","href":"/api-reference/purchase-credit-notes/apply-a-purchase-credit-note-to-purchase-invoices"},{"title":"Add a note to a purchase credit note","openapi":"POST /purchase_credit_notes/{purchase_credit_note_id}/notes","href":"/api-reference/purchase-credit-notes/add-a-note-to-a-purchase-credit-note"},{"title":"Delete a note from a purchase credit note","openapi":"DELETE /purchase_credit_notes/{purchase_credit_note_id}/notes/{note_id}","href":"/api-reference/purchase-credit-notes/delete-a-note-from-a-purchase-credit-note"}]},{"group":"Purchase credit note applications","expanded":false,"pages":[{"title":"Purchase credit note applications","sidebarTitle":"Overview","href":"/purchase-credit-note-applications"},{"title":"List purchase credit note applications","openapi":"GET /purchase_credit_note_applications","href":"/api-reference/purchase-credit-note-applications/list-purchase-credit-note-applications"},{"title":"Retrieve a purchase credit note application","openapi":"GET /purchase_credit_note_applications/{purchase_credit_note_application_id}","href":"/api-reference/purchase-credit-note-applications/retrieve-a-purchase-credit-note-application"}]},{"group":"Purchase express","expanded":false,"pages":[{"title":"Purchase express","sidebarTitle":"Overview","href":"/purchase-express"},{"title":"Create an express purchase order","openapi":"POST /purchase_express","href":"/api-reference/purchase-express/create-an-express-purchase-order"}]},{"group":"Return vendor authorizations","expanded":false,"pages":[{"title":"Return vendor authorizations","sidebarTitle":"Overview","href":"/return-vendor-authorizations"},{"title":"Create a return vendor authorization","openapi":"POST /return_vendor_authorizations","href":"/api-reference/return-vendor-authorizations/create-a-return-vendor-authorization"},{"title":"Delete a draft return vendor authorization","openapi":"DELETE /return_vendor_authorizations/{rva_id}","href":"/api-reference/return-vendor-authorizations/delete-a-draft-return-vendor-authorization"},{"title":"Update a return vendor authorization","openapi":"PATCH /return_vendor_authorizations/{rva_id}","href":"/api-reference/return-vendor-authorizations/update-a-return-vendor-authorization"},{"title":"Delete a return vendor authorization note","openapi":"DELETE /return_vendor_authorizations/{rva_id}/notes/{note_id}","href":"/api-reference/return-vendor-authorizations/delete-a-return-vendor-authorization-note"},{"title":"Delete a return vendor authorization note file","openapi":"DELETE /return_vendor_authorizations/{rva_id}/notes/{note_id}/files/{file_id}","href":"/api-reference/return-vendor-authorizations/delete-a-return-vendor-authorization-note-file"},{"title":"List return vendor authorizations","openapi":"GET /return_vendor_authorizations","href":"/api-reference/return-vendor-authorizations/list-return-vendor-authorizations"},{"title":"Retrieve a return vendor authorization","openapi":"GET /return_vendor_authorizations/{rva_id}","href":"/api-reference/return-vendor-authorizations/retrieve-a-return-vendor-authorization"}]},{"group":"ABA files","expanded":false,"pages":[{"title":"ABA files","sidebarTitle":"Overview","href":"/aba-files"},{"title":"Generate an ABA file","openapi":"POST /aba_file/generate","href":"/api-reference/aba-files/generate-an-aba-file"}]},{"group":"Receive terms","expanded":false,"pages":[{"title":"Receive terms","sidebarTitle":"Overview","href":"/receive-terms"},{"title":"List receive terms","openapi":"GET /settings/receive_terms","href":"/api-reference/receive-terms/list-receive-terms"},{"title":"Create a receive term","openapi":"POST /settings/receive_terms","href":"/api-reference/receive-terms/create-a-receive-term"},{"title":"Retrieve a receive term","openapi":"GET /settings/receive_terms/{receive_term_id}","href":"/api-reference/receive-terms/retrieve-a-receive-term"},{"title":"Delete a receive term","openapi":"DELETE /settings/receive_terms/{receive_term_id}","href":"/api-reference/receive-terms/delete-a-receive-term"},{"title":"Update a receive term","openapi":"PATCH /settings/receive_terms/{receive_term_id}","href":"/api-reference/receive-terms/update-a-receive-term"}]}]},{"group":"Work and people","icon":"briefcase","expanded":false,"pages":[{"group":"Labours","expanded":false,"pages":[{"title":"Labours","sidebarTitle":"Overview","href":"/labours"},{"title":"List labour availability","openapi":"GET /labour_availability","href":"/api-reference/labours/list-labour-availability"},{"title":"List labour profiles","openapi":"GET /labour_profiles","href":"/api-reference/labours/list-labour-profiles"},{"title":"Create a labour profile","openapi":"POST /labour_profiles","href":"/api-reference/labours/create-a-labour-profile"},{"title":"List labours","openapi":"GET /labours","href":"/api-reference/labours/list-labours"},{"title":"Create a labour","openapi":"POST /labours","href":"/api-reference/labours/create-a-labour"},{"title":"Retrieve a labour profile","openapi":"GET /labour_profiles/{labour_profile_id}","href":"/api-reference/labours/retrieve-a-labour-profile"},{"title":"Update a labour profile","openapi":"PATCH /labour_profiles/{labour_profile_id}","href":"/api-reference/labours/update-a-labour-profile"},{"title":"Delete a labour profile","openapi":"DELETE /labour_profiles/{labour_profile_id}","href":"/api-reference/labours/delete-a-labour-profile"},{"title":"List labours available for booking","openapi":"GET /labours/available_for_booking","href":"/api-reference/labours/list-labours-available-for-booking"},{"title":"Update a labour","openapi":"PATCH /labours/{labour_uuid}","href":"/api-reference/labours/update-a-labour"},{"title":"Delete a labour","openapi":"DELETE /labours/{labour_uuid}","href":"/api-reference/labours/delete-a-labour"},{"title":"Retrieve a labour","openapi":"GET /labours/{labour_uuid}","href":"/api-reference/labours/retrieve-a-labour"},{"title":"Cancel a labour","openapi":"POST /labours/{labour_id}/cancel","href":"/api-reference/labours/cancel-a-labour"},{"title":"Reactivate a labour","openapi":"POST /labours/{labour_id}/reactivate","href":"/api-reference/labours/reactivate-a-labour"},{"title":"List a labour's orders","openapi":"GET /labours/{labour_uuid}/orders","href":"/api-reference/labours/list-a-labours-orders"},{"title":"Update labour availability in bulk","openapi":"PATCH /labour_availability","href":"/api-reference/labours/update-labour-availability-in-bulk"},{"title":"List a labour profile's sessions","openapi":"GET /labour_profiles/{labour_profile_id}/sessions","href":"/api-reference/labours/list-a-labour-profiles-sessions"},{"title":"Retrieve a labour profile session","openapi":"GET /labour_profiles/{labour_profile_id}/sessions/{session_id}","href":"/api-reference/labours/retrieve-a-labour-profile-session"},{"title":"Retrieve a labour's availability calendar","openapi":"GET /labours/{labour_id}/availability","href":"/api-reference/labours/retrieve-a-labours-availability-calendar"}]},{"group":"Tasks","expanded":false,"pages":[{"title":"Tasks","sidebarTitle":"Overview","href":"/tasks"},{"title":"List tasks","openapi":"GET /tasks","href":"/api-reference/tasks/list-tasks"},{"title":"Delete a task","openapi":"DELETE /tasks/{task_id}","href":"/api-reference/tasks/delete-a-task"},{"title":"Retrieve a task","openapi":"GET /tasks/{task_id}","href":"/api-reference/tasks/retrieve-a-task"},{"title":"Update a task","openapi":"PATCH /tasks/{task_id}","href":"/api-reference/tasks/update-a-task"},{"title":"List a task's checklist items","openapi":"GET /tasks/{task_id}/checklist","href":"/api-reference/tasks/list-a-tasks-checklist-items"},{"title":"Add checklist items to a task","openapi":"POST /tasks/{task_id}/checklist","href":"/api-reference/tasks/add-checklist-items-to-a-task"},{"title":"List a task's notes","openapi":"GET /tasks/{task_code}/notes","href":"/api-reference/tasks/list-a-tasks-notes"},{"title":"Add a note to a task","openapi":"POST /tasks/{task_code}/notes","href":"/api-reference/tasks/add-a-note-to-a-task"},{"title":"Retrieve a checklist item","openapi":"GET /tasks/{task_id}/checklist/{task_checklist_uuid}","href":"/api-reference/tasks/retrieve-a-checklist-item"},{"title":"Delete a task note","openapi":"DELETE /tasks/{task_code}/notes/{note_id}","href":"/api-reference/tasks/delete-a-task-note"},{"title":"Create a task","openapi":"POST /tasks","href":"/api-reference/tasks/create-a-task"},{"title":"Delete a checklist item","openapi":"DELETE /tasks/{task_id}/checklist/{task_checklist_uuid}","href":"/api-reference/tasks/delete-a-checklist-item"},{"title":"Update a checklist item","openapi":"PATCH /tasks/{task_id}/checklist/{task_checklist_uuid}","href":"/api-reference/tasks/update-a-checklist-item"},{"title":"Delete a task note file","openapi":"DELETE /tasks/{task_code}/notes/{note_id}/files/{file_id}","href":"/api-reference/tasks/delete-a-task-note-file"},{"title":"List a task note's files","openapi":"GET /tasks/{task_code}/notes/{note_id}/files","href":"/api-reference/tasks/list-a-task-notes-files"},{"title":"Retrieve a task note file","openapi":"GET /tasks/{task_code}/notes/{note_id}/files/{file_id}","href":"/api-reference/tasks/retrieve-a-task-note-file"},{"title":"Retrieve a task note","openapi":"GET /tasks/{task_code}/notes/{note_id}","href":"/api-reference/tasks/retrieve-a-task-note"},{"title":"Update a task note","openapi":"PATCH /tasks/{task_code}/notes/{note_id}","href":"/api-reference/tasks/update-a-task-note"}]},{"group":"Timesheets","expanded":false,"pages":[{"title":"Timesheets","sidebarTitle":"Overview","href":"/timesheets"},{"title":"List timesheets","openapi":"GET /timesheets","href":"/api-reference/timesheets/list-timesheets"},{"title":"Create a timesheet","openapi":"POST /timesheets","href":"/api-reference/timesheets/create-a-timesheet"},{"title":"Delete a timesheet","openapi":"DELETE /timesheets/{timesheet_id}","href":"/api-reference/timesheets/delete-a-timesheet"},{"title":"Update a timesheet","openapi":"PATCH /timesheets/{timesheet_id}","href":"/api-reference/timesheets/update-a-timesheet"},{"title":"Retrieve a timesheet","openapi":"GET /timesheets/{timesheet_id}","href":"/api-reference/timesheets/retrieve-a-timesheet"}]},{"group":"Milestones","expanded":false,"pages":[{"title":"Milestones","sidebarTitle":"Overview","href":"/milestones"},{"title":"List milestones","openapi":"GET /milestones","href":"/api-reference/milestones/list-milestones"},{"title":"List an account's milestones","openapi":"GET /milestones/account/{account_id}","href":"/api-reference/milestones/list-an-accounts-milestones"},{"title":"List a labour's milestones","openapi":"GET /milestones/labour/{labour_id}","href":"/api-reference/milestones/list-a-labours-milestones"},{"title":"List an employee's milestones","openapi":"GET /milestones/employee/{employee_code}","href":"/api-reference/milestones/list-an-employees-milestones"},{"title":"Retrieve a milestone","openapi":"GET /milestones/{milestone_uuid}","href":"/api-reference/milestones/retrieve-a-milestone"}]},{"group":"Employees","expanded":false,"pages":[{"title":"Employees","sidebarTitle":"Overview","href":"/employees"},{"title":"List employees","openapi":"GET /employees","href":"/api-reference/employees/list-employees"},{"title":"Create an employee","openapi":"POST /employees","href":"/api-reference/employees/create-an-employee"},{"title":"Delete an employee","openapi":"DELETE /employees/{employee_id}","href":"/api-reference/employees/delete-an-employee"},{"title":"Retrieve an employee","openapi":"GET /employees/{employee_id}","href":"/api-reference/employees/retrieve-an-employee"},{"title":"Update an employee","openapi":"PATCH /employees/{employee_id}","href":"/api-reference/employees/update-an-employee"}]},{"group":"Departments","expanded":false,"pages":[{"title":"Departments","sidebarTitle":"Overview","href":"/departments"},{"title":"List departments","openapi":"GET /settings/departments","href":"/api-reference/departments/list-departments"},{"title":"Retrieve a department","openapi":"GET /settings/departments/{department_id}","href":"/api-reference/departments/retrieve-a-department"}]},{"group":"Designations","expanded":false,"pages":[{"title":"Designations","sidebarTitle":"Overview","href":"/designations"},{"title":"List designations","openapi":"GET /settings/designations","href":"/api-reference/designations/list-designations"},{"title":"Create a designation","openapi":"POST /settings/designations","href":"/api-reference/designations/create-a-designation"},{"title":"Retrieve a designation","openapi":"GET /settings/designations/{designation_id}","href":"/api-reference/designations/retrieve-a-designation"},{"title":"Delete a designation","openapi":"DELETE /settings/designations/{designation_id}","href":"/api-reference/designations/delete-a-designation"},{"title":"Update a designation","openapi":"PATCH /settings/designations/{designation_id}","href":"/api-reference/designations/update-a-designation"}]},{"group":"Teams","expanded":false,"pages":[{"title":"Teams","sidebarTitle":"Overview","href":"/teams"},{"title":"List teams","openapi":"GET /settings/teams","href":"/api-reference/teams/list-teams"},{"title":"Create a team","openapi":"POST /settings/teams","href":"/api-reference/teams/create-a-team"},{"title":"Retrieve a team","openapi":"GET /settings/teams/{team_id}","href":"/api-reference/teams/retrieve-a-team"},{"title":"Delete a team","openapi":"DELETE /settings/teams/{team_id}","href":"/api-reference/teams/delete-a-team"},{"title":"Update a team","openapi":"PATCH /settings/teams/{team_id}","href":"/api-reference/teams/update-a-team"}]},{"group":"Time periods","expanded":false,"pages":[{"title":"Time periods","sidebarTitle":"Overview","href":"/time-periods"},{"title":"List time periods","openapi":"GET /settings/time_periods","href":"/api-reference/time-periods/list-time-periods"},{"title":"Create a time period","openapi":"POST /settings/time_periods","href":"/api-reference/time-periods/create-a-time-period"},{"title":"Retrieve a time period","openapi":"GET /settings/time_periods/{time_period_id}","href":"/api-reference/time-periods/retrieve-a-time-period"},{"title":"Delete a time period","openapi":"DELETE /settings/time_periods/{time_period_id}","href":"/api-reference/time-periods/delete-a-time-period"},{"title":"Update a time period","openapi":"PATCH /settings/time_periods/{time_period_id}","href":"/api-reference/time-periods/update-a-time-period"}]}]},{"group":"Workflows, approvals and alerts","icon":"diagram-project","expanded":false,"pages":[{"group":"Workflows","expanded":false,"pages":[{"title":"Workflows","sidebarTitle":"Overview","href":"/workflows"},{"title":"List workflows","openapi":"GET /workflows","href":"/api-reference/workflows/list-workflows"},{"title":"Retrieve a workflow","openapi":"GET /workflows/{workflow_id}","href":"/api-reference/workflows/retrieve-a-workflow"},{"title":"Create a workflow","openapi":"POST /workflows","href":"/api-reference/workflows/create-a-workflow"},{"title":"Update a workflow","openapi":"PATCH /workflows/{workflow_id}","href":"/api-reference/workflows/update-a-workflow"},{"title":"Delete a workflow","openapi":"DELETE /workflows/{workflow_id}","href":"/api-reference/workflows/delete-a-workflow"},{"title":"List a workflow's stages","openapi":"GET /workflows/{workflow_id}/stages","href":"/api-reference/workflows/list-a-workflows-stages"},{"title":"Retrieve a workflow stage","openapi":"GET /workflows/{workflow_id}/stages/{stage_id}","href":"/api-reference/workflows/retrieve-a-workflow-stage"},{"title":"List a workflow's milestones","openapi":"GET /workflows/{workflow_uuid}/milestones","href":"/api-reference/workflows/list-a-workflows-milestones"},{"title":"Retrieve a workflow milestone","openapi":"GET /workflows/{workflow_id}/milestones/{milestone_id}","href":"/api-reference/workflows/retrieve-a-workflow-milestone"},{"title":"Delete a milestone","openapi":"DELETE /milestones/{milestone_uuid}","href":"/api-reference/workflows/delete-a-milestone"},{"title":"List a component instance's workflow history","openapi":"GET /workflows/custom_components/{component_uuid}/{object_code}/history","href":"/api-reference/workflows/list-a-component-instances-workflow-history"},{"title":"List a component instance's milestones","openapi":"GET /workflows/custom_components/{component_uuid}/{object_code}/milestones","href":"/api-reference/workflows/list-a-component-instances-milestones"},{"title":"Retrieve a component instance's milestone","openapi":"GET /workflows/custom_components/{component_uuid}/{object_code}/milestones/{milestone_id}","href":"/api-reference/workflows/retrieve-a-component-instances-milestone"},{"title":"List a component instance's workflow history by instance code","openapi":"GET /workflow/component/{component_object_id}/history","href":"/api-reference/workflows/list-a-component-instances-workflow-history-by-instance-code"},{"title":"List a component instance's milestones by settings uuid","openapi":"GET /workflow/component/{component_uuid}/{component_object_id}/milestone","href":"/api-reference/workflows/list-a-component-instances-milestones-by-settings-uuid"}]},{"group":"Workflow settings","expanded":false,"pages":[{"title":"Workflow settings","sidebarTitle":"Overview","href":"/workflow-settings"},{"title":"List workflows (settings path)","openapi":"GET /settings/workflows","href":"/api-reference/workflow-settings/list-workflows-settings-path"},{"title":"Retrieve a workflow (settings path)","openapi":"GET /settings/workflows/{workflow_id}","href":"/api-reference/workflow-settings/retrieve-a-workflow-settings-path"}]},{"group":"Events","expanded":false,"pages":[{"title":"Events","sidebarTitle":"Overview","href":"/events"},{"title":"List events","openapi":"GET /events","href":"/api-reference/events/list-events"},{"title":"Retrieve an event","openapi":"GET /events/{event_uuid}","href":"/api-reference/events/retrieve-an-event"},{"title":"Execute an event","openapi":"POST /events/{event_uuid}/execute","href":"/api-reference/events/execute-an-event"},{"title":"Remove an event","openapi":"POST /events/{event_uuid}/remove","href":"/api-reference/events/remove-an-event"}]},{"group":"Custom events","expanded":false,"pages":[{"title":"Custom events","sidebarTitle":"Overview","href":"/custom-events"},{"title":"List custom events","openapi":"GET /settings/custom_events","href":"/api-reference/custom-events/list-custom-events"},{"title":"Create a custom event","openapi":"POST /settings/custom_events","href":"/api-reference/custom-events/create-a-custom-event"},{"title":"Retrieve a custom event","openapi":"GET /settings/custom_events/{custom_event_id}","href":"/api-reference/custom-events/retrieve-a-custom-event"},{"title":"Delete a custom event","openapi":"DELETE /settings/custom_events/{custom_event_id}","href":"/api-reference/custom-events/delete-a-custom-event"},{"title":"Update a custom event","openapi":"PATCH /settings/custom_events/{custom_event_id}","href":"/api-reference/custom-events/update-a-custom-event"}]},{"group":"System events","expanded":false,"pages":[{"title":"System events","sidebarTitle":"Overview","href":"/system-events"},{"title":"List system events","openapi":"GET /settings/system_events","href":"/api-reference/system-events/list-system-events"},{"title":"Retrieve a system event","openapi":"GET /settings/system_events/{system_event_id}","href":"/api-reference/system-events/retrieve-a-system-event"}]},{"group":"Approvals","expanded":false,"pages":[{"title":"Approvals","sidebarTitle":"Overview","href":"/approvals"},{"title":"List account approvals","openapi":"GET /approvals/account","href":"/api-reference/approvals/list-account-approvals"},{"title":"List sale order approvals","openapi":"GET /approvals/saleOrder","href":"/api-reference/approvals/list-sale-order-approvals"},{"title":"Retrieve an account approval","openapi":"GET /approvals/account/{account_uuid}","href":"/api-reference/approvals/retrieve-an-account-approval"},{"title":"Approve a pending approval","openapi":"POST /approvals/approve","href":"/api-reference/approvals/approve-a-pending-approval"},{"title":"Reject a pending approval","openapi":"POST /approvals/reject","href":"/api-reference/approvals/reject-a-pending-approval"}]},{"group":"Approval profiles","expanded":false,"pages":[{"title":"Approval profiles","sidebarTitle":"Overview","href":"/approval-profiles"},{"title":"List approval profiles","openapi":"GET /settings/approval_profiles","href":"/api-reference/approval-profiles/list-approval-profiles"},{"title":"Create an approval profile","openapi":"POST /settings/approval_profiles","href":"/api-reference/approval-profiles/create-an-approval-profile"},{"title":"Retrieve an approval profile","openapi":"GET /settings/approval_profiles/{approval_profile_id}","href":"/api-reference/approval-profiles/retrieve-an-approval-profile"},{"title":"Delete an approval profile","openapi":"DELETE /settings/approval_profiles/{approval_profile_id}","href":"/api-reference/approval-profiles/delete-an-approval-profile"},{"title":"Update an approval profile","openapi":"PATCH /settings/approval_profiles/{approval_profile_id}","href":"/api-reference/approval-profiles/update-an-approval-profile"}]},{"group":"Approval user groups","expanded":false,"pages":[{"title":"Approval user groups","sidebarTitle":"Overview","href":"/approval-user-groups"},{"title":"List approval user groups","openapi":"GET /settings/approval_user_groups","href":"/api-reference/approval-user-groups/list-approval-user-groups"},{"title":"Create an approval user group","openapi":"POST /settings/approval_user_groups","href":"/api-reference/approval-user-groups/create-an-approval-user-group"},{"title":"Retrieve an approval user group","openapi":"GET /settings/approval_user_groups/{approval_user_group_id}","href":"/api-reference/approval-user-groups/retrieve-an-approval-user-group"},{"title":"Delete an approval user group","openapi":"DELETE /settings/approval_user_groups/{approval_user_group_id}","href":"/api-reference/approval-user-groups/delete-an-approval-user-group"},{"title":"Update an approval user group","openapi":"PATCH /settings/approval_user_groups/{approval_user_group_id}","href":"/api-reference/approval-user-groups/update-an-approval-user-group"}]},{"group":"Alerts","expanded":false,"pages":[{"title":"Alerts","sidebarTitle":"Overview","href":"/alerts"},{"title":"List alerts","openapi":"GET /alerts","href":"/api-reference/alerts/list-alerts"},{"title":"Retrieve an alert","openapi":"GET /alerts/{alert_id}","href":"/api-reference/alerts/retrieve-an-alert"},{"title":"List an account's alerts","openapi":"GET /alerts/account/{account_id}","href":"/api-reference/alerts/list-an-accounts-alerts"},{"title":"List an employee's alerts","openapi":"GET /alerts/employee/{employee_id}","href":"/api-reference/alerts/list-an-employees-alerts"},{"title":"List a labour's alerts","openapi":"GET /alerts/labour/{labour_id}","href":"/api-reference/alerts/list-a-labours-alerts"}]},{"group":"Alert responsibility settings","expanded":false,"pages":[{"title":"Alert responsibility settings","sidebarTitle":"Overview","href":"/alert-responsibility-settings"},{"title":"List alert responsibilities (settings path)","openapi":"GET /settings/alert_responsibilities","href":"/api-reference/alert-responsibility-settings/list-alert-responsibilities-settings-path"},{"title":"Create an alert responsibility (settings path)","openapi":"POST /settings/alert_responsibilities","href":"/api-reference/alert-responsibility-settings/create-an-alert-responsibility-settings-path"},{"title":"Retrieve an alert responsibility (settings path)","openapi":"GET /settings/alert_responsibilities/{alert_responsibility_id}","href":"/api-reference/alert-responsibility-settings/retrieve-an-alert-responsibility-settings-path"},{"title":"Delete an alert responsibility (settings path)","openapi":"DELETE /settings/alert_responsibilities/{alert_responsibility_id}","href":"/api-reference/alert-responsibility-settings/delete-an-alert-responsibility-settings-path"},{"title":"Update an alert responsibility (settings path)","openapi":"PATCH /settings/alert_responsibilities/{alert_responsibility_id}","href":"/api-reference/alert-responsibility-settings/update-an-alert-responsibility-settings-path"}]},{"group":"Alert responsibilities","expanded":false,"pages":[{"title":"Alert responsibilities","sidebarTitle":"Overview","href":"/alert-responsibilities"},{"title":"List alert responsibilities","openapi":"GET /alert_responsibility","href":"/api-reference/alert-responsibilities/list-alert-responsibilities"},{"title":"Retrieve an alert responsibility","openapi":"GET /alert_responsibility/{alert_responsibility_id}","href":"/api-reference/alert-responsibilities/retrieve-an-alert-responsibility"},{"title":"Create an alert responsibility","openapi":"POST /alert_responsibility","href":"/api-reference/alert-responsibilities/create-an-alert-responsibility"},{"title":"Update an alert responsibility","openapi":"PATCH /alert_responsibility/{alert_responsibility_id}","href":"/api-reference/alert-responsibilities/update-an-alert-responsibility"},{"title":"Delete an alert responsibility","openapi":"DELETE /alert_responsibility/{alert_responsibility_id}","href":"/api-reference/alert-responsibilities/delete-an-alert-responsibility"}]},{"group":"Action scripts","expanded":false,"pages":[{"title":"Action scripts","sidebarTitle":"Overview","href":"/action-scripts"},{"title":"List action scripts","openapi":"GET /action_scripts","href":"/api-reference/action-scripts/list-action-scripts"},{"title":"Retrieve an action script","openapi":"GET /action_scripts/{action_script_id}","href":"/api-reference/action-scripts/retrieve-an-action-script"},{"title":"Create an action script","openapi":"POST /action_scripts","href":"/api-reference/action-scripts/create-an-action-script"},{"title":"Update an action script","openapi":"PATCH /action_scripts/{action_script_id}","href":"/api-reference/action-scripts/update-an-action-script"},{"title":"Delete an action script","openapi":"DELETE /action_scripts/{action_script_id}","href":"/api-reference/action-scripts/delete-an-action-script"}]},{"group":"Note groups","expanded":false,"pages":[{"title":"Note groups","sidebarTitle":"Overview","href":"/note-groups"},{"title":"List note groups","openapi":"GET /note_groups","href":"/api-reference/note-groups/list-note-groups"},{"title":"Create a note group","openapi":"POST /note_groups","href":"/api-reference/note-groups/create-a-note-group"},{"title":"Delete a note group","openapi":"DELETE /note_groups/{note_group_id}","href":"/api-reference/note-groups/delete-a-note-group"},{"title":"Retrieve a note group","openapi":"GET /note_groups/{note_group_id}","href":"/api-reference/note-groups/retrieve-a-note-group"},{"title":"Update a note group","openapi":"PATCH /note_groups/{note_group_id}","href":"/api-reference/note-groups/update-a-note-group"},{"title":"List a note group's notes","openapi":"GET /note_groups/{note_group_id}/notes","href":"/api-reference/note-groups/list-a-note-groups-notes"},{"title":"List a note group's notes for a user","openapi":"GET /note_groups/{note_group_id}/notes/user/{note_user}","href":"/api-reference/note-groups/list-a-note-groups-notes-for-a-user"}]},{"group":"Note attachments","expanded":false,"pages":[{"title":"Note attachments","sidebarTitle":"Overview","href":"/note-attachments"},{"title":"Retrieve a note attachment","openapi":"GET /note_attachment/{attachment_uuid}","href":"/api-reference/note-attachments/retrieve-a-note-attachment"}]}]},{"group":"Settings","icon":"sliders","expanded":false,"pages":[{"group":"Instance settings","expanded":false,"pages":[{"title":"Instance settings","sidebarTitle":"Overview","href":"/instance-settings"},{"title":"List custom objects","openapi":"GET /custom_objects","href":"/api-reference/instance-settings/list-custom-objects"},{"title":"List settings areas","openapi":"GET /settings","href":"/api-reference/instance-settings/list-settings-areas"},{"title":"Retrieve a custom object","openapi":"GET /custom_objects/{custom_object_id}","href":"/api-reference/instance-settings/retrieve-a-custom-object"},{"title":"List currencies","openapi":"GET /settings/currencies","href":"/api-reference/instance-settings/list-currencies"},{"title":"List custom logic scripts","openapi":"GET /settings/custom_logic_scripts","href":"/api-reference/instance-settings/list-custom-logic-scripts"},{"title":"Create a custom object in settings","openapi":"POST /settings/custom_objects","href":"/api-reference/instance-settings/create-a-custom-object-in-settings"},{"title":"List discount profiles","openapi":"GET /settings/discount_profiles","href":"/api-reference/instance-settings/list-discount-profiles"},{"title":"List item groups","openapi":"GET /settings/item_groups","href":"/api-reference/instance-settings/list-item-groups"},{"title":"Create an item group","openapi":"POST /settings/item_groups","href":"/api-reference/instance-settings/create-an-item-group"},{"title":"List payment processors","openapi":"GET /settings/payment_processors","href":"/api-reference/instance-settings/list-payment-processors"},{"title":"List payment terms","openapi":"GET /settings/payment_terms","href":"/api-reference/instance-settings/list-payment-terms"},{"title":"List pricing levels","openapi":"GET /settings/pricing_levels","href":"/api-reference/instance-settings/list-pricing-levels"},{"title":"List shipping profiles","openapi":"GET /settings/shipping_profiles","href":"/api-reference/instance-settings/list-shipping-profiles"},{"title":"List taxes","openapi":"GET /settings/taxes","href":"/api-reference/instance-settings/list-taxes"},{"title":"List time zones","openapi":"GET /settings/time_zones","href":"/api-reference/instance-settings/list-time-zones"},{"title":"List variations","openapi":"GET /settings/variations","href":"/api-reference/instance-settings/list-variations"},{"title":"Create a variation","openapi":"POST /settings/variations","href":"/api-reference/instance-settings/create-a-variation"},{"title":"List warehouses","openapi":"GET /settings/warehouses","href":"/api-reference/instance-settings/list-warehouses"},{"title":"Retrieve a currency","openapi":"GET /settings/currencies/{currency_id}","href":"/api-reference/instance-settings/retrieve-a-currency"},{"title":"Retrieve a custom logic script","openapi":"GET /settings/custom_logic_scripts/{custom_logic_script_id}","href":"/api-reference/instance-settings/retrieve-a-custom-logic-script"},{"title":"Delete a custom object in settings","openapi":"DELETE /settings/custom_objects/{custom_object_id}","href":"/api-reference/instance-settings/delete-a-custom-object-in-settings"},{"title":"Update a custom object in settings","openapi":"PATCH /settings/custom_objects/{custom_object_id}","href":"/api-reference/instance-settings/update-a-custom-object-in-settings"},{"title":"Update account field settings","openapi":"PATCH /settings/field_settings/account","href":"/api-reference/instance-settings/update-account-field-settings"},{"title":"Update item field settings","openapi":"PATCH /settings/field_settings/item","href":"/api-reference/instance-settings/update-item-field-settings"},{"title":"Update account general settings","openapi":"PATCH /settings/general_settings/account","href":"/api-reference/instance-settings/update-account-general-settings"},{"title":"Update item general settings","openapi":"PATCH /settings/general_settings/item","href":"/api-reference/instance-settings/update-item-general-settings"},{"title":"Delete an item group","openapi":"DELETE /settings/item_groups/{item_group_id}","href":"/api-reference/instance-settings/delete-an-item-group"},{"title":"Retrieve an item group","openapi":"GET /settings/item_groups/{item_group_id}","href":"/api-reference/instance-settings/retrieve-an-item-group"},{"title":"Update an item group","openapi":"PATCH /settings/item_groups/{item_group_id}","href":"/api-reference/instance-settings/update-an-item-group"},{"title":"Retrieve a time zone","openapi":"GET /settings/time_zones/{time_zone_id}","href":"/api-reference/instance-settings/retrieve-a-time-zone"},{"title":"Retrieve a variation","openapi":"GET /settings/variations/{variation_id}","href":"/api-reference/instance-settings/retrieve-a-variation"},{"title":"Update a variation","openapi":"PATCH /settings/variations/{variation_id}","href":"/api-reference/instance-settings/update-a-variation"},{"title":"Customise a custom object's attributes","openapi":"POST /settings/custom_objects/{custom_object_id}/customize","href":"/api-reference/instance-settings/customise-a-custom-objects-attributes"},{"title":"Update an item group's billing preferences","openapi":"POST /settings/item_groups/{item_group_id}/billing_preferences","href":"/api-reference/instance-settings/update-an-item-groups-billing-preferences"},{"title":"List enabled custom objects","openapi":"GET /settings/custom_objects","href":"/api-reference/instance-settings/list-enabled-custom-objects"},{"title":"Retrieve a custom object from settings","openapi":"GET /settings/custom_objects/{custom_object_id}","href":"/api-reference/instance-settings/retrieve-a-custom-object-from-settings"},{"title":"Create a custom object","openapi":"POST /custom_objects","href":"/api-reference/instance-settings/create-a-custom-object"},{"title":"Update a custom object","openapi":"PATCH /custom_objects/{custom_object_id}","href":"/api-reference/instance-settings/update-a-custom-object"},{"title":"Delete a custom object","openapi":"DELETE /custom_objects/{custom_object_id}","href":"/api-reference/instance-settings/delete-a-custom-object"},{"title":"Create a currency","openapi":"POST /settings/currencies","href":"/api-reference/instance-settings/create-a-currency"},{"title":"Update a currency","openapi":"PATCH /settings/currencies/{currency_id}","href":"/api-reference/instance-settings/update-a-currency"},{"title":"Create a custom logic script","openapi":"POST /settings/custom_logic_scripts","href":"/api-reference/instance-settings/create-a-custom-logic-script"},{"title":"Update a custom logic script","openapi":"PATCH /settings/custom_logic_scripts/{custom_logic_script_id}","href":"/api-reference/instance-settings/update-a-custom-logic-script"},{"title":"Delete a custom logic script","openapi":"DELETE /settings/custom_logic_scripts/{custom_logic_script_id}","href":"/api-reference/instance-settings/delete-a-custom-logic-script"},{"title":"Create a discount profile","openapi":"POST /settings/discount_profiles","href":"/api-reference/instance-settings/create-a-discount-profile"},{"title":"Retrieve a discount profile","openapi":"GET /settings/discount_profiles/{discount_profile_id}","href":"/api-reference/instance-settings/retrieve-a-discount-profile"},{"title":"Update a discount profile","openapi":"PATCH /settings/discount_profiles/{discount_profile_id}","href":"/api-reference/instance-settings/update-a-discount-profile"},{"title":"Delete a discount profile","openapi":"DELETE /settings/discount_profiles/{discount_profile_id}","href":"/api-reference/instance-settings/delete-a-discount-profile"},{"title":"List field settings","openapi":"GET /settings/field_settings","href":"/api-reference/instance-settings/list-field-settings"},{"title":"Retrieve a field setting","openapi":"GET /settings/field_settings/{field_setting_id}","href":"/api-reference/instance-settings/retrieve-a-field-setting"},{"title":"Retrieve a general settings group","openapi":"GET /settings/general_settings/{group}","href":"/api-reference/instance-settings/retrieve-a-general-settings-group"},{"title":"Retrieve a general setting","openapi":"GET /settings/general_settings/{group}/{general_setting_id}","href":"/api-reference/instance-settings/retrieve-a-general-setting"},{"title":"Update dashboard general settings","openapi":"PATCH /settings/general_settings/dashboard","href":"/api-reference/instance-settings/update-dashboard-general-settings"},{"title":"Update date and time general settings","openapi":"PATCH /settings/general_settings/date_and_time","href":"/api-reference/instance-settings/update-date-and-time-general-settings"},{"title":"Update display general settings","openapi":"PATCH /settings/general_settings/display","href":"/api-reference/instance-settings/update-display-general-settings"},{"title":"Update the general group of general settings","openapi":"PATCH /settings/general_settings/general","href":"/api-reference/instance-settings/update-the-general-group-of-general-settings"},{"title":"Update labour general settings","openapi":"PATCH /settings/general_settings/labour","href":"/api-reference/instance-settings/update-labour-general-settings"},{"title":"Update order general settings","openapi":"PATCH /settings/general_settings/order","href":"/api-reference/instance-settings/update-order-general-settings"},{"title":"Update portal general settings","openapi":"PATCH /settings/general_settings/portal","href":"/api-reference/instance-settings/update-portal-general-settings"},{"title":"Update purchase general settings","openapi":"PATCH /settings/general_settings/purchase","href":"/api-reference/instance-settings/update-purchase-general-settings"},{"title":"Update security general settings","openapi":"PATCH /settings/general_settings/security","href":"/api-reference/instance-settings/update-security-general-settings"},{"title":"Update transaction general settings","openapi":"PATCH /settings/general_settings/transaction","href":"/api-reference/instance-settings/update-transaction-general-settings"},{"title":"Create a payment processor","openapi":"POST /settings/payment_processors","href":"/api-reference/instance-settings/create-a-payment-processor"},{"title":"Retrieve a payment processor","openapi":"GET /settings/payment_processors/{payment_processor_id}","href":"/api-reference/instance-settings/retrieve-a-payment-processor"},{"title":"Update a payment processor","openapi":"PATCH /settings/payment_processors/{payment_processor_id}","href":"/api-reference/instance-settings/update-a-payment-processor"},{"title":"Delete a payment processor","openapi":"DELETE /settings/payment_processors/{payment_processor_id}","href":"/api-reference/instance-settings/delete-a-payment-processor"},{"title":"Create a payment term","openapi":"POST /settings/payment_terms","href":"/api-reference/instance-settings/create-a-payment-term"},{"title":"Retrieve a payment term","openapi":"GET /settings/payment_terms/{payment_term_id}","href":"/api-reference/instance-settings/retrieve-a-payment-term"},{"title":"Update a payment term","openapi":"PATCH /settings/payment_terms/{payment_term_id}","href":"/api-reference/instance-settings/update-a-payment-term"},{"title":"Delete a payment term","openapi":"DELETE /settings/payment_terms/{payment_term_id}","href":"/api-reference/instance-settings/delete-a-payment-term"},{"title":"Create a pricing level","openapi":"POST /settings/pricing_levels","href":"/api-reference/instance-settings/create-a-pricing-level"},{"title":"Retrieve a pricing level","openapi":"GET /settings/pricing_levels/{pricing_level_id}","href":"/api-reference/instance-settings/retrieve-a-pricing-level"},{"title":"Update a pricing level","openapi":"PATCH /settings/pricing_levels/{pricing_level_id}","href":"/api-reference/instance-settings/update-a-pricing-level"},{"title":"Delete a pricing level","openapi":"DELETE /settings/pricing_levels/{pricing_level_id}","href":"/api-reference/instance-settings/delete-a-pricing-level"},{"title":"Create a shipping profile","openapi":"POST /settings/shipping_profiles","href":"/api-reference/instance-settings/create-a-shipping-profile"},{"title":"Retrieve a shipping profile","openapi":"GET /settings/shipping_profiles/{shipping_profile_id}","href":"/api-reference/instance-settings/retrieve-a-shipping-profile"},{"title":"Update a shipping profile","openapi":"PATCH /settings/shipping_profiles/{shipping_profile_id}","href":"/api-reference/instance-settings/update-a-shipping-profile"},{"title":"Delete a shipping profile","openapi":"DELETE /settings/shipping_profiles/{shipping_profile_id}","href":"/api-reference/instance-settings/delete-a-shipping-profile"},{"title":"Create a warehouse","openapi":"POST /settings/warehouses","href":"/api-reference/instance-settings/create-a-warehouse"},{"title":"Retrieve a warehouse","openapi":"GET /settings/warehouses/{warehouse_id}","href":"/api-reference/instance-settings/retrieve-a-warehouse"},{"title":"Update a warehouse","openapi":"PATCH /settings/warehouses/{warehouse_id}","href":"/api-reference/instance-settings/update-a-warehouse"},{"title":"Delete a warehouse","openapi":"DELETE /settings/warehouses/{warehouse_id}","href":"/api-reference/instance-settings/delete-a-warehouse"},{"title":"Create a tax","openapi":"POST /settings/taxes","href":"/api-reference/instance-settings/create-a-tax"},{"title":"Retrieve a tax","openapi":"GET /settings/taxes/{tax_id}","href":"/api-reference/instance-settings/retrieve-a-tax"},{"title":"Update a tax","openapi":"PATCH /settings/taxes/{tax_id}","href":"/api-reference/instance-settings/update-a-tax"},{"title":"Delete a variation","openapi":"DELETE /settings/variations/{variation_id}","href":"/api-reference/instance-settings/delete-a-variation"}]},{"group":"Accounting codes","expanded":false,"pages":[{"title":"Accounting codes","sidebarTitle":"Overview","href":"/accounting-codes"},{"title":"List accounting codes","openapi":"GET /settings/accounting_codes","href":"/api-reference/accounting-codes/list-accounting-codes"},{"title":"Create an accounting code","openapi":"POST /settings/accounting_codes","href":"/api-reference/accounting-codes/create-an-accounting-code"},{"title":"Retrieve an accounting code","openapi":"GET /settings/accounting_codes/{accounting_code_id}","href":"/api-reference/accounting-codes/retrieve-an-accounting-code"},{"title":"Delete an accounting code","openapi":"DELETE /settings/accounting_codes/{accounting_code_id}","href":"/api-reference/accounting-codes/delete-an-accounting-code"},{"title":"Update an accounting code","openapi":"PATCH /settings/accounting_codes/{accounting_code_id}","href":"/api-reference/accounting-codes/update-an-accounting-code"}]},{"group":"Additional codes","expanded":false,"pages":[{"title":"Additional codes","sidebarTitle":"Overview","href":"/additional-codes"},{"title":"List additional codes","openapi":"GET /settings/additional_codes","href":"/api-reference/additional-codes/list-additional-codes"},{"title":"Create an additional code","openapi":"POST /settings/additional_codes","href":"/api-reference/additional-codes/create-an-additional-code"},{"title":"Retrieve an additional code","openapi":"GET /settings/additional_codes/{additional_code_id}","href":"/api-reference/additional-codes/retrieve-an-additional-code"},{"title":"Delete an additional code","openapi":"DELETE /settings/additional_codes/{additional_code_id}","href":"/api-reference/additional-codes/delete-an-additional-code"},{"title":"Update an additional code","openapi":"PATCH /settings/additional_codes/{additional_code_id}","href":"/api-reference/additional-codes/update-an-additional-code"}]},{"group":"Billing periods","expanded":false,"pages":[{"title":"Billing periods","sidebarTitle":"Overview","href":"/billing-periods"},{"title":"List billing periods","openapi":"GET /settings/billing_periods","href":"/api-reference/billing-periods/list-billing-periods"},{"title":"Create a billing period","openapi":"POST /settings/billing_periods","href":"/api-reference/billing-periods/create-a-billing-period"},{"title":"Retrieve a billing period","openapi":"GET /settings/billing_periods/{billing_period_id}","href":"/api-reference/billing-periods/retrieve-a-billing-period"},{"title":"Delete a billing period","openapi":"DELETE /settings/billing_periods/{billing_period_id}","href":"/api-reference/billing-periods/delete-a-billing-period"},{"title":"Update a billing period","openapi":"PATCH /settings/billing_periods/{billing_period_id}","href":"/api-reference/billing-periods/update-a-billing-period"}]},{"group":"Charging periods","expanded":false,"pages":[{"title":"Charging periods","sidebarTitle":"Overview","href":"/charging-periods"},{"title":"List charging periods","openapi":"GET /settings/charging_periods","href":"/api-reference/charging-periods/list-charging-periods"},{"title":"Create a charging period","openapi":"POST /settings/charging_periods","href":"/api-reference/charging-periods/create-a-charging-period"},{"title":"Retrieve a charging period","openapi":"GET /settings/charging_periods/{charging_period_id}","href":"/api-reference/charging-periods/retrieve-a-charging-period"},{"title":"Delete a charging period","openapi":"DELETE /settings/charging_periods/{charging_period_id}","href":"/api-reference/charging-periods/delete-a-charging-period"},{"title":"Update a charging period","openapi":"PATCH /settings/charging_periods/{charging_period_id}","href":"/api-reference/charging-periods/update-a-charging-period"}]},{"group":"Pricing periods","expanded":false,"pages":[{"title":"Pricing periods","sidebarTitle":"Overview","href":"/pricing-periods"},{"title":"List pricing periods","openapi":"GET /settings/pricing_periods","href":"/api-reference/pricing-periods/list-pricing-periods"},{"title":"Create a pricing period","openapi":"POST /settings/pricing_periods","href":"/api-reference/pricing-periods/create-a-pricing-period"},{"title":"Retrieve a pricing period","openapi":"GET /settings/pricing_periods/{pricing_period_id}","href":"/api-reference/pricing-periods/retrieve-a-pricing-period"},{"title":"Delete a pricing period","openapi":"DELETE /settings/pricing_periods/{pricing_period_id}","href":"/api-reference/pricing-periods/delete-a-pricing-period"},{"title":"Update a pricing period","openapi":"PATCH /settings/pricing_periods/{pricing_period_id}","href":"/api-reference/pricing-periods/update-a-pricing-period"}]},{"group":"Invoice terms","expanded":false,"pages":[{"title":"Invoice terms","sidebarTitle":"Overview","href":"/invoice-terms"},{"title":"List invoice terms","openapi":"GET /settings/invoice_terms","href":"/api-reference/invoice-terms/list-invoice-terms"},{"title":"Create an invoice term","openapi":"POST /settings/invoice_terms","href":"/api-reference/invoice-terms/create-an-invoice-term"},{"title":"Retrieve an invoice term","openapi":"GET /settings/invoice_terms/{invoice_term_id}","href":"/api-reference/invoice-terms/retrieve-an-invoice-term"},{"title":"Delete an invoice term","openapi":"DELETE /settings/invoice_terms/{invoice_term_id}","href":"/api-reference/invoice-terms/delete-an-invoice-term"},{"title":"Update an invoice term","openapi":"PATCH /settings/invoice_terms/{invoice_term_id}","href":"/api-reference/invoice-terms/update-an-invoice-term"}]},{"group":"Days of the month","expanded":false,"pages":[{"title":"Days of the month","sidebarTitle":"Overview","href":"/days-of-the-month"},{"title":"List days of the month","description":"Returns a page of the days of the month a date can be aligned to, under `data`.","openapi":"GET /settings/day_of_month","href":"/api-reference/days-of-the-month/list-days-of-the-month"},{"title":"Retrieve a day of the month","openapi":"GET /settings/day_of_month/{day_of_month_id}","href":"/api-reference/days-of-the-month/retrieve-a-day-of-the-month"}]},{"group":"Countries","expanded":false,"pages":[{"title":"Countries","sidebarTitle":"Overview","description":"List and read countries, and update a country's status, description and default address fields.","href":"/countries"},{"title":"List countries","openapi":"GET /settings/countries","href":"/api-reference/countries/list-countries"},{"title":"Retrieve a country","openapi":"GET /settings/countries/{country_id}","href":"/api-reference/countries/retrieve-a-country"},{"title":"Update a country","openapi":"PATCH /settings/countries/{country_id}","href":"/api-reference/countries/update-a-country"}]},{"group":"Salutations","expanded":false,"pages":[{"title":"Salutations","sidebarTitle":"Overview","href":"/salutations"},{"title":"List salutations","openapi":"GET /settings/salutations","href":"/api-reference/salutations/list-salutations"},{"title":"Create a salutation","openapi":"POST /settings/salutations","href":"/api-reference/salutations/create-a-salutation"},{"title":"Retrieve a salutation","openapi":"GET /settings/salutations/{salutation_id}","href":"/api-reference/salutations/retrieve-a-salutation"},{"title":"Delete a salutation","openapi":"DELETE /settings/salutations/{salutation_id}","href":"/api-reference/salutations/delete-a-salutation"},{"title":"Update a salutation","openapi":"PATCH /settings/salutations/{salutation_id}","href":"/api-reference/salutations/update-a-salutation"}]},{"group":"Document templates","expanded":false,"pages":[{"title":"Document templates","sidebarTitle":"Overview","href":"/document-templates"},{"title":"List document templates","openapi":"GET /settings/document_templates","href":"/api-reference/document-templates/list-document-templates"},{"title":"Create a document template","openapi":"POST /settings/document_templates","href":"/api-reference/document-templates/create-a-document-template"},{"title":"Retrieve a document template","openapi":"GET /settings/document_templates/{document_template_id}","href":"/api-reference/document-templates/retrieve-a-document-template"},{"title":"Delete a document template","openapi":"DELETE /settings/document_templates/{document_template_id}","href":"/api-reference/document-templates/delete-a-document-template"},{"title":"Update a document template","openapi":"PATCH /settings/document_templates/{document_template_id}","href":"/api-reference/document-templates/update-a-document-template"}]},{"group":"Email templates","expanded":false,"pages":[{"title":"Email templates","sidebarTitle":"Overview","href":"/email-templates"},{"title":"List email templates","openapi":"GET /settings/email_templates","href":"/api-reference/email-templates/list-email-templates"},{"title":"Create an email template","openapi":"POST /settings/email_templates","href":"/api-reference/email-templates/create-an-email-template"},{"title":"Retrieve an email template","openapi":"GET /settings/email_templates/{email_template_id}","href":"/api-reference/email-templates/retrieve-an-email-template"},{"title":"Delete an email template","openapi":"DELETE /settings/email_templates/{email_template_id}","href":"/api-reference/email-templates/delete-an-email-template"},{"title":"Update an email template","openapi":"PATCH /settings/email_templates/{email_template_id}","href":"/api-reference/email-templates/update-an-email-template"}]},{"group":"Roles","expanded":false,"pages":[{"title":"Roles","sidebarTitle":"Overview","href":"/roles"},{"title":"List roles","openapi":"GET /settings/roles","href":"/api-reference/roles/list-roles"},{"title":"Create a role","openapi":"POST /settings/roles","href":"/api-reference/roles/create-a-role"},{"title":"Retrieve a role","openapi":"GET /settings/roles/{role_id}","href":"/api-reference/roles/retrieve-a-role"},{"title":"Delete a role","openapi":"DELETE /settings/roles/{role_id}","href":"/api-reference/roles/delete-a-role"},{"title":"Update a role","openapi":"PATCH /settings/roles/{role_id}","href":"/api-reference/roles/update-a-role"}]},{"group":"Operators","expanded":false,"pages":[{"title":"Operators","sidebarTitle":"Overview","href":"/operators"},{"title":"List operators","openapi":"GET /settings/operators","href":"/api-reference/operators/list-operators"},{"title":"Create an operator","openapi":"POST /settings/operators","href":"/api-reference/operators/create-an-operator"},{"title":"Retrieve an operator","openapi":"GET /settings/operators/{operator_id}","href":"/api-reference/operators/retrieve-an-operator"},{"title":"Update an operator","openapi":"PATCH /settings/operators/{operator_id}","href":"/api-reference/operators/update-an-operator"}]},{"group":"Operator groups","expanded":false,"pages":[{"title":"Operator groups","sidebarTitle":"Overview","href":"/operator-groups"},{"title":"List operator groups","openapi":"GET /settings/operator_groups","href":"/api-reference/operator-groups/list-operator-groups"},{"title":"Create an operator group","openapi":"POST /settings/operator_groups","href":"/api-reference/operator-groups/create-an-operator-group"},{"title":"Retrieve an operator group","openapi":"GET /settings/operator_groups/{operator_group_id}","href":"/api-reference/operator-groups/retrieve-an-operator-group"},{"title":"Update an operator group","openapi":"PATCH /settings/operator_groups/{operator_group_id}","href":"/api-reference/operator-groups/update-an-operator-group"},{"title":"Delete an operator group","openapi":"DELETE /settings/operator_groups/{operator_group_id}","href":"/api-reference/operator-groups/delete-an-operator-group"}]},{"group":"User settings","expanded":false,"pages":[{"title":"User settings","sidebarTitle":"Overview","href":"/user-settings"},{"title":"Retrieve a user's settings","openapi":"GET /user_settings/{user_id}","href":"/api-reference/user-settings/retrieve-a-users-settings"},{"title":"Retrieve a user's profile image","openapi":"GET /user_settings/{user_id}/profile_image","href":"/api-reference/user-settings/retrieve-a-users-profile-image"}]}]},{"group":"Customisation","icon":"puzzle-piece","expanded":false,"pages":[{"group":"Custom attributes","expanded":false,"pages":[{"title":"Custom attributes","sidebarTitle":"Overview","href":"/custom-attributes"},{"title":"List custom attributes","openapi":"GET /custom_attributes","href":"/api-reference/custom-attributes/list-custom-attributes"},{"title":"Create a custom attribute","openapi":"POST /custom_attributes","href":"/api-reference/custom-attributes/create-a-custom-attribute"},{"title":"Delete a custom attribute","openapi":"DELETE /custom_attributes/{custom_attribute_id}","href":"/api-reference/custom-attributes/delete-a-custom-attribute"},{"title":"Retrieve a custom attribute","openapi":"GET /custom_attributes/{custom_attribute_id}","href":"/api-reference/custom-attributes/retrieve-a-custom-attribute"},{"title":"Update a custom attribute","openapi":"PATCH /custom_attributes/{custom_attribute_id}","href":"/api-reference/custom-attributes/update-a-custom-attribute"}]},{"group":"Custom components","expanded":false,"pages":[{"title":"Custom components","sidebarTitle":"Overview","href":"/custom-components"},{"title":"List component definitions","openapi":"GET /component","href":"/api-reference/custom-components/list-component-definitions"},{"title":"Retrieve a component definition","openapi":"GET /component/{component_uuid}","href":"/api-reference/custom-components/retrieve-a-component-definition"},{"title":"Create a component instance","openapi":"POST /component/{component_uuid}","href":"/api-reference/custom-components/create-a-component-instance"},{"title":"Delete a component instance","openapi":"DELETE /component/{component_uuid}/{component_object_id}","href":"/api-reference/custom-components/delete-a-component-instance"},{"title":"Update a component instance","openapi":"PATCH /component/{component_uuid}/{component_object_id}","href":"/api-reference/custom-components/update-a-component-instance"},{"title":"List component objects","openapi":"GET /components/{component_uuid}/objects","href":"/api-reference/custom-components/list-component-objects"},{"title":"Retrieve a component object","openapi":"GET /components/{component_uuid}/objects/{component_object_id}","href":"/api-reference/custom-components/retrieve-a-component-object"},{"title":"List a component object's activity","openapi":"GET /components/{component_uuid}/objects/{component_object_id}/activity","href":"/api-reference/custom-components/list-a-component-objects-activity"},{"title":"List a component object's custom objects","openapi":"GET /components/{component_uuid}/objects/{component_object_id}/custom_objects","href":"/api-reference/custom-components/list-a-component-objects-custom-objects"},{"title":"Retrieve a component object's PDF","openapi":"GET /components/{component_uuid}/objects/{component_object_id}/pdf","href":"/api-reference/custom-components/retrieve-a-component-objects-pdf"},{"title":"Create a component definition","openapi":"POST /component","href":"/api-reference/custom-components/create-a-component-definition"},{"title":"Update a component definition","openapi":"PATCH /component/{component_uuid}","href":"/api-reference/custom-components/update-a-component-definition"},{"title":"Create a component object","openapi":"POST /components/{component_uuid}/objects","href":"/api-reference/custom-components/create-a-component-object"},{"title":"Update a component object","openapi":"PATCH /components/{component_uuid}/objects/{component_object_id}","href":"/api-reference/custom-components/update-a-component-object"},{"title":"Delete a component object","openapi":"DELETE /components/{component_uuid}/objects/{component_object_id}","href":"/api-reference/custom-components/delete-a-component-object"},{"title":"Log an activity on a component object","openapi":"POST /components/{component_uuid}/objects/{component_object_id}/activity","href":"/api-reference/custom-components/log-an-activity-on-a-component-object"},{"title":"Retrieve a component object's activity","openapi":"GET /components/{component_uuid}/objects/{component_object_id}/activity/{activity_id}","href":"/api-reference/custom-components/retrieve-a-component-objects-activity"},{"title":"List a component object's workflow milestones","openapi":"GET /components/{component_uuid}/objects/{component_object_id}/milestones","href":"/api-reference/custom-components/list-a-component-objects-workflow-milestones"},{"title":"Retrieve a component object's workflow milestone","openapi":"GET /components/{component_uuid}/objects/{component_object_id}/milestones/{milestone_id}","href":"/api-reference/custom-components/retrieve-a-component-objects-workflow-milestone"},{"title":"List a component object's workflow history","openapi":"GET /components/{component_uuid}/objects/{component_object_id}/history","href":"/api-reference/custom-components/list-a-component-objects-workflow-history"},{"title":"Retrieve a component object's workflow history entry","openapi":"GET /components/{component_uuid}/objects/{component_object_id}/history/{history_id}","href":"/api-reference/custom-components/retrieve-a-component-objects-workflow-history-entry"},{"title":"List a component object's notes","openapi":"GET /components/{component_uuid}/objects/{component_object_id}/notes","href":"/api-reference/custom-components/list-a-component-objects-notes"},{"title":"Retrieve a component object's note","openapi":"GET /components/{component_uuid}/objects/{component_object_id}/notes/{note_id}","href":"/api-reference/custom-components/retrieve-a-component-objects-note"},{"title":"List the files of a component object's note","openapi":"GET /components/{component_uuid}/objects/{component_object_id}/notes/{note_id}/files","href":"/api-reference/custom-components/list-the-files-of-a-component-objects-note"},{"title":"Retrieve a file of a component object's note","openapi":"GET /components/{component_uuid}/objects/{component_object_id}/notes/{note_id}/files/{file_id}","href":"/api-reference/custom-components/retrieve-a-file-of-a-component-objects-note"},{"title":"Create a component object note","openapi":"POST /components/{component_uuid}/objects/{component_object_id}/notes","href":"/api-reference/custom-components/create-a-component-object-note"},{"title":"Update a component object note","openapi":"PATCH /components/{component_uuid}/objects/{component_object_id}/notes/{note_id}","href":"/api-reference/custom-components/update-a-component-object-note"},{"title":"Delete a component object note","openapi":"DELETE /components/{component_uuid}/objects/{component_object_id}/notes/{note_id}","href":"/api-reference/custom-components/delete-a-component-object-note"},{"title":"Delete a file from a component object's note","openapi":"DELETE /components/{component_uuid}/objects/{component_object_id}/notes/{note_id}/files/{file_id}","href":"/api-reference/custom-components/delete-a-file-from-a-component-objects-note"},{"title":"Retrieve a component object's custom object","openapi":"GET /components/{component_uuid}/objects/{component_object_id}/custom_objects/{custom_object_id}","href":"/api-reference/custom-components/retrieve-a-component-objects-custom-object"},{"title":"Create a custom object instance on a component object","openapi":"POST /components/{component_uuid}/objects/{component_object_id}/custom_objects/{custom_object_id}","href":"/api-reference/custom-components/create-a-custom-object-instance-on-a-component-object"},{"title":"Retrieve a custom object instance on a component object","openapi":"GET /components/{component_uuid}/objects/{component_object_id}/custom_objects/{custom_object_id}/instances/{instance_id}","href":"/api-reference/custom-components/retrieve-a-custom-object-instance-on-a-component-object"},{"title":"Update a custom object instance on a component object","openapi":"PATCH /components/{component_uuid}/objects/{component_object_id}/custom_objects/{custom_object_id}/instances/{instance_id}","href":"/api-reference/custom-components/update-a-custom-object-instance-on-a-component-object"},{"title":"Delete a custom object instance on a component object","openapi":"DELETE /components/{component_uuid}/objects/{component_object_id}/custom_objects/{custom_object_id}/instances/{instance_id}","href":"/api-reference/custom-components/delete-a-custom-object-instance-on-a-component-object"},{"title":"Link accounts or orders to a component object","openapi":"POST /components/{component_uuid}/objects/{component_object_id}/link_domains","href":"/api-reference/custom-components/link-accounts-or-orders-to-a-component-object"},{"title":"Replace the accounts or orders linked to a component object","openapi":"PATCH /components/{component_uuid}/objects/{component_object_id}/link_domains","href":"/api-reference/custom-components/replace-the-accounts-or-orders-linked-to-a-component-object"},{"title":"Unlink accounts or orders from a component object","openapi":"POST /components/{component_uuid}/objects/{component_object_id}/unlink_domains","href":"/api-reference/custom-components/unlink-accounts-or-orders-from-a-component-object"},{"title":"Change a component object's workflow status","openapi":"POST /components/{component_uuid}/objects/{component_object_id}/change_status","href":"/api-reference/custom-components/change-a-component-objects-workflow-status"},{"title":"Delete a component definition","openapi":"DELETE /component/{component_uuid}","href":"/api-reference/custom-components/delete-a-component-definition"}]},{"group":"Custom features","expanded":false,"pages":[{"title":"Custom features","sidebarTitle":"Overview","href":"/custom-features"},{"title":"List custom features","openapi":"GET /custom_feature","href":"/api-reference/custom-features/list-custom-features"},{"title":"Retrieve a custom feature","openapi":"GET /custom_feature/{custom_feature_id}","href":"/api-reference/custom-features/retrieve-a-custom-feature"},{"title":"Create a custom feature","openapi":"POST /custom_feature","href":"/api-reference/custom-features/create-a-custom-feature"},{"title":"Delete a custom feature","openapi":"DELETE /custom_feature/{custom_feature_id}","href":"/api-reference/custom-features/delete-a-custom-feature"},{"title":"Update a custom feature","openapi":"PATCH /custom_feature/{custom_feature_id}","href":"/api-reference/custom-features/update-a-custom-feature"},{"title":"Set a custom feature's form layout and attributes","openapi":"POST /custom_feature/{custom_feature_id}","href":"/api-reference/custom-features/set-a-custom-features-form-layout-and-attributes"}]},{"group":"Custom fields","expanded":false,"pages":[{"title":"Custom fields","sidebarTitle":"Overview","href":"/custom-fields"},{"title":"List custom fields","openapi":"GET /settings/custom_fields","href":"/api-reference/custom-fields/list-custom-fields"},{"title":"Retrieve a custom field","openapi":"GET /settings/custom_fields/{custom_field_id}","href":"/api-reference/custom-fields/retrieve-a-custom-field"}]},{"group":"Custom forms","expanded":false,"pages":[{"title":"Custom forms","sidebarTitle":"Overview","href":"/custom-forms"},{"title":"List custom forms","openapi":"GET /settings/custom_forms","href":"/api-reference/custom-forms/list-custom-forms"},{"title":"Create a custom form","openapi":"POST /settings/custom_forms","href":"/api-reference/custom-forms/create-a-custom-form"},{"title":"Retrieve a custom form","openapi":"GET /settings/custom_forms/{custom_form_id}","href":"/api-reference/custom-forms/retrieve-a-custom-form"},{"title":"Delete a custom form","openapi":"DELETE /settings/custom_forms/{custom_form_id}","href":"/api-reference/custom-forms/delete-a-custom-form"},{"title":"Update a custom form","openapi":"PATCH /settings/custom_forms/{custom_form_id}","href":"/api-reference/custom-forms/update-a-custom-form"}]},{"group":"Attribute attachments","expanded":false,"pages":[{"title":"Attribute attachments","sidebarTitle":"Overview","href":"/attribute-attachments"},{"title":"Retrieve an attribute attachment","openapi":"GET /attribute_attachment/{file_uuid}","href":"/api-reference/attribute-attachments/retrieve-an-attribute-attachment"}]}]},{"group":"Platform","icon":"server","expanded":false,"pages":[{"group":"Portal","expanded":false,"pages":[{"title":"Portal","sidebarTitle":"Overview","href":"/portal"},{"title":"Activate a portal account","openapi":"POST /portal/activate","href":"/api-reference/portal/activate-a-portal-account"},{"title":"Change a portal password","openapi":"POST /portal/change_password","href":"/api-reference/portal/change-a-portal-password"},{"title":"Log in a portal user","openapi":"POST /portal/login","href":"/api-reference/portal/log-in-a-portal-user"},{"title":"Reset a portal password with a code","openapi":"POST /portal/reset","href":"/api-reference/portal/reset-a-portal-password-with-a-code"},{"title":"Request a portal password reset link","openapi":"POST /portal/reset_link","href":"/api-reference/portal/request-a-portal-password-reset-link"},{"title":"Validate a portal account with a code","openapi":"POST /portal/validate","href":"/api-reference/portal/validate-a-portal-account-with-a-code"},{"title":"Set a portal password by email","openapi":"POST /portal/change","href":"/api-reference/portal/set-a-portal-password-by-email"}]},{"group":"Integration connections","expanded":false,"pages":[{"title":"Integration connections","sidebarTitle":"Overview","href":"/integration-connections"},{"title":"List integration connections","openapi":"GET /integration_connections","href":"/api-reference/integration-connections/list-integration-connections"},{"title":"Retrieve an integration connection","openapi":"GET /integration_connections/{integration_connection_id}","href":"/api-reference/integration-connections/retrieve-an-integration-connection"}]},{"group":"External databases","expanded":false,"pages":[{"title":"External databases","sidebarTitle":"Overview","href":"/external-databases"},{"title":"List external databases","openapi":"GET /external_databases","href":"/api-reference/external-databases/list-external-databases"},{"title":"Create an external database","openapi":"POST /external_databases","href":"/api-reference/external-databases/create-an-external-database"},{"title":"Retrieve an external database","openapi":"GET /external_databases/{db_name}","href":"/api-reference/external-databases/retrieve-an-external-database"},{"title":"Insert records into an external database table","openapi":"POST /external_databases/{db_name}/insert_records","href":"/api-reference/external-databases/insert-records-into-an-external-database-table"},{"title":"Search an external database table","openapi":"POST /external_databases/{db_name}/search","href":"/api-reference/external-databases/search-an-external-database-table"},{"title":"Update records in an external database table","openapi":"PATCH /external_databases/{db_name}/update_records","href":"/api-reference/external-databases/update-records-in-an-external-database-table"},{"title":"Retrieve the columns of an external database table","openapi":"GET /external_databases/{db_name}/tables/{table_name}","href":"/api-reference/external-databases/retrieve-the-columns-of-an-external-database-table"}]},{"group":"Reports","expanded":false,"pages":[{"title":"Reports","sidebarTitle":"Overview","href":"/reports"},{"title":"Retrieve the account overview report","openapi":"GET /reports/accounts/account_overview","href":"/api-reference/reports/retrieve-the-account-overview-report"},{"title":"Retrieve the invoice overview report","openapi":"GET /reports/invoices/invoice_overview","href":"/api-reference/reports/retrieve-the-invoice-overview-report"},{"title":"Retrieve the order overview report","openapi":"GET /reports/orders/order_overview","href":"/api-reference/reports/retrieve-the-order-overview-report"},{"title":"Retrieve the purchase invoice overview report","openapi":"GET /reports/purchase_invoices/purchase_invoice_overview","href":"/api-reference/reports/retrieve-the-purchase-invoice-overview-report"},{"title":"Retrieve the purchase order overview report","openapi":"GET /reports/purchase_orders/purchase_order_overview","href":"/api-reference/reports/retrieve-the-purchase-order-overview-report"},{"title":"Retrieve the purchase payment and refund overview report","openapi":"GET /reports/purchase_transactions/purchase_payment_and_refund_overview","href":"/api-reference/reports/retrieve-the-purchase-payment-and-refund-overview-report"},{"title":"Retrieve the payment and refund overview report","openapi":"GET /reports/transactions/payment_and_refund_overview","href":"/api-reference/reports/retrieve-the-payment-and-refund-overview-report"}]},{"group":"Applications","expanded":false,"pages":[{"title":"Applications","sidebarTitle":"Overview","href":"/applications"},{"title":"List applications","openapi":"GET /settings/applications","href":"/api-reference/applications/list-applications"},{"title":"Create an application","openapi":"POST /settings/applications","href":"/api-reference/applications/create-an-application"},{"title":"Retrieve an application","openapi":"GET /settings/applications/{application_id}","href":"/api-reference/applications/retrieve-an-application"},{"title":"Delete an application","openapi":"DELETE /settings/applications/{application_id}","href":"/api-reference/applications/delete-an-application"},{"title":"Update an application","openapi":"PATCH /settings/applications/{application_id}","href":"/api-reference/applications/update-an-application"}]},{"group":"Organisation","expanded":false,"pages":[{"title":"Organisation","sidebarTitle":"Overview","href":"/organisation"},{"title":"Retrieve the root organisation","openapi":"GET /settings/organisation","href":"/api-reference/organisation/retrieve-the-root-organisation"}]},{"group":"Child organisations","expanded":false,"pages":[{"title":"Child organisations","sidebarTitle":"Overview","href":"/child-organisations"},{"title":"List child organisations","openapi":"GET /settings/organisations","href":"/api-reference/child-organisations/list-child-organisations"},{"title":"Create a child organisation","openapi":"POST /settings/organisations","href":"/api-reference/child-organisations/create-a-child-organisation"},{"title":"Retrieve a child organisation","openapi":"GET /settings/organisations/{organisation_id}","href":"/api-reference/child-organisations/retrieve-a-child-organisation"},{"title":"Delete a child organisation","openapi":"DELETE /settings/organisations/{organisation_id}","href":"/api-reference/child-organisations/delete-a-child-organisation"},{"title":"Update a child organisation","openapi":"PATCH /settings/organisations/{organisation_id}","href":"/api-reference/child-organisations/update-a-child-organisation"}]},{"group":"Webhooks","expanded":false,"pages":[{"title":"Webhooks","sidebarTitle":"Overview","href":"/webhooks"},{"title":"Retrieve a webhook delivery","openapi":"GET /webhooks/{webhook_id}","href":"/api-reference/webhooks/retrieve-a-webhook-delivery"}]}]}]}]},"basePath":"","title":"Retrieve a day of the month - Exsited API \u0026 SDK","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}