Sharing codes decide which records a user can see.
In Noyax, some records (e.g. customers) can be marked with a sharing code so that only certain users can see them. The API follows the sharing codes of the user sent in X-UserID.
Visibility
A record is visible to the user when:
The record has no sharing code (SharingCode: null), so it is visible to everyone, or
The record’s sharing code is one of the sharing codes assigned to the user.
If your organization has no sharing codes defined, all records are visible.
Effect on the API
Operation
Behavior
List
Records the user cannot see are left out of the list and are not included in TotalCount
Get, update, delete
Returns 404 for a record the user cannot see. Whether the record exists is not revealed
Sub-records
If the customer is not visible, sub-record endpoints such as addresses and telephones return 404 too
Create, update
SharingCode must be empty or one of the user’s sharing codes
Sending a code the user does not have returns 400:
{ "Success": false, "ResultCode": "1017", "Message": "SharingCode must be one of the sharing codes assigned to the user.", "Errors": [ { "Code": "1017", "Message": "SharingCode must be one of the sharing codes assigned to the user." } ]}
If you get a 404 for a record you expect to exist, check X-CompanyID first, then the sharing codes of the user sent in X-UserID.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Noyax API","colors":{"primary":"#5B4AFF","light":"#8C80FF","dark":"#4A3AE0"},"logo":{"light":"https://mintcdn.com/noyax/K7LxoYHrQCdoQ4jy/logo/light.svg?fit=max\u0026auto=format\u0026n=K7LxoYHrQCdoQ4jy\u0026q=85\u0026s=78086fed969cddbbf46c4cd156eff780","dark":"https://mintcdn.com/noyax/K7LxoYHrQCdoQ4jy/logo/dark.svg?fit=max\u0026auto=format\u0026n=K7LxoYHrQCdoQ4jy\u0026q=85\u0026s=96614d322ed52bd768de7f3bfc057fb1","href":"/"},"favicon":"https://mintcdn.com/noyax/WZ1Gnfg0LydE9yNm/favicon.ico?fit=max\u0026auto=format\u0026n=WZ1Gnfg0LydE9yNm\u0026q=85\u0026s=b96b2569d70afdcc446a0d9785c6d34b","api":{"openapi":"api-reference/openapi.json","playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","csharp","javascript","python"]}},"footer":{"socials":{"website":"https://noyax.com"}},"seo":{"indexing":"navigable"},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"languages":[{"language":"tr","default":true,"href":"tr/v1"},{"language":"en","href":"en/v1"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"noyax","hasAudioNarration":false,"actualSubdomain":"noyax","customDomains":["apidocs.noyax.com"],"gitSource":{"type":"github","owner":"ataakalin","repo":"noyaxapi","deployBranch":"master","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6af70c2de766df7985e6260a","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"en","tag":"Modules","count":237},{"language":"tr","tag":"Modüller","count":237},{"language":"en","tag":"Customers","count":58},{"language":"tr","tag":"Cariler","count":56},{"language":"en","tag":"Finance","count":44},{"language":"tr","tag":"Finans","count":44},{"language":"en","tag":"Definitions","count":43},{"language":"tr","tag":"Tanımlar","count":43},{"language":"en","tag":"Bank","count":42},{"language":"tr","tag":"Banka","count":42},{"language":"en","tag":"Products","count":37},{"language":"tr","tag":"Ürünler","count":37},{"language":"en","tag":"Invoices","count":24},{"language":"tr","tag":"Faturalar","count":24},{"language":"en","tag":"Bank accounts","count":18},{"language":"tr","tag":"Banka hesapları","count":18},{"language":"en","tag":"Stock","count":14},{"language":"tr","tag":"Stok","count":14},{"language":"en","tag":"Parameter definitions","count":12},{"language":"tr","tag":"Parametre tanımları","count":12}]},"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":"custom-rbac-roles","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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"en/v1/guides/sharing-codes","slug":"/en/v1/guides/sharing-codes","pageMetadata":{"title":"Sharing codes","description":"Sharing codes decide which records a user can see.","icon":"eye","href":"/en/v1/guides/sharing-codes"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Sharing codes decide which records a user can see.\"\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={code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table,Tip}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`In Noyax, some records (e.g. customers) can be marked with a `,_jsx(_components.strong,{children:`sharing code`}),` so that only certain users can see them. The API follows the sharing codes of the user sent in `,_jsx(_components.code,{children:`X-UserID`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`visibility`,children:`Visibility`}),`\n`,_jsx(_components.p,{children:`A record is visible to the user when:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`The record has no sharing code (`,_jsx(_components.code,{children:`SharingCode: null`}),`), so it is visible to everyone, or`]}),`\n`,_jsx(_components.li,{children:`The record’s sharing code is one of the sharing codes assigned to the user.`}),`\n`]}),`\n`,_jsx(_components.p,{children:`If your organization has no sharing codes defined, all records are visible.`}),`\n`,_jsx(Heading,{level:`2`,id:`effect-on-the-api`,children:`Effect on the API`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Operation`}),_jsx(_components.th,{children:`Behavior`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`List`}),_jsxs(_components.td,{children:[`Records the user cannot see are left out of the list and are not included in `,_jsx(_components.code,{children:`TotalCount`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Get, update, delete`}),_jsxs(_components.td,{children:[`Returns `,_jsx(_components.strong,{children:`404`}),` for a record the user cannot see. Whether the record exists is not revealed`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Sub-records`}),_jsxs(_components.td,{children:[`If the customer is not visible, sub-record endpoints such as addresses and telephones return `,_jsx(_components.strong,{children:`404`}),` too`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Create, update`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`SharingCode`}),` must be empty or one of the user’s sharing codes`]})]})]})]}),`\n`,_jsxs(_components.p,{children:[`Sending a code the user does not have returns `,_jsx(_components.strong,{children:`400`}),`:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`8`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`8`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"Success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"ResultCode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"1017\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"Message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"SharingCode must be one of the sharing codes assigned to the user.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"Errors\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"Code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"1017\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"Message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"SharingCode must be one of the sharing codes assigned to the user.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`If you get a 404 for a record you expect to exist, check `,_jsx(_components.code,{children:`X-CompanyID`}),` first, then the sharing codes of the user sent in `,_jsx(_components.code,{children:`X-UserID`}),`.`]})})]})}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":"Sharing codes","description":"Sharing codes decide which records a user can see.","icon":"eye","href":"/en/v1/guides/sharing-codes"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Visibility","slug":"visibility","depth":2,"children":[]},{"title":"Effect on the API","slug":"effect-on-the-api","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"noyax","siteName":"Noyax API","title":"Sharing codes - Noyax API","navMaps":{"firstHrefInVersion":{"v1":{"href":"/en/v1/guides/sharing-codes","matchLevel":0}},"firstHrefInLanguage":{"tr":{"href":"/tr/v1/guides/sharing-codes","matchLevel":1},"en":{"href":"/en/v1/guides/sharing-codes","matchLevel":0}}},"lastModified":"2026-11-12T07:59:12.250Z","originalFileLocation":"en/v1/guides/sharing-codes.mdx","locale":"en"},"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=\"Sharing codes decide which records a user can see.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Noyax API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/noyax/9sQuPgprl2ESyHgF/_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/noyax/9sQuPgprl2ESyHgF/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/noyax/9sQuPgprl2ESyHgF/_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/noyax/9sQuPgprl2ESyHgF/_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/noyax/9sQuPgprl2ESyHgF/_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/noyax/9sQuPgprl2ESyHgF/_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/noyax/9sQuPgprl2ESyHgF/_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/noyax/9sQuPgprl2ESyHgF/_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/noyax/9sQuPgprl2ESyHgF/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Sharing codes - Noyax API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Sharing codes decide which records a user can see.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Noyax API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://apidocs.noyax.com/en/v1/guides/sharing-codes\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://noyax.mintlify.site/_mintlify/api/og/v2?division=Core+concepts\u0026amp;title=Sharing+codes\u0026amp;description=Sharing+codes+decide+which+records+a+user+can+see.\u0026amp;theme=ada594ee3d688db06027175d\u0026amp;signature=67bb215c4b710bd8ccff39354845b49690508bdea5a4b3600bacecb17990cff6\">\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=\"Sharing codes - Noyax API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Sharing codes decide which records a user can see.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://noyax.mintlify.site/_mintlify/api/og/v2?division=Core+concepts\u0026amp;title=Sharing+codes\u0026amp;description=Sharing+codes+decide+which+records+a+user+can+see.\u0026amp;theme=ada594ee3d688db06027175d\u0026amp;signature=67bb215c4b710bd8ccff39354845b49690508bdea5a4b3600bacecb17990cff6\">\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/noyax/9sQuPgprl2ESyHgF/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Noyax API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5B4AFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://apidocs.noyax.com/en/v1/guides/sharing-codes\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/en/v1/guides/sharing-codes.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://apidocs.noyax.com/en/v1/guides/sharing-codes\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"tr\" href=\"https://apidocs.noyax.com/tr/v1/guides/sharing-codes\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://apidocs.noyax.com/tr/v1/guides/sharing-codes\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://apidocs.noyax.com/#organization\",\"name\":\"Noyax API\",\"url\":\"https://apidocs.noyax.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/noyax/K7LxoYHrQCdoQ4jy/logo/light.svg?fit=max\u0026auto=format\u0026n=K7LxoYHrQCdoQ4jy\u0026q=85\u0026s=78086fed969cddbbf46c4cd156eff780\"}},{\"@type\":\"WebSite\",\"@id\":\"https://apidocs.noyax.com#website\",\"name\":\"Noyax API\",\"url\":\"https://apidocs.noyax.com\",\"publisher\":{\"@id\":\"https://apidocs.noyax.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://apidocs.noyax.com/en/v1/guides/sharing-codes#webpage\",\"url\":\"https://apidocs.noyax.com/en/v1/guides/sharing-codes\",\"name\":\"Sharing codes\",\"description\":\"Sharing codes decide which records a user can see.\",\"dateModified\":\"2026-11-12T07:59:12.250Z\",\"isPartOf\":{\"@id\":\"https://apidocs.noyax.com#website\"},\"breadcrumb\":{\"@id\":\"https://apidocs.noyax.com/en/v1/guides/sharing-codes#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://apidocs.noyax.com/en/v1/guides/sharing-codes#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Core concepts\",\"item\":\"https://apidocs.noyax.com/en/v1/guides/authentication\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Sharing codes\",\"item\":\"https://apidocs.noyax.com/en/v1/guides/sharing-codes\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://apidocs.noyax.com/en/v1/guides/sharing-codes#article\",\"headline\":\"Sharing codes\",\"name\":\"Sharing codes\",\"description\":\"Sharing codes decide which records a user can see.\",\"url\":\"https://apidocs.noyax.com/en/v1/guides/sharing-codes\",\"mainEntityOfPage\":{\"@id\":\"https://apidocs.noyax.com/en/v1/guides/sharing-codes#webpage\"},\"dateModified\":\"2026-11-12T07:59:12.250Z\",\"publisher\":{\"@id\":\"https://apidocs.noyax.com/#organization\"},\"isPartOf\":{\"@id\":\"https://apidocs.noyax.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Noyax API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Noyax API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/en/v1/guides/sharing-codes.md","siteName":"Noyax API","nav":{"global":null,"languages":[{"language":"tr","default":true,"pages":[{"title":"tr","href":"/tr/v1/guides/sharing-codes"}]},{"language":"en","versions":[{"version":"v1","default":true,"groups":[{"group":"Getting started","pages":[{"title":"Noyax API","sidebarTitle":"Introduction","icon":"house","href":"/en/v1"},{"title":"Quickstart","icon":"rocket","href":"/en/v1/quickstart"},{"title":"Postman collection","icon":"download","href":"/en/v1/postman"}]},{"group":"Core concepts","pages":[{"title":"Authentication","icon":"key","href":"/en/v1/guides/authentication"},{"title":"Request headers","icon":"id-card","href":"/en/v1/guides/request-context"},{"title":"Permissions","icon":"shield-check","href":"/en/v1/guides/permissions"},{"title":"Rate limits","icon":"gauge","href":"/en/v1/guides/rate-limits"},{"title":"Partial update","icon":"pen-to-square","href":"/en/v1/guides/partial-update"},{"title":"Errors","icon":"triangle-exclamation","href":"/en/v1/guides/errors"},{"title":"Result codes","icon":"list-ol","href":"/en/v1/guides/result-codes"},{"title":"Pagination and search","description":"Reading list endpoints page by page and searching.","icon":"list","href":"/en/v1/guides/pagination-search"},{"title":"Sharing codes","icon":"eye","href":"/en/v1/guides/sharing-codes"},{"title":"Versioning","description":"API versions, backward compatibility and retiring old versions.","icon":"code-branch","href":"/en/v1/guides/versioning"}]},{"group":"Modules","icon":"layer-group","pages":[{"group":"Definitions","icon":"book","root":{"title":"Definitions","icon":"book","href":"/en/v1/definitions/overview"},"expanded":false,"pages":[{"group":"Countries","icon":"earth-europe","pages":[{"title":"List countries","openapi":"api-reference/openapi.json GET /api/v1/definitions/countries","href":"/en/v1/definitions/countries/list"},{"title":"Get country","openapi":"api-reference/openapi.json GET /api/v1/definitions/countries/{countryId}","href":"/en/v1/definitions/countries/get"},{"title":"Create country","openapi":"api-reference/openapi.json POST /api/v1/definitions/countries","href":"/en/v1/definitions/countries/create"},{"title":"Update country","openapi":"api-reference/openapi.json PUT /api/v1/definitions/countries/{countryId}","href":"/en/v1/definitions/countries/update"},{"title":"Partially update country","openapi":"api-reference/openapi.json PATCH /api/v1/definitions/countries/{countryId}","href":"/en/v1/definitions/countries/patch"},{"title":"Delete country","openapi":"api-reference/openapi.json DELETE /api/v1/definitions/countries/{countryId}","href":"/en/v1/definitions/countries/delete"}]},{"group":"Cities","icon":"city","pages":[{"title":"List cities","openapi":"api-reference/openapi.json GET /api/v1/definitions/cities","href":"/en/v1/definitions/cities/list"},{"title":"Get city","openapi":"api-reference/openapi.json GET /api/v1/definitions/cities/{cityId}","href":"/en/v1/definitions/cities/get"},{"title":"Create city","openapi":"api-reference/openapi.json POST /api/v1/definitions/cities","href":"/en/v1/definitions/cities/create"},{"title":"Update city","openapi":"api-reference/openapi.json PUT /api/v1/definitions/cities/{cityId}","href":"/en/v1/definitions/cities/update"},{"title":"Partially update city","openapi":"api-reference/openapi.json PATCH /api/v1/definitions/cities/{cityId}","href":"/en/v1/definitions/cities/patch"},{"title":"Delete city","openapi":"api-reference/openapi.json DELETE /api/v1/definitions/cities/{cityId}","href":"/en/v1/definitions/cities/delete"}]},{"group":"Districts","icon":"map-pin","pages":[{"title":"List districts","openapi":"api-reference/openapi.json GET /api/v1/definitions/districts","href":"/en/v1/definitions/districts/list"},{"title":"Get district","openapi":"api-reference/openapi.json GET /api/v1/definitions/districts/{districtId}","href":"/en/v1/definitions/districts/get"},{"title":"Create district","openapi":"api-reference/openapi.json POST /api/v1/definitions/districts","href":"/en/v1/definitions/districts/create"},{"title":"Update district","openapi":"api-reference/openapi.json PUT /api/v1/definitions/districts/{districtId}","href":"/en/v1/definitions/districts/update"},{"title":"Partially update district","openapi":"api-reference/openapi.json PATCH /api/v1/definitions/districts/{districtId}","href":"/en/v1/definitions/districts/patch"},{"title":"Delete district","openapi":"api-reference/openapi.json DELETE /api/v1/definitions/districts/{districtId}","href":"/en/v1/definitions/districts/delete"}]},{"group":"Currencies","icon":"coins","pages":[{"title":"List currencies","openapi":"api-reference/openapi.json GET /api/v1/definitions/currencies","href":"/en/v1/definitions/currencies/list"},{"title":"Get currency","openapi":"api-reference/openapi.json GET /api/v1/definitions/currencies/{currencyId}","href":"/en/v1/definitions/currencies/get"},{"title":"Create currency","openapi":"api-reference/openapi.json POST /api/v1/definitions/currencies","href":"/en/v1/definitions/currencies/create"},{"title":"Update currency","openapi":"api-reference/openapi.json PUT /api/v1/definitions/currencies/{currencyId}","href":"/en/v1/definitions/currencies/update"},{"title":"Partially update currency","openapi":"api-reference/openapi.json PATCH /api/v1/definitions/currencies/{currencyId}","href":"/en/v1/definitions/currencies/patch"},{"title":"Delete currency","openapi":"api-reference/openapi.json DELETE /api/v1/definitions/currencies/{currencyId}","href":"/en/v1/definitions/currencies/delete"}]},{"group":"Units","icon":"ruler","pages":[{"title":"List units","openapi":"api-reference/openapi.json GET /api/v1/definitions/units","href":"/en/v1/definitions/units/list"},{"title":"Get unit","openapi":"api-reference/openapi.json GET /api/v1/definitions/units/{unitId}","href":"/en/v1/definitions/units/get"},{"title":"Create unit","openapi":"api-reference/openapi.json POST /api/v1/definitions/units","href":"/en/v1/definitions/units/create"},{"title":"Update unit","openapi":"api-reference/openapi.json PUT /api/v1/definitions/units/{unitId}","href":"/en/v1/definitions/units/update"},{"title":"Partially update unit","openapi":"api-reference/openapi.json PATCH /api/v1/definitions/units/{unitId}","href":"/en/v1/definitions/units/patch"},{"title":"Delete unit","openapi":"api-reference/openapi.json DELETE /api/v1/definitions/units/{unitId}","href":"/en/v1/definitions/units/delete"}]},{"group":"Line groups","icon":"layer-group","pages":[{"title":"List line groups","openapi":"api-reference/openapi.json GET /api/v1/definitions/line-groups","href":"/en/v1/definitions/line-groups/list"},{"title":"Get line group","openapi":"api-reference/openapi.json GET /api/v1/definitions/line-groups/{lineGroupId}","href":"/en/v1/definitions/line-groups/get"},{"title":"Create line group","openapi":"api-reference/openapi.json POST /api/v1/definitions/line-groups","href":"/en/v1/definitions/line-groups/create"},{"title":"Update line group","openapi":"api-reference/openapi.json PUT /api/v1/definitions/line-groups/{lineGroupId}","href":"/en/v1/definitions/line-groups/update"},{"title":"Partially update line group","openapi":"api-reference/openapi.json PATCH /api/v1/definitions/line-groups/{lineGroupId}","href":"/en/v1/definitions/line-groups/patch"},{"title":"Delete line group","openapi":"api-reference/openapi.json DELETE /api/v1/definitions/line-groups/{lineGroupId}","href":"/en/v1/definitions/line-groups/delete"}]},{"group":"VAT rates","icon":"percent","pages":[{"title":"List VAT rates","openapi":"api-reference/openapi.json GET /api/v1/definitions/vat-rates","href":"/en/v1/definitions/vat-rates/list"}]},{"group":"Shipment definitions","icon":"truck","pages":[{"title":"List shipment definitions","openapi":"api-reference/openapi.json GET /api/v1/definitions/shipment-definitions","href":"/en/v1/definitions/shipment-definitions/list"},{"title":"Get shipment definition","openapi":"api-reference/openapi.json GET /api/v1/definitions/shipment-definitions/{shipmentDefinitionId}","href":"/en/v1/definitions/shipment-definitions/get"},{"title":"Create shipment definition","openapi":"api-reference/openapi.json POST /api/v1/definitions/shipment-definitions","href":"/en/v1/definitions/shipment-definitions/create"},{"title":"Update shipment definition","openapi":"api-reference/openapi.json PUT /api/v1/definitions/shipment-definitions/{shipmentDefinitionId}","href":"/en/v1/definitions/shipment-definitions/update"},{"title":"Partially update shipment definition","openapi":"api-reference/openapi.json PATCH /api/v1/definitions/shipment-definitions/{shipmentDefinitionId}","href":"/en/v1/definitions/shipment-definitions/patch"},{"title":"Delete shipment definition","openapi":"api-reference/openapi.json DELETE /api/v1/definitions/shipment-definitions/{shipmentDefinitionId}","href":"/en/v1/definitions/shipment-definitions/delete"}]}]},{"group":"Customers","icon":"users","root":{"title":"Customer record","icon":"user","href":"/en/v1/customers/overview"},"expanded":false,"pages":[{"title":"Customer code generation","icon":"hashtag","href":"/en/v1/customers/customer-code"},{"group":"Customer definitions","icon":"book-open","pages":[{"title":"List customer groups","openapi":"api-reference/openapi.json GET /api/v1/customers/groups","href":"/en/v1/customers/definitions/groups"},{"group":"Parameter definitions","pages":[{"title":"List customer parameter definitions","openapi":"api-reference/openapi.json GET /api/v1/customers/parameter-definitions","href":"/en/v1/customers/definitions/parameter-definitions/list"},{"title":"Get customer parameter definition","openapi":"api-reference/openapi.json GET /api/v1/customers/parameter-definitions/{parameterDefinitionId}","href":"/en/v1/customers/definitions/parameter-definitions/get"},{"title":"Create customer parameter definition","openapi":"api-reference/openapi.json POST /api/v1/customers/parameter-definitions","href":"/en/v1/customers/definitions/parameter-definitions/create"},{"title":"Update customer parameter definition","openapi":"api-reference/openapi.json PUT /api/v1/customers/parameter-definitions/{parameterDefinitionId}","href":"/en/v1/customers/definitions/parameter-definitions/update"},{"title":"Partially update customer parameter definition","openapi":"api-reference/openapi.json PATCH /api/v1/customers/parameter-definitions/{parameterDefinitionId}","href":"/en/v1/customers/definitions/parameter-definitions/patch"},{"title":"Delete customer parameter definition","openapi":"api-reference/openapi.json DELETE /api/v1/customers/parameter-definitions/{parameterDefinitionId}","href":"/en/v1/customers/definitions/parameter-definitions/delete"}]}]},{"group":"Customer endpoints","icon":"user","pages":[{"title":"List customers","openapi":"api-reference/openapi.json GET /api/v1/customers","href":"/en/v1/customers/list"},{"title":"Get customer","openapi":"api-reference/openapi.json GET /api/v1/customers/{customerId}","href":"/en/v1/customers/get"},{"title":"Create customer","openapi":"api-reference/openapi.json POST /api/v1/customers","href":"/en/v1/customers/create"},{"title":"Update customer","openapi":"api-reference/openapi.json PUT /api/v1/customers/{customerId}","href":"/en/v1/customers/update"},{"title":"Partially update customer","openapi":"api-reference/openapi.json PATCH /api/v1/customers/{customerId}","href":"/en/v1/customers/patch"},{"title":"Delete customer","openapi":"api-reference/openapi.json DELETE /api/v1/customers/{customerId}","href":"/en/v1/customers/delete"}]},{"group":"Addresses","icon":"location-dot","pages":[{"title":"List addresses","openapi":"api-reference/openapi.json GET /api/v1/customers/{customerId}/addresses","href":"/en/v1/customers/addresses/list"},{"title":"Get address","openapi":"api-reference/openapi.json GET /api/v1/customers/{customerId}/addresses/{addressId}","href":"/en/v1/customers/addresses/get"},{"title":"Create address","openapi":"api-reference/openapi.json POST /api/v1/customers/{customerId}/addresses","href":"/en/v1/customers/addresses/create"},{"title":"Update address","openapi":"api-reference/openapi.json PUT /api/v1/customers/{customerId}/addresses/{addressId}","href":"/en/v1/customers/addresses/update"},{"title":"Partially update address","openapi":"api-reference/openapi.json PATCH /api/v1/customers/{customerId}/addresses/{addressId}","href":"/en/v1/customers/addresses/patch"},{"title":"Delete address","openapi":"api-reference/openapi.json DELETE /api/v1/customers/{customerId}/addresses/{addressId}","href":"/en/v1/customers/addresses/delete"}]},{"group":"Telephones","icon":"phone","pages":[{"title":"List telephones","openapi":"api-reference/openapi.json GET /api/v1/customers/{customerId}/telephones","href":"/en/v1/customers/telephones/list"},{"title":"Get telephone","openapi":"api-reference/openapi.json GET /api/v1/customers/{customerId}/telephones/{telephoneId}","href":"/en/v1/customers/telephones/get"},{"title":"Create telephone","openapi":"api-reference/openapi.json POST /api/v1/customers/{customerId}/telephones","href":"/en/v1/customers/telephones/create"},{"title":"Update telephone","openapi":"api-reference/openapi.json PUT /api/v1/customers/{customerId}/telephones/{telephoneId}","href":"/en/v1/customers/telephones/update"},{"title":"Partially update telephone","openapi":"api-reference/openapi.json PATCH /api/v1/customers/{customerId}/telephones/{telephoneId}","href":"/en/v1/customers/telephones/patch"},{"title":"Delete telephone","openapi":"api-reference/openapi.json DELETE /api/v1/customers/{customerId}/telephones/{telephoneId}","href":"/en/v1/customers/telephones/delete"}]},{"group":"Links","icon":"link","pages":[{"title":"List links","openapi":"api-reference/openapi.json GET /api/v1/customers/{customerId}/links","href":"/en/v1/customers/links/list"},{"title":"Get link","openapi":"api-reference/openapi.json GET /api/v1/customers/{customerId}/links/{linkId}","href":"/en/v1/customers/links/get"},{"title":"Create link","openapi":"api-reference/openapi.json POST /api/v1/customers/{customerId}/links","href":"/en/v1/customers/links/create"},{"title":"Update link","openapi":"api-reference/openapi.json PUT /api/v1/customers/{customerId}/links/{linkId}","href":"/en/v1/customers/links/update"},{"title":"Partially update link","openapi":"api-reference/openapi.json PATCH /api/v1/customers/{customerId}/links/{linkId}","href":"/en/v1/customers/links/patch"},{"title":"Delete link","openapi":"api-reference/openapi.json DELETE /api/v1/customers/{customerId}/links/{linkId}","href":"/en/v1/customers/links/delete"}]},{"group":"Representatives","icon":"user-tie","pages":[{"title":"List representatives","openapi":"api-reference/openapi.json GET /api/v1/customers/{customerId}/representatives","href":"/en/v1/customers/representatives/list"},{"title":"Get representative","openapi":"api-reference/openapi.json GET /api/v1/customers/{customerId}/representatives/{representativeId}","href":"/en/v1/customers/representatives/get"},{"title":"Create representative","openapi":"api-reference/openapi.json POST /api/v1/customers/{customerId}/representatives","href":"/en/v1/customers/representatives/create"},{"title":"Update representative","openapi":"api-reference/openapi.json PUT /api/v1/customers/{customerId}/representatives/{representativeId}","href":"/en/v1/customers/representatives/update"},{"title":"Partially update representative","openapi":"api-reference/openapi.json PATCH /api/v1/customers/{customerId}/representatives/{representativeId}","href":"/en/v1/customers/representatives/patch"},{"title":"Delete representative","openapi":"api-reference/openapi.json DELETE /api/v1/customers/{customerId}/representatives/{representativeId}","href":"/en/v1/customers/representatives/delete"}]},{"group":"Bank accounts","icon":"building-columns","pages":[{"title":"List bank accounts","openapi":"api-reference/openapi.json GET /api/v1/customers/{customerId}/bank-accounts","href":"/en/v1/customers/bank-accounts/list"},{"title":"Get bank account","openapi":"api-reference/openapi.json GET /api/v1/customers/{customerId}/bank-accounts/{bankAccountId}","href":"/en/v1/customers/bank-accounts/get"},{"title":"Create bank account","openapi":"api-reference/openapi.json POST /api/v1/customers/{customerId}/bank-accounts","href":"/en/v1/customers/bank-accounts/create"},{"title":"Update bank account","openapi":"api-reference/openapi.json PUT /api/v1/customers/{customerId}/bank-accounts/{bankAccountId}","href":"/en/v1/customers/bank-accounts/update"},{"title":"Partially update bank account","openapi":"api-reference/openapi.json PATCH /api/v1/customers/{customerId}/bank-accounts/{bankAccountId}","href":"/en/v1/customers/bank-accounts/patch"},{"title":"Delete bank account","openapi":"api-reference/openapi.json DELETE /api/v1/customers/{customerId}/bank-accounts/{bankAccountId}","href":"/en/v1/customers/bank-accounts/delete"}]},{"group":"Group memberships","icon":"users-rectangle","pages":[{"title":"List group memberships","openapi":"api-reference/openapi.json GET /api/v1/customers/{customerId}/group-members","href":"/en/v1/customers/group-members/list"},{"title":"Get group membership","openapi":"api-reference/openapi.json GET /api/v1/customers/{customerId}/group-members/{groupMemberId}","href":"/en/v1/customers/group-members/get"},{"title":"Create group membership","openapi":"api-reference/openapi.json POST /api/v1/customers/{customerId}/group-members","href":"/en/v1/customers/group-members/create"},{"title":"Update group membership","openapi":"api-reference/openapi.json PUT /api/v1/customers/{customerId}/group-members/{groupMemberId}","href":"/en/v1/customers/group-members/update"},{"title":"Partially update group membership","openapi":"api-reference/openapi.json PATCH /api/v1/customers/{customerId}/group-members/{groupMemberId}","href":"/en/v1/customers/group-members/patch"},{"title":"Delete group membership","openapi":"api-reference/openapi.json DELETE /api/v1/customers/{customerId}/group-members/{groupMemberId}","href":"/en/v1/customers/group-members/delete"}]},{"group":"Parameters","icon":"sliders","pages":[{"title":"List parameters","openapi":"api-reference/openapi.json GET /api/v1/customers/{customerId}/parameters","href":"/en/v1/customers/parameters/list"},{"title":"Get parameter","openapi":"api-reference/openapi.json GET /api/v1/customers/{customerId}/parameters/{parameterId}","href":"/en/v1/customers/parameters/get"},{"title":"Create parameter","openapi":"api-reference/openapi.json POST /api/v1/customers/{customerId}/parameters","href":"/en/v1/customers/parameters/create"},{"title":"Update parameter","openapi":"api-reference/openapi.json PUT /api/v1/customers/{customerId}/parameters/{parameterId}","href":"/en/v1/customers/parameters/update"},{"title":"Partially update parameter value","openapi":"api-reference/openapi.json PATCH /api/v1/customers/{customerId}/parameters/{parameterId}","href":"/en/v1/customers/parameters/patch"},{"title":"Delete parameter","openapi":"api-reference/openapi.json DELETE /api/v1/customers/{customerId}/parameters/{parameterId}","href":"/en/v1/customers/parameters/delete"}]}]},{"group":"Products","icon":"box","root":{"title":"Product card","icon":"box","href":"/en/v1/products/overview"},"expanded":false,"pages":[{"title":"List products","openapi":"api-reference/openapi.json GET /api/v1/products","href":"/en/v1/products/list"},{"title":"List changed products","openapi":"api-reference/openapi.json GET /api/v1/products/changes","href":"/en/v1/products/changes"},{"title":"Get product","openapi":"api-reference/openapi.json GET /api/v1/products/{productId}","href":"/en/v1/products/get"},{"title":"Create product","openapi":"api-reference/openapi.json POST /api/v1/products","href":"/en/v1/products/create"},{"title":"Update product","openapi":"api-reference/openapi.json PUT /api/v1/products/{productId}","href":"/en/v1/products/update"},{"title":"Partially update product","openapi":"api-reference/openapi.json PATCH /api/v1/products/{productId}","href":"/en/v1/products/patch"},{"title":"Delete product","openapi":"api-reference/openapi.json DELETE /api/v1/products/{productId}","href":"/en/v1/products/delete"},{"group":"Product definitions","icon":"book-open","pages":[{"group":"Parameter definitions","pages":[{"title":"List product parameter definitions","openapi":"api-reference/openapi.json GET /api/v1/products/parameter-definitions","href":"/en/v1/products/definitions/parameter-definitions/list"},{"title":"Get product parameter definition","openapi":"api-reference/openapi.json GET /api/v1/products/parameter-definitions/{parameterDefinitionId}","href":"/en/v1/products/definitions/parameter-definitions/get"},{"title":"Create product parameter definition","openapi":"api-reference/openapi.json POST /api/v1/products/parameter-definitions","href":"/en/v1/products/definitions/parameter-definitions/create"},{"title":"Update product parameter definition","openapi":"api-reference/openapi.json PUT /api/v1/products/parameter-definitions/{parameterDefinitionId}","href":"/en/v1/products/definitions/parameter-definitions/update"},{"title":"Partially update product parameter definition","openapi":"api-reference/openapi.json PATCH /api/v1/products/parameter-definitions/{parameterDefinitionId}","href":"/en/v1/products/definitions/parameter-definitions/patch"},{"title":"Delete product parameter definition","openapi":"api-reference/openapi.json DELETE /api/v1/products/parameter-definitions/{parameterDefinitionId}","href":"/en/v1/products/definitions/parameter-definitions/delete"}]}]},{"group":"Groups","icon":"sitemap","pages":[{"title":"List product group details","openapi":"api-reference/openapi.json GET /api/v1/products/groups","href":"/en/v1/products/groups/list"},{"title":"Get product group detail","openapi":"api-reference/openapi.json GET /api/v1/products/groups/{groupDetailId}","href":"/en/v1/products/groups/get"},{"title":"Create product group detail","openapi":"api-reference/openapi.json POST /api/v1/products/groups","href":"/en/v1/products/groups/create"},{"title":"Update product group detail","openapi":"api-reference/openapi.json PUT /api/v1/products/groups/{groupDetailId}","href":"/en/v1/products/groups/update"},{"title":"Partially update product group detail","openapi":"api-reference/openapi.json PATCH /api/v1/products/groups/{groupDetailId}","href":"/en/v1/products/groups/patch"},{"title":"Delete product group detail","openapi":"api-reference/openapi.json DELETE /api/v1/products/groups/{groupDetailId}","href":"/en/v1/products/groups/delete"}]},{"group":"Parameters","icon":"sliders","pages":[{"title":"List product parameter values","openapi":"api-reference/openapi.json GET /api/v1/products/{productId}/parameters","href":"/en/v1/products/parameters/list"},{"title":"Get product parameter value","openapi":"api-reference/openapi.json GET /api/v1/products/{productId}/parameters/{parameterId}","href":"/en/v1/products/parameters/get"},{"title":"Create product parameter value","openapi":"api-reference/openapi.json POST /api/v1/products/{productId}/parameters","href":"/en/v1/products/parameters/create"},{"title":"Update product parameter value","openapi":"api-reference/openapi.json PUT /api/v1/products/{productId}/parameters/{parameterId}","href":"/en/v1/products/parameters/update"},{"title":"Partially update product parameter value","openapi":"api-reference/openapi.json PATCH /api/v1/products/{productId}/parameters/{parameterId}","href":"/en/v1/products/parameters/patch"},{"title":"Delete product parameter value","openapi":"api-reference/openapi.json DELETE /api/v1/products/{productId}/parameters/{parameterId}","href":"/en/v1/products/parameters/delete"}]},{"group":"Prices","icon":"tag","pages":[{"title":"List product prices","openapi":"api-reference/openapi.json GET /api/v1/products/{productId}/prices","href":"/en/v1/products/prices/list"},{"title":"Get product price","openapi":"api-reference/openapi.json GET /api/v1/products/{productId}/prices/{priceId}","href":"/en/v1/products/prices/get"},{"title":"Create product price","openapi":"api-reference/openapi.json POST /api/v1/products/{productId}/prices","href":"/en/v1/products/prices/create"},{"title":"Update product price","openapi":"api-reference/openapi.json PUT /api/v1/products/{productId}/prices/{priceId}","href":"/en/v1/products/prices/update"},{"title":"Partially update product price","openapi":"api-reference/openapi.json PATCH /api/v1/products/{productId}/prices/{priceId}","href":"/en/v1/products/prices/patch"},{"title":"Delete product price","openapi":"api-reference/openapi.json DELETE /api/v1/products/{productId}/prices/{priceId}","href":"/en/v1/products/prices/delete"}]},{"group":"Critical stock","icon":"triangle-exclamation","pages":[{"title":"List critical stock definitions","openapi":"api-reference/openapi.json GET /api/v1/products/{productId}/critical-stock","href":"/en/v1/products/critical-stock/list"},{"title":"Get critical stock definition","openapi":"api-reference/openapi.json GET /api/v1/products/{productId}/critical-stock/{criticalStockId}","href":"/en/v1/products/critical-stock/get"},{"title":"Create critical stock definition","openapi":"api-reference/openapi.json POST /api/v1/products/{productId}/critical-stock","href":"/en/v1/products/critical-stock/create"},{"title":"Update critical stock definition","openapi":"api-reference/openapi.json PUT /api/v1/products/{productId}/critical-stock/{criticalStockId}","href":"/en/v1/products/critical-stock/update"},{"title":"Partially update critical stock definition","openapi":"api-reference/openapi.json PATCH /api/v1/products/{productId}/critical-stock/{criticalStockId}","href":"/en/v1/products/critical-stock/patch"},{"title":"Delete critical stock definition","openapi":"api-reference/openapi.json DELETE /api/v1/products/{productId}/critical-stock/{criticalStockId}","href":"/en/v1/products/critical-stock/delete"}]}]},{"group":"Stock","icon":"boxes-stacked","expanded":false,"pages":[{"group":"Warehouses","icon":"warehouse","pages":[{"title":"List warehouses","openapi":"api-reference/openapi.json GET /api/v1/stock/warehouses","href":"/en/v1/stock/warehouses/list"},{"title":"Get warehouse","openapi":"api-reference/openapi.json GET /api/v1/stock/warehouses/{warehouseId}","href":"/en/v1/stock/warehouses/get"},{"title":"Create warehouse","openapi":"api-reference/openapi.json POST /api/v1/stock/warehouses","href":"/en/v1/stock/warehouses/create"},{"title":"Update warehouse","openapi":"api-reference/openapi.json PUT /api/v1/stock/warehouses/{warehouseId}","href":"/en/v1/stock/warehouses/update"},{"title":"Partially update warehouse","openapi":"api-reference/openapi.json PATCH /api/v1/stock/warehouses/{warehouseId}","href":"/en/v1/stock/warehouses/patch"},{"title":"Delete warehouse","openapi":"api-reference/openapi.json DELETE /api/v1/stock/warehouses/{warehouseId}","href":"/en/v1/stock/warehouses/delete"},{"group":"Sections","icon":"map-pin","pages":[{"title":"List sections","openapi":"api-reference/openapi.json GET /api/v1/stock/warehouses/{warehouseId}/sections","href":"/en/v1/stock/warehouses/sections/list"},{"title":"Get section","openapi":"api-reference/openapi.json GET /api/v1/stock/warehouses/{warehouseId}/sections/{sectionId}","href":"/en/v1/stock/warehouses/sections/get"},{"title":"Create section","openapi":"api-reference/openapi.json POST /api/v1/stock/warehouses/{warehouseId}/sections","href":"/en/v1/stock/warehouses/sections/create"},{"title":"Update section","openapi":"api-reference/openapi.json PUT /api/v1/stock/warehouses/{warehouseId}/sections/{sectionId}","href":"/en/v1/stock/warehouses/sections/update"},{"title":"Partially update section","openapi":"api-reference/openapi.json PATCH /api/v1/stock/warehouses/{warehouseId}/sections/{sectionId}","href":"/en/v1/stock/warehouses/sections/patch"},{"title":"Delete section","openapi":"api-reference/openapi.json DELETE /api/v1/stock/warehouses/{warehouseId}/sections/{sectionId}","href":"/en/v1/stock/warehouses/sections/delete"}]}]},{"group":"Product Stock Status","icon":"boxes-packing","pages":[{"title":"Product stock status","openapi":"api-reference/openapi.json GET /api/v1/stock/products/{productId}/status","href":"/en/v1/stock/products/status"},{"title":"Product stock status by code","openapi":"api-reference/openapi.json GET /api/v1/stock/products/status","href":"/en/v1/stock/products/status-by-code"}]}]},{"group":"Quotes","icon":"file-signature","root":{"title":"Quotes","icon":"file-signature","href":"/en/v1/quotes/overview"},"expanded":false,"pages":[{"title":"Calculating quote amounts","href":"/en/v1/quotes/calculations"},{"title":"List quotes","openapi":"api-reference/openapi.json GET /api/v1/quotes","href":"/en/v1/quotes/list"},{"title":"Get quote","openapi":"api-reference/openapi.json GET /api/v1/quotes/{quoteId}","href":"/en/v1/quotes/get"},{"title":"Create quote","openapi":"api-reference/openapi.json POST /api/v1/quotes","href":"/en/v1/quotes/create"},{"title":"Update quote","openapi":"api-reference/openapi.json PUT /api/v1/quotes/{quoteId}","href":"/en/v1/quotes/update"},{"title":"Partially update quote","openapi":"api-reference/openapi.json PATCH /api/v1/quotes/{quoteId}","href":"/en/v1/quotes/patch"},{"title":"Delete quote","openapi":"api-reference/openapi.json DELETE /api/v1/quotes/{quoteId}","href":"/en/v1/quotes/delete"}]},{"group":"Orders","icon":"cart-shopping","root":{"title":"Orders","icon":"cart-shopping","href":"/en/v1/orders/overview"},"expanded":false,"pages":[{"title":"List orders","openapi":"api-reference/openapi.json GET /api/v1/orders","href":"/en/v1/orders/list"},{"title":"Get order","openapi":"api-reference/openapi.json GET /api/v1/orders/{orderId}","href":"/en/v1/orders/get"},{"title":"Create order","openapi":"api-reference/openapi.json POST /api/v1/orders","href":"/en/v1/orders/create"},{"title":"Update order","openapi":"api-reference/openapi.json PUT /api/v1/orders/{orderId}","href":"/en/v1/orders/update"},{"title":"Partially update order","openapi":"api-reference/openapi.json PATCH /api/v1/orders/{orderId}","href":"/en/v1/orders/patch"},{"title":"Delete order","openapi":"api-reference/openapi.json DELETE /api/v1/orders/{orderId}","href":"/en/v1/orders/delete"}]},{"group":"Despatches","icon":"truck","root":{"title":"Despatches","icon":"truck","href":"/en/v1/despatches/overview"},"expanded":false,"pages":[{"title":"List despatches","openapi":"api-reference/openapi.json GET /api/v1/despatches","href":"/en/v1/despatches/list"},{"title":"Get despatch","openapi":"api-reference/openapi.json GET /api/v1/despatches/{despatchId}","href":"/en/v1/despatches/get"},{"title":"Create despatch","openapi":"api-reference/openapi.json POST /api/v1/despatches","href":"/en/v1/despatches/create"},{"title":"Update despatch","openapi":"api-reference/openapi.json PUT /api/v1/despatches/{despatchId}","href":"/en/v1/despatches/update"},{"title":"Partially update despatch","openapi":"api-reference/openapi.json PATCH /api/v1/despatches/{despatchId}","href":"/en/v1/despatches/patch"},{"title":"Delete despatch","openapi":"api-reference/openapi.json DELETE /api/v1/despatches/{despatchId}","href":"/en/v1/despatches/delete"}]},{"group":"Invoices","icon":"file-invoice","expanded":false,"pages":[{"group":"Purchase Invoices","root":{"title":"Purchase Invoices","icon":"file-invoice","href":"/en/v1/purchase-invoices/overview"},"pages":[{"title":"List purchase invoices","openapi":"api-reference/openapi.json GET /api/v1/purchase-invoices","href":"/en/v1/purchase-invoices/list"},{"title":"Get purchase invoice","openapi":"api-reference/openapi.json GET /api/v1/purchase-invoices/{invoiceId}","href":"/en/v1/purchase-invoices/get"},{"title":"Create purchase invoice","openapi":"api-reference/openapi.json POST /api/v1/purchase-invoices","href":"/en/v1/purchase-invoices/create"},{"title":"Update purchase invoice","openapi":"api-reference/openapi.json PUT /api/v1/purchase-invoices/{invoiceId}","href":"/en/v1/purchase-invoices/update"},{"title":"Partially update purchase invoice","openapi":"api-reference/openapi.json PATCH /api/v1/purchase-invoices/{invoiceId}","href":"/en/v1/purchase-invoices/patch"},{"title":"Delete purchase invoice","openapi":"api-reference/openapi.json DELETE /api/v1/purchase-invoices/{invoiceId}","href":"/en/v1/purchase-invoices/delete"}]},{"group":"Sales Invoices","root":{"title":"Sales Invoices","icon":"file-invoice","href":"/en/v1/sales-invoices/overview"},"pages":[{"title":"List sales invoices","openapi":"api-reference/openapi.json GET /api/v1/sales-invoices","href":"/en/v1/sales-invoices/list"},{"title":"Get sales invoice","openapi":"api-reference/openapi.json GET /api/v1/sales-invoices/{invoiceId}","href":"/en/v1/sales-invoices/get"},{"title":"Create sales invoice","openapi":"api-reference/openapi.json POST /api/v1/sales-invoices","href":"/en/v1/sales-invoices/create"},{"title":"Update sales invoice","openapi":"api-reference/openapi.json PUT /api/v1/sales-invoices/{invoiceId}","href":"/en/v1/sales-invoices/update"},{"title":"Partially update sales invoice","openapi":"api-reference/openapi.json PATCH /api/v1/sales-invoices/{invoiceId}","href":"/en/v1/sales-invoices/patch"},{"title":"Delete sales invoice","openapi":"api-reference/openapi.json DELETE /api/v1/sales-invoices/{invoiceId}","href":"/en/v1/sales-invoices/delete"}]},{"group":"Purchase Return Invoices","root":{"title":"Purchase Return Invoices","icon":"file-invoice","href":"/en/v1/purchase-return-invoices/overview"},"pages":[{"title":"List purchase return invoices","openapi":"api-reference/openapi.json GET /api/v1/purchase-return-invoices","href":"/en/v1/purchase-return-invoices/list"},{"title":"Get purchase return invoice","openapi":"api-reference/openapi.json GET /api/v1/purchase-return-invoices/{invoiceId}","href":"/en/v1/purchase-return-invoices/get"},{"title":"Create purchase return invoice","openapi":"api-reference/openapi.json POST /api/v1/purchase-return-invoices","href":"/en/v1/purchase-return-invoices/create"},{"title":"Update purchase return invoice","openapi":"api-reference/openapi.json PUT /api/v1/purchase-return-invoices/{invoiceId}","href":"/en/v1/purchase-return-invoices/update"},{"title":"Partially update purchase return invoice","openapi":"api-reference/openapi.json PATCH /api/v1/purchase-return-invoices/{invoiceId}","href":"/en/v1/purchase-return-invoices/patch"},{"title":"Delete purchase return invoice","openapi":"api-reference/openapi.json DELETE /api/v1/purchase-return-invoices/{invoiceId}","href":"/en/v1/purchase-return-invoices/delete"}]},{"group":"Sales Return Invoices","root":{"title":"Sales Return Invoices","icon":"file-invoice","href":"/en/v1/sales-return-invoices/overview"},"pages":[{"title":"List sales return invoices","openapi":"api-reference/openapi.json GET /api/v1/sales-return-invoices","href":"/en/v1/sales-return-invoices/list"},{"title":"Get sales return invoice","openapi":"api-reference/openapi.json GET /api/v1/sales-return-invoices/{invoiceId}","href":"/en/v1/sales-return-invoices/get"},{"title":"Create sales return invoice","openapi":"api-reference/openapi.json POST /api/v1/sales-return-invoices","href":"/en/v1/sales-return-invoices/create"},{"title":"Update sales return invoice","openapi":"api-reference/openapi.json PUT /api/v1/sales-return-invoices/{invoiceId}","href":"/en/v1/sales-return-invoices/update"},{"title":"Partially update sales return invoice","openapi":"api-reference/openapi.json PATCH /api/v1/sales-return-invoices/{invoiceId}","href":"/en/v1/sales-return-invoices/patch"},{"title":"Delete sales return invoice","openapi":"api-reference/openapi.json DELETE /api/v1/sales-return-invoices/{invoiceId}","href":"/en/v1/sales-return-invoices/delete"}]}]},{"group":"Finance","icon":"building-columns","root":{"title":"Finance","icon":"building-columns","href":"/en/v1/finance/overview"},"expanded":false,"pages":[{"group":"Customers","icon":"address-card","pages":[{"title":"Customer balances","openapi":"api-reference/openapi.json GET /api/v1/finance/customers/balances","href":"/en/v1/finance/customers/balances"},{"title":"Customer transactions","openapi":"api-reference/openapi.json GET /api/v1/finance/customers/{customerId}/transactions","href":"/en/v1/finance/customers/transactions"}]},{"group":"Bank","icon":"landmark","pages":[{"group":"Bank transfers","icon":"money-bill-transfer","root":{"title":"Bank Transfer Vouchers","icon":"money-bill-transfer","href":"/en/v1/finance/bank-transfers/overview"},"pages":[{"title":"List bank transfers","openapi":"api-reference/openapi.json GET /api/v1/finance/bank-transfers","href":"/en/v1/finance/bank-transfers/list"},{"title":"Get bank transfer","openapi":"api-reference/openapi.json GET /api/v1/finance/bank-transfers/{bankTransferId}","href":"/en/v1/finance/bank-transfers/get"},{"title":"Create bank transfer","openapi":"api-reference/openapi.json POST /api/v1/finance/bank-transfers","href":"/en/v1/finance/bank-transfers/create"},{"title":"Update bank transfer","openapi":"api-reference/openapi.json PUT /api/v1/finance/bank-transfers/{bankTransferId}","href":"/en/v1/finance/bank-transfers/update"},{"title":"Partially update bank transfer","openapi":"api-reference/openapi.json PATCH /api/v1/finance/bank-transfers/{bankTransferId}","href":"/en/v1/finance/bank-transfers/patch"},{"title":"Delete bank transfer","openapi":"api-reference/openapi.json DELETE /api/v1/finance/bank-transfers/{bankTransferId}","href":"/en/v1/finance/bank-transfers/delete"}]},{"group":"Bank openings","icon":"door-open","root":{"title":"Bank Opening Vouchers","icon":"door-open","href":"/en/v1/finance/bank-openings/overview"},"pages":[{"title":"List bank openings","openapi":"api-reference/openapi.json GET /api/v1/finance/bank-openings","href":"/en/v1/finance/bank-openings/list"},{"title":"Get bank opening","openapi":"api-reference/openapi.json GET /api/v1/finance/bank-openings/{bankOpeningId}","href":"/en/v1/finance/bank-openings/get"},{"title":"Create bank opening","openapi":"api-reference/openapi.json POST /api/v1/finance/bank-openings","href":"/en/v1/finance/bank-openings/create"},{"title":"Update bank opening","openapi":"api-reference/openapi.json PUT /api/v1/finance/bank-openings/{bankOpeningId}","href":"/en/v1/finance/bank-openings/update"},{"title":"Partially update bank opening","openapi":"api-reference/openapi.json PATCH /api/v1/finance/bank-openings/{bankOpeningId}","href":"/en/v1/finance/bank-openings/patch"},{"title":"Delete bank opening","openapi":"api-reference/openapi.json DELETE /api/v1/finance/bank-openings/{bankOpeningId}","href":"/en/v1/finance/bank-openings/delete"}]},{"group":"Bank internal transfers","icon":"right-left","root":{"title":"Bank Internal Transfer Vouchers","icon":"right-left","href":"/en/v1/finance/bank-internal-transfers/overview"},"pages":[{"title":"List bank internal transfers","openapi":"api-reference/openapi.json GET /api/v1/finance/bank-internal-transfers","href":"/en/v1/finance/bank-internal-transfers/list"},{"title":"Get bank internal transfer","openapi":"api-reference/openapi.json GET /api/v1/finance/bank-internal-transfers/{bankInternalTransferId}","href":"/en/v1/finance/bank-internal-transfers/get"},{"title":"Create bank internal transfer","openapi":"api-reference/openapi.json POST /api/v1/finance/bank-internal-transfers","href":"/en/v1/finance/bank-internal-transfers/create"},{"title":"Update bank internal transfer","openapi":"api-reference/openapi.json PUT /api/v1/finance/bank-internal-transfers/{bankInternalTransferId}","href":"/en/v1/finance/bank-internal-transfers/update"},{"title":"Partially update bank internal transfer","openapi":"api-reference/openapi.json PATCH /api/v1/finance/bank-internal-transfers/{bankInternalTransferId}","href":"/en/v1/finance/bank-internal-transfers/patch"},{"title":"Delete bank internal transfer","openapi":"api-reference/openapi.json DELETE /api/v1/finance/bank-internal-transfers/{bankInternalTransferId}","href":"/en/v1/finance/bank-internal-transfers/delete"}]},{"group":"Credit card collections","icon":"credit-card","root":{"title":"Credit Card Collection Vouchers","icon":"credit-card","href":"/en/v1/finance/credit-card-collections/overview"},"pages":[{"title":"List credit card collections","openapi":"api-reference/openapi.json GET /api/v1/finance/credit-card-collections","href":"/en/v1/finance/credit-card-collections/list"},{"title":"Get credit card collection","openapi":"api-reference/openapi.json GET /api/v1/finance/credit-card-collections/{creditCardCollectionId}","href":"/en/v1/finance/credit-card-collections/get"},{"title":"Create credit card collection","openapi":"api-reference/openapi.json POST /api/v1/finance/credit-card-collections","href":"/en/v1/finance/credit-card-collections/create"},{"title":"Update credit card collection","openapi":"api-reference/openapi.json PUT /api/v1/finance/credit-card-collections/{creditCardCollectionId}","href":"/en/v1/finance/credit-card-collections/update"},{"title":"Partially update credit card collection","openapi":"api-reference/openapi.json PATCH /api/v1/finance/credit-card-collections/{creditCardCollectionId}","href":"/en/v1/finance/credit-card-collections/patch"},{"title":"Delete credit card collection","openapi":"api-reference/openapi.json DELETE /api/v1/finance/credit-card-collections/{creditCardCollectionId}","href":"/en/v1/finance/credit-card-collections/delete"}]},{"group":"Bank definitions","icon":"building-columns","pages":[{"title":"List banks","openapi":"api-reference/openapi.json GET /api/v1/finance/banks","href":"/en/v1/finance/banks/list"},{"title":"Get bank","openapi":"api-reference/openapi.json GET /api/v1/finance/banks/{bankId}","href":"/en/v1/finance/banks/get"},{"title":"Create bank","openapi":"api-reference/openapi.json POST /api/v1/finance/banks","href":"/en/v1/finance/banks/create"},{"title":"Update bank","openapi":"api-reference/openapi.json PUT /api/v1/finance/banks/{bankId}","href":"/en/v1/finance/banks/update"},{"title":"Partially update bank","openapi":"api-reference/openapi.json PATCH /api/v1/finance/banks/{bankId}","href":"/en/v1/finance/banks/patch"},{"title":"Delete bank","openapi":"api-reference/openapi.json DELETE /api/v1/finance/banks/{bankId}","href":"/en/v1/finance/banks/delete"}]},{"group":"Bank accounts","icon":"credit-card","pages":[{"title":"List bank accounts","openapi":"api-reference/openapi.json GET /api/v1/finance/bank-accounts","href":"/en/v1/finance/bank-accounts/list"},{"title":"Get bank account","openapi":"api-reference/openapi.json GET /api/v1/finance/bank-accounts/{bankAccountId}","href":"/en/v1/finance/bank-accounts/get"},{"title":"Create bank account","openapi":"api-reference/openapi.json POST /api/v1/finance/bank-accounts","href":"/en/v1/finance/bank-accounts/create"},{"title":"Update bank account","openapi":"api-reference/openapi.json PUT /api/v1/finance/bank-accounts/{bankAccountId}","href":"/en/v1/finance/bank-accounts/update"},{"title":"Partially update bank account","openapi":"api-reference/openapi.json PATCH /api/v1/finance/bank-accounts/{bankAccountId}","href":"/en/v1/finance/bank-accounts/patch"},{"title":"Delete bank account","openapi":"api-reference/openapi.json DELETE /api/v1/finance/bank-accounts/{bankAccountId}","href":"/en/v1/finance/bank-accounts/delete"},{"group":"Repayment plans","icon":"calendar-days","pages":[{"title":"List repayment plans","openapi":"api-reference/openapi.json GET /api/v1/finance/bank-accounts/{bankAccountId}/repayment-plans","href":"/en/v1/finance/bank-accounts/repayment-plans/list"},{"title":"Get repayment plan","openapi":"api-reference/openapi.json GET /api/v1/finance/bank-accounts/{bankAccountId}/repayment-plans/{repaymentPlanId}","href":"/en/v1/finance/bank-accounts/repayment-plans/get"},{"title":"Create repayment plan","openapi":"api-reference/openapi.json POST /api/v1/finance/bank-accounts/{bankAccountId}/repayment-plans","href":"/en/v1/finance/bank-accounts/repayment-plans/create"},{"title":"Update repayment plan","openapi":"api-reference/openapi.json PUT /api/v1/finance/bank-accounts/{bankAccountId}/repayment-plans/{repaymentPlanId}","href":"/en/v1/finance/bank-accounts/repayment-plans/update"},{"title":"Partially update repayment plan","openapi":"api-reference/openapi.json PATCH /api/v1/finance/bank-accounts/{bankAccountId}/repayment-plans/{repaymentPlanId}","href":"/en/v1/finance/bank-accounts/repayment-plans/patch"},{"title":"Delete repayment plan","openapi":"api-reference/openapi.json DELETE /api/v1/finance/bank-accounts/{bankAccountId}/repayment-plans/{repaymentPlanId}","href":"/en/v1/finance/bank-accounts/repayment-plans/delete"}]}]}]}]}]},{"group":"Release notes","pages":[{"title":"Release notes","icon":"clock-rotate-left","href":"/en/v1/changelog"}]}]}]}]},"basePath":"","title":"Sharing codes - Noyax API","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":[],"chunks":[]}