{"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":"6ae30736bfc6b3f8ac65f926","collectionId":"4079bcdf-0019-4b48-88c5-394119dfc5b9","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae30736bfc6b3f8ac65f926"},"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/entitlements/list-customer-entitlement-balances-with-advanced-filtering","slug":"/api-reference/entitlements/list-customer-entitlement-balances-with-advanced-filtering","pageMetadata":{"title":"List customer entitlement balances with advanced filtering","description":"Retrieve customer entitlement balances with comprehensive filtering, sorting, and pagination.\n\nFilter by:\n- Customer: customer, customer__in (filter by specific customer IDs).\n- Entitlement: entitlement, entitlement__in (filter by specific entitlement IDs).\n- Contract: contract_id, contract_id__in (filter by contract IDs - useful for contract-specific entitlements).\n- Quantities: quantity, quantity_used with range filters (gt, gte, lt, lte, neq).\n- Dates: created_at, active_from with range filters for time-based filtering.\n- Status: Use quantity__gt=0 to show only active balances, or quantity_used__lt=quantity to show available balances.\n\nEnrichment options (populate parameter):\n- customer: Include customer name and email details.\n- contract: Include contract name for entitlements granted by contracts.\n- product: Include product name for product-specific entitlements.\n- invoice: Include invoice number for invoice-generated entitlements.\n- Multiple: Use comma-separated values like 'customer,contract,product,invoice' for full enrichment.\n\nPagination \u0026 sorting:\n- limit: page size (1-100, default 50).\n- cursor: pass 'next' from previous response to paginate.\n- sort_key: field to sort by (id, created_at, quantity, quantity_used, active_from, expiry_at).\n- sort_type: 'asc' or 'desc' (default 'asc').\n- search: text search across entitlement names and descriptions.\n\nCommon use cases:\n- Contract entitlements: Use contract_id filter to get all entitlements for a specific contract.\n- Customer overview: Use customer filter with populate=contract,product for complete customer entitlement view.\n- Low balance alerts: Use quantity__gt=0 and quantity_used__gte with percentage calculations.\n- Expiring entitlements: Use expiry_at__lt with future date to find soon-to-expire entitlements.","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements/customers_balances","href":"/api-reference/entitlements/list-customer-entitlement-balances-with-advanced-filtering","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 customer entitlement balances with comprehensive filtering, sorting, and pagination.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Filter by:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Customer: customer, customer__in (filter by specific customer IDs).\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Entitlement: entitlement, entitlement__in (filter by specific entitlement IDs).\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Contract: contract_id, contract_id__in (filter by contract IDs - useful for contract-specific entitlements).\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Quantities: quantity, quantity_used with range filters (gt, gte, lt, lte, neq).\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Dates: created_at, active_from with range filters for time-based filtering.\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Status: Use quantity__gt=0 to show only active balances, or quantity_used__lt=quantity to show available balances.\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Enrichment options (populate parameter):\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"customer: Include customer name and email details.\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"contract: Include contract name for entitlements granted by contracts.\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"product: Include product name for product-specific entitlements.\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"invoice: Include invoice number for invoice-generated entitlements.\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Multiple: Use comma-separated values like ‘customer,contract,product,invoice’ for full enrichment.\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Pagination \u0026 sorting:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"limit: page size (1-100, default 50).\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"cursor: pass ‘next’ from previous response to paginate.\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"sort_key: field to sort by (id, created_at, quantity, quantity_used, active_from, expiry_at).\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"sort_type: ‘asc’ or ‘desc’ (default ‘asc’).\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"search: text search across entitlement names and descriptions.\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Common use cases:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Contract entitlements: Use contract_id filter to get all entitlements for a specific contract.\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Customer overview: Use customer filter with populate=contract,product for complete customer entitlement view.\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Low balance alerts: Use quantity__gt=0 and quantity_used__gte with percentage calculations.\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Expiring entitlements: Use expiry_at__lt with future date to find soon-to-expire entitlements.\"\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":"List customer entitlement balances with advanced filtering","description":"Retrieve customer entitlement balances with comprehensive filtering, sorting, and pagination.\n\nFilter by:\n- Customer: customer, customer__in (filter by specific customer IDs).\n- Entitlement: entitlement, entitlement__in (filter by specific entitlement IDs).\n- Contract: contract_id, contract_id__in (filter by contract IDs - useful for contract-specific entitlements).\n- Quantities: quantity, quantity_used with range filters (gt, gte, lt, lte, neq).\n- Dates: created_at, active_from with range filters for time-based filtering.\n- Status: Use quantity__gt=0 to show only active balances, or quantity_used__lt=quantity to show available balances.\n\nEnrichment options (populate parameter):\n- customer: Include customer name and email details.\n- contract: Include contract name for entitlements granted by contracts.\n- product: Include product name for product-specific entitlements.\n- invoice: Include invoice number for invoice-generated entitlements.\n- Multiple: Use comma-separated values like 'customer,contract,product,invoice' for full enrichment.\n\nPagination \u0026 sorting:\n- limit: page size (1-100, default 50).\n- cursor: pass 'next' from previous response to paginate.\n- sort_key: field to sort by (id, created_at, quantity, quantity_used, active_from, expiry_at).\n- sort_type: 'asc' or 'desc' (default 'asc').\n- search: text search across entitlement names and descriptions.\n\nCommon use cases:\n- Contract entitlements: Use contract_id filter to get all entitlements for a specific contract.\n- Customer overview: Use customer filter with populate=contract,product for complete customer entitlement view.\n- Low balance alerts: Use quantity__gt=0 and quantity_used__gte with percentage calculations.\n- Expiring entitlements: Use expiry_at__lt with future date to find soon-to-expire entitlements.","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements/customers_balances","href":"/api-reference/entitlements/list-customer-entitlement-balances-with-advanced-filtering","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Entitlements"],"summary":"List customer entitlement balances with advanced filtering","description":"Retrieve customer entitlement balances with comprehensive filtering, sorting, and pagination.\n\nFilter by:\n- Customer: customer, customer__in (filter by specific customer IDs).\n- Entitlement: entitlement, entitlement__in (filter by specific entitlement IDs).\n- Contract: contract_id, contract_id__in (filter by contract IDs - useful for contract-specific entitlements).\n- Quantities: quantity, quantity_used with range filters (gt, gte, lt, lte, neq).\n- Dates: created_at, active_from with range filters for time-based filtering.\n- Status: Use quantity__gt=0 to show only active balances, or quantity_used__lt=quantity to show available balances.\n\nEnrichment options (populate parameter):\n- customer: Include customer name and email details.\n- contract: Include contract name for entitlements granted by contracts.\n- product: Include product name for product-specific entitlements.\n- invoice: Include invoice number for invoice-generated entitlements.\n- Multiple: Use comma-separated values like 'customer,contract,product,invoice' for full enrichment.\n\nPagination \u0026 sorting:\n- limit: page size (1-100, default 50).\n- cursor: pass 'next' from previous response to paginate.\n- sort_key: field to sort by (id, created_at, quantity, quantity_used, active_from, expiry_at).\n- sort_type: 'asc' or 'desc' (default 'asc').\n- search: text search across entitlement names and descriptions.\n\nCommon use cases:\n- Contract entitlements: Use contract_id filter to get all entitlements for a specific contract.\n- Customer overview: Use customer filter with populate=contract,product for complete customer entitlement view.\n- Low balance alerts: Use quantity__gt=0 and quantity_used__gte with percentage calculations.\n- Expiring entitlements: Use expiry_at__lt with future date to find soon-to-expire entitlements.","operationId":"List-customer-entitlement-balances-with-advanced-filtering","parameters":["c3a64b1b-3d4e-4114-8988-18816080ddfe","e78f6103-3697-4b45-9776-37f3afbab5ac","b4344ae0-bf45-4241-9d6d-d81652865334","c9221deb-686a-4b2a-9b19-29f4bc442b32","eacb1c9e-fe37-40a7-bf08-0f55a0d0071a","0fde0fbe-c0b0-4b50-a3e9-49bcf054b767","c686bc5f-ebb9-4c43-a401-c01526eedc0b","e053959c-0adc-405c-ba69-2758118d808d","c9a914fb-24bd-40bc-b67d-6b3d56003a32","4892efe8-801c-46ed-9f59-6be961ad8093","b448a8d8-971c-48a1-bbc9-f7878ca46492","8e57ac28-c4ed-4bc4-8e20-1da0b9512ba6","0ab6269a-8495-412a-961f-6806587fff58","2933d1c5-77f9-4a59-b138-dab46e993332","4b50b600-12e4-4ccd-abcb-a18924276f30","799a4fd4-6c61-4fc4-bdad-0ebe4084cf54","bf6addce-5958-41c5-baf6-c41c46207888","5ff08923-bbf5-4efc-84bb-b10dbce3532c","d9a60f7c-a2fa-4b7a-a41c-2dd203436170","424b3409-6448-4143-a8cf-73619d1b196a","15f6d2da-8536-412d-912a-428ccfd2f29d","d3fd8360-a9d5-41af-bec2-3aec9662765c","6343e035-248b-4d24-bfea-f89a7752ca9b","c9244513-3758-4b25-aaf5-7060d93e3bbc","43cc9fc8-2486-49d7-bda8-b27fe868707e","94f9cff6-64ea-4652-803b-513ee9a5d526","aea0ef58-437b-467c-88e4-608e2eeb3626","9e4ab61f-f2be-4362-9aac-56a45f70fc74","9f852eb2-d65e-4053-b0d5-6620ae5eb7a7","5a7bae27-b5e6-4585-805e-e7269b14e539","c4433246-d679-4fb6-8049-d82737ff6ce9","a307c776-20fb-4bbb-8132-370b60be7888","9373c147-1cc1-4f0c-bfe6-960fbccd6c5e","19fa77ae-4304-49e2-a4c7-046aa6a0db67","8452d9d8-86df-47f7-9b30-eaefd3b81db5","96f9f2ad-370c-4787-bae4-99d069948e25","c4cabf85-9986-41b9-ab7c-a83ea1260246","3db71d61-9156-4c31-be38-94d07f1b42dc","255485e1-d636-43cd-a644-5a24d8651f8b","88a0a32e-41c2-4475-ab97-36d9df57ea1f","0cbc804e-9fd6-434d-a8a3-0658061ff404","1b3b92d9-b1b4-41c3-81a9-09dc8296e278","0b4c0c3c-0d6b-42d1-b267-5bf65418e12d","b7dc595f-a041-4cd0-be9a-bd74bec99735","b5ba4fe8-7cbf-4a11-9637-270befd5ba3d","13ad9225-75a8-4e1a-ad8a-245345228237","c6e31acf-b318-4bf5-8fe3-88d94ee89322","a4c216fb-c7f5-4dd9-8453-d93c080fc2b8","ad38a140-47da-4b52-8b95-b85c1e29a83b","e5af0543-4f85-45a1-93a2-c19820baa838"],"responses":{"200":"c508e1af-de91-4f0a-8bf4-77d1e9b284a9","400":"ff757b33-d5c1-43f1-96ba-bb7b62e20544","422":"183ac6f2-ca81-40e2-a6d6-e05ba0407999","500":"f93b8a73-6f65-49a6-9243-a14f3593da0d"},"method":"get","type":"path","servers":["b5800edb-bebb-41b7-ba92-5775ad182a17"],"security":["95049f99-a4b8-435b-a365-25b6391f1cff"],"path":"/entitlements/customers_balances","baseUrlOptions":["https://api.zenskar.com"],"title":"List customer entitlement balances with advanced filtering","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"c3a64b1b-3d4e-4114-8988-18816080ddfe":{"name":"cursor","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Cursor","description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response","example":"V2VsbCBhcmV1IGN1cmlvdxM=","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Cursor","description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response","example":"V2VsbCBhcmV1IGN1cmlvdxM=","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"},"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response"},"e78f6103-3697-4b45-9776-37f3afbab5ac":{"name":"limit","in":"query","required":false,"schema":{"oneOf":[{"type":"integer","title":"Limit","description":"The number of results to return - defaults to 10","example":10,"uniqueKey":"oneOf.0","typeLabel":"integer"},{"type":"null","title":"Limit","description":"The number of results to return - defaults to 10","example":10,"uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"integer | null"},"description":"The number of results to return - defaults to 10"},"b4344ae0-bf45-4241-9d6d-d81652865334":{"name":"sort_key","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Sort Key","description":"Field to sort results by","example":"id","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Sort Key","description":"Field to sort results by","example":"id","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"},"description":"Field to sort results by"},"c9221deb-686a-4b2a-9b19-29f4bc442b32":{"name":"sort_type","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Sort Type","description":"Sort direction (asc or desc)","example":"asc","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Sort Type","description":"Sort direction (asc or desc)","example":"asc","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"},"description":"Sort direction (asc or desc)"},"eacb1c9e-fe37-40a7-bf08-0f55a0d0071a":{"name":"search","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Search","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Search","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"0fde0fbe-c0b0-4b50-a3e9-49bcf054b767":{"name":"populate","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Populate","description":"Comma-separated list of fields to populate with related data","example":"customer","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Populate","description":"Comma-separated list of fields to populate with related data","example":"customer","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"},"description":"Comma-separated list of fields to populate with related data"},"c686bc5f-ebb9-4c43-a401-c01526eedc0b":{"name":"id","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Id","format":"uuid","uniqueKey":"oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","title":"Id","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cuuid> | null"}},"e053959c-0adc-405c-ba69-2758118d808d":{"name":"id__in","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Id In","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Id In","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"c9a914fb-24bd-40bc-b67d-6b3d56003a32":{"name":"id__isnull","in":"query","required":false,"schema":{"oneOf":[{"type":"boolean","title":"Id Isnull","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Id Isnull","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean | null"}},"4892efe8-801c-46ed-9f59-6be961ad8093":{"name":"entitlement","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Entitlement","format":"uuid","uniqueKey":"oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","title":"Entitlement","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cuuid> | null"}},"b448a8d8-971c-48a1-bbc9-f7878ca46492":{"name":"entitlement__in","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Entitlement In","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Entitlement In","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"8e57ac28-c4ed-4bc4-8e20-1da0b9512ba6":{"name":"entitlement__isnull","in":"query","required":false,"schema":{"oneOf":[{"type":"boolean","title":"Entitlement Isnull","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Entitlement Isnull","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean | null"}},"0ab6269a-8495-412a-961f-6806587fff58":{"name":"customer","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Customer","format":"uuid","uniqueKey":"oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","title":"Customer","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cuuid> | null"}},"2933d1c5-77f9-4a59-b138-dab46e993332":{"name":"customer__in","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Customer In","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Customer In","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"4b50b600-12e4-4ccd-abcb-a18924276f30":{"name":"customer__isnull","in":"query","required":false,"schema":{"oneOf":[{"type":"boolean","title":"Customer Isnull","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Customer Isnull","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean | null"}},"799a4fd4-6c61-4fc4-bdad-0ebe4084cf54":{"name":"contract_id","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Contract Id","format":"uuid","uniqueKey":"oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","title":"Contract Id","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cuuid> | null"}},"bf6addce-5958-41c5-baf6-c41c46207888":{"name":"contract_id__in","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Contract Id In","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Contract Id In","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"5ff08923-bbf5-4efc-84bb-b10dbce3532c":{"name":"contract_id__isnull","in":"query","required":false,"schema":{"oneOf":[{"type":"boolean","title":"Contract Id Isnull","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Contract Id Isnull","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean | null"}},"d9a60f7c-a2fa-4b7a-a41c-2dd203436170":{"name":"created_at","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Created At","format":"date-time","uniqueKey":"oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Created At","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time> | null"}},"424b3409-6448-4143-a8cf-73619d1b196a":{"name":"created_at__neq","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Created At Neq","format":"date-time","uniqueKey":"oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Created At Neq","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time> | null"}},"15f6d2da-8536-412d-912a-428ccfd2f29d":{"name":"created_at__gt","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Created At Gt","format":"date-time","uniqueKey":"oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Created At Gt","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time> | null"}},"d3fd8360-a9d5-41af-bec2-3aec9662765c":{"name":"created_at__gte","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Created At Gte","format":"date-time","uniqueKey":"oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Created At Gte","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time> | null"}},"6343e035-248b-4d24-bfea-f89a7752ca9b":{"name":"created_at__lt","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Created At Lt","format":"date-time","uniqueKey":"oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Created At Lt","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time> | null"}},"c9244513-3758-4b25-aaf5-7060d93e3bbc":{"name":"created_at__lte","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Created At Lte","format":"date-time","uniqueKey":"oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Created At Lte","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time> | null"}},"43cc9fc8-2486-49d7-bda8-b27fe868707e":{"name":"created_at__isnull","in":"query","required":false,"schema":{"oneOf":[{"type":"boolean","title":"Created At Isnull","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Created At Isnull","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean | null"}},"94f9cff6-64ea-4652-803b-513ee9a5d526":{"name":"created_at__in","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Created At In","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Created At In","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"aea0ef58-437b-467c-88e4-608e2eeb3626":{"name":"active_from","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Active From","format":"date-time","uniqueKey":"oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Active From","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time> | null"}},"9e4ab61f-f2be-4362-9aac-56a45f70fc74":{"name":"active_from__neq","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Active From Neq","format":"date-time","uniqueKey":"oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Active From Neq","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time> | null"}},"9f852eb2-d65e-4053-b0d5-6620ae5eb7a7":{"name":"active_from__gt","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Active From Gt","format":"date-time","uniqueKey":"oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Active From Gt","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time> | null"}},"5a7bae27-b5e6-4585-805e-e7269b14e539":{"name":"active_from__gte","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Active From Gte","format":"date-time","uniqueKey":"oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Active From Gte","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time> | null"}},"c4433246-d679-4fb6-8049-d82737ff6ce9":{"name":"active_from__lt","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Active From Lt","format":"date-time","uniqueKey":"oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Active From Lt","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time> | null"}},"a307c776-20fb-4bbb-8132-370b60be7888":{"name":"active_from__lte","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Active From Lte","format":"date-time","uniqueKey":"oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Active From Lte","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time> | null"}},"9373c147-1cc1-4f0c-bfe6-960fbccd6c5e":{"name":"active_from__isnull","in":"query","required":false,"schema":{"oneOf":[{"type":"boolean","title":"Active From Isnull","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Active From Isnull","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean | null"}},"19fa77ae-4304-49e2-a4c7-046aa6a0db67":{"name":"active_from__in","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Active From In","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Active From In","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"8452d9d8-86df-47f7-9b30-eaefd3b81db5":{"name":"quantity","in":"query","required":false,"schema":{"oneOf":[{"type":"number","title":"Quantity","uniqueKey":"oneOf.0","typeLabel":"number"},{"type":"null","title":"Quantity","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"number | null"}},"96f9f2ad-370c-4787-bae4-99d069948e25":{"name":"quantity__neq","in":"query","required":false,"schema":{"oneOf":[{"type":"number","title":"Quantity Neq","uniqueKey":"oneOf.0","typeLabel":"number"},{"type":"null","title":"Quantity Neq","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"number | null"}},"c4cabf85-9986-41b9-ab7c-a83ea1260246":{"name":"quantity__gt","in":"query","required":false,"schema":{"oneOf":[{"type":"number","title":"Quantity Gt","uniqueKey":"oneOf.0","typeLabel":"number"},{"type":"null","title":"Quantity Gt","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"number | null"}},"3db71d61-9156-4c31-be38-94d07f1b42dc":{"name":"quantity__gte","in":"query","required":false,"schema":{"oneOf":[{"type":"number","title":"Quantity Gte","uniqueKey":"oneOf.0","typeLabel":"number"},{"type":"null","title":"Quantity Gte","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"number | null"}},"255485e1-d636-43cd-a644-5a24d8651f8b":{"name":"quantity__lt","in":"query","required":false,"schema":{"oneOf":[{"type":"number","title":"Quantity Lt","uniqueKey":"oneOf.0","typeLabel":"number"},{"type":"null","title":"Quantity Lt","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"number | null"}},"88a0a32e-41c2-4475-ab97-36d9df57ea1f":{"name":"quantity__lte","in":"query","required":false,"schema":{"oneOf":[{"type":"number","title":"Quantity Lte","uniqueKey":"oneOf.0","typeLabel":"number"},{"type":"null","title":"Quantity Lte","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"number | null"}},"0cbc804e-9fd6-434d-a8a3-0658061ff404":{"name":"quantity__isnull","in":"query","required":false,"schema":{"oneOf":[{"type":"boolean","title":"Quantity Isnull","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Quantity Isnull","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean | null"}},"1b3b92d9-b1b4-41c3-81a9-09dc8296e278":{"name":"quantity__in","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Quantity In","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Quantity In","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"0b4c0c3c-0d6b-42d1-b267-5bf65418e12d":{"name":"quantity_used","in":"query","required":false,"schema":{"oneOf":[{"type":"number","title":"Quantity Used","uniqueKey":"oneOf.0","typeLabel":"number"},{"type":"null","title":"Quantity Used","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"number | null"}},"b7dc595f-a041-4cd0-be9a-bd74bec99735":{"name":"quantity_used__neq","in":"query","required":false,"schema":{"oneOf":[{"type":"number","title":"Quantity Used Neq","uniqueKey":"oneOf.0","typeLabel":"number"},{"type":"null","title":"Quantity Used Neq","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"number | null"}},"b5ba4fe8-7cbf-4a11-9637-270befd5ba3d":{"name":"quantity_used__gt","in":"query","required":false,"schema":{"oneOf":[{"type":"number","title":"Quantity Used Gt","uniqueKey":"oneOf.0","typeLabel":"number"},{"type":"null","title":"Quantity Used Gt","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"number | null"}},"13ad9225-75a8-4e1a-ad8a-245345228237":{"name":"quantity_used__gte","in":"query","required":false,"schema":{"oneOf":[{"type":"number","title":"Quantity Used Gte","uniqueKey":"oneOf.0","typeLabel":"number"},{"type":"null","title":"Quantity Used Gte","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"number | null"}},"c6e31acf-b318-4bf5-8fe3-88d94ee89322":{"name":"quantity_used__lt","in":"query","required":false,"schema":{"oneOf":[{"type":"number","title":"Quantity Used Lt","uniqueKey":"oneOf.0","typeLabel":"number"},{"type":"null","title":"Quantity Used Lt","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"number | null"}},"a4c216fb-c7f5-4dd9-8453-d93c080fc2b8":{"name":"quantity_used__lte","in":"query","required":false,"schema":{"oneOf":[{"type":"number","title":"Quantity Used Lte","uniqueKey":"oneOf.0","typeLabel":"number"},{"type":"null","title":"Quantity Used Lte","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"number | null"}},"ad38a140-47da-4b52-8b95-b85c1e29a83b":{"name":"quantity_used__isnull","in":"query","required":false,"schema":{"oneOf":[{"type":"boolean","title":"Quantity Used Isnull","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Quantity Used Isnull","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean | null"}},"e5af0543-4f85-45a1-93a2-c19820baa838":{"name":"quantity_used__in","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Quantity Used In","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Quantity Used In","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}}},"responses":{"c508e1af-de91-4f0a-8bf4-77d1e9b284a9":{"description":"Successfully retrieved customer entitlement balances","content":{"application/json":{"schema":{"properties":{"results":{"items":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Entitlement Customer Row Id","isRequired":true,"uniqueKey":"results.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"entitlement":{"type":"string","format":"uuid","title":"Entitlement","description":"Entitlement ID","isRequired":true,"uniqueKey":"results.items.[INDEX].entitlement","typeLabel":"string\u003cuuid>"},"name":{"type":"string","title":"Name","description":"Entitlement Name","isRequired":true,"uniqueKey":"results.items.[INDEX].name","typeLabel":"string"},"units":{"oneOf":[{"type":"string","title":"Units","description":"Entitlement units","isRequired":true,"uniqueKey":"results.items.[INDEX].units.oneOf.0","typeLabel":"string"},{"type":"null","title":"Units","description":"Entitlement units","isRequired":true,"uniqueKey":"results.items.[INDEX].units.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"results.items.[INDEX].units","typeLabel":"string | null"},"customer":{"oneOf":[{"type":"string","title":"Customer","description":"Customer ID","format":"uuid","isRequired":true,"uniqueKey":"results.items.[INDEX].customer.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"object","title":"DetailsObject","description":"Customer ID","properties":{"id":{"oneOf":[{"type":"string","title":"Id","format":"uuid","uniqueKey":"results.items.[INDEX].customer.oneOf.1.id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","title":"Id","uniqueKey":"results.items.[INDEX].customer.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].customer.oneOf.1.id","typeLabel":"string\u003cuuid> | null"},"name":{"oneOf":[{"type":"string","title":"Name","uniqueKey":"results.items.[INDEX].customer.oneOf.1.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","uniqueKey":"results.items.[INDEX].customer.oneOf.1.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].customer.oneOf.1.name","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","title":"Email","uniqueKey":"results.items.[INDEX].customer.oneOf.1.email.oneOf.0","typeLabel":"string"},{"type":"null","title":"Email","uniqueKey":"results.items.[INDEX].customer.oneOf.1.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].customer.oneOf.1.email","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"results.items.[INDEX].customer.oneOf.1","typeLabel":"DetailsObject · object"}],"isRequired":true,"uniqueKey":"results.items.[INDEX].customer","typeLabel":"string\u003cuuid> | DetailsObject · object"},"type":{"oneOf":[{"type":"string","title":"EntitlementType","description":"Entitlement Type","enum":["Feature","Quantity","Credits"],"uniqueKey":"results.items.[INDEX].type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Entitlement Type","uniqueKey":"results.items.[INDEX].type.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].type","typeLabel":"enum\u003cstring> | null"},"source_type":{"oneOf":[{"type":"string","title":"SourceType","description":"Entitlement source type","enum":["Grant","Billable","Rollover","Adjustment"],"uniqueKey":"results.items.[INDEX].source_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Entitlement source type","uniqueKey":"results.items.[INDEX].source_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].source_type","typeLabel":"enum\u003cstring> | null"},"source_id":{"oneOf":[{"type":"string","title":"Source Id","description":"Entitlement source id","format":"uuid","uniqueKey":"results.items.[INDEX].source_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","title":"Source Id","description":"Entitlement source id","uniqueKey":"results.items.[INDEX].source_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].source_id","typeLabel":"string\u003cuuid> | null"},"contract":{"oneOf":[{"type":"object","title":"DetailsObject","description":"Contract Details","properties":{"id":{"oneOf":[{"type":"string","title":"Id","format":"uuid","uniqueKey":"results.items.[INDEX].contract.oneOf.0.id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","title":"Id","uniqueKey":"results.items.[INDEX].contract.oneOf.0.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].contract.oneOf.0.id","typeLabel":"string\u003cuuid> | null"},"name":{"oneOf":[{"type":"string","title":"Name","uniqueKey":"results.items.[INDEX].contract.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","uniqueKey":"results.items.[INDEX].contract.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].contract.oneOf.0.name","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","title":"Email","uniqueKey":"results.items.[INDEX].contract.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","title":"Email","uniqueKey":"results.items.[INDEX].contract.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].contract.oneOf.0.email","typeLabel":"string | null"}},"uniqueKey":"results.items.[INDEX].contract.oneOf.0","typeLabel":"DetailsObject · object"},{"type":"null","description":"Contract Details","uniqueKey":"results.items.[INDEX].contract.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].contract","typeLabel":"DetailsObject · object | null"},"product":{"oneOf":[{"type":"object","title":"DetailsObject","description":"Product Details","properties":{"id":{"oneOf":[{"type":"string","title":"Id","format":"uuid","uniqueKey":"results.items.[INDEX].product.oneOf.0.id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","title":"Id","uniqueKey":"results.items.[INDEX].product.oneOf.0.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].product.oneOf.0.id","typeLabel":"string\u003cuuid> | null"},"name":{"oneOf":[{"type":"string","title":"Name","uniqueKey":"results.items.[INDEX].product.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","uniqueKey":"results.items.[INDEX].product.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].product.oneOf.0.name","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","title":"Email","uniqueKey":"results.items.[INDEX].product.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","title":"Email","uniqueKey":"results.items.[INDEX].product.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].product.oneOf.0.email","typeLabel":"string | null"}},"uniqueKey":"results.items.[INDEX].product.oneOf.0","typeLabel":"DetailsObject · object"},{"type":"null","description":"Product Details","uniqueKey":"results.items.[INDEX].product.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].product","typeLabel":"DetailsObject · object | null"},"invoice":{"oneOf":[{"type":"object","title":"DetailsObject","description":"Invoice Details","properties":{"id":{"oneOf":[{"type":"string","title":"Id","format":"uuid","uniqueKey":"results.items.[INDEX].invoice.oneOf.0.id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","title":"Id","uniqueKey":"results.items.[INDEX].invoice.oneOf.0.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].invoice.oneOf.0.id","typeLabel":"string\u003cuuid> | null"},"name":{"oneOf":[{"type":"string","title":"Name","uniqueKey":"results.items.[INDEX].invoice.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","uniqueKey":"results.items.[INDEX].invoice.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].invoice.oneOf.0.name","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","title":"Email","uniqueKey":"results.items.[INDEX].invoice.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","title":"Email","uniqueKey":"results.items.[INDEX].invoice.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].invoice.oneOf.0.email","typeLabel":"string | null"}},"uniqueKey":"results.items.[INDEX].invoice.oneOf.0","typeLabel":"DetailsObject · object"},{"type":"null","description":"Invoice Details","uniqueKey":"results.items.[INDEX].invoice.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].invoice","typeLabel":"DetailsObject · object | null"},"active_from":{"oneOf":[{"type":"string","title":"Active From","description":"Entitlement Active From","format":"date-time","uniqueKey":"results.items.[INDEX].active_from.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Active From","description":"Entitlement Active From","uniqueKey":"results.items.[INDEX].active_from.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].active_from","typeLabel":"string\u003cdate-time> | null"},"expiry_at":{"oneOf":[{"type":"string","title":"Expiry At","description":"Entitlement Expiry Time","format":"date-time","uniqueKey":"results.items.[INDEX].expiry_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Expiry At","description":"Entitlement Expiry Time","uniqueKey":"results.items.[INDEX].expiry_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].expiry_at","typeLabel":"string\u003cdate-time> | null"},"quantity":{"oneOf":[{"type":"number","title":"Quantity","description":"Entitlement Units assigned","uniqueKey":"results.items.[INDEX].quantity.oneOf.0","typeLabel":"number"},{"type":"null","title":"Quantity","description":"Entitlement Units assigned","uniqueKey":"results.items.[INDEX].quantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].quantity","typeLabel":"number | null"},"quantity_used":{"oneOf":[{"type":"number","title":"Quantity Used","description":"Entitlement Units Consumed","uniqueKey":"results.items.[INDEX].quantity_used.oneOf.0","typeLabel":"number"},{"type":"null","title":"Quantity Used","description":"Entitlement Units Consumed","uniqueKey":"results.items.[INDEX].quantity_used.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].quantity_used","typeLabel":"number | null"},"quantity_remaining":{"oneOf":[{"type":"number","title":"Quantity Remaining","description":"Entitlement Units Remaining","uniqueKey":"results.items.[INDEX].quantity_remaining.oneOf.0","typeLabel":"number"},{"type":"null","title":"Quantity Remaining","description":"Entitlement Units Remaining","uniqueKey":"results.items.[INDEX].quantity_remaining.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].quantity_remaining","typeLabel":"number | null"},"created_at":{"oneOf":[{"type":"string","title":"Created At","description":"created time","format":"date-time","uniqueKey":"results.items.[INDEX].created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Created At","description":"created time","uniqueKey":"results.items.[INDEX].created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].created_at","typeLabel":"string\u003cdate-time> | null"},"contract_id":{"oneOf":[{"type":"string","title":"Contract Id","description":"Contract ID","format":"uuid","uniqueKey":"results.items.[INDEX].contract_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","title":"Contract Id","description":"Contract ID","uniqueKey":"results.items.[INDEX].contract_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].contract_id","typeLabel":"string\u003cuuid> | null"},"event":{"oneOf":[{"type":"string","title":"Event","description":"Event","uniqueKey":"results.items.[INDEX].event.oneOf.0","typeLabel":"string"},{"type":"null","title":"Event","description":"Event","uniqueKey":"results.items.[INDEX].event.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].event","typeLabel":"string | null"},"invoice_id":{"oneOf":[{"type":"string","title":"Invoice Id","description":"Source ID","format":"uuid","uniqueKey":"results.items.[INDEX].invoice_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","title":"Invoice Id","description":"Source ID","uniqueKey":"results.items.[INDEX].invoice_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].invoice_id","typeLabel":"string\u003cuuid> | null"},"status":{"oneOf":[{"type":"string","title":"EntitlementCustomerStatus","description":"Entitlement status","enum":["draft","active","expired","voided"],"uniqueKey":"results.items.[INDEX].status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Entitlement status","uniqueKey":"results.items.[INDEX].status.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].status","typeLabel":"enum\u003cstring> | null"}},"type":"object","required":["id","entitlement","name","units","customer"],"title":"EntitlementCustomerResponseSchema","description":"Create Entitlement Customer Request Schema","uniqueKey":"results.items.[INDEX]","typeLabel":"EntitlementCustomerResponseSchema · object"},"type":"array","title":"Results","description":"The results for the current page","isRequired":true,"uniqueKey":"results","typeLabel":"EntitlementCustomerResponseSchema · object[]"},"next":{"oneOf":[{"type":"string","title":"Next","description":"The cursor for the next page of results","example":"V2VsbCBhcmV1IGN1cmlvdxM=","uniqueKey":"next.oneOf.0","typeLabel":"string"},{"type":"null","title":"Next","description":"The cursor for the next page of results","example":"V2VsbCBhcmV1IGN1cmlvdxM=","uniqueKey":"next.oneOf.1","typeLabel":"null"}],"uniqueKey":"next","typeLabel":"string | null"},"previous":{"oneOf":[{"type":"string","title":"Previous","description":"The cursor for the previous page of results","example":"GmBsbCBhcmV1IGN1cmlvdxM=","uniqueKey":"previous.oneOf.0","typeLabel":"string"},{"type":"null","title":"Previous","description":"The cursor for the previous page of results","example":"GmBsbCBhcmV1IGN1cmlvdxM=","uniqueKey":"previous.oneOf.1","typeLabel":"null"}],"uniqueKey":"previous","typeLabel":"string | null"},"total_count":{"oneOf":[{"type":"integer","title":"Total Count","description":"The total count of rows","uniqueKey":"total_count.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Total Count","description":"The total count of rows","uniqueKey":"total_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"total_count","typeLabel":"integer | null"}},"type":"object","required":["results"],"title":"PaginatedResults[EntitlementCustomerResponseSchema]","uniqueKey":"","typeLabel":"PaginatedResults[EntitlementCustomerResponseSchema] · object"},"example":{"results":[{"id":"123e4567-e89b-12d3-a456-426614174000","name":"API Calls","units":"calls","type":"Quantity","entitlement":"456e7890-e12b-34c5-d678-901234567890","customer":{"id":"789e0123-e45f-67g8-h901-234567890123","name":"Acme Corp","email":"billing@acme.com"},"quantity":10000,"quantity_used":2500,"quantity_remaining":7500,"active_from":"2024-01-01T00:00:00Z","expiry_at":"2024-12-31T23:59:59Z","created_at":"2024-01-01T10:30:00Z","contract_id":"contract-uuid-123","contract":{"id":"contract-uuid-123","name":"Enterprise Plan 2024"},"product":{"id":"product-uuid-456","name":"API Access Product"},"invoice":{"id":"invoice-uuid-789","name":"INV-2024-001"},"event":"Invoice","invoice_id":"invoice-uuid-789"},{"id":"234e5678-e90b-12d3-a456-426614174001","name":"Storage","units":"GB","type":"Quantity","entitlement":"567e8901-e23f-45g6-h789-012345678901","customer":{"id":"890e1234-e56f-78g9-h012-345678901234","name":"Tech Solutions Inc","email":"accounts@techsolutions.com"},"quantity":100,"quantity_used":45.2,"quantity_remaining":54.8,"active_from":"2024-01-15T00:00:00Z","expiry_at":"2024-02-14T23:59:59Z","created_at":"2024-01-15T14:20:00Z","contract_id":"contract-uuid-456","event":"Manual"}],"next":"cursor_to_next_page","total":150},"examples":{"Example":{"title":"Example","value":{"results":[{"id":"123e4567-e89b-12d3-a456-426614174000","name":"API Calls","units":"calls","type":"Quantity","entitlement":"456e7890-e12b-34c5-d678-901234567890","customer":{"id":"789e0123-e45f-67g8-h901-234567890123","name":"Acme Corp","email":"billing@acme.com"},"quantity":10000,"quantity_used":2500,"quantity_remaining":7500,"active_from":"2024-01-01T00:00:00Z","expiry_at":"2024-12-31T23:59:59Z","created_at":"2024-01-01T10:30:00Z","contract_id":"contract-uuid-123","contract":{"id":"contract-uuid-123","name":"Enterprise Plan 2024"},"product":{"id":"product-uuid-456","name":"API Access Product"},"invoice":{"id":"invoice-uuid-789","name":"INV-2024-001"},"event":"Invoice","invoice_id":"invoice-uuid-789"},{"id":"234e5678-e90b-12d3-a456-426614174001","name":"Storage","units":"GB","type":"Quantity","entitlement":"567e8901-e23f-45g6-h789-012345678901","customer":{"id":"890e1234-e56f-78g9-h012-345678901234","name":"Tech Solutions Inc","email":"accounts@techsolutions.com"},"quantity":100,"quantity_used":45.2,"quantity_remaining":54.8,"active_from":"2024-01-15T00:00:00Z","expiry_at":"2024-02-14T23:59:59Z","created_at":"2024-01-15T14:20:00Z","contract_id":"contract-uuid-456","event":"Manual"}],"next":"cursor_to_next_page","total":150}}},"exampleType":"examples"}},"exampleType":"examples"},"ff757b33-d5c1-43f1-96ba-bb7b62e20544":{"description":"Bad request - invalid parameters","content":{"application/json":{"examples":{"invalid_sort_key":{"title":"invalid_sort_key","value":{"error_code":"INVALID_SORT_KEY","message":"Invalid key: abc not available for sorting."}}},"exampleType":"examples"}},"exampleType":"examples"},"183ac6f2-ca81-40e2-a6d6-e05ba0407999":{"description":"Unprocessable Entity - invalid query parameters","content":{"application/json":{"example":{"status_code":10422,"message":"Contract ID should be a valid UUID"},"examples":{"Example":{"title":"Example","value":{"status_code":10422,"message":"Contract ID should be a valid UUID"}}},"exampleType":"examples"}},"exampleType":"examples"},"f93b8a73-6f65-49a6-9243-a14f3593da0d":{"description":"Internal server error","content":{"application/json":{"example":{"error_code":"INTERNAL_SERVER_ERROR","message":"Failed to retrieve customer entitlement balances"},"examples":{"Example":{"title":"Example","value":{"error_code":"INTERNAL_SERVER_ERROR","message":"Failed to retrieve customer entitlement balances"}}},"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":"List customer entitlement balances with advanced filtering - Zenskar Documentation","contextualStarterQuestions":[{"_id":"6a1ea18d2a685f4ecf01abb9","deploymentId":"69e0a11c3e5ca76e4bd3f576","questionText":"How do I find expiring balances?","status":"active","generatedBy":"contextual","path":"api-reference/entitlements/list-customer-entitlement-balances-with-advanced-filtering","createdAt":"2026-06-02T09:25:33.452Z","updatedAt":"2026-06-02T09:25:33.452Z","__v":0},{"_id":"6a1ea18d2a685f4ecf01abb7","deploymentId":"69e0a11c3e5ca76e4bd3f576","questionText":"How do I filter by contract?","status":"active","generatedBy":"contextual","path":"api-reference/entitlements/list-customer-entitlement-balances-with-advanced-filtering","createdAt":"2026-06-02T09:25:33.452Z","updatedAt":"2026-06-02T09:25:33.452Z","__v":0},{"_id":"6a1ea18d2a685f4ecf01abb8","deploymentId":"69e0a11c3e5ca76e4bd3f576","questionText":"What enrichment options exist?","status":"active","generatedBy":"contextual","path":"api-reference/entitlements/list-customer-entitlement-balances-with-advanced-filtering","createdAt":"2026-06-02T09:25:33.452Z","updatedAt":"2026-06-02T09:25:33.452Z","__v":0}],"navMaps":{"firstHrefInVersion":{"cedar.ALPHA.20260301":{"href":"/api-reference/entitlements/list-customer-entitlement-balances-with-advanced-filtering","matchLevel":0},"baobab.20240301":{"href":"/api-reference/entitlements/list-customer-entitlement-balances-with-advanced-filtering","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-08-21T07:01:53.023Z","originalFileLocation":"api-reference/entitlements/list-customer-entitlement-balances-with-advanced-filtering.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 customer entitlement balances with comprehensive filtering, sorting, and pagination. Filter by: - Customer: customer, customerin (filter by specific customer IDs). - Entitlement: entitlement, entitlementin (filter by specific entitlement IDs). - Contract: contract_id, contract_id__in (filter by contract IDs - useful for contract-specific entitlements). - Quantities: quantity, quantity_used with range filters (gt, gte, lt, lte, neq). - Dates: created_at, active_from with range filters for time-based filtering. - Status: Use quantity__gt=0 to show only active balances, or quantity_used__lt=quantity to show available balances. Enrichment options (populate parameter): - customer: Include customer name and email details. - contract: Include contract name for entitlements granted by contracts. - product: Include product name for product-specific entitlements. - invoice: Include invoice number for invoice-generated entitlements. - Multiple: Use comma-separated values like \u0026#x27;customer,contract,product,invoice\u0026#x27; for full enrichment. Pagination \u0026amp; sorting: - limit: page size (1-100, default 50). - cursor: pass \u0026#x27;next\u0026#x27; from previous response to paginate. - sort_key: field to sort by (id, created_at, quantity, quantity_used, active_from, expiry_at). - sort_type: \u0026#x27;asc\u0026#x27; or \u0026#x27;desc\u0026#x27; (default \u0026#x27;asc\u0026#x27;). - search: text search across entitlement names and descriptions. Common use cases: - Contract entitlements: Use contract_id filter to get all entitlements for a specific contract. - Customer overview: Use customer filter with populate=contract,product for complete customer entitlement view. - Low balance alerts: Use quantity__gt=0 and quantity_used__gte with percentage calculations. - Expiring entitlements: Use expiry_at__lt with future date to find soon-to-expire entitlements.\">\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=\"List customer entitlement balances with advanced filtering - Zenskar Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve customer entitlement balances with comprehensive filtering, sorting, and pagination. Filter by: - Customer: customer, customerin (filter by specific customer IDs). - Entitlement: entitlement, entitlementin (filter by specific entitlement IDs). - Contract: contract_id, contract_id__in (filter by contract IDs - useful for contract-specific entitlements). - Quantities: quantity, quantity_used with range filters (gt, gte, lt, lte, neq). - Dates: created_at, active_from with range filters for time-based filtering. - Status: Use quantity__gt=0 to show only active balances, or quantity_used__lt=quantity to show available balances. Enrichment options (populate parameter): - customer: Include customer name and email details. - contract: Include contract name for entitlements granted by contracts. - product: Include product name for product-specific entitlements. - invoice: Include invoice number for invoice-generated entitlements. - Multiple: Use comma-separated values like \u0026#x27;customer,contract,product,invoice\u0026#x27; for full enrichment. Pagination \u0026amp; sorting: - limit: page size (1-100, default 50). - cursor: pass \u0026#x27;next\u0026#x27; from previous response to paginate. - sort_key: field to sort by (id, created_at, quantity, quantity_used, active_from, expiry_at). - sort_type: \u0026#x27;asc\u0026#x27; or \u0026#x27;desc\u0026#x27; (default \u0026#x27;asc\u0026#x27;). - search: text search across entitlement names and descriptions. Common use cases: - Contract entitlements: Use contract_id filter to get all entitlements for a specific contract. - Customer overview: Use customer filter with populate=contract,product for complete customer entitlement view. - Low balance alerts: Use quantity__gt=0 and quantity_used__gte with percentage calculations. - Expiring entitlements: Use expiry_at__lt with future date to find soon-to-expire entitlements.\">\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/entitlements/list-customer-entitlement-balances-with-advanced-filtering\">\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=Entitlements\u0026amp;title=List+customer+entitlement+balances+with+advanced+filtering\u0026amp;description=Retrieve+customer+entitlement+balances+with+comprehensive+filtering%2C+sorting%2C+and+pagination.%0A%0AFilter+by%3A%0A-+Customer%3A+customer%2C+customer__in+%28filter+by+specific\u0026amp;theme=a962312433b97c96be242726\u0026amp;signature=5b6d7885601ca62c96815facf95b2a94ef1cf89c7a69e238b3463c4986ae68dd\">\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=\"List customer entitlement balances with advanced filtering - Zenskar Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve customer entitlement balances with comprehensive filtering, sorting, and pagination. Filter by: - Customer: customer, customerin (filter by specific customer IDs). - Entitlement: entitlement, entitlementin (filter by specific entitlement IDs). - Contract: contract_id, contract_id__in (filter by contract IDs - useful for contract-specific entitlements). - Quantities: quantity, quantity_used with range filters (gt, gte, lt, lte, neq). - Dates: created_at, active_from with range filters for time-based filtering. - Status: Use quantity__gt=0 to show only active balances, or quantity_used__lt=quantity to show available balances. Enrichment options (populate parameter): - customer: Include customer name and email details. - contract: Include contract name for entitlements granted by contracts. - product: Include product name for product-specific entitlements. - invoice: Include invoice number for invoice-generated entitlements. - Multiple: Use comma-separated values like \u0026#x27;customer,contract,product,invoice\u0026#x27; for full enrichment. Pagination \u0026amp; sorting: - limit: page size (1-100, default 50). - cursor: pass \u0026#x27;next\u0026#x27; from previous response to paginate. - sort_key: field to sort by (id, created_at, quantity, quantity_used, active_from, expiry_at). - sort_type: \u0026#x27;asc\u0026#x27; or \u0026#x27;desc\u0026#x27; (default \u0026#x27;asc\u0026#x27;). - search: text search across entitlement names and descriptions. Common use cases: - Contract entitlements: Use contract_id filter to get all entitlements for a specific contract. - Customer overview: Use customer filter with populate=contract,product for complete customer entitlement view. - Low balance alerts: Use quantity__gt=0 and quantity_used__gte with percentage calculations. - Expiring entitlements: Use expiry_at__lt with future date to find soon-to-expire entitlements.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://zenskar-3d451781.mintlify.app/_mintlify/api/og/v2?division=Entitlements\u0026amp;title=List+customer+entitlement+balances+with+advanced+filtering\u0026amp;description=Retrieve+customer+entitlement+balances+with+comprehensive+filtering%2C+sorting%2C+and+pagination.%0A%0AFilter+by%3A%0A-+Customer%3A+customer%2C+customer__in+%28filter+by+specific\u0026amp;theme=a962312433b97c96be242726\u0026amp;signature=5b6d7885601ca62c96815facf95b2a94ef1cf89c7a69e238b3463c4986ae68dd\">\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/entitlements/list-customer-entitlement-balances-with-advanced-filtering\">\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/entitlements/list-customer-entitlement-balances-with-advanced-filtering.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/entitlements/list-customer-entitlement-balances-with-advanced-filtering#webpage\",\"url\":\"https://zenskar.com/docs/api-reference/entitlements/list-customer-entitlement-balances-with-advanced-filtering\",\"name\":\"List customer entitlement balances with advanced filtering\",\"description\":\"Retrieve customer entitlement balances with comprehensive filtering, sorting, and pagination. Filter by: - Customer: customer, customerin (filter by specific customer IDs). - Entitlement: entitlement, entitlementin (filter by specific entitlement IDs). - Contract: contract_id, contract_id__in (filter by contract IDs - useful for contract-specific entitlements). - Quantities: quantity, quantity_used with range filters (gt, gte, lt, lte, neq). - Dates: created_at, active_from with range filters for time-based filtering. - Status: Use quantity__gt=0 to show only active balances, or quantity_used__lt=quantity to show available balances. Enrichment options (populate parameter): - customer: Include customer name and email details. - contract: Include contract name for entitlements granted by contracts. - product: Include product name for product-specific entitlements. - invoice: Include invoice number for invoice-generated entitlements. - Multiple: Use comma-separated values like 'customer,contract,product,invoice' for full enrichment. Pagination \u0026 sorting: - limit: page size (1-100, default 50). - cursor: pass 'next' from previous response to paginate. - sort_key: field to sort by (id, created_at, quantity, quantity_used, active_from, expiry_at). - sort_type: 'asc' or 'desc' (default 'asc'). - search: text search across entitlement names and descriptions. Common use cases: - Contract entitlements: Use contract_id filter to get all entitlements for a specific contract. - Customer overview: Use customer filter with populate=contract,product for complete customer entitlement view. - Low balance alerts: Use quantity__gt=0 and quantity_used__gte with percentage calculations. - Expiring entitlements: Use expiry_at__lt with future date to find soon-to-expire entitlements.\",\"dateModified\":\"2026-08-21T07:01:53.023Z\",\"isPartOf\":{\"@id\":\"https://zenskar.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://zenskar.com/docs/api-reference/entitlements/list-customer-entitlement-balances-with-advanced-filtering#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://zenskar.com/docs/api-reference/entitlements/list-customer-entitlement-balances-with-advanced-filtering#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Entitlements\",\"item\":\"https://zenskar.com/docs/api-reference/entitlements/list-entitlements\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List customer entitlement balances with advanced filtering\",\"item\":\"https://zenskar.com/docs/api-reference/entitlements/list-customer-entitlement-balances-with-advanced-filtering\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://zenskar.com/docs/api-reference/entitlements/list-customer-entitlement-balances-with-advanced-filtering#apireference\",\"headline\":\"List customer entitlement balances with advanced filtering\",\"name\":\"List customer entitlement balances with advanced filtering\",\"description\":\"Retrieve customer entitlement balances with comprehensive filtering, sorting, and pagination. Filter by: - Customer: customer, customerin (filter by specific customer IDs). - Entitlement: entitlement, entitlementin (filter by specific entitlement IDs). - Contract: contract_id, contract_id__in (filter by contract IDs - useful for contract-specific entitlements). - Quantities: quantity, quantity_used with range filters (gt, gte, lt, lte, neq). - Dates: created_at, active_from with range filters for time-based filtering. - Status: Use quantity__gt=0 to show only active balances, or quantity_used__lt=quantity to show available balances. Enrichment options (populate parameter): - customer: Include customer name and email details. - contract: Include contract name for entitlements granted by contracts. - product: Include product name for product-specific entitlements. - invoice: Include invoice number for invoice-generated entitlements. - Multiple: Use comma-separated values like 'customer,contract,product,invoice' for full enrichment. Pagination \u0026 sorting: - limit: page size (1-100, default 50). - cursor: pass 'next' from previous response to paginate. - sort_key: field to sort by (id, created_at, quantity, quantity_used, active_from, expiry_at). - sort_type: 'asc' or 'desc' (default 'asc'). - search: text search across entitlement names and descriptions. Common use cases: - Contract entitlements: Use contract_id filter to get all entitlements for a specific contract. - Customer overview: Use customer filter with populate=contract,product for complete customer entitlement view. - Low balance alerts: Use quantity__gt=0 and quantity_used__gte with percentage calculations. - Expiring entitlements: Use expiry_at__lt with future date to find soon-to-expire entitlements.\",\"url\":\"https://zenskar.com/docs/api-reference/entitlements/list-customer-entitlement-balances-with-advanced-filtering\",\"mainEntityOfPage\":{\"@id\":\"https://zenskar.com/docs/api-reference/entitlements/list-customer-entitlement-balances-with-advanced-filtering#webpage\"},\"dateModified\":\"2026-08-21T07:01:53.023Z\",\"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","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","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","description":"Create a new 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","description":"Get entitlement details by its unique identifier","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","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","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","description":"Create a new 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","description":"Get entitlement details by its unique identifier","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":"List customer entitlement balances with advanced filtering - 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"]}