{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Zenskar Documentation","colors":{"primary":"#0A1633","light":"#3B82F6","dark":"#1D3461"},"logo":{"light":"https://mintcdn.com/zenskar-3d451781/8zM5vHUy4GbBMWvZ/logo/for-light-themes.svg?fit=max\u0026auto=format\u0026n=8zM5vHUy4GbBMWvZ\u0026q=85\u0026s=7b3708e348af5e2ca4bd6f302186ccc2","dark":"https://mintcdn.com/zenskar-3d451781/8zM5vHUy4GbBMWvZ/logo/for-dark-themes.svg?fit=max\u0026auto=format\u0026n=8zM5vHUy4GbBMWvZ\u0026q=85\u0026s=591296922399ed1050dc1ee22842edbc"},"favicon":"https://mintcdn.com/zenskar-3d451781/8zM5vHUy4GbBMWvZ/favicon.svg?fit=max\u0026auto=format\u0026n=8zM5vHUy4GbBMWvZ\u0026q=85\u0026s=9a4afe8a43b76270c67c367963907132","navbar":{"links":[{"href":"mailto:help@zenskar.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.zenskar.com"}},"footer":{"socials":{"x":"https://x.com/zenskar","github":"https://github.com/zenskar","linkedin":"https://linkedin.com/company/zenskar"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://www.zenskar.com/blog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"zenskar-3d451781","hasAudioNarration":false,"actualSubdomain":"zenskar-3d451781","customDomains":["zenskar.com"],"gitSource":{"type":"github","owner":"zenskar","repo":"documentation-public","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae44f03a3eed560d7e476ac","collectionId":"86bb2415-b9f8-4d7a-8bdd-ea1e647079c0","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae44f03a3eed560d7e476ac"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae44f03a3eed560d7e476ac","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"Documentation","count":322},{"language":"default","tag":"Product modules","count":191},{"language":"default","tag":"API Reference","count":164},{"language":"default","tag":"Third-party integrations","count":68},{"language":"default","tag":"How-to guides","count":43},{"language":"default","tag":"Contracts","count":40},{"language":"default","tag":"Data sources","count":39},{"language":"default","tag":"Concepts","count":36},{"language":"default","tag":"Accounting","count":35},{"language":"default","tag":"Settings","count":34}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@zenskar.com","showHelpButton":true}},"basePath":"/docs","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":"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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/customers/get-customer-by-id","slug":"/api-reference/customers/get-customer-by-id","pageMetadata":{"title":"Get customer by ID","description":"Retrieve detailed information for a specific customer by their unique identifier.\n\nReturns comprehensive customer data including:\n- Basic information: name, email, phone\n- Address details: billing and shipping addresses\n- Custom data: organization-specific custom fields\n- Metadata: creation and update timestamps\n\nRequirements:\n- Customer must belong to the authenticated organization\n- Valid UUID format required for customer_id\n- Returns 404 if customer doesn't exist or is not accessible","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /customers/{customer_id}","href":"/api-reference/customers/get-customer-by-id","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n li: \"li\",\n p: \"p\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Retrieve detailed information for a specific customer by their unique identifier.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Returns comprehensive customer data including:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Basic information: name, email, phone\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Address details: billing and shipping addresses\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Custom data: organization-specific custom fields\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Metadata: creation and update timestamps\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Requirements:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Customer must belong to the authenticated organization\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Valid UUID format required for customer_id\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Returns 404 if customer doesn’t exist or is not accessible\"\n }), \"\\n\"]\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get customer by ID","description":"Retrieve detailed information for a specific customer by their unique identifier.\n\nReturns comprehensive customer data including:\n- Basic information: name, email, phone\n- Address details: billing and shipping addresses\n- Custom data: organization-specific custom fields\n- Metadata: creation and update timestamps\n\nRequirements:\n- Customer must belong to the authenticated organization\n- Valid UUID format required for customer_id\n- Returns 404 if customer doesn't exist or is not accessible","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /customers/{customer_id}","href":"/api-reference/customers/get-customer-by-id","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Customers"],"summary":"Get customer by ID","description":"Retrieve detailed information for a specific customer by their unique identifier.\n\nReturns comprehensive customer data including:\n- Basic information: name, email, phone\n- Address details: billing and shipping addresses\n- Custom data: organization-specific custom fields\n- Metadata: creation and update timestamps\n\nRequirements:\n- Customer must belong to the authenticated organization\n- Valid UUID format required for customer_id\n- Returns 404 if customer doesn't exist or is not accessible","operationId":"Get-customer-by-ID","parameters":["14078549-0339-4098-b97c-20524f9d288e"],"responses":{"200":"a2d1ef39-a7af-48f6-8717-67ae07aa00eb","400":"d8f4338a-f4ce-4e96-bc0e-d00e9413663c","404":"ab9b9a93-2fe2-43e4-bc95-38402791bbd9","422":"8237287a-2276-4027-a9f9-eadc4092dd16","500":"cb88030e-c0f8-4433-bb30-62598d64e7f4"},"method":"get","type":"path","servers":["b5800edb-bebb-41b7-ba92-5775ad182a17"],"security":["95049f99-a4b8-435b-a365-25b6391f1cff"],"path":"/customers/{customer_id}","baseUrlOptions":["https://api.zenskar.com"],"title":"Get customer by ID","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"14078549-0339-4098-b97c-20524f9d288e":{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Customer Id","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"a2d1ef39-a7af-48f6-8717-67ae07aa00eb":{"description":"Successfully retrieved customer","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Customer ID","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"external_id":{"oneOf":[{"type":"string","title":"External Id","description":"External Customer Id","isRequired":true,"uniqueKey":"external_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"External Id","description":"External Customer Id","isRequired":true,"uniqueKey":"external_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"external_id","typeLabel":"string | null"},"customer_name":{"type":"string","title":"Customer Name","description":"Customer name","isRequired":true,"uniqueKey":"customer_name","typeLabel":"string"},"custom_data":{"oneOf":[{"type":"object","title":"Custom Data","description":"Customer Custom Data","additionalProperties":true,"isRequired":true,"uniqueKey":"custom_data.oneOf.0","typeLabel":"Custom Data · object"},{"type":"null","title":"Custom Data","description":"Customer Custom Data","isRequired":true,"uniqueKey":"custom_data.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"custom_data","typeLabel":"Custom Data · object | null"},"address":{"oneOf":[{"type":"object","title":"AddressResponse","description":"Customer address","properties":{"line1":{"oneOf":[{"type":"string","title":"Line1","description":"Street address line 1 (e.g., building number and street name)","uniqueKey":"address.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"type":"null","title":"Line1","description":"Street address line 1 (e.g., building number and street name)","uniqueKey":"address.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"type":"string","title":"Line2","description":"Street address line 2 (e.g., apartment, suite, unit number)","uniqueKey":"address.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"type":"null","title":"Line2","description":"Street address line 2 (e.g., apartment, suite, unit number)","uniqueKey":"address.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.oneOf.0.line2","typeLabel":"string | null"},"line3":{"oneOf":[{"type":"string","title":"Line3","description":"Street address line 3 (additional address information)","uniqueKey":"address.oneOf.0.line3.oneOf.0","typeLabel":"string"},{"type":"null","title":"Line3","description":"Street address line 3 (additional address information)","uniqueKey":"address.oneOf.0.line3.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.oneOf.0.line3","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","title":"City","description":"City or locality name","uniqueKey":"address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","title":"City","description":"City or locality name","uniqueKey":"address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.oneOf.0.city","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","title":"State","description":"State, province, or region","uniqueKey":"address.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","title":"State","description":"State, province, or region","uniqueKey":"address.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.oneOf.0.state","typeLabel":"string | null"},"zipCode":{"oneOf":[{"type":"string","title":"Zipcode","description":"Postal code or ZIP code","uniqueKey":"address.oneOf.0.zipCode.oneOf.0","typeLabel":"string"},{"type":"null","title":"Zipcode","description":"Postal code or ZIP code","uniqueKey":"address.oneOf.0.zipCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.oneOf.0.zipCode","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","title":"Country","description":"Country name (e.g., 'United States')","uniqueKey":"address.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","title":"Country","description":"Country name (e.g., 'United States')","uniqueKey":"address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.oneOf.0.country","typeLabel":"string | null"},"country_code":{"oneOf":[{"type":"string","title":"Country Code","description":"Two-letter ISO country code (e.g., 'US', 'GB')","uniqueKey":"address.oneOf.0.country_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Country Code","description":"Two-letter ISO country code (e.g., 'US', 'GB')","uniqueKey":"address.oneOf.0.country_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.oneOf.0.country_code","typeLabel":"string | null"},"validation_status":{"oneOf":[{"type":"string","title":"Validation Status","description":"Address validation status","uniqueKey":"address.oneOf.0.validation_status.oneOf.0","typeLabel":"string"},{"type":"null","title":"Validation Status","description":"Address validation status","uniqueKey":"address.oneOf.0.validation_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.oneOf.0.validation_status","typeLabel":"string | null"},"connector_validation":{"oneOf":[{"type":"object","title":"Connector Validation","description":"Validation data from external connector","additionalProperties":true,"uniqueKey":"address.oneOf.0.connector_validation.oneOf.0","typeLabel":"Connector Validation · object"},{"type":"null","title":"Connector Validation","description":"Validation data from external connector","uniqueKey":"address.oneOf.0.connector_validation.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.oneOf.0.connector_validation","typeLabel":"Connector Validation · object | null"}},"isRequired":true,"uniqueKey":"address.oneOf.0","typeLabel":"AddressResponse · object"},{"type":"null","description":"Customer address","isRequired":true,"uniqueKey":"address.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"address","typeLabel":"AddressResponse · object | null"},"ship_to_address":{"oneOf":[{"type":"object","title":"AddressResponse","description":"Customer Ship To address","properties":{"line1":{"oneOf":[{"type":"string","title":"Line1","description":"Street address line 1 (e.g., building number and street name)","uniqueKey":"ship_to_address.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"type":"null","title":"Line1","description":"Street address line 1 (e.g., building number and street name)","uniqueKey":"ship_to_address.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_to_address.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"type":"string","title":"Line2","description":"Street address line 2 (e.g., apartment, suite, unit number)","uniqueKey":"ship_to_address.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"type":"null","title":"Line2","description":"Street address line 2 (e.g., apartment, suite, unit number)","uniqueKey":"ship_to_address.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_to_address.oneOf.0.line2","typeLabel":"string | null"},"line3":{"oneOf":[{"type":"string","title":"Line3","description":"Street address line 3 (additional address information)","uniqueKey":"ship_to_address.oneOf.0.line3.oneOf.0","typeLabel":"string"},{"type":"null","title":"Line3","description":"Street address line 3 (additional address information)","uniqueKey":"ship_to_address.oneOf.0.line3.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_to_address.oneOf.0.line3","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","title":"City","description":"City or locality name","uniqueKey":"ship_to_address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","title":"City","description":"City or locality name","uniqueKey":"ship_to_address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_to_address.oneOf.0.city","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","title":"State","description":"State, province, or region","uniqueKey":"ship_to_address.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","title":"State","description":"State, province, or region","uniqueKey":"ship_to_address.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_to_address.oneOf.0.state","typeLabel":"string | null"},"zipCode":{"oneOf":[{"type":"string","title":"Zipcode","description":"Postal code or ZIP code","uniqueKey":"ship_to_address.oneOf.0.zipCode.oneOf.0","typeLabel":"string"},{"type":"null","title":"Zipcode","description":"Postal code or ZIP code","uniqueKey":"ship_to_address.oneOf.0.zipCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_to_address.oneOf.0.zipCode","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","title":"Country","description":"Country name (e.g., 'United States')","uniqueKey":"ship_to_address.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","title":"Country","description":"Country name (e.g., 'United States')","uniqueKey":"ship_to_address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_to_address.oneOf.0.country","typeLabel":"string | null"},"country_code":{"oneOf":[{"type":"string","title":"Country Code","description":"Two-letter ISO country code (e.g., 'US', 'GB')","uniqueKey":"ship_to_address.oneOf.0.country_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Country Code","description":"Two-letter ISO country code (e.g., 'US', 'GB')","uniqueKey":"ship_to_address.oneOf.0.country_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_to_address.oneOf.0.country_code","typeLabel":"string | null"},"validation_status":{"oneOf":[{"type":"string","title":"Validation Status","description":"Address validation status","uniqueKey":"ship_to_address.oneOf.0.validation_status.oneOf.0","typeLabel":"string"},{"type":"null","title":"Validation Status","description":"Address validation status","uniqueKey":"ship_to_address.oneOf.0.validation_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_to_address.oneOf.0.validation_status","typeLabel":"string | null"},"connector_validation":{"oneOf":[{"type":"object","title":"Connector Validation","description":"Validation data from external connector","additionalProperties":true,"uniqueKey":"ship_to_address.oneOf.0.connector_validation.oneOf.0","typeLabel":"Connector Validation · object"},{"type":"null","title":"Connector Validation","description":"Validation data from external connector","uniqueKey":"ship_to_address.oneOf.0.connector_validation.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_to_address.oneOf.0.connector_validation","typeLabel":"Connector Validation · object | null"}},"uniqueKey":"ship_to_address.oneOf.0","typeLabel":"AddressResponse · object"},{"type":"null","description":"Customer Ship To address","uniqueKey":"ship_to_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_to_address","typeLabel":"AddressResponse · object | null"},"tax_info":{"oneOf":[{"type":"array","items":{"properties":{"country_code":{"oneOf":[{"type":"string","title":"Country Code","description":"Two-letter ISO country code for the tax ID (e.g., 'US', 'GB', 'IN')","uniqueKey":"tax_info.oneOf.0.items.[INDEX].country_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Country Code","description":"Two-letter ISO country code for the tax ID (e.g., 'US', 'GB', 'IN')","uniqueKey":"tax_info.oneOf.0.items.[INDEX].country_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"tax_info.oneOf.0.items.[INDEX].country_code","typeLabel":"string | null"},"tax_code":{"oneOf":[{"type":"string","title":"Tax Code","description":"Type of tax identifier (e.g., 'VAT', 'GST', 'EIN')","uniqueKey":"tax_info.oneOf.0.items.[INDEX].tax_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Tax Code","description":"Type of tax identifier (e.g., 'VAT', 'GST', 'EIN')","uniqueKey":"tax_info.oneOf.0.items.[INDEX].tax_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"tax_info.oneOf.0.items.[INDEX].tax_code","typeLabel":"string | null"},"tax_id":{"oneOf":[{"type":"string","title":"Tax Id","description":"The actual tax identification number","uniqueKey":"tax_info.oneOf.0.items.[INDEX].tax_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Tax Id","description":"The actual tax identification number","uniqueKey":"tax_info.oneOf.0.items.[INDEX].tax_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"tax_info.oneOf.0.items.[INDEX].tax_id","typeLabel":"string | null"}},"type":"object","title":"TaxId","description":"Tax Id Schema","uniqueKey":"tax_info.oneOf.0.items.[INDEX]","typeLabel":"TaxId · object"},"title":"Tax Info","description":"Customer Tax Ids","default":[],"uniqueKey":"tax_info.oneOf.0","typeLabel":"TaxId · object[]"},{"type":"null","title":"Tax Info","description":"Customer Tax Ids","default":[],"uniqueKey":"tax_info.oneOf.1","typeLabel":"null"}],"uniqueKey":"tax_info","typeLabel":"TaxId · object[] | null"},"phone_number":{"oneOf":[{"type":"string","title":"Phone Number","description":"Customer Phone Number","uniqueKey":"phone_number.oneOf.0","typeLabel":"string"},{"type":"null","title":"Phone Number","description":"Customer Phone Number","uniqueKey":"phone_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"phone_number","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","title":"Email","description":"Customer primary email address","uniqueKey":"email.oneOf.0","typeLabel":"string"},{"type":"null","title":"Email","description":"Customer primary email address","uniqueKey":"email.oneOf.1","typeLabel":"null"}],"uniqueKey":"email","typeLabel":"string | null"},"contacts":{"oneOf":[{"type":"array","items":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Contact Id","isRequired":true,"uniqueKey":"contacts.oneOf.0.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"customer":{"type":"string","format":"uuid","title":"Customer","description":" ","isRequired":true,"uniqueKey":"contacts.oneOf.0.items.[INDEX].customer","typeLabel":"string\u003cuuid>"},"email":{"type":"string","title":"Email","description":"Contact Email","isRequired":true,"uniqueKey":"contacts.oneOf.0.items.[INDEX].email","typeLabel":"string"},"first_name":{"oneOf":[{"type":"string","title":"First Name","description":"Contact first name","uniqueKey":"contacts.oneOf.0.items.[INDEX].first_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"First Name","description":"Contact first name","uniqueKey":"contacts.oneOf.0.items.[INDEX].first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.oneOf.0.items.[INDEX].first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","title":"Last Name","description":"Contact last name","uniqueKey":"contacts.oneOf.0.items.[INDEX].last_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Last Name","description":"Contact last name","uniqueKey":"contacts.oneOf.0.items.[INDEX].last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.oneOf.0.items.[INDEX].last_name","typeLabel":"string | null"},"send_contract":{"type":"boolean","title":"Send Contract","description":"Send Contract","default":false,"uniqueKey":"contacts.oneOf.0.items.[INDEX].send_contract","typeLabel":"boolean"},"send_invoice":{"type":"boolean","title":"Send Invoice","description":"Send Contact","default":true,"uniqueKey":"contacts.oneOf.0.items.[INDEX].send_invoice","typeLabel":"boolean"}},"type":"object","required":["id","customer","email"],"title":"ContactResponseSchema","description":"Create \u0026 Update Contact Response Schema","uniqueKey":"contacts.oneOf.0.items.[INDEX]","typeLabel":"ContactResponseSchema · object"},"title":"Contacts","description":"List of associated contacts","uniqueKey":"contacts.oneOf.0","typeLabel":"ContactResponseSchema · object[]"},{"type":"null","title":"Contacts","description":"List of associated contacts","uniqueKey":"contacts.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts","typeLabel":"ContactResponseSchema · object[] | null"},"custom_attributes":{"oneOf":[{"type":"object","title":"Custom Attributes","description":"Customer Tags","additionalProperties":true,"uniqueKey":"custom_attributes.oneOf.0","typeLabel":"Custom Attributes · object"},{"type":"null","title":"Custom Attributes","description":"Customer Tags","uniqueKey":"custom_attributes.oneOf.1","typeLabel":"null"}],"uniqueKey":"custom_attributes","typeLabel":"Custom Attributes · object | null"},"communications_enabled":{"oneOf":[{"type":"boolean","title":"Communications Enabled","description":"To enable/disable communications","default":true,"uniqueKey":"communications_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Communications Enabled","description":"To enable/disable communications","default":true,"uniqueKey":"communications_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"communications_enabled","typeLabel":"boolean | null"},"auto_charge_enabled":{"oneOf":[{"type":"boolean","title":"Auto Charge Enabled","description":"To enable/disable auto-charge","default":true,"uniqueKey":"auto_charge_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Auto Charge Enabled","description":"To enable/disable auto-charge","default":true,"uniqueKey":"auto_charge_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"auto_charge_enabled","typeLabel":"boolean | null"},"invoice_details":{"oneOf":[{"type":"object","title":"InvoiceDetailsObject","description":"Invoice Details Object","properties":{"no_of_invoices":{"oneOf":[{"type":"integer","title":"No Of Invoices","uniqueKey":"invoice_details.oneOf.0.no_of_invoices.oneOf.0","typeLabel":"integer"},{"type":"null","title":"No Of Invoices","uniqueKey":"invoice_details.oneOf.0.no_of_invoices.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_details.oneOf.0.no_of_invoices","typeLabel":"integer | null"},"total_amount_due":{"oneOf":[{"type":"number","title":"Total Amount Due","uniqueKey":"invoice_details.oneOf.0.total_amount_due.oneOf.0","typeLabel":"number"},{"type":"null","title":"Total Amount Due","uniqueKey":"invoice_details.oneOf.0.total_amount_due.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_details.oneOf.0.total_amount_due","typeLabel":"number | null"}},"uniqueKey":"invoice_details.oneOf.0","typeLabel":"InvoiceDetailsObject · object"},{"type":"null","description":"Invoice Details Object","uniqueKey":"invoice_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_details","typeLabel":"InvoiceDetailsObject · object | null"},"created_at":{"oneOf":[{"type":"string","title":"Created At","description":"Created At","format":"date-time","uniqueKey":"created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Created At","description":"Created At","uniqueKey":"created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"created_at","typeLabel":"string\u003cdate-time> | null"},"updated_at":{"oneOf":[{"type":"string","title":"Updated At","description":"Updated At","format":"date-time","uniqueKey":"updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Updated At","description":"Updated At","uniqueKey":"updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time> | null"},"default_payment_method":{"oneOf":[{"type":"object","title":"CustomerPaymentMethodsResponseSchema","description":"default_payment_method","required":["id","customer_id","organisation_id","connector_id","connector_name","external_id","is_default"],"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Customer Id","isRequired":true,"uniqueKey":"default_payment_method.oneOf.0.id","typeLabel":"string\u003cuuid>"},"customer_id":{"type":"string","format":"uuid","title":"Customer Id","description":"Customer Id","isRequired":true,"uniqueKey":"default_payment_method.oneOf.0.customer_id","typeLabel":"string\u003cuuid>"},"organisation_id":{"type":"string","format":"uuid","title":"Organisation Id","description":"Organisation Id","isRequired":true,"uniqueKey":"default_payment_method.oneOf.0.organisation_id","typeLabel":"string\u003cuuid>"},"connector_id":{"type":"string","format":"uuid","title":"Connector Id","description":"Connector Id","isRequired":true,"uniqueKey":"default_payment_method.oneOf.0.connector_id","typeLabel":"string\u003cuuid>"},"connector_name":{"type":"string","title":"Connector Name","description":"Connector Name","isRequired":true,"uniqueKey":"default_payment_method.oneOf.0.connector_name","typeLabel":"string"},"external_id":{"type":"string","title":"External Id","description":"External Id","isRequired":true,"uniqueKey":"default_payment_method.oneOf.0.external_id","typeLabel":"string"},"is_default":{"type":"boolean","title":"Is Default","description":"is default payment method","isRequired":true,"uniqueKey":"default_payment_method.oneOf.0.is_default","typeLabel":"boolean"},"status":{"oneOf":[{"type":"string","title":"Status","description":"status","uniqueKey":"default_payment_method.oneOf.0.status.oneOf.0","typeLabel":"string"},{"type":"null","title":"Status","description":"status","uniqueKey":"default_payment_method.oneOf.0.status.oneOf.1","typeLabel":"null"}],"uniqueKey":"default_payment_method.oneOf.0.status","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","title":"Country","description":"country","uniqueKey":"default_payment_method.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","title":"Country","description":"country","uniqueKey":"default_payment_method.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"default_payment_method.oneOf.0.country","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","title":"Type","description":"payment method type","uniqueKey":"default_payment_method.oneOf.0.type.oneOf.0","typeLabel":"string"},{"type":"null","title":"Type","description":"payment method type","uniqueKey":"default_payment_method.oneOf.0.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"default_payment_method.oneOf.0.type","typeLabel":"string | null"},"details":{"oneOf":[{"type":"object","title":"Details","description":"Payment Method Details","additionalProperties":true,"uniqueKey":"default_payment_method.oneOf.0.details.oneOf.0","typeLabel":"Details · object"},{"type":"null","title":"Details","description":"Payment Method Details","uniqueKey":"default_payment_method.oneOf.0.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"default_payment_method.oneOf.0.details","typeLabel":"Details · object | null"}},"uniqueKey":"default_payment_method.oneOf.0","typeLabel":"CustomerPaymentMethodsResponseSchema · object"},{"type":"null","description":"default_payment_method","uniqueKey":"default_payment_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"default_payment_method","typeLabel":"CustomerPaymentMethodsResponseSchema · object | null"},"business_entity_id":{"oneOf":[{"type":"string","title":"Business Entity Id","description":"Business Entity Id","format":"uuid","uniqueKey":"business_entity_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","title":"Business Entity Id","description":"Business Entity Id","uniqueKey":"business_entity_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"business_entity_id","typeLabel":"string\u003cuuid> | null"},"business_entity":{"oneOf":[{"type":"object","title":"BusinessEntityResponseSchema","description":"Business Entity","required":["id","name","is_default"],"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Business Entity ID","isRequired":true,"uniqueKey":"business_entity.oneOf.0.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","title":"Name","description":"Business Entity Name","isRequired":true,"uniqueKey":"business_entity.oneOf.0.name","typeLabel":"string"},"is_default":{"type":"boolean","title":"Is Default","description":"Business Entity default","isRequired":true,"uniqueKey":"business_entity.oneOf.0.is_default","typeLabel":"boolean"},"address":{"oneOf":[{"type":"object","title":"EntityAddress","description":"Business Entity address","properties":{"line1":{"oneOf":[{"type":"string","title":"Line1","description":"Line 1","uniqueKey":"business_entity.oneOf.0.address.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"type":"null","title":"Line1","description":"Line 1","uniqueKey":"business_entity.oneOf.0.address.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"business_entity.oneOf.0.address.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"type":"string","title":"Line2","description":"Line 2","uniqueKey":"business_entity.oneOf.0.address.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"type":"null","title":"Line2","description":"Line 2","uniqueKey":"business_entity.oneOf.0.address.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"business_entity.oneOf.0.address.oneOf.0.line2","typeLabel":"string | null"},"line3":{"oneOf":[{"type":"string","title":"Line3","description":"Line 3","uniqueKey":"business_entity.oneOf.0.address.oneOf.0.line3.oneOf.0","typeLabel":"string"},{"type":"null","title":"Line3","description":"Line 3","uniqueKey":"business_entity.oneOf.0.address.oneOf.0.line3.oneOf.1","typeLabel":"null"}],"uniqueKey":"business_entity.oneOf.0.address.oneOf.0.line3","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","title":"City","description":"City","uniqueKey":"business_entity.oneOf.0.address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","title":"City","description":"City","uniqueKey":"business_entity.oneOf.0.address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"business_entity.oneOf.0.address.oneOf.0.city","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","title":"State","description":"State","uniqueKey":"business_entity.oneOf.0.address.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","title":"State","description":"State","uniqueKey":"business_entity.oneOf.0.address.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"business_entity.oneOf.0.address.oneOf.0.state","typeLabel":"string | null"},"zipCode":{"oneOf":[{"type":"string","title":"Zipcode","description":"Zip Code","uniqueKey":"business_entity.oneOf.0.address.oneOf.0.zipCode.oneOf.0","typeLabel":"string"},{"type":"null","title":"Zipcode","description":"Zip Code","uniqueKey":"business_entity.oneOf.0.address.oneOf.0.zipCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"business_entity.oneOf.0.address.oneOf.0.zipCode","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","title":"Country","description":"Country","uniqueKey":"business_entity.oneOf.0.address.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","title":"Country","description":"Country","uniqueKey":"business_entity.oneOf.0.address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"business_entity.oneOf.0.address.oneOf.0.country","typeLabel":"string | null"},"validation_status":{"oneOf":[{"type":"string","title":"Validation Status","description":"Address Validation Status","uniqueKey":"business_entity.oneOf.0.address.oneOf.0.validation_status.oneOf.0","typeLabel":"string"},{"type":"null","title":"Validation Status","description":"Address Validation Status","uniqueKey":"business_entity.oneOf.0.address.oneOf.0.validation_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"business_entity.oneOf.0.address.oneOf.0.validation_status","typeLabel":"string | null"}},"uniqueKey":"business_entity.oneOf.0.address.oneOf.0","typeLabel":"EntityAddress · object"},{"type":"null","description":"Business Entity address","uniqueKey":"business_entity.oneOf.0.address.oneOf.1","typeLabel":"null"}],"uniqueKey":"business_entity.oneOf.0.address","typeLabel":"EntityAddress · object | null"},"email":{"oneOf":[{"type":"string","title":"Email","description":"Business Entity email","uniqueKey":"business_entity.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","title":"Email","description":"Business Entity email","uniqueKey":"business_entity.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"business_entity.oneOf.0.email","typeLabel":"string | null"},"phone_number":{"oneOf":[{"type":"string","title":"Phone Number","description":"Business Entity phone number","uniqueKey":"business_entity.oneOf.0.phone_number.oneOf.0","typeLabel":"string"},{"type":"null","title":"Phone Number","description":"Business Entity phone number","uniqueKey":"business_entity.oneOf.0.phone_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"business_entity.oneOf.0.phone_number","typeLabel":"string | null"},"tax_config":{"oneOf":[{"type":"object","title":"Tax Config","description":"Business Entity tax config","additionalProperties":true,"uniqueKey":"business_entity.oneOf.0.tax_config.oneOf.0","typeLabel":"Tax Config · object"},{"type":"null","title":"Tax Config","description":"Business Entity tax config","uniqueKey":"business_entity.oneOf.0.tax_config.oneOf.1","typeLabel":"null"}],"uniqueKey":"business_entity.oneOf.0.tax_config","typeLabel":"Tax Config · object | null"},"logo_url":{"oneOf":[{"type":"string","title":"Logo Url","description":"Business Entity logo URL","uniqueKey":"business_entity.oneOf.0.logo_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Logo Url","description":"Business Entity logo URL","uniqueKey":"business_entity.oneOf.0.logo_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"business_entity.oneOf.0.logo_url","typeLabel":"string | null"}},"uniqueKey":"business_entity.oneOf.0","typeLabel":"BusinessEntityResponseSchema · object"},{"type":"null","description":"Business Entity","uniqueKey":"business_entity.oneOf.1","typeLabel":"null"}],"uniqueKey":"business_entity","typeLabel":"BusinessEntityResponseSchema · object | null"}},"type":"object","required":["id","external_id","customer_name","custom_data","address"],"title":"GetCustomerResponseSchema","description":"Create Customer Response Schema","uniqueKey":"","typeLabel":"GetCustomerResponseSchema · object"},"example":{"id":"123e4567-e89b-12d3-a456-426614174000","customer_name":"Acme Corporation","email":"billing@acme.com","phone":"+1-555-0100","billing_address":{"street":"123 Business Ave","city":"San Francisco","state":"CA","postal_code":"94102","country":"US"},"custom_data":{"industry":"Technology","company_size":"50-200"},"created_at":"2023-01-01T00:00:00","updated_at":"2023-06-15T10:30:00"},"examples":{"Example":{"title":"Example","value":{"id":"123e4567-e89b-12d3-a456-426614174000","customer_name":"Acme Corporation","email":"billing@acme.com","phone":"+1-555-0100","billing_address":{"street":"123 Business Ave","city":"San Francisco","state":"CA","postal_code":"94102","country":"US"},"custom_data":{"industry":"Technology","company_size":"50-200"},"created_at":"2023-01-01T00:00:00","updated_at":"2023-06-15T10:30:00"}}},"exampleType":"examples"}},"exampleType":"examples"},"d8f4338a-f4ce-4e96-bc0e-d00e9413663c":{"description":"Bad request - invalid customer ID format","content":{"application/json":{"example":{"error_code":"BAD_REQUEST","message":"Invalid customer ID format"},"examples":{"Example":{"title":"Example","value":{"error_code":"BAD_REQUEST","message":"Invalid customer ID format"}}},"exampleType":"examples"}},"exampleType":"examples"},"ab9b9a93-2fe2-43e4-bc95-38402791bbd9":{"description":"Customer not found","content":{"application/json":{"example":{"error_code":"NOT_FOUND","message":"Customer with id 123e4567-e89b-12d3-a456-426614174000 not found"},"examples":{"Example":{"title":"Example","value":{"error_code":"NOT_FOUND","message":"Customer with id 123e4567-e89b-12d3-a456-426614174000 not found"}}},"exampleType":"examples"}},"exampleType":"examples"},"8237287a-2276-4027-a9f9-eadc4092dd16":{"description":"Unprocessable Entity - invalid UUID","content":{"application/json":{"example":{"status_code":10422,"message":"1 validation error for Path; customer_id: value is not a valid uuid"},"examples":{"Example":{"title":"Example","value":{"status_code":10422,"message":"1 validation error for Path; customer_id: value is not a valid uuid"}}},"exampleType":"examples"}},"exampleType":"examples"},"cb88030e-c0f8-4433-bb30-62598d64e7f4":{"description":"Internal server error","content":{"application/json":{"example":{"error_code":"INTERNAL_SERVER_ERROR","message":"Failed to retrieve customer"},"examples":{"Example":{"title":"Example","value":{"error_code":"INTERNAL_SERVER_ERROR","message":"Failed to retrieve customer"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"95049f99-a4b8-435b-a365-25b6391f1cff":{"ApiTokenAuth":{"type":"apiKey","in":"header","name":"x-api-key","x-default":"\u003cyour-api-key>","scopes":[]},"OrganisationAuth":{"type":"apiKey","in":"header","name":"organisation","x-default":"\u003cyour-organisation-id>","scopes":[]}}},"servers":{"b5800edb-bebb-41b7-ba92-5775ad182a17":{"url":"https://api.zenskar.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","x-default":"\u003cyour-api-key>","scopes":[]},"schema":{"title":"x-api-key","type":"string","isRequired":true,"default":"\u003cyour-api-key>","typeLabel":"string","deprecated":false},"schemeName":"ApiTokenAuth","name":"x-api-key"},{"scheme":{"type":"apiKey","in":"header","name":"organisation","x-default":"\u003cyour-organisation-id>","scopes":[]},"schema":{"title":"organisation","type":"string","isRequired":true,"default":"\u003cyour-organisation-id>","typeLabel":"string","deprecated":false},"schemeName":"OrganisationAuth","name":"organisation"}],"title":"ApiTokenAuth \u0026 OrganisationAuth"}]},"originalFileLocation":"openAPI/openapi-20240301.json"},"subdomain":"zenskar-3d451781","siteName":"Zenskar Documentation","title":"Get customer by ID - Zenskar Documentation","contextualStarterQuestions":[{"_id":"6a1ea18a2a685f4ecf01ab1d","deploymentId":"69e0a11c3e5ca76e4bd3f576","questionText":"Why am I getting a 404 error?","status":"active","generatedBy":"contextual","path":"api-reference/customers/get-customer-by-id","createdAt":"2026-06-02T09:25:30.970Z","updatedAt":"2026-06-02T09:25:30.970Z","__v":0},{"_id":"6a1ea18a2a685f4ecf01ab1c","deploymentId":"69e0a11c3e5ca76e4bd3f576","questionText":"How do I format the customer ID?","status":"active","generatedBy":"contextual","path":"api-reference/customers/get-customer-by-id","createdAt":"2026-06-02T09:25:30.970Z","updatedAt":"2026-06-02T09:25:30.970Z","__v":0},{"_id":"6a1ea18a2a685f4ecf01ab1b","deploymentId":"69e0a11c3e5ca76e4bd3f576","questionText":"What data does this endpoint return?","status":"active","generatedBy":"contextual","path":"api-reference/customers/get-customer-by-id","createdAt":"2026-06-02T09:25:30.969Z","updatedAt":"2026-06-02T09:25:30.969Z","__v":0}],"navMaps":{"firstHrefInVersion":{"cedar.ALPHA.20260301":{"href":"/api-reference/customers/get-customer-by-id","matchLevel":0},"baobab.20240301":{"href":"/api-reference/customers/get-customer-by-id","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-08-21T07:01:52.796Z","originalFileLocation":"api-reference/customers/get-customer-by-id.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=\"Retrieve detailed information for a specific customer by their unique identifier. Returns comprehensive customer data including: - Basic information: name, email, phone - Address details: billing and shipping addresses - Custom data: organization-specific custom fields - Metadata: creation and update timestamps Requirements: - Customer must belong to the authenticated organization - Valid UUID format required for customer_id - Returns 404 if customer doesn\u0026#x27;t exist or is not accessible\">\u003cmeta data-mint-head name=\"application-name\" content=\"Zenskar Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/zenskar-3d451781/MYgNV77YbtdSqIUY/_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=\"/docs/mintlify-assets/_mintlify/favicons/zenskar-3d451781/MYgNV77YbtdSqIUY/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/zenskar-3d451781/MYgNV77YbtdSqIUY/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/zenskar-3d451781/MYgNV77YbtdSqIUY/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/zenskar-3d451781/MYgNV77YbtdSqIUY/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/zenskar-3d451781/MYgNV77YbtdSqIUY/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/zenskar-3d451781/MYgNV77YbtdSqIUY/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/zenskar-3d451781/MYgNV77YbtdSqIUY/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/zenskar-3d451781/MYgNV77YbtdSqIUY/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get customer by ID - Zenskar Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve detailed information for a specific customer by their unique identifier. Returns comprehensive customer data including: - Basic information: name, email, phone - Address details: billing and shipping addresses - Custom data: organization-specific custom fields - Metadata: creation and update timestamps Requirements: - Customer must belong to the authenticated organization - Valid UUID format required for customer_id - Returns 404 if customer doesn\u0026#x27;t exist or is not accessible\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Zenskar Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://zenskar.com/docs/api-reference/customers/get-customer-by-id\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://zenskar-3d451781.mintlify.app/_mintlify/api/og/v2?division=Customers\u0026amp;title=Get+customer+by+ID\u0026amp;description=Retrieve+detailed+information+for+a+specific+customer+by+their+unique+identifier.%0A%0AReturns+comprehensive+customer+data+including%3A%0A-+Basic+information%3A+name%2C+ema\u0026amp;theme=a962312433b97c96be242726\u0026amp;signature=392c2199051f27a171600d9b22af622562e12624f50dc1527ae24e3820aad77d\">\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=\"Get customer by ID - Zenskar Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve detailed information for a specific customer by their unique identifier. Returns comprehensive customer data including: - Basic information: name, email, phone - Address details: billing and shipping addresses - Custom data: organization-specific custom fields - Metadata: creation and update timestamps Requirements: - Customer must belong to the authenticated organization - Valid UUID format required for customer_id - Returns 404 if customer doesn\u0026#x27;t exist or is not accessible\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://zenskar-3d451781.mintlify.app/_mintlify/api/og/v2?division=Customers\u0026amp;title=Get+customer+by+ID\u0026amp;description=Retrieve+detailed+information+for+a+specific+customer+by+their+unique+identifier.%0A%0AReturns+comprehensive+customer+data+including%3A%0A-+Basic+information%3A+name%2C+ema\u0026amp;theme=a962312433b97c96be242726\u0026amp;signature=392c2199051f27a171600d9b22af622562e12624f50dc1527ae24e3820aad77d\">\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=\"/docs/mintlify-assets/_mintlify/favicons/zenskar-3d451781/MYgNV77YbtdSqIUY/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Zenskar Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0A1633\">\u003clink data-mint-head rel=\"canonical\" href=\"https://zenskar.com/docs/api-reference/customers/get-customer-by-id\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/customers/get-customer-by-id.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://zenskar.com/#organization\",\"name\":\"Zenskar Documentation\",\"url\":\"https://zenskar.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/zenskar-3d451781/8zM5vHUy4GbBMWvZ/logo/for-light-themes.svg?fit=max\u0026auto=format\u0026n=8zM5vHUy4GbBMWvZ\u0026q=85\u0026s=7b3708e348af5e2ca4bd6f302186ccc2\"}},{\"@type\":\"WebSite\",\"@id\":\"https://zenskar.com/docs#website\",\"name\":\"Zenskar Documentation\",\"url\":\"https://zenskar.com/docs\",\"publisher\":{\"@id\":\"https://zenskar.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://zenskar.com/docs/api-reference/customers/get-customer-by-id#webpage\",\"url\":\"https://zenskar.com/docs/api-reference/customers/get-customer-by-id\",\"name\":\"Get customer by ID\",\"description\":\"Retrieve detailed information for a specific customer by their unique identifier. Returns comprehensive customer data including: - Basic information: name, email, phone - Address details: billing and shipping addresses - Custom data: organization-specific custom fields - Metadata: creation and update timestamps Requirements: - Customer must belong to the authenticated organization - Valid UUID format required for customer_id - Returns 404 if customer doesn't exist or is not accessible\",\"dateModified\":\"2026-08-21T07:01:52.796Z\",\"isPartOf\":{\"@id\":\"https://zenskar.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://zenskar.com/docs/api-reference/customers/get-customer-by-id#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://zenskar.com/docs/api-reference/customers/get-customer-by-id#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Customers\",\"item\":\"https://zenskar.com/docs/api-reference/customers/list-customers-with-filtering-and-pagination\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get customer by ID\",\"item\":\"https://zenskar.com/docs/api-reference/customers/get-customer-by-id\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://zenskar.com/docs/api-reference/customers/get-customer-by-id#apireference\",\"headline\":\"Get customer by ID\",\"name\":\"Get customer by ID\",\"description\":\"Retrieve detailed information for a specific customer by their unique identifier. Returns comprehensive customer data including: - Basic information: name, email, phone - Address details: billing and shipping addresses - Custom data: organization-specific custom fields - Metadata: creation and update timestamps Requirements: - Customer must belong to the authenticated organization - Valid UUID format required for customer_id - Returns 404 if customer doesn't exist or is not accessible\",\"url\":\"https://zenskar.com/docs/api-reference/customers/get-customer-by-id\",\"mainEntityOfPage\":{\"@id\":\"https://zenskar.com/docs/api-reference/customers/get-customer-by-id#webpage\"},\"dateModified\":\"2026-08-21T07:01:52.796Z\",\"publisher\":{\"@id\":\"https://zenskar.com/#organization\"},\"isPartOf\":{\"@id\":\"https://zenskar.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Zenskar Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Zenskar Documentation","nav":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://www.zenskar.com/blog"}]},"versions":[{"version":"cedar.ALPHA.20260301","default":false,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/20260301/getting-started/introduction"}]},{"tab":"API Guides","pages":[{"title":"API Guides","href":"/20260301/api-guides/authentication"}]},{"tab":"API Reference","groups":[{"group":"Accounting","pages":[{"title":"Get chart of accounts","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/chart_of_accounts","href":"/api-reference/accounting/get-chart-of-accounts"},{"title":"Get accounts","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/accounts","href":"/api-reference/accounting/get-accounts"},{"title":"Create account","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /accounting_new/accounts","href":"/api-reference/accounting/create-account"},{"title":"Get close date","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/close_date","href":"/api-reference/accounting/get-close-date"},{"title":"Create close date","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /accounting_new/close_date","href":"/api-reference/accounting/create-close-date"},{"title":"Update close date","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /accounting_new/close_date","href":"/api-reference/accounting/update-close-date"},{"title":"Create journal entry","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /accounting_new/journal_entry","href":"/api-reference/accounting/create-journal-entry"},{"title":"Get journal entry","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/journal_entry/{journal_entry_id}","href":"/api-reference/accounting/get-journal-entry"},{"title":"Update journal entry","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json put /accounting_new/journal_entry/{journal_entry_id}","href":"/api-reference/accounting/update-journal-entry"},{"title":"Get account balance by tag","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/accounts/{account_id}/balance","href":"/api-reference/accounting/get-account-balance-by-tag"},{"title":"Get journal entries","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/journal_entries","href":"/api-reference/accounting/get-journal-entries"},{"title":"Get journal lines","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/journal_lines","href":"/api-reference/accounting/get-journal-lines"},{"title":"Get balance sheet","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/balance_sheet/v2","href":"/api-reference/accounting/get-balance-sheet"},{"title":"Get income statement","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/income_statement/v2","href":"/api-reference/accounting/get-income-statement"},{"title":"Validate period close","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /accounting_new/periods/validate-close","href":"/api-reference/accounting/validate-period-close"},{"title":"Close accounting period","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /accounting_new/periods/close","href":"/api-reference/accounting/close-accounting-period"},{"title":"Get accounting periods","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/periods","href":"/api-reference/accounting/get-accounting-periods"},{"title":"Get last closed period","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/periods/last","href":"/api-reference/accounting/get-last-closed-period"},{"title":"Get accounting period","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/periods/{period_id}","href":"/api-reference/accounting/get-accounting-period"}]},{"group":"Billable Metrics","pages":[{"title":"List billable metrics","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /aggregates","href":"/api-reference/billable-metrics/list-billable-metrics"},{"title":"Create billable metric","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /aggregates","href":"/api-reference/billable-metrics/create-billable-metric"},{"title":"Get aggregate estimates for a period","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /aggregates/estimates","href":"/api-reference/billable-metrics/get-aggregate-estimates-for-a-period"},{"title":"Get billable metric","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /aggregates/{aggregate_id}","href":"/api-reference/billable-metrics/get-billable-metric"},{"title":"Delete aggregate","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /aggregates/{aggregate_id}","href":"/api-reference/billable-metrics/delete-aggregate"},{"title":"Update aggregate","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /aggregates/{aggregate_id}","href":"/api-reference/billable-metrics/update-aggregate"}]},{"group":"Business Entities","pages":[{"title":"List business entities","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /business_entities","href":"/api-reference/business-entities/list-business-entities"},{"title":"Create business entity","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /business_entities","href":"/api-reference/business-entities/create-business-entity"},{"title":"Get business entity","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /business_entities/{entity_id}","href":"/api-reference/business-entities/get-business-entity"},{"title":"Update business entity","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /business_entities/{entity_id}","href":"/api-reference/business-entities/update-business-entity"},{"title":"Get business entity config","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /business_entities/{business_entity_id}/config","href":"/api-reference/business-entities/get-business-entity-config"},{"title":"Set business entity config","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json put /business_entities/{business_entity_id}/config","href":"/api-reference/business-entities/set-business-entity-config"},{"title":"Get region config","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /business_entities/{business_entity_id}/config/{country_code}","href":"/api-reference/business-entities/get-region-config"},{"title":"Upsert region config","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json put /business_entities/{business_entity_id}/config/{country_code}","href":"/api-reference/business-entities/upsert-region-config"},{"title":"Delete region config","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /business_entities/{business_entity_id}/config/{country_code}","href":"/api-reference/business-entities/delete-region-config"}]},{"group":"Contacts","pages":[{"title":"List contacts","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Create contact","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /contacts","href":"/api-reference/contacts/create-contact"},{"title":"Get contact","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /contacts/{contact_id}","href":"/api-reference/contacts/get-contact"},{"title":"Delete contact","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /contacts/{contact_id}","href":"/api-reference/contacts/delete-contact"},{"title":"Update contact","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /contacts/{contact_id}","href":"/api-reference/contacts/update-contact"}]},{"group":"Contracts","pages":[{"title":"List contracts","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /contract_v2","href":"/api-reference/contracts/list-contracts"},{"title":"Create contract","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /contract_v2","href":"/api-reference/contracts/create-contract"},{"title":"Get contract by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /contract_v2/{contract_id}","href":"/api-reference/contracts/get-contract-by-id"},{"title":"Update contract","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json put /contract_v2/{contract_id}","href":"/api-reference/contracts/update-contract"},{"title":"Delete contract","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /contract_v2/{contract_id}","href":"/api-reference/contracts/delete-contract"},{"title":"Get contract amendments","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /contract_v2/{contract_id}/amendments","href":"/api-reference/contracts/get-contract-amendments"},{"title":"Create contract phase","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /contract_v2/{contract_id}/phases","href":"/api-reference/contracts/create-contract-phase"},{"title":"Pause contract","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /contract_v2/{contract_id}/pause","href":"/api-reference/contracts/pause-contract"},{"title":"Update pause contract","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /contract_v2/{contract_id}/pause","href":"/api-reference/contracts/update-pause-contract"},{"title":"Resume contract","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /contract_v2/{contract_id}/resume","href":"/api-reference/contracts/resume-contract"},{"title":"Create contract phase pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /contract_v2/{contract_id}/phases/{phase_id}/pricing","href":"/api-reference/contracts/create-contract-phase-pricing"},{"title":"Expire contract","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /contract_v2/{contract_id}/expire","href":"/api-reference/contracts/expire-contract"}]},{"group":"Credit Notes","pages":[{"title":"Get credit note list","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /credit_notes","href":"/api-reference/credit-notes/get-credit-note-list"},{"title":"Create credit note","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /credit_notes","href":"/api-reference/credit-notes/create-credit-note"},{"title":"Get credit note by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /credit_notes/{credit_note_id}","href":"/api-reference/credit-notes/get-credit-note-by-id"},{"title":"Update credit note by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /credit_notes/{credit_note_id}","href":"/api-reference/credit-notes/update-credit-note-by-id"},{"title":"Get line items by credit note ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /credit_notes/line_items/{credit_note_id}","href":"/api-reference/credit-notes/get-line-items-by-credit-note-id"}]},{"group":"Custom Attributes","pages":[{"title":"List custom attribute definitions","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /custom_attributes","href":"/api-reference/custom-attributes/list-custom-attribute-definitions"},{"title":"Create custom attribute definition","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /custom_attributes","href":"/api-reference/custom-attributes/create-custom-attribute-definition"},{"title":"Get custom attribute definition","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /custom_attributes/{definition_id}","href":"/api-reference/custom-attributes/get-custom-attribute-definition"},{"title":"Update custom attribute definition","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /custom_attributes/{definition_id}","href":"/api-reference/custom-attributes/update-custom-attribute-definition"}]},{"group":"Customers","pages":[{"title":"List customers with filtering and pagination","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /customers","href":"/api-reference/customers/list-customers-with-filtering-and-pagination"},{"title":"Create customer","description":"Creates a new customer object in Zenskar. Customer objects represent the individuals or companies you do business with and serve for your revenue operations—they must exist before you can create contracts, generate invoices, or process payments.\n\nThe customer record stores essential billing information including contact details, billing and shipping addresses, tax identifiers, payment preferences, and custom metadata specific to your business needs. Only customer_name is required at creation—all other fields are optional, allowing you to capture minimal information initially. The customer address is an important field which is used for Regional tax calculation, make sure this field is correct for the required customers.\n\nWhen integrated with external systems, newly created customers are automatically synchronized with configured platforms like Stripe, HubSpot, Zoho, or Xero. Use the external_id field to maintain references to source systems for bidirectional synchronization.","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /customers","href":"/api-reference/customers/create-customer"},{"title":"Get customer by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /customers/{customer_id}","href":"/api-reference/customers/get-customer-by-id"},{"title":"Delete customer","description":"Deletes a customer by ID.","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /customers/{customer_id}","href":"/api-reference/customers/delete-customer"},{"title":"Update customer","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /customers/{customer_id}","href":"/api-reference/customers/update-customer"},{"title":"Create customer relationships","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /customers/{customer_id}/relationships","href":"/api-reference/customers/create-customer-relationships"},{"title":"List payment methods","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /customers/{customer_id}/payment_methods","href":"/api-reference/customers/list-payment-methods"},{"title":"Patch Customer Connector Id","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /customers/{customer_id}/connector","href":"/api-reference/customers/patch-customer-connector-id"},{"title":"Attach external payment method","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /customers/{customer_id}/payment_methods/attach","href":"/api-reference/customers/attach-external-payment-method"},{"title":"Delete payment method","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /customers/{customer_id}/payment_methods/{payment_method_id}","href":"/api-reference/customers/delete-payment-method"},{"title":"Delete third-party connector","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /customers/connector/{customer_id}","href":"/api-reference/customers/delete-third-party-connector"},{"title":"Create customer or guest session","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /customers/session","href":"/api-reference/customers/create-customer-or-guest-session"},{"title":"Get customer connector details","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /customers/{customer_id}/connector/{connector_name}","href":"/api-reference/customers/get-customer-connector-details"}]},{"group":"Customer Addresses","pages":[{"title":"List customer addresses","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /customers/{customer_id}/addresses","href":"/api-reference/customer-addresses/list-customer-addresses"},{"title":"Create customer address","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /customers/{customer_id}/addresses","href":"/api-reference/customer-addresses/create-customer-address"},{"title":"Get customer address","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /customers/{customer_id}/addresses/{address_id}","href":"/api-reference/customer-addresses/get-customer-address"},{"title":"Delete customer address","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /customers/{customer_id}/addresses/{address_id}","href":"/api-reference/customer-addresses/delete-customer-address"},{"title":"Update customer address","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /customers/{customer_id}/addresses/{address_id}","href":"/api-reference/customer-addresses/update-customer-address"}]},{"group":"Data Sources","pages":[{"title":"List data-source connectors","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /datasources","href":"/api-reference/data-sources/list-data-source-connectors"},{"title":"Create data-source connector","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /datasources","href":"/api-reference/data-sources/create-data-source-connector"},{"title":"Get data-source connector","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /datasources/{datasource_id}","href":"/api-reference/data-sources/get-data-source-connector"},{"title":"Update data-source connector","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /datasources/{datasource_id}","href":"/api-reference/data-sources/update-data-source-connector"}]},{"group":"Entitlements","pages":[{"title":"List entitlements","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements","href":"/api-reference/entitlements/list-entitlements"},{"title":"Create entitlement","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /entitlements","href":"/api-reference/entitlements/create-entitlement"},{"title":"List customer entitlement balances with advanced filtering","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements/customers_balances","href":"/api-reference/entitlements/list-customer-entitlement-balances-with-advanced-filtering"},{"title":"Get entitlement","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements/{entitlement_id}","href":"/api-reference/entitlements/get-entitlement"},{"title":"Delete entitlement","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /entitlements/{entitlement_id}","href":"/api-reference/entitlements/delete-entitlement"},{"title":"Update entitlement","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /entitlements/{entitlement_id}","href":"/api-reference/entitlements/update-entitlement"},{"title":"Create entitlement customer","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /entitlements/{entitlement_id}/customer","href":"/api-reference/entitlements/create-entitlement-customer"},{"title":"List entitlements for customer","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements/{entitlement_id}/customer/{customer_id}","href":"/api-reference/entitlements/list-entitlements-for-customer"},{"title":"Get total customer entitlements","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements/{entitlement_id}/customer/{customer_id}/total","href":"/api-reference/entitlements/get-total-customer-entitlements"},{"title":"List customer entitlements","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements/customer/{customer_id}","href":"/api-reference/entitlements/list-customer-entitlements"},{"title":"List unique entitlements for customer","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements/customer/unique/{customer_id}","href":"/api-reference/entitlements/list-unique-entitlements-for-customer"},{"title":"Get entitlement customer","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements/{entitlement_id}/customer/{customer_id}/{ec_id}","href":"/api-reference/entitlements/get-entitlement-customer"},{"title":"Delete customer entitlement","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /entitlements/{entitlement_id}/customer/{customer_id}/{ec_id}","href":"/api-reference/entitlements/delete-customer-entitlement"},{"title":"Update customer entitlement","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /entitlements/{entitlement_id}/customer/{customer_id}/{ec_id}","href":"/api-reference/entitlements/update-customer-entitlement"},{"title":"Get Customer Entitlement by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements/entitlement_customer/{ec_id}","href":"/api-reference/entitlements/get-customer-entitlement-by-id"}]},{"group":"Invoices","pages":[{"title":"List invoices","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /invoices","href":"/api-reference/invoices/list-invoices"},{"title":"Get invoice","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /invoices/{invoice_id}","href":"/api-reference/invoices/get-invoice"},{"title":"Get invoice by external Id","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /invoices/external_id/{external_id}","href":"/api-reference/invoices/get-invoice-by-external-id"},{"title":"Generate an invoice","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /invoices/generate_invoice","href":"/api-reference/invoices/generate-an-invoice"},{"title":"Approve invoice","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /invoices/{invoice_id}/approve","href":"/api-reference/invoices/approve-invoice"},{"title":"Approve V3 invoice","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /invoices/v3/{invoice_id}/approve","href":"/api-reference/invoices/approve-v3-invoice"},{"title":"Get invoice line items","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /invoices/{invoice_id}/line_items","href":"/api-reference/invoices/get-invoice-line-items"},{"title":"Void invoice","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /invoices/{invoice_id}/void","href":"/api-reference/invoices/void-invoice"},{"title":"Create credit note against invoice","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /invoices/{invoice_id}/credit_note","href":"/api-reference/invoices/create-credit-note-against-invoice"}]},{"group":"Jobs","pages":[{"title":"List jobs","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /jobs","href":"/api-reference/jobs/list-jobs"},{"title":"Get job by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /jobs/{job_id}","href":"/api-reference/jobs/get-job-by-id"},{"title":"Get job outcomes by filters","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /jobs/joboutcomes/logs","href":"/api-reference/jobs/get-job-outcomes-by-filters"},{"title":"Get job outcomes by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /jobs/{job_id}/logs","href":"/api-reference/jobs/get-job-outcomes-by-id"},{"title":"Get job with sub-jobs","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /jobs/{job_id}/sub-jobs","href":"/api-reference/jobs/get-job-with-sub-jobs"}]},{"group":"Payments","pages":[{"title":"Get invoice payments","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /payments/invoice/{invoice_id}","href":"/api-reference/payments/get-invoice-payments"},{"title":"Get payment by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /payments/{payment_id}","href":"/api-reference/payments/get-payment-by-id"},{"title":"Delete manual payment","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /payments/{payment_id}","href":"/api-reference/payments/delete-manual-payment"},{"title":"Update payment","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /payments/{payment_id}","href":"/api-reference/payments/update-payment"},{"title":"Get payments","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /payments","href":"/api-reference/payments/get-payments"},{"title":"Create payment","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /payments","href":"/api-reference/payments/create-payment"},{"title":"Create invoice charge","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /payments/invoice/{invoice_id}/charge","href":"/api-reference/payments/create-invoice-charge"},{"title":"Edit manual payment","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /payments/manual_payment/{payment_id}","href":"/api-reference/payments/edit-manual-payment"},{"title":"Refund payment","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /payments/{payment_id}/refund","href":"/api-reference/payments/refund-payment"}]},{"group":"Plans","pages":[{"title":"List plans","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /plans","href":"/api-reference/plans/list-plans"},{"title":"Create plan","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /plans","href":"/api-reference/plans/create-plan"},{"title":"Get plan by Id","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /plans/{plan_id}","href":"/api-reference/plans/get-plan-by-id"},{"title":"Update plan","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json put /plans/{plan_id}","href":"/api-reference/plans/update-plan"},{"title":"Delete plan by Id","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /plans/{plan_id}","href":"/api-reference/plans/delete-plan-by-id"},{"title":"Create plan phase","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /plans/{plan_id}/phases","href":"/api-reference/plans/create-plan-phase"},{"title":"Update plan phase","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json put /plans/{plan_id}/phases/{phase_id}","href":"/api-reference/plans/update-plan-phase"},{"title":"Delete plan phase","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /plans/{plan_id}/phases/{phase_id}","href":"/api-reference/plans/delete-plan-phase"},{"title":"Create plan phase pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /plans/{plan_id}/phases/{phase_id}/pricing","href":"/api-reference/plans/create-plan-phase-pricing"},{"title":"Update plan phase pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json put /plans/{plan_id}/phases/{phase_id}/pricing/{phase_pricing_id}","href":"/api-reference/plans/update-plan-phase-pricing"},{"title":"Delete plan phase pricing by Id","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /plans/{plan_id}/phases/{phase_id}/pricing/{pricing_id}","href":"/api-reference/plans/delete-plan-phase-pricing-by-id"},{"title":"Create new version","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /plans/{plan_id}/new_version","href":"/api-reference/plans/create-new-version"}]},{"group":"Products","pages":[{"title":"List products","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /products","href":"/api-reference/products/list-products"},{"title":"Create product","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /products","href":"/api-reference/products/create-product"},{"title":"Get product","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /products/{product_id}","href":"/api-reference/products/get-product"},{"title":"Delete product","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /products/{product_id}","href":"/api-reference/products/delete-product"},{"title":"Update product","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /products/{product_id}","href":"/api-reference/products/update-product"},{"title":"Get product pricings","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /products/{product_id}/pricing","href":"/api-reference/products/get-product-pricings"},{"title":"Create product pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /products/{product_id}/pricing","href":"/api-reference/products/create-product-pricing"},{"title":"Get product pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /products/{product_id}/pricing/{pricing_id}","href":"/api-reference/products/get-product-pricing"},{"title":"Delete product pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /products/{product_id}/pricing/{pricing_id}","href":"/api-reference/products/delete-product-pricing"},{"title":"Update product pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /products/{product_id}/pricing/{pricing_id}","href":"/api-reference/products/update-product-pricing"},{"title":"Get product bundle pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /products/bundle/{product_id}/pricing/{pricing_id}","href":"/api-reference/products/get-product-bundle-pricing"},{"title":"Update product bundle pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /products/bundle/{product_id}/pricing/{pricing_id}","href":"/api-reference/products/update-product-bundle-pricing"},{"title":"Create product bundle pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /products/bundle/{product_id}/pricing","href":"/api-reference/products/create-product-bundle-pricing"}]},{"group":"Tax","pages":[{"title":"List tax categories","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /tax/categories","href":"/api-reference/tax/list-tax-categories"},{"title":"Create tax category","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /tax/categories","href":"/api-reference/tax/create-tax-category"},{"title":"Get tax category","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /tax/categories/{code}","href":"/api-reference/tax/get-tax-category"},{"title":"Update tax category","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /tax/categories/{code}","href":"/api-reference/tax/update-tax-category"},{"title":"List jurisdiction rates","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /tax/business_entities/{business_entity_id}/jurisdiction_rates","href":"/api-reference/tax/list-jurisdiction-rates"},{"title":"Create jurisdiction rate","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /tax/business_entities/{business_entity_id}/jurisdiction_rates","href":"/api-reference/tax/create-jurisdiction-rate"},{"title":"Get jurisdiction rate","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /tax/business_entities/{business_entity_id}/jurisdiction_rates/{jurisdiction_rate_id}","href":"/api-reference/tax/get-jurisdiction-rate"},{"title":"Update jurisdiction rate","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /tax/business_entities/{business_entity_id}/jurisdiction_rates/{jurisdiction_rate_id}","href":"/api-reference/tax/update-jurisdiction-rate"},{"title":"Resolve the applicable tax rate for a destination","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /tax/business_entities/{business_entity_id}/rates/lookup","href":"/api-reference/tax/resolve-the-applicable-tax-rate-for-a-destination"},{"title":"List tax rates","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /tax/business_entities/{business_entity_id}/jurisdiction_rates/{jurisdiction_rate_id}/rates","href":"/api-reference/tax/list-tax-rates"},{"title":"Get tax rate","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /tax/business_entities/{business_entity_id}/rates/{rate_id}","href":"/api-reference/tax/get-tax-rate"},{"title":"Update tax rate","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /tax/business_entities/{business_entity_id}/rates/{rate_id}","href":"/api-reference/tax/update-tax-rate"}]},{"group":"Tags","pages":[{"title":"List tags","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /tags/{holder}/{item_id}","href":"/api-reference/tags/list-tags"},{"title":"Upsert tags","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /tags","href":"/api-reference/tags/upsert-tags"}]},{"group":"Usage Events","pages":[{"title":"List usage events","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /rawmetrics","href":"/api-reference/usage-events/list-usage-events"},{"title":"Create usage event","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /rawmetrics","href":"/api-reference/usage-events/create-usage-event"},{"title":"Get usage event by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /rawmetrics/{raw_metric_id}","href":"/api-reference/usage-events/get-usage-event-by-id"},{"title":"Update usage event","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /rawmetrics/{raw_metric_id}","href":"/api-reference/usage-events/update-usage-event"},{"title":"Get usage event by slug","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /rawmetrics/slug/{raw_metric_slug}","href":"/api-reference/usage-events/get-usage-event-by-slug"}]}]}]},{"version":"baobab.20240301","default":true,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/20240301/getting-started/introduction"}]},{"tab":"API Guides","pages":[{"title":"API Guides","href":"/20240301/api-guides/authentication"}]},{"tab":"API Reference","groups":[{"group":"Accounting","pages":[{"title":"Get chart of accounts","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/chart_of_accounts","href":"/api-reference/accounting/get-chart-of-accounts"},{"title":"Get accounts","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/accounts","href":"/api-reference/accounting/get-accounts"},{"title":"Create account","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /accounting_new/accounts","href":"/api-reference/accounting/create-account"},{"title":"Get close date","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/close_date","href":"/api-reference/accounting/get-close-date"},{"title":"Create close date","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /accounting_new/close_date","href":"/api-reference/accounting/create-close-date"},{"title":"Update close date","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /accounting_new/close_date","href":"/api-reference/accounting/update-close-date"},{"title":"Create journal entry","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /accounting_new/journal_entry","href":"/api-reference/accounting/create-journal-entry"},{"title":"Get journal entry","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/journal_entry/{journal_entry_id}","href":"/api-reference/accounting/get-journal-entry"},{"title":"Update journal entry","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json put /accounting_new/journal_entry/{journal_entry_id}","href":"/api-reference/accounting/update-journal-entry"},{"title":"Get account balance by tag","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/accounts/{account_id}/balance","href":"/api-reference/accounting/get-account-balance-by-tag"},{"title":"Get journal entries","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/journal_entries","href":"/api-reference/accounting/get-journal-entries"},{"title":"Get journal lines","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/journal_lines","href":"/api-reference/accounting/get-journal-lines"},{"title":"Get balance sheet","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/balance_sheet/v2","href":"/api-reference/accounting/get-balance-sheet"},{"title":"Get income statement","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/income_statement/v2","href":"/api-reference/accounting/get-income-statement"},{"title":"Validate period close","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /accounting_new/periods/validate-close","href":"/api-reference/accounting/validate-period-close"},{"title":"Close accounting period","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /accounting_new/periods/close","href":"/api-reference/accounting/close-accounting-period"},{"title":"Get accounting periods","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/periods","href":"/api-reference/accounting/get-accounting-periods"},{"title":"Get last closed period","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/periods/last","href":"/api-reference/accounting/get-last-closed-period"},{"title":"Get accounting period","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/periods/{period_id}","href":"/api-reference/accounting/get-accounting-period"}]},{"group":"Billable Metrics","pages":[{"title":"List billable metrics","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /aggregates","href":"/api-reference/billable-metrics/list-billable-metrics"},{"title":"Create billable metric","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /aggregates","href":"/api-reference/billable-metrics/create-billable-metric"},{"title":"Get aggregate estimates for a period","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /aggregates/estimates","href":"/api-reference/billable-metrics/get-aggregate-estimates-for-a-period"},{"title":"Get billable metric","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /aggregates/{aggregate_id}","href":"/api-reference/billable-metrics/get-billable-metric"},{"title":"Delete aggregate","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /aggregates/{aggregate_id}","href":"/api-reference/billable-metrics/delete-aggregate"},{"title":"Update aggregate","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /aggregates/{aggregate_id}","href":"/api-reference/billable-metrics/update-aggregate"}]},{"group":"Business Entities","pages":[{"title":"List business entities","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /business_entities","href":"/api-reference/business-entities/list-business-entities"},{"title":"Create business entity","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /business_entities","href":"/api-reference/business-entities/create-business-entity"},{"title":"Get business entity","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /business_entities/{entity_id}","href":"/api-reference/business-entities/get-business-entity"},{"title":"Update business entity","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /business_entities/{entity_id}","href":"/api-reference/business-entities/update-business-entity"},{"title":"Get business entity config","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /business_entities/{business_entity_id}/config","href":"/api-reference/business-entities/get-business-entity-config"},{"title":"Set business entity config","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json put /business_entities/{business_entity_id}/config","href":"/api-reference/business-entities/set-business-entity-config"},{"title":"Get region config","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /business_entities/{business_entity_id}/config/{country_code}","href":"/api-reference/business-entities/get-region-config"},{"title":"Upsert region config","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json put /business_entities/{business_entity_id}/config/{country_code}","href":"/api-reference/business-entities/upsert-region-config"},{"title":"Delete region config","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /business_entities/{business_entity_id}/config/{country_code}","href":"/api-reference/business-entities/delete-region-config"}]},{"group":"Contacts","pages":[{"title":"List contacts","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Create contact","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /contacts","href":"/api-reference/contacts/create-contact"},{"title":"Get contact","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /contacts/{contact_id}","href":"/api-reference/contacts/get-contact"},{"title":"Delete contact","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /contacts/{contact_id}","href":"/api-reference/contacts/delete-contact"},{"title":"Update contact","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /contacts/{contact_id}","href":"/api-reference/contacts/update-contact"}]},{"group":"Contracts","pages":[{"title":"List contracts","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /contract_v2","href":"/api-reference/contracts/list-contracts"},{"title":"Create contract","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /contract_v2","href":"/api-reference/contracts/create-contract"},{"title":"Get contract by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /contract_v2/{contract_id}","href":"/api-reference/contracts/get-contract-by-id"},{"title":"Update contract","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json put /contract_v2/{contract_id}","href":"/api-reference/contracts/update-contract"},{"title":"Delete contract","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /contract_v2/{contract_id}","href":"/api-reference/contracts/delete-contract"},{"title":"Get contract amendments","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /contract_v2/{contract_id}/amendments","href":"/api-reference/contracts/get-contract-amendments"},{"title":"Create contract phase","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /contract_v2/{contract_id}/phases","href":"/api-reference/contracts/create-contract-phase"},{"title":"Pause contract","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /contract_v2/{contract_id}/pause","href":"/api-reference/contracts/pause-contract"},{"title":"Update pause contract","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /contract_v2/{contract_id}/pause","href":"/api-reference/contracts/update-pause-contract"},{"title":"Resume contract","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /contract_v2/{contract_id}/resume","href":"/api-reference/contracts/resume-contract"},{"title":"Create contract phase pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /contract_v2/{contract_id}/phases/{phase_id}/pricing","href":"/api-reference/contracts/create-contract-phase-pricing"},{"title":"Expire contract","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /contract_v2/{contract_id}/expire","href":"/api-reference/contracts/expire-contract"}]},{"group":"Credit Notes","pages":[{"title":"Get credit note list","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /credit_notes","href":"/api-reference/credit-notes/get-credit-note-list"},{"title":"Create credit note","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /credit_notes","href":"/api-reference/credit-notes/create-credit-note"},{"title":"Get credit note by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /credit_notes/{credit_note_id}","href":"/api-reference/credit-notes/get-credit-note-by-id"},{"title":"Update credit note by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /credit_notes/{credit_note_id}","href":"/api-reference/credit-notes/update-credit-note-by-id"},{"title":"Get line items by credit note ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /credit_notes/line_items/{credit_note_id}","href":"/api-reference/credit-notes/get-line-items-by-credit-note-id"}]},{"group":"Custom Attributes","pages":[{"title":"List custom attribute definitions","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /custom_attributes","href":"/api-reference/custom-attributes/list-custom-attribute-definitions"},{"title":"Create custom attribute definition","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /custom_attributes","href":"/api-reference/custom-attributes/create-custom-attribute-definition"},{"title":"Get custom attribute definition","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /custom_attributes/{definition_id}","href":"/api-reference/custom-attributes/get-custom-attribute-definition"},{"title":"Update custom attribute definition","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /custom_attributes/{definition_id}","href":"/api-reference/custom-attributes/update-custom-attribute-definition"}]},{"group":"Customers","pages":[{"title":"List customers with filtering and pagination","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /customers","href":"/api-reference/customers/list-customers-with-filtering-and-pagination"},{"title":"Create customer","description":"Creates a new customer object in Zenskar. Customer objects represent the individuals or companies you do business with and serve for your revenue operations—they must exist before you can create contracts, generate invoices, or process payments.\n\nThe customer record stores essential billing information including contact details, billing and shipping addresses, tax identifiers, payment preferences, and custom metadata specific to your business needs. Only customer_name is required at creation—all other fields are optional, allowing you to capture minimal information initially. The customer address is an important field which is used for Regional tax calculation, make sure this field is correct for the required customers.\n\nWhen integrated with external systems, newly created customers are automatically synchronized with configured platforms like Stripe, HubSpot, Zoho, or Xero. Use the external_id field to maintain references to source systems for bidirectional synchronization.","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /customers","href":"/api-reference/customers/create-customer"},{"title":"Get customer by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /customers/{customer_id}","href":"/api-reference/customers/get-customer-by-id"},{"title":"Delete customer","description":"Deletes a customer by ID.","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /customers/{customer_id}","href":"/api-reference/customers/delete-customer"},{"title":"Update customer","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /customers/{customer_id}","href":"/api-reference/customers/update-customer"},{"title":"Create customer relationships","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /customers/{customer_id}/relationships","href":"/api-reference/customers/create-customer-relationships"},{"title":"List payment methods","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /customers/{customer_id}/payment_methods","href":"/api-reference/customers/list-payment-methods"},{"title":"Patch Customer Connector Id","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /customers/{customer_id}/connector","href":"/api-reference/customers/patch-customer-connector-id"},{"title":"Attach external payment method","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /customers/{customer_id}/payment_methods/attach","href":"/api-reference/customers/attach-external-payment-method"},{"title":"Delete payment method","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /customers/{customer_id}/payment_methods/{payment_method_id}","href":"/api-reference/customers/delete-payment-method"},{"title":"Delete third-party connector","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /customers/connector/{customer_id}","href":"/api-reference/customers/delete-third-party-connector"},{"title":"Create customer or guest session","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /customers/session","href":"/api-reference/customers/create-customer-or-guest-session"},{"title":"Get customer connector details","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /customers/{customer_id}/connector/{connector_name}","href":"/api-reference/customers/get-customer-connector-details"}]},{"group":"Customer Addresses","pages":[{"title":"List customer addresses","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /customers/{customer_id}/addresses","href":"/api-reference/customer-addresses/list-customer-addresses"},{"title":"Create customer address","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /customers/{customer_id}/addresses","href":"/api-reference/customer-addresses/create-customer-address"},{"title":"Get customer address","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /customers/{customer_id}/addresses/{address_id}","href":"/api-reference/customer-addresses/get-customer-address"},{"title":"Delete customer address","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /customers/{customer_id}/addresses/{address_id}","href":"/api-reference/customer-addresses/delete-customer-address"},{"title":"Update customer address","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /customers/{customer_id}/addresses/{address_id}","href":"/api-reference/customer-addresses/update-customer-address"}]},{"group":"Data Sources","pages":[{"title":"List data-source connectors","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /datasources","href":"/api-reference/data-sources/list-data-source-connectors"},{"title":"Create data-source connector","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /datasources","href":"/api-reference/data-sources/create-data-source-connector"},{"title":"Get data-source connector","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /datasources/{datasource_id}","href":"/api-reference/data-sources/get-data-source-connector"},{"title":"Update data-source connector","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /datasources/{datasource_id}","href":"/api-reference/data-sources/update-data-source-connector"}]},{"group":"Entitlements","pages":[{"title":"List entitlements","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements","href":"/api-reference/entitlements/list-entitlements"},{"title":"Create entitlement","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /entitlements","href":"/api-reference/entitlements/create-entitlement"},{"title":"List customer entitlement balances with advanced filtering","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements/customers_balances","href":"/api-reference/entitlements/list-customer-entitlement-balances-with-advanced-filtering"},{"title":"Get entitlement","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements/{entitlement_id}","href":"/api-reference/entitlements/get-entitlement"},{"title":"Delete entitlement","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /entitlements/{entitlement_id}","href":"/api-reference/entitlements/delete-entitlement"},{"title":"Update entitlement","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /entitlements/{entitlement_id}","href":"/api-reference/entitlements/update-entitlement"},{"title":"Create entitlement customer","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /entitlements/{entitlement_id}/customer","href":"/api-reference/entitlements/create-entitlement-customer"},{"title":"List entitlements for customer","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements/{entitlement_id}/customer/{customer_id}","href":"/api-reference/entitlements/list-entitlements-for-customer"},{"title":"Get total customer entitlements","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements/{entitlement_id}/customer/{customer_id}/total","href":"/api-reference/entitlements/get-total-customer-entitlements"},{"title":"List customer entitlements","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements/customer/{customer_id}","href":"/api-reference/entitlements/list-customer-entitlements"},{"title":"List unique entitlements for customer","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements/customer/unique/{customer_id}","href":"/api-reference/entitlements/list-unique-entitlements-for-customer"},{"title":"Get entitlement customer","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements/{entitlement_id}/customer/{customer_id}/{ec_id}","href":"/api-reference/entitlements/get-entitlement-customer"},{"title":"Delete customer entitlement","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /entitlements/{entitlement_id}/customer/{customer_id}/{ec_id}","href":"/api-reference/entitlements/delete-customer-entitlement"},{"title":"Update customer entitlement","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /entitlements/{entitlement_id}/customer/{customer_id}/{ec_id}","href":"/api-reference/entitlements/update-customer-entitlement"},{"title":"Get Customer Entitlement by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements/entitlement_customer/{ec_id}","href":"/api-reference/entitlements/get-customer-entitlement-by-id"}]},{"group":"Invoices","pages":[{"title":"List invoices","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /invoices","href":"/api-reference/invoices/list-invoices"},{"title":"Get invoice","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /invoices/{invoice_id}","href":"/api-reference/invoices/get-invoice"},{"title":"Get invoice by external Id","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /invoices/external_id/{external_id}","href":"/api-reference/invoices/get-invoice-by-external-id"},{"title":"Generate an invoice","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /invoices/generate_invoice","href":"/api-reference/invoices/generate-an-invoice"},{"title":"Approve invoice","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /invoices/{invoice_id}/approve","href":"/api-reference/invoices/approve-invoice"},{"title":"Approve V3 invoice","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /invoices/v3/{invoice_id}/approve","href":"/api-reference/invoices/approve-v3-invoice"},{"title":"Get invoice line items","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /invoices/{invoice_id}/line_items","href":"/api-reference/invoices/get-invoice-line-items"},{"title":"Void invoice","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /invoices/{invoice_id}/void","href":"/api-reference/invoices/void-invoice"},{"title":"Create credit note against invoice","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /invoices/{invoice_id}/credit_note","href":"/api-reference/invoices/create-credit-note-against-invoice"}]},{"group":"Jobs","pages":[{"title":"List jobs","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /jobs","href":"/api-reference/jobs/list-jobs"},{"title":"Get job by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /jobs/{job_id}","href":"/api-reference/jobs/get-job-by-id"},{"title":"Get job outcomes by filters","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /jobs/joboutcomes/logs","href":"/api-reference/jobs/get-job-outcomes-by-filters"},{"title":"Get job outcomes by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /jobs/{job_id}/logs","href":"/api-reference/jobs/get-job-outcomes-by-id"},{"title":"Get job with sub-jobs","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /jobs/{job_id}/sub-jobs","href":"/api-reference/jobs/get-job-with-sub-jobs"}]},{"group":"Payments","pages":[{"title":"Get invoice payments","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /payments/invoice/{invoice_id}","href":"/api-reference/payments/get-invoice-payments"},{"title":"Get payment by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /payments/{payment_id}","href":"/api-reference/payments/get-payment-by-id"},{"title":"Delete manual payment","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /payments/{payment_id}","href":"/api-reference/payments/delete-manual-payment"},{"title":"Update payment","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /payments/{payment_id}","href":"/api-reference/payments/update-payment"},{"title":"Get payments","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /payments","href":"/api-reference/payments/get-payments"},{"title":"Create payment","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /payments","href":"/api-reference/payments/create-payment"},{"title":"Create invoice charge","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /payments/invoice/{invoice_id}/charge","href":"/api-reference/payments/create-invoice-charge"},{"title":"Edit manual payment","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /payments/manual_payment/{payment_id}","href":"/api-reference/payments/edit-manual-payment"},{"title":"Refund payment","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /payments/{payment_id}/refund","href":"/api-reference/payments/refund-payment"}]},{"group":"Plans","pages":[{"title":"List plans","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /plans","href":"/api-reference/plans/list-plans"},{"title":"Create plan","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /plans","href":"/api-reference/plans/create-plan"},{"title":"Get plan by Id","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /plans/{plan_id}","href":"/api-reference/plans/get-plan-by-id"},{"title":"Update plan","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json put /plans/{plan_id}","href":"/api-reference/plans/update-plan"},{"title":"Delete plan by Id","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /plans/{plan_id}","href":"/api-reference/plans/delete-plan-by-id"},{"title":"Create plan phase","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /plans/{plan_id}/phases","href":"/api-reference/plans/create-plan-phase"},{"title":"Update plan phase","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json put /plans/{plan_id}/phases/{phase_id}","href":"/api-reference/plans/update-plan-phase"},{"title":"Delete plan phase","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /plans/{plan_id}/phases/{phase_id}","href":"/api-reference/plans/delete-plan-phase"},{"title":"Create plan phase pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /plans/{plan_id}/phases/{phase_id}/pricing","href":"/api-reference/plans/create-plan-phase-pricing"},{"title":"Update plan phase pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json put /plans/{plan_id}/phases/{phase_id}/pricing/{phase_pricing_id}","href":"/api-reference/plans/update-plan-phase-pricing"},{"title":"Delete plan phase pricing by Id","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /plans/{plan_id}/phases/{phase_id}/pricing/{pricing_id}","href":"/api-reference/plans/delete-plan-phase-pricing-by-id"},{"title":"Create new version","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /plans/{plan_id}/new_version","href":"/api-reference/plans/create-new-version"}]},{"group":"Products","pages":[{"title":"List products","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /products","href":"/api-reference/products/list-products"},{"title":"Create product","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /products","href":"/api-reference/products/create-product"},{"title":"Get product","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /products/{product_id}","href":"/api-reference/products/get-product"},{"title":"Delete product","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /products/{product_id}","href":"/api-reference/products/delete-product"},{"title":"Update product","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /products/{product_id}","href":"/api-reference/products/update-product"},{"title":"Get product pricings","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /products/{product_id}/pricing","href":"/api-reference/products/get-product-pricings"},{"title":"Create product pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /products/{product_id}/pricing","href":"/api-reference/products/create-product-pricing"},{"title":"Get product pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /products/{product_id}/pricing/{pricing_id}","href":"/api-reference/products/get-product-pricing"},{"title":"Delete product pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /products/{product_id}/pricing/{pricing_id}","href":"/api-reference/products/delete-product-pricing"},{"title":"Update product pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /products/{product_id}/pricing/{pricing_id}","href":"/api-reference/products/update-product-pricing"},{"title":"Get product bundle pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /products/bundle/{product_id}/pricing/{pricing_id}","href":"/api-reference/products/get-product-bundle-pricing"},{"title":"Update product bundle pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /products/bundle/{product_id}/pricing/{pricing_id}","href":"/api-reference/products/update-product-bundle-pricing"},{"title":"Create product bundle pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /products/bundle/{product_id}/pricing","href":"/api-reference/products/create-product-bundle-pricing"}]},{"group":"Tax","pages":[{"title":"List tax categories","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /tax/categories","href":"/api-reference/tax/list-tax-categories"},{"title":"Create tax category","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /tax/categories","href":"/api-reference/tax/create-tax-category"},{"title":"Get tax category","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /tax/categories/{code}","href":"/api-reference/tax/get-tax-category"},{"title":"Update tax category","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /tax/categories/{code}","href":"/api-reference/tax/update-tax-category"},{"title":"List jurisdiction rates","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /tax/business_entities/{business_entity_id}/jurisdiction_rates","href":"/api-reference/tax/list-jurisdiction-rates"},{"title":"Create jurisdiction rate","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /tax/business_entities/{business_entity_id}/jurisdiction_rates","href":"/api-reference/tax/create-jurisdiction-rate"},{"title":"Get jurisdiction rate","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /tax/business_entities/{business_entity_id}/jurisdiction_rates/{jurisdiction_rate_id}","href":"/api-reference/tax/get-jurisdiction-rate"},{"title":"Update jurisdiction rate","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /tax/business_entities/{business_entity_id}/jurisdiction_rates/{jurisdiction_rate_id}","href":"/api-reference/tax/update-jurisdiction-rate"},{"title":"Resolve the applicable tax rate for a destination","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /tax/business_entities/{business_entity_id}/rates/lookup","href":"/api-reference/tax/resolve-the-applicable-tax-rate-for-a-destination"},{"title":"List tax rates","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /tax/business_entities/{business_entity_id}/jurisdiction_rates/{jurisdiction_rate_id}/rates","href":"/api-reference/tax/list-tax-rates"},{"title":"Get tax rate","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /tax/business_entities/{business_entity_id}/rates/{rate_id}","href":"/api-reference/tax/get-tax-rate"},{"title":"Update tax rate","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /tax/business_entities/{business_entity_id}/rates/{rate_id}","href":"/api-reference/tax/update-tax-rate"}]},{"group":"Tags","pages":[{"title":"List tags","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /tags/{holder}/{item_id}","href":"/api-reference/tags/list-tags"},{"title":"Upsert tags","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /tags","href":"/api-reference/tags/upsert-tags"}]},{"group":"Usage Events","pages":[{"title":"List usage events","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /rawmetrics","href":"/api-reference/usage-events/list-usage-events"},{"title":"Create usage event","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /rawmetrics","href":"/api-reference/usage-events/create-usage-event"},{"title":"Get usage event by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /rawmetrics/{raw_metric_id}","href":"/api-reference/usage-events/get-usage-event-by-id"},{"title":"Update usage event","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /rawmetrics/{raw_metric_id}","href":"/api-reference/usage-events/update-usage-event"},{"title":"Get usage event by slug","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /rawmetrics/slug/{raw_metric_slug}","href":"/api-reference/usage-events/get-usage-event-by-slug"}]}]}]}]},"title":"Get customer by ID - Zenskar Documentation","buildId":"dpl_DGmhKsAzJdVqypJzon18vViniWRY","deploymentId":"dpl_DGmhKsAzJdVqypJzon18vViniWRY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-2jF_ccbi.js","utils-NNMVb_sb.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DdtBhtt6.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D1OxL5O8.js","snippetPresets-DDC-KAXp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BOnTqOyQ.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-EEWI6FIO.js","shallow-fGZcWzm2.js","getApiPlaygroundDisplay-B3B8qEvw.js","CodeSnippet-BG9nsSU4.js","CodeSnippets-BlRACLKl.js","Page-FtoC8lZ9.js","getPastedJson-COV-Kgnr.js","icon-BXu3lasn.js","MethodPill-DGMUqJKh.js","DuplicateIcon-JEUJDHz_.js","createIcon-BDFucJ34.js","DynamicMarkdown-34OtG_BH.js","SectionHeading-tBbRD59j.js","axios-vUo_bRtp.js","Markdown-SoRz2nk2.js","clsx-BOmkPVIU.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DN0dCbTw.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BcsLYcfW.js"]}