{"items":[{"type":"link","fsPath":"index.md","metadata":{"type":"markdown"},"label":"Overview","link":"/","routeSlug":"/"},{"type":"group","label":"Getting Started","items":[{"type":"link","fsPath":"docs/first-payment.md","metadata":{"type":"markdown"},"label":"First Payment","link":"/docs/first-payment","routeSlug":"/docs/first-payment"},{"type":"link","fsPath":"docs/test-numbers-and-uat-testing.md","metadata":{"type":"markdown"},"label":"Environments & Test Data","link":"/docs/test-numbers-and-uat-testing","routeSlug":"/docs/test-numbers-and-uat-testing"},{"type":"link","fsPath":"docs/sandbox-testing.md","metadata":{"type":"markdown"},"label":"Accounts for Sandbox Testing Digital Wallets","link":"/docs/sandbox-testing","routeSlug":"/docs/sandbox-testing"}]},{"type":"group","label":"Authentication & Access","items":[{"type":"link","fsPath":"docs/api-keys-and-account-hierarchy.md","metadata":{"type":"markdown"},"label":"API Keys & Account Hierarchy","link":"/docs/api-keys-and-account-hierarchy","routeSlug":"/docs/api-keys-and-account-hierarchy"},{"type":"link","fsPath":"docs/jwt-authentication.md","metadata":{"type":"markdown"},"label":"JWT Authentication","link":"/docs/jwt-authentication","routeSlug":"/docs/jwt-authentication"},{"type":"link","fsPath":"docs/session-token.md","metadata":{"type":"markdown"},"label":"Session Token Creation","link":"/docs/session-token","routeSlug":"/docs/session-token"},{"type":"link","fsPath":"docs/service-access-and-key-entitlements.md","metadata":{"type":"markdown"},"label":"Service Access and Key Entitlements","link":"/docs/service-access-and-key-entitlements","routeSlug":"/docs/service-access-and-key-entitlements"}]},{"type":"group","label":"UI & Tokenization","items":[{"type":"link","fsPath":"docs/tokenization-overview.md","metadata":{"type":"markdown"},"label":"Tokenization Overview","link":"/docs/tokenization-overview","routeSlug":"/docs/tokenization-overview"},{"type":"link","fsPath":"docs/hosted-tokenization-iframe.md","metadata":{"type":"markdown"},"label":"Embedded Tokenization Experience","link":"/docs/hosted-tokenization-iframe","routeSlug":"/docs/hosted-tokenization-iframe"},{"type":"link","fsPath":"docs/card-detection.md","metadata":{"type":"markdown"},"label":"Card Testing / Carding Detection","link":"/docs/card-detection","routeSlug":"/docs/card-detection"},{"type":"link","fsPath":"docs/payment-widget.md","metadata":{"type":"markdown"},"label":"Payment Widget","link":"/docs/payment-widget","routeSlug":"/docs/payment-widget"},{"type":"link","fsPath":"docs/ui-sdk-reference.md","metadata":{"type":"markdown"},"label":"UI SDK Reference","link":"/docs/ui-sdk-reference","routeSlug":"/docs/ui-sdk-reference"},{"type":"link","fsPath":"docs/card-ach.md","metadata":{"type":"markdown"},"label":"Card and ACH","link":"/docs/card-ach","routeSlug":"/docs/card-ach"},{"type":"link","fsPath":"docs/apple-pay.md","metadata":{"type":"markdown"},"label":"Apple Pay","link":"/docs/apple-pay","routeSlug":"/docs/apple-pay"},{"type":"link","fsPath":"docs/paypal.md","metadata":{"type":"markdown"},"label":"PayPal and Venmo","link":"/docs/paypal","routeSlug":"/docs/paypal"}]},{"type":"group","label":"Payments","items":[{"type":"link","fsPath":"docs/creating-a-payment-with-a-token.md","metadata":{"type":"markdown"},"label":"Creating a Payment with a Token","link":"/docs/creating-a-payment-with-a-token","routeSlug":"/docs/creating-a-payment-with-a-token"},{"type":"link","fsPath":"docs/credit-card-payment-lifecycle-and-transaction-types.md","metadata":{"type":"markdown"},"label":"Credit Card Transactions","link":"/docs/credit-card-payment-lifecycle-and-transaction-types","routeSlug":"/docs/credit-card-payment-lifecycle-and-transaction-types"},{"type":"link","fsPath":"docs/ach-payment-lifecycle-and-transaction-types.md","metadata":{"type":"markdown"},"label":"ACH Transactions","link":"/docs/ach-payment-lifecycle-and-transaction-types","routeSlug":"/docs/ach-payment-lifecycle-and-transaction-types"},{"type":"link","fsPath":"docs/applepay-transactions.md","metadata":{"type":"markdown"},"label":"Apple Pay Transactions","link":"/docs/applepay-transactions","routeSlug":"/docs/applepay-transactions"},{"type":"link","fsPath":"docs/paypal-and-venmo-transactions.md","metadata":{"type":"markdown"},"label":"PayPal and Venmo Transactions","link":"/docs/paypal-and-venmo-transactions","routeSlug":"/docs/paypal-and-venmo-transactions"},{"type":"link","fsPath":"docs/payment-credential-lifecycle-management.md","metadata":{"type":"markdown"},"label":"Payment Credential Lifecycle Management","link":"/docs/payment-credential-lifecycle-management","routeSlug":"/docs/payment-credential-lifecycle-management"}]},{"type":"group","label":"Customer Data & Vault","items":[{"type":"link","fsPath":"docs/customer-data-and-vault-overview.md","metadata":{"type":"markdown"},"label":"Overview","link":"/docs/customer-data-and-vault-overview","routeSlug":"/docs/customer-data-and-vault-overview"},{"type":"link","fsPath":"docs/profiles-accounts-and-relationships.md","metadata":{"type":"markdown"},"label":"Profiles, Accounts & Relationships","link":"/docs/profiles-accounts-and-relationships","routeSlug":"/docs/profiles-accounts-and-relationships"},{"type":"link","fsPath":"docs/stored-payment-methods.md","metadata":{"type":"markdown"},"label":"Stored Payment Methods","link":"/docs/stored-payment-methods","routeSlug":"/docs/stored-payment-methods"},{"type":"link","fsPath":"docs/using-profiles.md","metadata":{"type":"markdown"},"label":"Using Profiles (Example)","link":"/docs/using-profiles","routeSlug":"/docs/using-profiles"}]},{"type":"group","label":"Billing","items":[{"type":"link","fsPath":"docs/billing-and-ledger.md","metadata":{"type":"markdown"},"label":"Billing & Ledger","link":"/docs/billing-and-ledger","routeSlug":"/docs/billing-and-ledger"},{"type":"link","fsPath":"docs/billing-and-ledger-end-to-end-walkthrough.md","metadata":{"type":"markdown"},"label":"Billing Walkthrough","link":"/docs/billing-and-ledger-end-to-end-walkthrough","routeSlug":"/docs/billing-and-ledger-end-to-end-walkthrough"},{"type":"group","label":"Billing Configuration","items":[{"type":"link","fsPath":"docs/rates-and-rate-cards.md","metadata":{"type":"markdown"},"label":"Rates & Rate Cards","link":"/docs/rates-and-rate-cards","routeSlug":"/docs/rates-and-rate-cards"},{"type":"link","fsPath":"docs/allocation-rules-and-responsibility.md","metadata":{"type":"markdown"},"label":"Allocation Rules & Responsibilities","link":"/docs/allocation-rules-and-responsibility","routeSlug":"/docs/allocation-rules-and-responsibility"},{"type":"link","fsPath":"docs/subscriptions-and-billing-intent.md","metadata":{"type":"markdown"},"label":"Subscriptions & Billing Intent","link":"/docs/subscriptions-and-billing-intent","routeSlug":"/docs/subscriptions-and-billing-intent"},{"type":"link","fsPath":"docs/versioning-and-change-management.md","metadata":{"type":"markdown"},"label":"Versioning & Change Management","link":"/docs/versioning-and-change-management","routeSlug":"/docs/versioning-and-change-management"}]},{"type":"group","label":"Recurring Billing","items":[{"type":"link","fsPath":"docs/recurring-billing.md","metadata":{"type":"markdown"},"label":"Recurring Billing","link":"/docs/recurring-billing","routeSlug":"/docs/recurring-billing"},{"type":"link","fsPath":"docs/recurring-billing-end-to-end-walkthrough.md","metadata":{"type":"markdown"},"label":"Recurring Billing Walkthrough","link":"/docs/recurring-billing-end-to-end-walkthrough","routeSlug":"/docs/recurring-billing-end-to-end-walkthrough"}]}]},{"type":"group","label":"Invoices & Receipts","items":[{"type":"link","fsPath":"docs/invoices.md","metadata":{"type":"markdown"},"label":"Invoices","link":"/docs/invoices","routeSlug":"/docs/invoices"},{"type":"link","fsPath":"docs/invoice-template-language-and-branding.md","metadata":{"type":"markdown"},"label":"Invoice Templates & Branding","link":"/docs/invoice-template-language-and-branding","routeSlug":"/docs/invoice-template-language-and-branding"},{"type":"link","fsPath":"docs/invoice-service-end-to-end-walkthrough.md","metadata":{"type":"markdown"},"label":"Invoice End-to-End Walkthrough","link":"/docs/invoice-service-end-to-end-walkthrough","routeSlug":"/docs/invoice-service-end-to-end-walkthrough"},{"type":"link","fsPath":"docs/receipts.md","metadata":{"type":"markdown"},"label":"Receipts","link":"/docs/receipts","routeSlug":"/docs/receipts"}]},{"type":"group","label":"Settlement & Reconciliation","items":[{"type":"link","fsPath":"docs/remittance-and-settlement.md","metadata":{"type":"markdown"},"label":"Remittance & Settlement Service","link":"/docs/remittance-and-settlement","routeSlug":"/docs/remittance-and-settlement"}]},{"type":"group","label":"Tagging","items":[{"type":"link","fsPath":"docs/tagging-overview.md","metadata":{"type":"markdown"},"label":"Overview","link":"/docs/tagging-overview","routeSlug":"/docs/tagging-overview"},{"type":"link","fsPath":"docs/taggable-entities-and-services.md","metadata":{"type":"markdown"},"label":"Taggable Entities & Services","link":"/docs/taggable-entities-and-services","routeSlug":"/docs/taggable-entities-and-services"},{"type":"link","fsPath":"docs/tag-consolidation-and-propagation.md","metadata":{"type":"markdown"},"label":"Tag Consolidation & Propagation","link":"/docs/tag-consolidation-and-propagation","routeSlug":"/docs/tag-consolidation-and-propagation"},{"type":"link","fsPath":"docs/tagging-use-cases-and-best-practices.md","metadata":{"type":"markdown"},"label":"Use Cases & Best Practices","link":"/docs/tagging-use-cases-and-best-practices","routeSlug":"/docs/tagging-use-cases-and-best-practices"}]},{"type":"group","label":"API & References","items":[{"type":"group","label":"Payments","items":[{"type":"link","label":"Payments API","link":"/apis/osi-payments-api","routeSlug":"/apis/osi-payments-api"},{"label":"Process a Payment Request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/osi-payments-api/other/processpaymentrequest","routeSlug":"/apis/osi-payments-api/other/processpaymentrequest","metadata":{"seo":{"title":"Process a Payment Request","description":"Perform a request to process a payment."}},"httpPath":"/"},{"label":"Get Payment by paymentTransactionId","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/osi-payments-api/other/getpayment","routeSlug":"/apis/osi-payments-api/other/getpayment","metadata":{"seo":{"title":"Get Payment by paymentTransactionId","description":"Retrieve a previously-processed payment by its NPS paymentTransactionId (UUID). If no transaction is found, returns responseCode = E402 (DATA_NOT_FOUND) and a descriptive responseMessage."}},"httpPath":"/{paymentTransactionId}"},{"type":"link","fsPath":"apis/payments-api-codes.md","metadata":{"type":"markdown"},"label":"Response Codes","link":"/apis/payments-api-codes","routeSlug":"/apis/payments-api-codes"},{"type":"link","fsPath":"apis/avs-codes.md","metadata":{"type":"markdown"},"label":"Address Verification (AVS) Codes","link":"/apis/avs-codes","routeSlug":"/apis/avs-codes"},{"type":"link","fsPath":"apis/cvv-codes.md","metadata":{"type":"markdown"},"label":"Card Verification (CVV) Codes","link":"/apis/cvv-codes","routeSlug":"/apis/cvv-codes"}]},{"type":"group","label":"ApplePay Onboarding","items":[{"type":"link","label":"Apple Pay","link":"/apis/applepay-api-spec","routeSlug":"/apis/applepay-api-spec"},{"type":"link","label":"Onboarding Steps","link":"/apis/applepay-api-spec/section/onboarding-steps","routeSlug":"/apis/applepay-api-spec/section/onboarding-steps"},{"type":"link","label":"Payment Session Retrieval","link":"/apis/applepay-api-spec/section/payment-session-retrieval","routeSlug":"/apis/applepay-api-spec/section/payment-session-retrieval"},{"label":"Retrieve Domain Verification File","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/applepay-api-spec/other/getdomainverificationfile","routeSlug":"/apis/applepay-api-spec/other/getdomainverificationfile","metadata":{"seo":{"title":"Retrieve Domain Verification File","description":"Retrieve the Apple Pay domain verification file to verify your domain."}},"httpPath":"/domain-verification-file"},{"label":"Register Merchant and Domains","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/applepay-api-spec/other/registerdomains","routeSlug":"/apis/applepay-api-spec/other/registerdomains","metadata":{"seo":{"title":"Register Merchant and Domains","description":"Register your merchant account and verified domains to enable Apple Pay on your website."}},"httpPath":"/domains/register"},{"label":"Retrieve Apple Pay Payment Session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/applepay-api-spec/other/getpaymentsession","routeSlug":"/apis/applepay-api-spec/other/getpaymentsession","metadata":{"seo":{"title":"Retrieve Apple Pay Payment Session","description":"Request a new Apple Pay session object for Apple Pay on the Web."}},"httpPath":"/paymentSession"}]},{"type":"group","label":"Risk","items":[{"type":"group","label":"Grant List","items":[{"type":"link","label":"Grant List API","link":"/apis/grant-list-api-spec","routeSlug":"/apis/grant-list-api-spec"},{"label":"Add or Remove an Account from the Grant List","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/grant-list-api-spec/other/addtoachgrantlistv2","routeSlug":"/apis/grant-list-api-spec/other/addtoachgrantlistv2","metadata":{"seo":{"title":"Add or Remove an Account from the Grant List","description":"Add or remove an account from the Grant List. Requires bearer authentication. The request uses a nested paymentType structure for account details. On success the response contains responseCode and responseMessage. On error, a single error returns responseCode and responseMessage; multiple validation errors also include responseDetails."}},"httpPath":"/accounts"},{"type":"link","fsPath":"apis/grant-list-response-error-codes.md","metadata":{"type":"markdown"},"label":"Response Error Codes","link":"/apis/grant-list-response-error-codes","routeSlug":"/apis/grant-list-response-error-codes"}]},{"type":"group","label":"Fraud","items":[{"type":"link","label":"Risk Service","link":"/apis/risk-api-spec","routeSlug":"/apis/risk-api-spec"},{"type":"group","label":"Fraud","link":"/apis/risk-api-spec/fraud","routeSlug":"/apis/risk-api-spec/fraud","items":[{"label":"Evaluates a Transaction for Risk Scoring Purposes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/risk-api-spec/fraud/score_2","routeSlug":"/apis/risk-api-spec/fraud/score_2","metadata":{"seo":{"title":"Evaluates a Transaction for Risk Scoring Purposes","description":"Submit a transaction for risk evaluation via NPS Token. Returns HTTP 200 for all outcomes; inspect responseCode to determine success. Success codes start with 'A'; error codes start with 'E'. The entityId in the request body must match the entity authorised by the token."}},"httpPath":"/nps/risk/scores"},{"label":"Retrieve a Previously Scored Transaction by Risk UUID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/risk-api-spec/fraud/read_1","routeSlug":"/apis/risk-api-spec/fraud/read_1","metadata":{"seo":{"title":"Retrieve a Previously Scored Transaction by Risk UUID","description":"Retrieve a previously scored transaction by its risk UUID for NPS Merchant. Returns HTTP 200 for all outcomes; inspect responseCode for success or error. The entityId query parameter must match the entity authorised by the token."}},"httpPath":"/nps/risk/scores/{uuid}"},{"label":"Update a Previously Scored Transaction","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/risk-api-spec/fraud/update_2","routeSlug":"/apis/risk-api-spec/fraud/update_2","metadata":{"seo":{"title":"Update a Previously Scored Transaction","description":"Update a previously scored transaction via NPS Token. Returns HTTP 200 for all outcomes; inspect responseCode to determine success. The entityId in the request body must match the entity authorised by the token."}},"httpPath":"/nps/risk/scores/{uuid}"}]},{"type":"link","fsPath":"apis/risk-service-response-error-codes.md","metadata":{"type":"markdown"},"label":"Response Error Codes","link":"/apis/risk-service-response-error-codes","routeSlug":"/apis/risk-service-response-error-codes"}]},{"type":"group","label":"Account Validation","items":[{"type":"link","label":"ACH Account Validation API","link":"/apis/account-validation-api-spec","routeSlug":"/apis/account-validation-api-spec"},{"type":"group","label":"Validation","link":"/apis/account-validation-api-spec/validation","routeSlug":"/apis/account-validation-api-spec/validation","items":[{"label":"Validate one or more US bank accounts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/account-validation-api-spec/validation/validateaccount","routeSlug":"/apis/account-validation-api-spec/validation/validateaccount","metadata":{"seo":{"title":"Validate one or more US bank accounts","description":"Submits a batch of bank accounts for validation. The level of validation performed on each account is controlled by its validationService field (see the API overview)."}},"httpPath":"/accountValidation"}]}]}]},{"type":"group","label":"ACH Rules Validation","items":[{"type":"link","label":"Rules Engine","link":"/apis/rule-engine-api-spec","routeSlug":"/apis/rule-engine-api-spec"},{"type":"group","label":"rules","link":"/apis/rule-engine-api-spec/rules","routeSlug":"/apis/rule-engine-api-spec/rules","items":[{"label":"Add ACH File Expected Totals","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rule-engine-api-spec/rules/addfileexpectedtotalsv2","routeSlug":"/apis/rule-engine-api-spec/rules/addfileexpectedtotalsv2","metadata":{"seo":{"title":"Add ACH File Expected Totals","description":"Submit expected file totals for an ACH file. Requires bearer authentication. The request uses a nested structure (net, debit, credit, gross). On success the response contains responseCode and responseMessage. On error, a single error returns responseCode and responseMessage; multiple validation errors also include responseDetails."}},"httpPath":"/ach/files/expectedTotals"}]},{"type":"link","fsPath":"apis/rules-engine-error-codes.md","metadata":{"type":"markdown"},"label":"Response Error Codes","link":"/apis/rules-engine-error-codes","routeSlug":"/apis/rules-engine-error-codes"}]},{"type":"group","label":"Profiles","items":[{"type":"link","label":"Profile Service API","link":"/apis/profile-service","routeSlug":"/apis/profile-service"},{"type":"link","label":"Key Concepts","link":"/apis/profile-service/section/key-concepts","routeSlug":"/apis/profile-service/section/key-concepts"},{"type":"link","label":"BillableEntity","link":"/apis/profile-service/section/billableentity","routeSlug":"/apis/profile-service/section/billableentity"},{"type":"link","label":"Account","link":"/apis/profile-service/section/account","routeSlug":"/apis/profile-service/section/account"},{"type":"link","label":"Person vs Organization","link":"/apis/profile-service/section/person-vs-organization","routeSlug":"/apis/profile-service/section/person-vs-organization"},{"type":"link","label":"Payment Methods","link":"/apis/profile-service/section/payment-methods","routeSlug":"/apis/profile-service/section/payment-methods"},{"type":"link","label":"Multi-Tenant Isolation","link":"/apis/profile-service/section/multi-tenant-isolation","routeSlug":"/apis/profile-service/section/multi-tenant-isolation"},{"type":"link","label":"Error Handling","link":"/apis/profile-service/section/error-handling","routeSlug":"/apis/profile-service/section/error-handling"},{"type":"link","label":"Authentication Note","link":"/apis/profile-service/section/authentication-note","routeSlug":"/apis/profile-service/section/authentication-note"},{"type":"group","label":"Billable items","link":"/apis/profile-service/billableentities","routeSlug":"/apis/profile-service/billableentities","items":[{"label":"List BillableEntities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/billableentities/listbillableentities","routeSlug":"/apis/profile-service/billableentities/listbillableentities","metadata":{"seo":{"title":"List BillableEntities","description":"List all billable entities for the authenticated merchant with pagination and filtering."}},"httpPath":"/billableEntities"},{"label":"Create BillableEntity","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/billableentities/createbillableentity","routeSlug":"/apis/profile-service/billableentities/createbillableentity","metadata":{"seo":{"title":"Create BillableEntity","description":"Create a new billable entity (e.g., member, subscription, participant)."}},"httpPath":"/billableEntities"},{"label":"Get BillableEntity Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/billableentities/getbillableentity","routeSlug":"/apis/profile-service/billableentities/getbillableentity","metadata":{"seo":{"title":"Get BillableEntity Details","description":"Retrieve details of a specific billable entity"}},"httpPath":"/billableEntities/{billableEntityId}"},{"label":"Update BillableEntity","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/billableentities/updatebillableentity","routeSlug":"/apis/profile-service/billableentities/updatebillableentity","metadata":{"seo":{"title":"Update BillableEntity","description":"Update a billable entity's information (partial update)"}},"httpPath":"/billableEntities/{billableEntityId}"},{"label":"Replace BillableEntity","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/billableentities/replacebillableentity","routeSlug":"/apis/profile-service/billableentities/replacebillableentity","metadata":{"seo":{"title":"Replace BillableEntity","description":"Replace a billable entity's information (full update)"}},"httpPath":"/billableEntities/{billableEntityId}"},{"label":"Delete BillableEntity","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/billableentities/deletebillableentity","routeSlug":"/apis/profile-service/billableentities/deletebillableentity","metadata":{"seo":{"title":"Delete BillableEntity","description":"Soft delete a billable entity (marked as deleted but retained for 7 years per compliance requirements)."}},"httpPath":"/billableEntities/{billableEntityId}"},{"label":"Get BillableEntity Tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/billableentities/getbillableentitytags","routeSlug":"/apis/profile-service/billableentities/getbillableentitytags","metadata":{"seo":{"title":"Get BillableEntity Tags","description":"Retrieve all tags for a specific billable entity in nested namespace format."}},"httpPath":"/billableEntities/{billableEntityId}/tags"},{"label":"Replace BillableEntity Tags","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/billableentities/replacebillableentitytags","routeSlug":"/apis/profile-service/billableentities/replacebillableentitytags","metadata":{"seo":{"title":"Replace BillableEntity Tags","description":"Replace ALL tags on a billable entity. Any existing tags not included in the request body are removed. Maximum 50 tags per entity."}},"httpPath":"/billableEntities/{billableEntityId}/tags"},{"label":"Merge BillableEntity Tags","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/billableentities/mergebillableentitytags","routeSlug":"/apis/profile-service/billableentities/mergebillableentitytags","metadata":{"seo":{"title":"Merge BillableEntity Tags","description":"Merge (upsert) tags on a billable entity. Existing tags not in the request body are preserved. Tags in the request body are added or updated."}},"httpPath":"/billableEntities/{billableEntityId}/tags"},{"label":"Remove All BillableEntity Tags","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/billableentities/deletebillableentitytags","routeSlug":"/apis/profile-service/billableentities/deletebillableentitytags","metadata":{"seo":{"title":"Remove All BillableEntity Tags","description":"Remove all tags from a billable entity."}},"httpPath":"/billableEntities/{billableEntityId}/tags"},{"label":"List Accounts for Billable Entity","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/billableentities/getbillableentityaccounts","routeSlug":"/apis/profile-service/billableentities/getbillableentityaccounts","metadata":{"seo":{"title":"List Accounts for Billable Entity","description":"Retrieve all accounts associated with a specific billable entity."}},"httpPath":"/billableEntities/{billableEntityId}/accounts"},{"label":"Reactivate Soft-Deleted BillableEntity","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/billableentities/reactivatebillableentity","routeSlug":"/apis/profile-service/billableentities/reactivatebillableentity","metadata":{"seo":{"title":"Reactivate Soft-Deleted BillableEntity","description":"Reactivate a soft-deleted billable entity (US-PROF-PMV-013), clearing its deletedAttimestamp and restoring it to active status so it reappears in standard list/search results."}},"httpPath":"/billableEntities/{billableEntityId}/reactivate"},{"label":"Batch Resolve Billable Entity Names","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/billableentities/batchresolvebillableentities","routeSlug":"/apis/profile-service/billableentities/batchresolvebillableentities","metadata":{"seo":{"title":"Batch Resolve Billable Entity Names","description":"Resolve billable entity names for a batch of IDs in a single request."}},"httpPath":"/billableEntities/batch"}]},{"type":"group","label":"Financially responsible parties","link":"/apis/profile-service/accounts","routeSlug":"/apis/profile-service/accounts","items":[{"label":"List Accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/accounts/listaccounts","routeSlug":"/apis/profile-service/accounts/listaccounts","metadata":{"seo":{"title":"List Accounts","description":"List all accounts for the authenticated merchant with pagination and filtering."}},"httpPath":"/accounts"},{"label":"Create Account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/accounts/createaccount","routeSlug":"/apis/profile-service/accounts/createaccount","metadata":{"seo":{"title":"Create Account","description":"Create a new account."}},"httpPath":"/accounts"},{"label":"List Auto-Pay Eligible Accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/accounts/listautopayeligibleaccounts","routeSlug":"/apis/profile-service/accounts/listautopayeligibleaccounts","metadata":{"seo":{"title":"List Auto-Pay Eligible Accounts","description":"List accounts that are eligible for auto-pay, i.e. accounts that have a payerwith a stored auto-pay payment method configured."}},"httpPath":"/accounts/autoPayEligible"},{"label":"Get Account Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/accounts/getaccount","routeSlug":"/apis/profile-service/accounts/getaccount","metadata":{"seo":{"title":"Get Account Details","description":"Retrieve details of a specific account"}},"httpPath":"/accounts/{accountId}"},{"label":"Update Account","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/accounts/updateaccount","routeSlug":"/apis/profile-service/accounts/updateaccount","metadata":{"seo":{"title":"Update Account","description":"Update an account's information (partial update)"}},"httpPath":"/accounts/{accountId}"},{"label":"Replace Account","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/accounts/replaceaccount","routeSlug":"/apis/profile-service/accounts/replaceaccount","metadata":{"seo":{"title":"Replace Account","description":"Replace an account's information (full update)"}},"httpPath":"/accounts/{accountId}"},{"label":"Delete Account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/accounts/deleteaccount","routeSlug":"/apis/profile-service/accounts/deleteaccount","metadata":{"seo":{"title":"Delete Account","description":"Soft delete an account (marked as deleted but retained for 7 years)."}},"httpPath":"/accounts/{accountId}"},{"label":"Get Account Tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/accounts/getaccounttags","routeSlug":"/apis/profile-service/accounts/getaccounttags","metadata":{"seo":{"title":"Get Account Tags","description":"Retrieve all tags for a specific account in nested namespace format."}},"httpPath":"/accounts/{accountId}/tags"},{"label":"Replace Account Tags","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/accounts/replaceaccounttags","routeSlug":"/apis/profile-service/accounts/replaceaccounttags","metadata":{"seo":{"title":"Replace Account Tags","description":"Replace ALL tags on an account. Any existing tags not included in the request body are removed. Maximum 50 tags per entity."}},"httpPath":"/accounts/{accountId}/tags"},{"label":"Merge Account Tags","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/accounts/mergeaccounttags","routeSlug":"/apis/profile-service/accounts/mergeaccounttags","metadata":{"seo":{"title":"Merge Account Tags","description":"Merge (upsert) tags on an account. Existing tags not in the request body are preserved. Tags in the request body are added or updated."}},"httpPath":"/accounts/{accountId}/tags"},{"label":"Remove All Account Tags","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/accounts/deleteaccounttags","routeSlug":"/apis/profile-service/accounts/deleteaccounttags","metadata":{"seo":{"title":"Remove All Account Tags","description":"Remove all tags from an account."}},"httpPath":"/accounts/{accountId}/tags"},{"label":"Get BillableEntities for Account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/accounts/getaccountbillableentities","routeSlug":"/apis/profile-service/accounts/getaccountbillableentities","metadata":{"seo":{"title":"Get BillableEntities for Account","description":"Retrieve all billable entities associated with an account"}},"httpPath":"/accounts/{accountId}/billableEntities"},{"label":"Associate BillableEntity with Account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/accounts/associatebillableentitywithaccount","routeSlug":"/apis/profile-service/accounts/associatebillableentitywithaccount","metadata":{"seo":{"title":"Associate BillableEntity with Account","description":"Create a many-to-many association between a billable entity and an account."}},"httpPath":"/accounts/{accountId}/billableEntities/{billableEntityId}"},{"label":"Remove BillableEntity from Account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/accounts/removebillableentityfromaccount","routeSlug":"/apis/profile-service/accounts/removebillableentityfromaccount","metadata":{"seo":{"title":"Remove BillableEntity from Account","description":"Remove the association between a billable entity and an account."}},"httpPath":"/accounts/{accountId}/billableEntities/{billableEntityId}"},{"label":"List Payers for Account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/accounts/getaccountpayers","routeSlug":"/apis/profile-service/accounts/getaccountpayers","metadata":{"seo":{"title":"List Payers for Account","description":"Retrieve all payers (People and Organizations) assigned to an account."}},"httpPath":"/accounts/{accountId}/payers"},{"label":"Assign Payer to Account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/accounts/assignpayer","routeSlug":"/apis/profile-service/accounts/assignpayer","metadata":{"seo":{"title":"Assign Payer to Account","description":"Assign a person or organization as a payer for an account."}},"httpPath":"/accounts/{accountId}/payers/{payerId}"},{"label":"Update Payer Settings","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/accounts/updatepayer","routeSlug":"/apis/profile-service/accounts/updatepayer","metadata":{"seo":{"title":"Update Payer Settings","description":"Update payer settings (e.g., auto-pay configuration)"}},"httpPath":"/accounts/{accountId}/payers/{payerId}"},{"label":"Remove Payer from Account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/accounts/removepayer","routeSlug":"/apis/profile-service/accounts/removepayer","metadata":{"seo":{"title":"Remove Payer from Account","description":"Remove the payer role from a person or organization."}},"httpPath":"/accounts/{accountId}/payers/{payerId}"},{"label":"List Contacts for Account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/accounts/getaccountcontacts","routeSlug":"/apis/profile-service/accounts/getaccountcontacts","metadata":{"seo":{"title":"List Contacts for Account","description":"Retrieve all contacts (People and Organizations) for an account."}},"httpPath":"/accounts/{accountId}/contacts"},{"label":"Assign Contact to Account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/accounts/assigncontact","routeSlug":"/apis/profile-service/accounts/assigncontact","metadata":{"seo":{"title":"Assign Contact to Account","description":"Assign a person or organization as a contact for an account."}},"httpPath":"/accounts/{accountId}/contacts/{contactId}"},{"label":"Remove Contact from Account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/accounts/removecontact","routeSlug":"/apis/profile-service/accounts/removecontact","metadata":{"seo":{"title":"Remove Contact from Account","description":"Remove the contact role from a person or organization (idempotent)"}},"httpPath":"/accounts/{accountId}/contacts/{contactId}"},{"label":"Batch Resolve Account Names","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/accounts/batchresolveaccounts","routeSlug":"/apis/profile-service/accounts/batchresolveaccounts","metadata":{"seo":{"title":"Batch Resolve Account Names","description":"Resolve account names for a batch of account IDs in a single request."}},"httpPath":"/accounts/batch"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Contact Registration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/profile-service/accounts/webhookcontactregistration","routeSlug":"/apis/profile-service/accounts/webhookcontactregistration","metadata":{"seo":{"title":"Contact Registration","description":"Fired when a contact is registered for billing notifications (eventType: profile.contact.registration)."}},"httpPath":"contactRegistration"},{"label":"Account Created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/profile-service/accounts/webhookaccountcreated","routeSlug":"/apis/profile-service/accounts/webhookaccountcreated","metadata":{"seo":{"title":"Account Created","description":"Fired when a new Account is created."}},"httpPath":"accountCreated"},{"label":"Account Updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/profile-service/accounts/webhookaccountupdated","routeSlug":"/apis/profile-service/accounts/webhookaccountupdated","metadata":{"seo":{"title":"Account Updated","description":"Fired when an existing Account is updated."}},"httpPath":"accountUpdated"},{"label":"Account Payer Assigned","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/profile-service/accounts/webhookaccountpayerassigned","routeSlug":"/apis/profile-service/accounts/webhookaccountpayerassigned","metadata":{"seo":{"title":"Account Payer Assigned","description":"Fired when a Person or Organization is assigned as a Payer on an Account."}},"httpPath":"accountPayerAssigned"},{"label":"Account Contact Assigned","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/profile-service/accounts/webhookaccountcontactassigned","routeSlug":"/apis/profile-service/accounts/webhookaccountcontactassigned","metadata":{"seo":{"title":"Account Contact Assigned","description":"Fired when a Person or Organization is assigned as a Contact on an Account. For Person contacts, this also triggers PNS registration for billing notifications."}},"httpPath":"accountContactAssigned"}]},{"type":"group","label":"Human identities","link":"/apis/profile-service/people","routeSlug":"/apis/profile-service/people","items":[{"label":"List People","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/people/listpeople","routeSlug":"/apis/profile-service/people/listpeople","metadata":{"seo":{"title":"List People","description":"List all people for the authenticated merchant with pagination and filtering"}},"httpPath":"/people"},{"label":"Create Person","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/people/createperson","routeSlug":"/apis/profile-service/people/createperson","metadata":{"seo":{"title":"Create Person","description":"Create a new person (payer, contact, agency representative)"}},"httpPath":"/people"},{"label":"Get Person Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/people/getperson","routeSlug":"/apis/profile-service/people/getperson","metadata":{"seo":{"title":"Get Person Details","description":"Retrieve details of a specific person"}},"httpPath":"/people/{personId}"},{"label":"Update Person","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/people/updateperson","routeSlug":"/apis/profile-service/people/updateperson","metadata":{"seo":{"title":"Update Person","description":"Update a person's information (partial update)"}},"httpPath":"/people/{personId}"},{"label":"Replace Person","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/people/replaceperson","routeSlug":"/apis/profile-service/people/replaceperson","metadata":{"seo":{"title":"Replace Person","description":"Replace a person's information (full update)"}},"httpPath":"/people/{personId}"},{"label":"Delete Person","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/people/deleteperson","routeSlug":"/apis/profile-service/people/deleteperson","metadata":{"seo":{"title":"Delete Person","description":"Soft delete a person (marked as deleted but retained for 7 years)."}},"httpPath":"/people/{personId}"},{"label":"Get Person's Role Assignments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/people/getpersonroles","routeSlug":"/apis/profile-service/people/getpersonroles","metadata":{"seo":{"title":"Get Person's Role Assignments","description":"Retrieve all role assignments (Payer and/or Contact) for a person across all accounts"}},"httpPath":"/people/{personId}/roles"},{"label":"Get Person Notification Preferences","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/people/getpersonnotificationpreferences","routeSlug":"/apis/profile-service/people/getpersonnotificationpreferences","metadata":{"seo":{"title":"Get Person Notification Preferences","description":"Retrieve effective notification preferences for a person-account combination."}},"httpPath":"/people/{personId}/notificationPreferences"},{"label":"Update Person Notification Preferences","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/people/updatepersonnotificationpreferences","routeSlug":"/apis/profile-service/people/updatepersonnotificationpreferences","metadata":{"seo":{"title":"Update Person Notification Preferences","description":"Create, update, or clear explicit notification preference overrides for aperson-account combination."}},"httpPath":"/people/{personId}/notificationPreferences"},{"label":"List Payment Methods for Person","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/people/listpersonpaymentmethods","routeSlug":"/apis/profile-service/people/listpersonpaymentmethods","metadata":{"seo":{"title":"List Payment Methods for Person","description":"Retrieve all payment methods for a person"}},"httpPath":"/people/{personId}/paymentMethods"},{"label":"Add Payment Method for Person","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/people/addpersonpaymentmethod","routeSlug":"/apis/profile-service/people/addpersonpaymentmethod","metadata":{"seo":{"title":"Add Payment Method for Person","description":"Add a tokenized payment method to a person."}},"httpPath":"/people/{personId}/paymentMethods"},{"label":"Get Payment Method Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/people/getpersonpaymentmethod","routeSlug":"/apis/profile-service/people/getpersonpaymentmethod","metadata":{"seo":{"title":"Get Payment Method Details","description":"Retrieve details of a specific payment method"}},"httpPath":"/people/{personId}/paymentMethods/{paymentMethodId}"},{"label":"Update Payment Method","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/people/updatepersonpaymentmethod","routeSlug":"/apis/profile-service/people/updatepersonpaymentmethod","metadata":{"seo":{"title":"Update Payment Method","description":"Update a payment method's label or default status (partial update)."}},"httpPath":"/people/{personId}/paymentMethods/{paymentMethodId}"},{"label":"Replace Payment Method","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/people/replacepersonpaymentmethod","routeSlug":"/apis/profile-service/people/replacepersonpaymentmethod","metadata":{"seo":{"title":"Replace Payment Method","description":"Full replacement of a payment method. Token and type are immutable - the values provided MUST match the existing payment method. Use this to update label and isDefault while sending the complete resource. To change the underlying payment instrument, create a new payment method instead."}},"httpPath":"/people/{personId}/paymentMethods/{paymentMethodId}"},{"label":"Delete Payment Method","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/people/deletepersonpaymentmethod","routeSlug":"/apis/profile-service/people/deletepersonpaymentmethod","metadata":{"seo":{"title":"Delete Payment Method","description":"Delete a payment method (idempotent)."}},"httpPath":"/people/{personId}/paymentMethods/{paymentMethodId}"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Person Created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/profile-service/people/webhookpersoncreated","routeSlug":"/apis/profile-service/people/webhookpersoncreated","metadata":{"seo":{"title":"Person Created","description":"Fired when a new Person entity is created."}},"httpPath":"personCreated"},{"label":"Person Updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/profile-service/people/webhookpersonupdated","routeSlug":"/apis/profile-service/people/webhookpersonupdated","metadata":{"seo":{"title":"Person Updated","description":"Fired when an existing Person entity is updated."}},"httpPath":"personUpdated"}]},{"type":"group","label":"Non-human entities","link":"/apis/profile-service/organizations","routeSlug":"/apis/profile-service/organizations","items":[{"label":"List Organizations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/organizations/listorganizations","routeSlug":"/apis/profile-service/organizations/listorganizations","metadata":{"seo":{"title":"List Organizations","description":"List all organizations for the authenticated merchant with pagination and filtering"}},"httpPath":"/organizations"},{"label":"Create Organization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/organizations/createorganization","routeSlug":"/apis/profile-service/organizations/createorganization","metadata":{"seo":{"title":"Create Organization","description":"Create a new organization (business, charity, government agency)"}},"httpPath":"/organizations"},{"label":"Get Organization Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/organizations/getorganization","routeSlug":"/apis/profile-service/organizations/getorganization","metadata":{"seo":{"title":"Get Organization Details","description":"Retrieve details of a specific organization"}},"httpPath":"/organizations/{organizationId}"},{"label":"Update Organization","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/organizations/updateorganization","routeSlug":"/apis/profile-service/organizations/updateorganization","metadata":{"seo":{"title":"Update Organization","description":"Update an organization's information (partial update)"}},"httpPath":"/organizations/{organizationId}"},{"label":"Replace Organization","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/organizations/replaceorganization","routeSlug":"/apis/profile-service/organizations/replaceorganization","metadata":{"seo":{"title":"Replace Organization","description":"Replace an organization's information (full update)"}},"httpPath":"/organizations/{organizationId}"},{"label":"Delete Organization","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/organizations/deleteorganization","routeSlug":"/apis/profile-service/organizations/deleteorganization","metadata":{"seo":{"title":"Delete Organization","description":"Soft delete an organization (marked as deleted but retained for 7 years)."}},"httpPath":"/organizations/{organizationId}"},{"label":"Get Organization's Role Assignments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/organizations/getorganizationroles","routeSlug":"/apis/profile-service/organizations/getorganizationroles","metadata":{"seo":{"title":"Get Organization's Role Assignments","description":"Retrieve all role assignments (Payer and/or Contact) for an organization across all accounts"}},"httpPath":"/organizations/{organizationId}/roles"},{"label":"List Payment Methods for Organization","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/organizations/listorganizationpaymentmethods","routeSlug":"/apis/profile-service/organizations/listorganizationpaymentmethods","metadata":{"seo":{"title":"List Payment Methods for Organization","description":"Retrieve all payment methods for an organization"}},"httpPath":"/organizations/{organizationId}/paymentMethods"},{"label":"Add Payment Method for Organization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/organizations/addorganizationpaymentmethod","routeSlug":"/apis/profile-service/organizations/addorganizationpaymentmethod","metadata":{"seo":{"title":"Add Payment Method for Organization","description":"Add a tokenized payment method to an organization"}},"httpPath":"/organizations/{organizationId}/paymentMethods"},{"label":"Get Payment Method Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/organizations/getorganizationpaymentmethod","routeSlug":"/apis/profile-service/organizations/getorganizationpaymentmethod","metadata":{"seo":{"title":"Get Payment Method Details","description":"Retrieve details of a specific payment method"}},"httpPath":"/organizations/{organizationId}/paymentMethods/{paymentMethodId}"},{"label":"Update Payment Method","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/organizations/updateorganizationpaymentmethod","routeSlug":"/apis/profile-service/organizations/updateorganizationpaymentmethod","metadata":{"seo":{"title":"Update Payment Method","description":"Update a payment method's label or default status (partial update)"}},"httpPath":"/organizations/{organizationId}/paymentMethods/{paymentMethodId}"},{"label":"Replace Payment Method","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/organizations/replaceorganizationpaymentmethod","routeSlug":"/apis/profile-service/organizations/replaceorganizationpaymentmethod","metadata":{"seo":{"title":"Replace Payment Method","description":"Full replacement of a payment method. Token and type are immutable - the values provided MUST match the existing payment method. Use this to update label and isDefault while sending the complete resource. To change the underlying payment instrument, create a new payment method instead."}},"httpPath":"/organizations/{organizationId}/paymentMethods/{paymentMethodId}"},{"label":"Delete Payment Method","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/organizations/deleteorganizationpaymentmethod","routeSlug":"/apis/profile-service/organizations/deleteorganizationpaymentmethod","metadata":{"seo":{"title":"Delete Payment Method","description":"Delete a payment method (idempotent)"}},"httpPath":"/organizations/{organizationId}/paymentMethods/{paymentMethodId}"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Organization Created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/profile-service/organizations/webhookorganizationcreated","routeSlug":"/apis/profile-service/organizations/webhookorganizationcreated","metadata":{"seo":{"title":"Organization Created","description":"Fired when a new Organization entity is created."}},"httpPath":"organizationCreated"},{"label":"Organization Updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/profile-service/organizations/webhookorganizationupdated","routeSlug":"/apis/profile-service/organizations/webhookorganizationupdated","metadata":{"seo":{"title":"Organization Updated","description":"Fired when an existing Organization entity is updated."}},"httpPath":"organizationUpdated"}]},{"type":"group","label":"Payer and Contact assignments","link":"/apis/profile-service/roles","routeSlug":"/apis/profile-service/roles","items":[{"label":"List Payers for Account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/roles/getaccountpayers","routeSlug":"/apis/profile-service/roles/getaccountpayers","metadata":{"seo":{"title":"List Payers for Account","description":"Retrieve all payers (People and Organizations) assigned to an account."}},"httpPath":"/accounts/{accountId}/payers"},{"label":"Assign Payer to Account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/roles/assignpayer","routeSlug":"/apis/profile-service/roles/assignpayer","metadata":{"seo":{"title":"Assign Payer to Account","description":"Assign a person or organization as a payer for an account."}},"httpPath":"/accounts/{accountId}/payers/{payerId}"},{"label":"Update Payer Settings","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/roles/updatepayer","routeSlug":"/apis/profile-service/roles/updatepayer","metadata":{"seo":{"title":"Update Payer Settings","description":"Update payer settings (e.g., auto-pay configuration)"}},"httpPath":"/accounts/{accountId}/payers/{payerId}"},{"label":"Remove Payer from Account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/roles/removepayer","routeSlug":"/apis/profile-service/roles/removepayer","metadata":{"seo":{"title":"Remove Payer from Account","description":"Remove the payer role from a person or organization."}},"httpPath":"/accounts/{accountId}/payers/{payerId}"},{"label":"List Contacts for Account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/roles/getaccountcontacts","routeSlug":"/apis/profile-service/roles/getaccountcontacts","metadata":{"seo":{"title":"List Contacts for Account","description":"Retrieve all contacts (People and Organizations) for an account."}},"httpPath":"/accounts/{accountId}/contacts"},{"label":"Assign Contact to Account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/roles/assigncontact","routeSlug":"/apis/profile-service/roles/assigncontact","metadata":{"seo":{"title":"Assign Contact to Account","description":"Assign a person or organization as a contact for an account."}},"httpPath":"/accounts/{accountId}/contacts/{contactId}"},{"label":"Remove Contact from Account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/roles/removecontact","routeSlug":"/apis/profile-service/roles/removecontact","metadata":{"seo":{"title":"Remove Contact from Account","description":"Remove the contact role from a person or organization (idempotent)"}},"httpPath":"/accounts/{accountId}/contacts/{contactId}"},{"label":"Get Person's Role Assignments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/roles/getpersonroles","routeSlug":"/apis/profile-service/roles/getpersonroles","metadata":{"seo":{"title":"Get Person's Role Assignments","description":"Retrieve all role assignments (Payer and/or Contact) for a person across all accounts"}},"httpPath":"/people/{personId}/roles"},{"label":"Get Organization's Role Assignments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/roles/getorganizationroles","routeSlug":"/apis/profile-service/roles/getorganizationroles","metadata":{"seo":{"title":"Get Organization's Role Assignments","description":"Retrieve all role assignments (Payer and/or Contact) for an organization across all accounts"}},"httpPath":"/organizations/{organizationId}/roles"}]},{"type":"group","label":"Entity-Account relationships","link":"/apis/profile-service/associations","routeSlug":"/apis/profile-service/associations","items":[{"label":"Get BillableEntities for Account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/associations/getaccountbillableentities","routeSlug":"/apis/profile-service/associations/getaccountbillableentities","metadata":{"seo":{"title":"Get BillableEntities for Account","description":"Retrieve all billable entities associated with an account"}},"httpPath":"/accounts/{accountId}/billableEntities"},{"label":"Associate BillableEntity with Account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/associations/associatebillableentitywithaccount","routeSlug":"/apis/profile-service/associations/associatebillableentitywithaccount","metadata":{"seo":{"title":"Associate BillableEntity with Account","description":"Create a many-to-many association between a billable entity and an account."}},"httpPath":"/accounts/{accountId}/billableEntities/{billableEntityId}"},{"label":"Remove BillableEntity from Account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/associations/removebillableentityfromaccount","routeSlug":"/apis/profile-service/associations/removebillableentityfromaccount","metadata":{"seo":{"title":"Remove BillableEntity from Account","description":"Remove the association between a billable entity and an account."}},"httpPath":"/accounts/{accountId}/billableEntities/{billableEntityId}"}]},{"type":"group","label":"Tokenized payment credentials","link":"/apis/profile-service/paymentmethods","routeSlug":"/apis/profile-service/paymentmethods","items":[{"label":"List Payment Methods for Person","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/paymentmethods/listpersonpaymentmethods","routeSlug":"/apis/profile-service/paymentmethods/listpersonpaymentmethods","metadata":{"seo":{"title":"List Payment Methods for Person","description":"Retrieve all payment methods for a person"}},"httpPath":"/people/{personId}/paymentMethods"},{"label":"Add Payment Method for Person","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/paymentmethods/addpersonpaymentmethod","routeSlug":"/apis/profile-service/paymentmethods/addpersonpaymentmethod","metadata":{"seo":{"title":"Add Payment Method for Person","description":"Add a tokenized payment method to a person."}},"httpPath":"/people/{personId}/paymentMethods"},{"label":"Get Payment Method Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/paymentmethods/getpersonpaymentmethod","routeSlug":"/apis/profile-service/paymentmethods/getpersonpaymentmethod","metadata":{"seo":{"title":"Get Payment Method Details","description":"Retrieve details of a specific payment method"}},"httpPath":"/people/{personId}/paymentMethods/{paymentMethodId}"},{"label":"Update Payment Method","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/paymentmethods/updatepersonpaymentmethod","routeSlug":"/apis/profile-service/paymentmethods/updatepersonpaymentmethod","metadata":{"seo":{"title":"Update Payment Method","description":"Update a payment method's label or default status (partial update)."}},"httpPath":"/people/{personId}/paymentMethods/{paymentMethodId}"},{"label":"Replace Payment Method","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/paymentmethods/replacepersonpaymentmethod","routeSlug":"/apis/profile-service/paymentmethods/replacepersonpaymentmethod","metadata":{"seo":{"title":"Replace Payment Method","description":"Full replacement of a payment method. Token and type are immutable - the values provided MUST match the existing payment method. Use this to update label and isDefault while sending the complete resource. To change the underlying payment instrument, create a new payment method instead."}},"httpPath":"/people/{personId}/paymentMethods/{paymentMethodId}"},{"label":"Delete Payment Method","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/paymentmethods/deletepersonpaymentmethod","routeSlug":"/apis/profile-service/paymentmethods/deletepersonpaymentmethod","metadata":{"seo":{"title":"Delete Payment Method","description":"Delete a payment method (idempotent)."}},"httpPath":"/people/{personId}/paymentMethods/{paymentMethodId}"},{"label":"List Payment Methods for Organization","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/paymentmethods/listorganizationpaymentmethods","routeSlug":"/apis/profile-service/paymentmethods/listorganizationpaymentmethods","metadata":{"seo":{"title":"List Payment Methods for Organization","description":"Retrieve all payment methods for an organization"}},"httpPath":"/organizations/{organizationId}/paymentMethods"},{"label":"Add Payment Method for Organization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/paymentmethods/addorganizationpaymentmethod","routeSlug":"/apis/profile-service/paymentmethods/addorganizationpaymentmethod","metadata":{"seo":{"title":"Add Payment Method for Organization","description":"Add a tokenized payment method to an organization"}},"httpPath":"/organizations/{organizationId}/paymentMethods"},{"label":"Get Payment Method Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/paymentmethods/getorganizationpaymentmethod","routeSlug":"/apis/profile-service/paymentmethods/getorganizationpaymentmethod","metadata":{"seo":{"title":"Get Payment Method Details","description":"Retrieve details of a specific payment method"}},"httpPath":"/organizations/{organizationId}/paymentMethods/{paymentMethodId}"},{"label":"Update Payment Method","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/paymentmethods/updateorganizationpaymentmethod","routeSlug":"/apis/profile-service/paymentmethods/updateorganizationpaymentmethod","metadata":{"seo":{"title":"Update Payment Method","description":"Update a payment method's label or default status (partial update)"}},"httpPath":"/organizations/{organizationId}/paymentMethods/{paymentMethodId}"},{"label":"Replace Payment Method","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/paymentmethods/replaceorganizationpaymentmethod","routeSlug":"/apis/profile-service/paymentmethods/replaceorganizationpaymentmethod","metadata":{"seo":{"title":"Replace Payment Method","description":"Full replacement of a payment method. Token and type are immutable - the values provided MUST match the existing payment method. Use this to update label and isDefault while sending the complete resource. To change the underlying payment instrument, create a new payment method instead."}},"httpPath":"/organizations/{organizationId}/paymentMethods/{paymentMethodId}"},{"label":"Delete Payment Method","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/paymentmethods/deleteorganizationpaymentmethod","routeSlug":"/apis/profile-service/paymentmethods/deleteorganizationpaymentmethod","metadata":{"seo":{"title":"Delete Payment Method","description":"Delete a payment method (idempotent)"}},"httpPath":"/organizations/{organizationId}/paymentMethods/{paymentMethodId}"}]},{"type":"group","label":"Tags","link":"/apis/profile-service/tags","routeSlug":"/apis/profile-service/tags","items":[{"label":"Get BillableEntity Tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/tags/getbillableentitytags","routeSlug":"/apis/profile-service/tags/getbillableentitytags","metadata":{"seo":{"title":"Get BillableEntity Tags","description":"Retrieve all tags for a specific billable entity in nested namespace format."}},"httpPath":"/billableEntities/{billableEntityId}/tags"},{"label":"Replace BillableEntity Tags","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/tags/replacebillableentitytags","routeSlug":"/apis/profile-service/tags/replacebillableentitytags","metadata":{"seo":{"title":"Replace BillableEntity Tags","description":"Replace ALL tags on a billable entity. Any existing tags not included in the request body are removed. Maximum 50 tags per entity."}},"httpPath":"/billableEntities/{billableEntityId}/tags"},{"label":"Merge BillableEntity Tags","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/tags/mergebillableentitytags","routeSlug":"/apis/profile-service/tags/mergebillableentitytags","metadata":{"seo":{"title":"Merge BillableEntity Tags","description":"Merge (upsert) tags on a billable entity. Existing tags not in the request body are preserved. Tags in the request body are added or updated."}},"httpPath":"/billableEntities/{billableEntityId}/tags"},{"label":"Remove All BillableEntity Tags","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/tags/deletebillableentitytags","routeSlug":"/apis/profile-service/tags/deletebillableentitytags","metadata":{"seo":{"title":"Remove All BillableEntity Tags","description":"Remove all tags from a billable entity."}},"httpPath":"/billableEntities/{billableEntityId}/tags"},{"label":"Get Account Tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/tags/getaccounttags","routeSlug":"/apis/profile-service/tags/getaccounttags","metadata":{"seo":{"title":"Get Account Tags","description":"Retrieve all tags for a specific account in nested namespace format."}},"httpPath":"/accounts/{accountId}/tags"},{"label":"Replace Account Tags","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/tags/replaceaccounttags","routeSlug":"/apis/profile-service/tags/replaceaccounttags","metadata":{"seo":{"title":"Replace Account Tags","description":"Replace ALL tags on an account. Any existing tags not included in the request body are removed. Maximum 50 tags per entity."}},"httpPath":"/accounts/{accountId}/tags"},{"label":"Merge Account Tags","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/tags/mergeaccounttags","routeSlug":"/apis/profile-service/tags/mergeaccounttags","metadata":{"seo":{"title":"Merge Account Tags","description":"Merge (upsert) tags on an account. Existing tags not in the request body are preserved. Tags in the request body are added or updated."}},"httpPath":"/accounts/{accountId}/tags"},{"label":"Remove All Account Tags","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/tags/deleteaccounttags","routeSlug":"/apis/profile-service/tags/deleteaccounttags","metadata":{"seo":{"title":"Remove All Account Tags","description":"Remove all tags from an account."}},"httpPath":"/accounts/{accountId}/tags"}]},{"type":"group","label":"Configuration","link":"/apis/profile-service/configuration","routeSlug":"/apis/profile-service/configuration","items":[{"label":"Get Invoicing Configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/configuration/getinvoicingconfig","routeSlug":"/apis/profile-service/configuration/getinvoicingconfig","metadata":{"seo":{"title":"Get Invoicing Configuration","description":"Retrieve the per-merchant invoicing configuration stored locally by the Profile Service."}},"httpPath":"/merchants/invoicingConfig"},{"label":"Upsert Invoicing Configuration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/configuration/upsertinvoicingconfig","routeSlug":"/apis/profile-service/configuration/upsertinvoicingconfig","metadata":{"seo":{"title":"Upsert Invoicing Configuration","description":"Create or update the per-merchant invoicing configuration."}},"httpPath":"/merchants/invoicingConfig"}]},{"type":"group","label":"AuthorizationRecords","link":"/apis/profile-service/authorizationrecords","routeSlug":"/apis/profile-service/authorizationrecords","items":[{"label":"Store Authorization Language Record","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/authorizationrecords/createauthorizationrecord","routeSlug":"/apis/profile-service/authorizationrecords/createauthorizationrecord","metadata":{"seo":{"title":"Store Authorization Language Record","description":"Store an authorization language artifact captured at auto-pay enrollment time.Called by Payment Widget Backend. Not consumer-facing."}},"httpPath":"/authorizationRecords"},{"label":"Retrieve Authorization Records (internal - compliance/support)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/authorizationrecords/retrieveauthorizations","routeSlug":"/apis/profile-service/authorizationrecords/retrieveauthorizations","metadata":{"seo":{"title":"Retrieve Authorization Records (internal - compliance/support)","description":"Retrieve stored auto-pay enrollment authorization records for compliance/support (US-AUTH-LANG-002).Supports the two business day SLA for banking partner requests - operational, non-batch access."}},"httpPath":"/authorizations"},{"label":"Authorization Linkage Verification Report (internal)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/profile-service/authorizationrecords/getauthorizationverificationreport","routeSlug":"/apis/profile-service/authorizationrecords/getauthorizationverificationreport","metadata":{"seo":{"title":"Authorization Linkage Verification Report (internal)","description":"Verify that auto-pay enrollments have a properly linked authorization record and that storedrecords meet NACHA content and affirmative-consent requirements (US-AUTH-LANG-003).Phase 11 extends this report so it can contribute Profile Service evidence to theon-demand authorization compliance validation package (US-AUTH-LANG-005)."}},"httpPath":"/authorizations/verificationReport"}]}]},{"type":"group","label":"Billing & Ledger","items":[{"type":"link","label":"Billing & Ledger Service API","link":"/apis/billing-ledger-service","routeSlug":"/apis/billing-ledger-service"},{"type":"link","label":"Key Concepts","link":"/apis/billing-ledger-service/section/key-concepts","routeSlug":"/apis/billing-ledger-service/section/key-concepts"},{"type":"link","label":"Charge Lifecycle","link":"/apis/billing-ledger-service/section/charge-lifecycle","routeSlug":"/apis/billing-ledger-service/section/charge-lifecycle"},{"type":"link","label":"Allocation Configuration","link":"/apis/billing-ledger-service/section/allocation-configuration","routeSlug":"/apis/billing-ledger-service/section/allocation-configuration"},{"type":"link","label":"Double-Entry Ledger","link":"/apis/billing-ledger-service/section/double-entry-ledger","routeSlug":"/apis/billing-ledger-service/section/double-entry-ledger"},{"type":"link","label":"Monetary Values","link":"/apis/billing-ledger-service/section/monetary-values","routeSlug":"/apis/billing-ledger-service/section/monetary-values"},{"type":"link","label":"Error Handling","link":"/apis/billing-ledger-service/section/error-handling","routeSlug":"/apis/billing-ledger-service/section/error-handling"},{"type":"link","label":"Authentication Note","link":"/apis/billing-ledger-service/section/authentication-note","routeSlug":"/apis/billing-ledger-service/section/authentication-note"},{"type":"group","label":"Account operations","link":"/apis/billing-ledger-service/accounts","routeSlug":"/apis/billing-ledger-service/accounts","items":[{"label":"Get Account Balance","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/accounts/getaccountbalance","routeSlug":"/apis/billing-ledger-service/accounts/getaccountbalance","metadata":{"seo":{"title":"Get Account Balance","description":"Retrieve the current balance for a specific account."}},"httpPath":"/accounts/{accountId}/balance"}]},{"type":"group","label":"Rates","link":"/apis/billing-ledger-service/rates","routeSlug":"/apis/billing-ledger-service/rates","items":[{"label":"List Rates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/rates/listrates","routeSlug":"/apis/billing-ledger-service/rates/listrates","metadata":{"seo":{"title":"List Rates","description":"List all rates (pricing catalog) for the authenticated merchant with pagination and filtering. Rates define how much each type of service costs."}},"httpPath":"/rates"},{"label":"Create Rate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/rates/createrate","routeSlug":"/apis/billing-ledger-service/rates/createrate","metadata":{"seo":{"title":"Create Rate","description":"Create a new rate in the pricing catalog."}},"httpPath":"/rates"},{"label":"Get Rate Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/rates/getrate","routeSlug":"/apis/billing-ledger-service/rates/getrate","metadata":{"seo":{"title":"Get Rate Details","description":"Retrieve details of a specific rate"}},"httpPath":"/rates/{rateId}"},{"label":"Update Rate","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/rates/updaterate","routeSlug":"/apis/billing-ledger-service/rates/updaterate","metadata":{"seo":{"title":"Update Rate","description":"Update a rate's information (partial update)."}},"httpPath":"/rates/{rateId}"},{"label":"Delete Rate","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/rates/deleterate","routeSlug":"/apis/billing-ledger-service/rates/deleterate","metadata":{"seo":{"title":"Delete Rate","description":"Soft delete a rate (marked as deleted but retained for audit purposes)."}},"httpPath":"/rates/{rateId}"},{"label":"Preview Rate Propagation Impact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/rates/previewratepropagation","routeSlug":"/apis/billing-ledger-service/rates/previewratepropagation","metadata":{"seo":{"title":"Preview Rate Propagation Impact","description":"Preview the future charge impact of a proposed rate price change for subscriptions using this rate."}},"httpPath":"/rates/{rateId}/propagationPreview"},{"label":"Schedule Effective-Dated Rate Price Change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/rates/scheduleratechange","routeSlug":"/apis/billing-ledger-service/rates/scheduleratechange","metadata":{"seo":{"title":"Schedule Effective-Dated Rate Price Change","description":"Schedule a future price change for a rate. Immediate same-day price changes continue to usePATCH /rates/{rateId}. A scheduled change leaves the current rate price and version unchangeduntil the effective date, then Billing & Ledger applies the change, increments the rate businessversion, and future charges snapshot the new rateVersion."}},"httpPath":"/rates/{rateId}/scheduleChange"},{"label":"Get Rate Tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/rates/getratetags","routeSlug":"/apis/billing-ledger-service/rates/getratetags","metadata":{"seo":{"title":"Get Rate Tags","description":"Retrieve all tags for a specific rate in nested namespace format."}},"httpPath":"/rates/{rateId}/tags"},{"label":"Replace Rate Tags","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/rates/replaceratetags","routeSlug":"/apis/billing-ledger-service/rates/replaceratetags","metadata":{"seo":{"title":"Replace Rate Tags","description":"Replace ALL tags on a rate. Any existing tags not included in the request body are removed. Maximum 50 tags per entity."}},"httpPath":"/rates/{rateId}/tags"},{"label":"Merge Rate Tags","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/rates/mergeratetags","routeSlug":"/apis/billing-ledger-service/rates/mergeratetags","metadata":{"seo":{"title":"Merge Rate Tags","description":"Merge (upsert) tags on a rate. Existing tags not in the request body are preserved. Tags in the request body are added or updated."}},"httpPath":"/rates/{rateId}/tags"},{"label":"Remove All Rate Tags","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/rates/deleteratetags","routeSlug":"/apis/billing-ledger-service/rates/deleteratetags","metadata":{"seo":{"title":"Remove All Rate Tags","description":"Remove all tags from a rate."}},"httpPath":"/rates/{rateId}/tags"}]},{"type":"group","label":"RateCards","link":"/apis/billing-ledger-service/ratecards","routeSlug":"/apis/billing-ledger-service/ratecards","items":[{"label":"List Rate Cards","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/ratecards/listratecards","routeSlug":"/apis/billing-ledger-service/ratecards/listratecards","metadata":{"seo":{"title":"List Rate Cards","description":"List all rate cards for the authenticated merchant. Rate cards group related rates for easier UI presentation and selection."}},"httpPath":"/rateCards"},{"label":"Create Rate Card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/ratecards/createratecard","routeSlug":"/apis/billing-ledger-service/ratecards/createratecard","metadata":{"seo":{"title":"Create Rate Card","description":"Create a new rate card to group related rates."}},"httpPath":"/rateCards"},{"label":"Get Rate Card Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/ratecards/getratecard","routeSlug":"/apis/billing-ledger-service/ratecards/getratecard","metadata":{"seo":{"title":"Get Rate Card Details","description":"Retrieve details of a specific rate card including associated rates"}},"httpPath":"/rateCards/{rateCardId}"},{"label":"Update Rate Card","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/ratecards/updateratecard","routeSlug":"/apis/billing-ledger-service/ratecards/updateratecard","metadata":{"seo":{"title":"Update Rate Card","description":"Update a rate card's information (partial update)"}},"httpPath":"/rateCards/{rateCardId}"},{"label":"Delete Rate Card","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/ratecards/deleteratecard","routeSlug":"/apis/billing-ledger-service/ratecards/deleteratecard","metadata":{"seo":{"title":"Delete Rate Card","description":"Delete a rate card (does not delete associated rates)"}},"httpPath":"/rateCards/{rateCardId}"},{"label":"Set Rate Card Allocation Configuration","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/ratecards/setratecardallocationconfiguration","routeSlug":"/apis/billing-ledger-service/ratecards/setratecardallocationconfiguration","metadata":{"seo":{"title":"Set Rate Card Allocation Configuration","description":"Associate or update the allocation configuration for a rate card."}},"httpPath":"/rateCards/{rateCardId}/allocationConfiguration"},{"label":"Add Rate to Rate Card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/ratecards/addratetoratecard","routeSlug":"/apis/billing-ledger-service/ratecards/addratetoratecard","metadata":{"seo":{"title":"Add Rate to Rate Card","description":"Associate a rate with a rate card (idempotent)"}},"httpPath":"/rateCards/{rateCardId}/rates/{rateId}"},{"label":"Remove Rate from Rate Card","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/ratecards/removeratefromratecard","routeSlug":"/apis/billing-ledger-service/ratecards/removeratefromratecard","metadata":{"seo":{"title":"Remove Rate from Rate Card","description":"Remove a rate from a rate card (idempotent)"}},"httpPath":"/rateCards/{rateCardId}/rates/{rateId}"},{"label":"Get Rate Card Tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/ratecards/getratecardtags","routeSlug":"/apis/billing-ledger-service/ratecards/getratecardtags","metadata":{"seo":{"title":"Get Rate Card Tags","description":"Retrieve all tags for a specific rate card in nested namespace format."}},"httpPath":"/rateCards/{rateCardId}/tags"},{"label":"Replace Rate Card Tags","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/ratecards/replaceratecardtags","routeSlug":"/apis/billing-ledger-service/ratecards/replaceratecardtags","metadata":{"seo":{"title":"Replace Rate Card Tags","description":"Replace ALL tags on a rate card. Any existing tags not included in the request body are removed. Maximum 50 tags per entity."}},"httpPath":"/rateCards/{rateCardId}/tags"},{"label":"Merge Rate Card Tags","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/ratecards/mergeratecardtags","routeSlug":"/apis/billing-ledger-service/ratecards/mergeratecardtags","metadata":{"seo":{"title":"Merge Rate Card Tags","description":"Merge (upsert) tags on a rate card. Existing tags not in the request body are preserved. Tags in the request body are added or updated."}},"httpPath":"/rateCards/{rateCardId}/tags"},{"label":"Remove All Rate Card Tags","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/ratecards/deleteratecardtags","routeSlug":"/apis/billing-ledger-service/ratecards/deleteratecardtags","metadata":{"seo":{"title":"Remove All Rate Card Tags","description":"Remove all tags from a rate card."}},"httpPath":"/rateCards/{rateCardId}/tags"}]},{"type":"group","label":"Subscriptions","link":"/apis/billing-ledger-service/subscriptions","routeSlug":"/apis/billing-ledger-service/subscriptions","items":[{"label":"List Subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/subscriptions/listsubscriptions","routeSlug":"/apis/billing-ledger-service/subscriptions/listsubscriptions","metadata":{"seo":{"title":"List Subscriptions","description":"List all subscriptions for the authenticated merchant. Subscriptions link billable entities to rates with allocation configurations."}},"httpPath":"/subscriptions"},{"label":"Create Subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/subscriptions/createsubscription","routeSlug":"/apis/billing-ledger-service/subscriptions/createsubscription","metadata":{"seo":{"title":"Create Subscription","description":"Create a new subscription linking a billable entity to a rate."}},"httpPath":"/subscriptions"},{"label":"Bulk Subscription Rate Change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/subscriptions/bulkchangesubscriptionrates","routeSlug":"/apis/billing-ledger-service/subscriptions/bulkchangesubscriptionrates","metadata":{"seo":{"title":"Bulk Subscription Rate Change","description":"Move selected subscriptions from one source rate to a target rate in a single audited operation.This supports full rate migrations and selective grandfathering without updating each subscriptionone at a time."}},"httpPath":"/subscriptions/bulkRateChange"},{"label":"Get Subscription Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/subscriptions/getsubscription","routeSlug":"/apis/billing-ledger-service/subscriptions/getsubscription","metadata":{"seo":{"title":"Get Subscription Details","description":"Retrieve details of a specific subscription"}},"httpPath":"/subscriptions/{subscriptionId}"},{"label":"Update Subscription","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/subscriptions/updatesubscription","routeSlug":"/apis/billing-ledger-service/subscriptions/updatesubscription","metadata":{"seo":{"title":"Update Subscription","description":"Update a subscription's information (partial update)."}},"httpPath":"/subscriptions/{subscriptionId}"},{"label":"Cancel Subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/subscriptions/deletesubscription","routeSlug":"/apis/billing-ledger-service/subscriptions/deletesubscription","metadata":{"seo":{"title":"Cancel Subscription","description":"Soft-cancel a subscription. The implementation sets status=CANCELLED andprevents the subscription from generating new charges. Existing chargesare unaffected."}},"httpPath":"/subscriptions/{subscriptionId}"},{"label":"Get Subscription Tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/subscriptions/getsubscriptiontags","routeSlug":"/apis/billing-ledger-service/subscriptions/getsubscriptiontags","metadata":{"seo":{"title":"Get Subscription Tags","description":"Retrieve all tags for a specific subscription in nested namespace format."}},"httpPath":"/subscriptions/{subscriptionId}/tags"},{"label":"Replace Subscription Tags","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/subscriptions/replacesubscriptiontags","routeSlug":"/apis/billing-ledger-service/subscriptions/replacesubscriptiontags","metadata":{"seo":{"title":"Replace Subscription Tags","description":"Replace ALL tags on a subscription. Any existing tags not included in the request body are removed. Maximum 50 tags per entity."}},"httpPath":"/subscriptions/{subscriptionId}/tags"},{"label":"Merge Subscription Tags","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/subscriptions/mergesubscriptiontags","routeSlug":"/apis/billing-ledger-service/subscriptions/mergesubscriptiontags","metadata":{"seo":{"title":"Merge Subscription Tags","description":"Merge (upsert) tags on a subscription. Existing tags not in the request body are preserved. Tags in the request body are added or updated."}},"httpPath":"/subscriptions/{subscriptionId}/tags"},{"label":"Remove All Subscription Tags","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/subscriptions/deletesubscriptiontags","routeSlug":"/apis/billing-ledger-service/subscriptions/deletesubscriptiontags","metadata":{"seo":{"title":"Remove All Subscription Tags","description":"Remove all tags from a subscription."}},"httpPath":"/subscriptions/{subscriptionId}/tags"}]},{"type":"group","label":"AllocationConfigurations","link":"/apis/billing-ledger-service/allocationconfigurations","routeSlug":"/apis/billing-ledger-service/allocationconfigurations","items":[{"label":"List Allocation Configurations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/allocationconfigurations/listallocationconfigurations","routeSlug":"/apis/billing-ledger-service/allocationconfigurations/listallocationconfigurations","metadata":{"seo":{"title":"List Allocation Configurations","description":"List all allocation configurations for the authenticated merchant."}},"httpPath":"/allocationConfigurations"},{"label":"Create Allocation Configuration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/allocationconfigurations/createallocationconfiguration","routeSlug":"/apis/billing-ledger-service/allocationconfigurations/createallocationconfiguration","metadata":{"seo":{"title":"Create Allocation Configuration","description":"Create a new allocation configuration with rules."}},"httpPath":"/allocationConfigurations"},{"label":"Get Allocation Configuration Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/allocationconfigurations/getallocationconfiguration","routeSlug":"/apis/billing-ledger-service/allocationconfigurations/getallocationconfiguration","metadata":{"seo":{"title":"Get Allocation Configuration Details","description":"Retrieve details of a specific allocation configuration including all rules"}},"httpPath":"/allocationConfigurations/{allocationConfigId}"},{"label":"Update Allocation Configuration","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/allocationconfigurations/updateallocationconfiguration","routeSlug":"/apis/billing-ledger-service/allocationconfigurations/updateallocationconfiguration","metadata":{"seo":{"title":"Update Allocation Configuration","description":"Update an allocation configuration (partial update)."}},"httpPath":"/allocationConfigurations/{allocationConfigId}"},{"label":"Delete Allocation Configuration","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/allocationconfigurations/deleteallocationconfiguration","routeSlug":"/apis/billing-ledger-service/allocationconfigurations/deleteallocationconfiguration","metadata":{"seo":{"title":"Delete Allocation Configuration","description":"Soft delete an allocation configuration."}},"httpPath":"/allocationConfigurations/{allocationConfigId}"},{"label":"Validate Allocation Configuration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/allocationconfigurations/validateallocationconfiguration","routeSlug":"/apis/billing-ledger-service/allocationconfigurations/validateallocationconfiguration","metadata":{"seo":{"title":"Validate Allocation Configuration","description":"Validate an allocation configuration for a specific billable entity."}},"httpPath":"/allocationValidations"},{"label":"Get Allocation Configuration Tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/allocationconfigurations/getallocationconfigtags","routeSlug":"/apis/billing-ledger-service/allocationconfigurations/getallocationconfigtags","metadata":{"seo":{"title":"Get Allocation Configuration Tags","description":"Retrieve all tags for a specific allocation configuration in nested namespace format."}},"httpPath":"/allocationConfigurations/{allocationConfigId}/tags"},{"label":"Replace Allocation Configuration Tags","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/allocationconfigurations/replaceallocationconfigtags","routeSlug":"/apis/billing-ledger-service/allocationconfigurations/replaceallocationconfigtags","metadata":{"seo":{"title":"Replace Allocation Configuration Tags","description":"Replace ALL tags on an allocation configuration. Any existing tags not included in the request body are removed. Maximum 50 tags per entity."}},"httpPath":"/allocationConfigurations/{allocationConfigId}/tags"},{"label":"Merge Allocation Configuration Tags","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/allocationconfigurations/mergeallocationconfigtags","routeSlug":"/apis/billing-ledger-service/allocationconfigurations/mergeallocationconfigtags","metadata":{"seo":{"title":"Merge Allocation Configuration Tags","description":"Merge (upsert) tags on an allocation configuration. Existing tags not in the request body are preserved. Tags in the request body are added or updated."}},"httpPath":"/allocationConfigurations/{allocationConfigId}/tags"},{"label":"Remove All Allocation Configuration Tags","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/allocationconfigurations/deleteallocationconfigtags","routeSlug":"/apis/billing-ledger-service/allocationconfigurations/deleteallocationconfigtags","metadata":{"seo":{"title":"Remove All Allocation Configuration Tags","description":"Remove all tags from an allocation configuration."}},"httpPath":"/allocationConfigurations/{allocationConfigId}/tags"}]},{"type":"group","label":"Charges","link":"/apis/billing-ledger-service/charges","routeSlug":"/apis/billing-ledger-service/charges","items":[{"label":"List Charges","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/charges/listcharges","routeSlug":"/apis/billing-ledger-service/charges/listcharges","metadata":{"seo":{"title":"List Charges","description":"List charges (mutable pre-invoice state) for the authenticated merchant."}},"httpPath":"/charges"},{"label":"Create Charge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/charges/createcharge","routeSlug":"/apis/billing-ledger-service/charges/createcharge","metadata":{"seo":{"title":"Create Charge","description":"Create a new charge for a billable entity."}},"httpPath":"/charges"},{"label":"Get Charge Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/charges/getcharge","routeSlug":"/apis/billing-ledger-service/charges/getcharge","metadata":{"seo":{"title":"Get Charge Details","description":"Retrieve details of a specific charge"}},"httpPath":"/charges/{chargeId}"},{"label":"Update Charge","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/charges/updatecharge","routeSlug":"/apis/billing-ledger-service/charges/updatecharge","metadata":{"seo":{"title":"Update Charge","description":"Update a charge (partial update)."}},"httpPath":"/charges/{chargeId}"},{"label":"Delete Charge","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/charges/deletecharge","routeSlug":"/apis/billing-ledger-service/charges/deletecharge","metadata":{"seo":{"title":"Delete Charge","description":"Delete a charge (hard delete for PENDING, soft delete/void for BILLED)."}},"httpPath":"/charges/{chargeId}"},{"label":"Get Charge Tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/charges/getchargetags","routeSlug":"/apis/billing-ledger-service/charges/getchargetags","metadata":{"seo":{"title":"Get Charge Tags","description":"Retrieve all tags for a specific charge in nested namespace format."}},"httpPath":"/charges/{chargeId}/tags"},{"label":"Replace Charge Tags","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/charges/replacechargetags","routeSlug":"/apis/billing-ledger-service/charges/replacechargetags","metadata":{"seo":{"title":"Replace Charge Tags","description":"Replace ALL tags on a charge. Any existing tags not included in the request body are removed.Maximum 50 tags per entity."}},"httpPath":"/charges/{chargeId}/tags"},{"label":"Merge Charge Tags","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/charges/mergechargetags","routeSlug":"/apis/billing-ledger-service/charges/mergechargetags","metadata":{"seo":{"title":"Merge Charge Tags","description":"Merge (upsert) tags on a charge. Existing tags not in the request body are preserved.Tags in the request body are added or updated."}},"httpPath":"/charges/{chargeId}/tags"},{"label":"Remove All Charge Tags","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/charges/deletechargetags","routeSlug":"/apis/billing-ledger-service/charges/deletechargetags","metadata":{"seo":{"title":"Remove All Charge Tags","description":"Remove all tags from a charge."}},"httpPath":"/charges/{chargeId}/tags"},{"label":"Get Charge Status History","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/charges/getchargestatushistory","routeSlug":"/apis/billing-ledger-service/charges/getchargestatushistory","metadata":{"seo":{"title":"Get Charge Status History","description":"Returns the audit trail of all status transitions for a charge. Enables compliance auditing and debugging of charge lifecycle issues."}},"httpPath":"/charges/{chargeId}/history"},{"label":"Settle Charges via Invoicing","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/charges/settlechargesviainvoice","routeSlug":"/apis/billing-ledger-service/charges/settlechargesviainvoice","metadata":{"seo":{"title":"Settle Charges via Invoicing","description":"Called by the Invoice Service when an invoice is approved/posted.Moves each referenced charge from the mutable Charge table to theimmutable SettledCharge table with settlementType=INVOICED."}},"httpPath":"/charges/invoice"},{"label":"Settle Charges via Direct Payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/charges/settlechargesviadirectpayment","routeSlug":"/apis/billing-ledger-service/charges/settlechargesviadirectpayment","metadata":{"seo":{"title":"Settle Charges via Direct Payment","description":"Called by the Payment Widget for ACCOUNT_BALANCE mode.Finds oldest BILLED charges for the given account and settles themusing FIFO ordering (oldest first). Each charge is either fully paidor not touched (no partial settlement at the charge level)."}},"httpPath":"/charges/settle"},{"label":"Outstanding Balances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/charges/getoutstandingbalances","routeSlug":"/apis/billing-ledger-service/charges/getoutstandingbalances","metadata":{"seo":{"title":"Outstanding Balances","description":"Aggregated view of outstanding balances across settled charges."}},"httpPath":"/outstandingBalances"},{"label":"Charges by Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/charges/getchargesbystatus","routeSlug":"/apis/billing-ledger-service/charges/getchargesbystatus","metadata":{"seo":{"title":"Charges by Status","description":"Aggregated summary of charges grouped by status."}},"httpPath":"/chargesByStatus"}]},{"type":"group","label":"SettledCharges","link":"/apis/billing-ledger-service/settledcharges","routeSlug":"/apis/billing-ledger-service/settledcharges","items":[{"label":"List Settled Charges","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/settledcharges/listsettledcharges","routeSlug":"/apis/billing-ledger-service/settledcharges/listsettledcharges","metadata":{"seo":{"title":"List Settled Charges","description":"List settled charges (immutable post-invoice/payment state)."}},"httpPath":"/settledCharges"},{"label":"Get Settled Charge Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/settledcharges/getsettledcharge","routeSlug":"/apis/billing-ledger-service/settledcharges/getsettledcharge","metadata":{"seo":{"title":"Get Settled Charge Details","description":"Retrieve details of a specific settled charge."}},"httpPath":"/settledCharges/{settledChargeId}"},{"label":"List Payment Applications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/settledcharges/listsettledchargepayments","routeSlug":"/apis/billing-ledger-service/settledcharges/listsettledchargepayments","metadata":{"seo":{"title":"List Payment Applications","description":"Returns paginated list of all payment applications for a specificsettled charge. Records are append-only (immutable). Reversals andadjustments create new records rather than modifying existing ones."}},"httpPath":"/settledCharges/{settledChargeId}/payments"},{"label":"Record Payment Application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/settledcharges/createsettledchargepayment","routeSlug":"/apis/billing-ledger-service/settledcharges/createsettledchargepayment","metadata":{"seo":{"title":"Record Payment Application","description":"Record a payment application against a settled charge.Called by the Invoice Service after successfully processing a payment."}},"httpPath":"/settledCharges/{settledChargeId}/payments"}]},{"type":"group","label":"Refunds","link":"/apis/billing-ledger-service/refunds","routeSlug":"/apis/billing-ledger-service/refunds","items":[{"label":"Create Refund","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/refunds/createrefund","routeSlug":"/apis/billing-ledger-service/refunds/createrefund","metadata":{"seo":{"title":"Create Refund","description":"Initiate a refund for one or more invoices, charges, or as a standalone refund."}},"httpPath":"/refunds"},{"label":"List Refunds","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/refunds/listrefunds","routeSlug":"/apis/billing-ledger-service/refunds/listrefunds","metadata":{"seo":{"title":"List Refunds","description":"List all refunds with pagination and filtering"}},"httpPath":"/refunds"},{"label":"Get Refund","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/refunds/getrefund","routeSlug":"/apis/billing-ledger-service/refunds/getrefund","metadata":{"seo":{"title":"Get Refund","description":"Retrieve details of a specific refund"}},"httpPath":"/refunds/{refundId}"},{"label":"Update Refund Method","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/refunds/updaterefundmethod","routeSlug":"/apis/billing-ledger-service/refunds/updaterefundmethod","metadata":{"seo":{"title":"Update Refund Method","description":"Apply an alternative refund method (CHECK, CASH, or CREDIT_BALANCE) and complete the refund in one step. Allowed when the refund status is REQUIRES_ALTERNATIVE or FAILED. Creates the corresponding journal entry automatically."}},"httpPath":"/refunds/{refundId}"},{"label":"Process Refund","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/refunds/processrefund","routeSlug":"/apis/billing-ledger-service/refunds/processrefund","metadata":{"seo":{"title":"Process Refund","description":"Process a pending refund, triggering the actual refund execution and journal entry creation."}},"httpPath":"/refunds/{refundId}/process"},{"label":"Cancel Refund","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/refunds/cancelrefund","routeSlug":"/apis/billing-ledger-service/refunds/cancelrefund","metadata":{"seo":{"title":"Cancel Refund","description":"Cancel a pending refund before it has been processed."}},"httpPath":"/refunds/{refundId}/cancel"},{"label":"Retry Refund Journal Entry","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/refunds/retryrefundjournal","routeSlug":"/apis/billing-ledger-service/refunds/retryrefundjournal","metadata":{"seo":{"title":"Retry Refund Journal Entry","description":"Retry creating the journal entry for a refund that failed during journal posting."}},"httpPath":"/refunds/{refundId}/retryJournal"}]},{"type":"group","label":"Adjustments","link":"/apis/billing-ledger-service/adjustments","routeSlug":"/apis/billing-ledger-service/adjustments","items":[{"label":"Create Manual Adjustment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/adjustments/createadjustment","routeSlug":"/apis/billing-ledger-service/adjustments/createadjustment","metadata":{"seo":{"title":"Create Manual Adjustment","description":"Create a manual adjustment to correct ledger entries."}},"httpPath":"/adjustments"},{"label":"List Adjustments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/adjustments/listadjustments","routeSlug":"/apis/billing-ledger-service/adjustments/listadjustments","metadata":{"seo":{"title":"List Adjustments","description":"List all manual adjustments with pagination and filtering"}},"httpPath":"/adjustments"},{"label":"Get Adjustment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/adjustments/getadjustment","routeSlug":"/apis/billing-ledger-service/adjustments/getadjustment","metadata":{"seo":{"title":"Get Adjustment","description":"Retrieve details of a specific adjustment"}},"httpPath":"/adjustments/{adjustmentId}"}]},{"type":"group","label":"Deposits","link":"/apis/billing-ledger-service/deposits","routeSlug":"/apis/billing-ledger-service/deposits","items":[{"label":"Create Deposit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/deposits/createdeposit","routeSlug":"/apis/billing-ledger-service/deposits/createdeposit","metadata":{"seo":{"title":"Create Deposit","description":"Create a deposit record for a family/account (US-RPT-010). Creates a liability journal entry(Debit Cash/Clearing, Credit DEPOSIT_LIABILITY) via the ledger, source DEPOSIT_CREATED."}},"httpPath":"/deposits"},{"label":"List / Report Deposits (cross-account)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/deposits/listdeposits","routeSlug":"/apis/billing-ledger-service/deposits/listdeposits","metadata":{"seo":{"title":"List / Report Deposits (cross-account)","description":"Cross-account deposit report with filters (US-RPT-012). Also serves as the list endpoint(US-RPT-010). Merchant isolation enforced via entityId."}},"httpPath":"/deposits"},{"label":"List Deposits for Account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/deposits/listaccountdeposits","routeSlug":"/apis/billing-ledger-service/deposits/listaccountdeposits","metadata":{"seo":{"title":"List Deposits for Account","description":"List all deposits for a specific account (US-RPT-010)."}},"httpPath":"/accounts/{accountId}/deposits"},{"label":"Get Deposit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/deposits/getdeposit","routeSlug":"/apis/billing-ledger-service/deposits/getdeposit","metadata":{"seo":{"title":"Get Deposit","description":"Retrieve a specific deposit by ID."}},"httpPath":"/deposits/{depositId}"},{"label":"Update Deposit","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/deposits/updatedeposit","routeSlug":"/apis/billing-ledger-service/deposits/updatedeposit","metadata":{"seo":{"title":"Update Deposit","description":"Update mutable non-financial deposit fields - currently staffNotes (US-RPT-010). Financial lifecycletransitions (apply/refund/forfeit) use the dedicated action endpoints, which post journal entries.Deposit status is accounting-derived and cannot be directly patched."}},"httpPath":"/deposits/{depositId}"},{"label":"Apply Deposit to Tuition","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/deposits/applydeposit","routeSlug":"/apis/billing-ledger-service/deposits/applydeposit","metadata":{"seo":{"title":"Apply Deposit to Tuition","description":"Apply all or part of a deposit to tuition (US-RPT-011). Reduces the deposit balance and postsa journal entry (Debit DEPOSIT_LIABILITY, Credit REVENUE/AR), source DEPOSIT_APPLIED.Partial apply is allowed when amount ≤ remaining balance."}},"httpPath":"/deposits/{depositId}/apply"},{"label":"Refund Deposit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/deposits/refunddeposit","routeSlug":"/apis/billing-ledger-service/deposits/refunddeposit","metadata":{"seo":{"title":"Refund Deposit","description":"Refund all or part of a deposit to the family (US-RPT-011). Reduces the deposit balance and postsa journal entry (Debit DEPOSIT_LIABILITY, Credit CLEARING/BANK), source DEPOSIT_REFUNDED.Partial refund is allowed when amount ≤ remaining balance."}},"httpPath":"/deposits/{depositId}/refund"},{"label":"Forfeit Deposit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/deposits/forfeitdeposit","routeSlug":"/apis/billing-ledger-service/deposits/forfeitdeposit","metadata":{"seo":{"title":"Forfeit Deposit","description":"Forfeit all or part of a deposit per policy (US-RPT-011). Reduces the deposit balance and postsa journal entry (Debit DEPOSIT_LIABILITY, Credit OTHER_INCOME), source DEPOSIT_FORFEITED.Partial forfeit is allowed when amount ≤ remaining balance."}},"httpPath":"/deposits/{depositId}/forfeit"}]},{"type":"group","label":"Ledger","link":"/apis/billing-ledger-service/ledger","routeSlug":"/apis/billing-ledger-service/ledger","items":[{"label":"List Journal Entries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/ledger/listjournalentries","routeSlug":"/apis/billing-ledger-service/ledger/listjournalentries","metadata":{"seo":{"title":"List Journal Entries","description":"List journal entries (double-entry accounting records)."}},"httpPath":"/ledger/journalEntries"},{"label":"Create Journal Entry","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/ledger/createjournalentry","routeSlug":"/apis/billing-ledger-service/ledger/createjournalentry","metadata":{"seo":{"title":"Create Journal Entry","description":"Create a new journal entry with lines."}},"httpPath":"/ledger/journalEntries"},{"label":"Get Journal Entry Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/ledger/getjournalentry","routeSlug":"/apis/billing-ledger-service/ledger/getjournalentry","metadata":{"seo":{"title":"Get Journal Entry Details","description":"Retrieve details of a specific journal entry including all lines"}},"httpPath":"/ledger/journalEntries/{journalEntryId}"},{"label":"List GL Sync Attempts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/ledger/listjournalentryglsyncattempts","routeSlug":"/apis/billing-ledger-service/ledger/listjournalentryglsyncattempts","metadata":{"seo":{"title":"List GL Sync Attempts","description":"List external general ledger connector sync attempts for an immutable journal entry."}},"httpPath":"/ledger/journalEntries/{journalEntryId}/glSyncAttempts"},{"label":"Record GL Sync Attempt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/ledger/recordjournalentryglsyncattempt","routeSlug":"/apis/billing-ledger-service/ledger/recordjournalentryglsyncattempt","metadata":{"seo":{"title":"Record GL Sync Attempt","description":"Record a connector's external GL sync attempt for a journal entry."}},"httpPath":"/ledger/journalEntries/{journalEntryId}/glSyncAttempts"},{"label":"Get Journal Entry Tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/ledger/getjournalentrytags","routeSlug":"/apis/billing-ledger-service/ledger/getjournalentrytags","metadata":{"seo":{"title":"Get Journal Entry Tags","description":"Retrieve all tags for a specific journal entry in nested namespace format."}},"httpPath":"/ledger/journalEntries/{journalEntryId}/tags"},{"label":"Replace Journal Entry Tags","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/ledger/replacejournalentrytags","routeSlug":"/apis/billing-ledger-service/ledger/replacejournalentrytags","metadata":{"seo":{"title":"Replace Journal Entry Tags","description":"Replace ALL tags on a journal entry. Any existing tags not included in the request body are removed. Maximum 50 tags per entity."}},"httpPath":"/ledger/journalEntries/{journalEntryId}/tags"},{"label":"Merge Journal Entry Tags","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/ledger/mergejournalentrytags","routeSlug":"/apis/billing-ledger-service/ledger/mergejournalentrytags","metadata":{"seo":{"title":"Merge Journal Entry Tags","description":"Merge (upsert) tags on a journal entry. Existing tags not in the request body are preserved. Tags in the request body are added or updated."}},"httpPath":"/ledger/journalEntries/{journalEntryId}/tags"},{"label":"Remove All Journal Entry Tags","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/ledger/deletejournalentrytags","routeSlug":"/apis/billing-ledger-service/ledger/deletejournalentrytags","metadata":{"seo":{"title":"Remove All Journal Entry Tags","description":"Remove all tags from a journal entry."}},"httpPath":"/ledger/journalEntries/{journalEntryId}/tags"},{"label":"Get Journal Line Tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/ledger/getjournallinetags","routeSlug":"/apis/billing-ledger-service/ledger/getjournallinetags","metadata":{"seo":{"title":"Get Journal Line Tags","description":"Retrieve all tags for a specific journal line in nested namespace format."}},"httpPath":"/ledger/journalEntries/{journalEntryId}/lines/{journalLineId}/tags"},{"label":"Replace Journal Line Tags","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/ledger/replacejournallinetags","routeSlug":"/apis/billing-ledger-service/ledger/replacejournallinetags","metadata":{"seo":{"title":"Replace Journal Line Tags","description":"Replace ALL tags on a journal line. Any existing tags not included in the request body are removed. Maximum 50 tags per entity."}},"httpPath":"/ledger/journalEntries/{journalEntryId}/lines/{journalLineId}/tags"},{"label":"Merge Journal Line Tags","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/ledger/mergejournallinetags","routeSlug":"/apis/billing-ledger-service/ledger/mergejournallinetags","metadata":{"seo":{"title":"Merge Journal Line Tags","description":"Merge (upsert) tags on a journal line. Existing tags not in the request body are preserved. Tags in the request body are added or updated."}},"httpPath":"/ledger/journalEntries/{journalEntryId}/lines/{journalLineId}/tags"},{"label":"Remove All Journal Line Tags","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/ledger/deletejournallinetags","routeSlug":"/apis/billing-ledger-service/ledger/deletejournallinetags","metadata":{"seo":{"title":"Remove All Journal Line Tags","description":"Remove all tags from a journal line."}},"httpPath":"/ledger/journalEntries/{journalEntryId}/lines/{journalLineId}/tags"},{"label":"Get Account Balances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/ledger/getaccountbalances","routeSlug":"/apis/billing-ledger-service/ledger/getaccountbalances","metadata":{"seo":{"title":"Get Account Balances","description":"Get current balances for all ledger account codes."}},"httpPath":"/ledger/accountBalances"},{"label":"Get Trial Balance","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/ledger/gettrialbalance","routeSlug":"/apis/billing-ledger-service/ledger/gettrialbalance","metadata":{"seo":{"title":"Get Trial Balance","description":"Get trial balance report showing all accounts with their debit and credit totals."}},"httpPath":"/ledger/trialBalance"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Journal Entry Created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/billing-ledger-service/ledger/webhookjournalentrycreated","routeSlug":"/apis/billing-ledger-service/ledger/webhookjournalentrycreated","metadata":{"seo":{"title":"Journal Entry Created","description":"Fired when a new journal entry is created. Uses the OSI Push Notification Service envelope format."}},"httpPath":"ledgerJournalEntryCreated"}]},{"type":"group","label":"Exports","link":"/apis/billing-ledger-service/exports","routeSlug":"/apis/billing-ledger-service/exports","items":[{"label":"Export Charges to CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/exports/exportcharges","routeSlug":"/apis/billing-ledger-service/exports/exportcharges","metadata":{"seo":{"title":"Export Charges to CSV","description":"Export charges to CSV format."}},"httpPath":"/exports/charges"},{"label":"Export Ledger Entries to CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/exports/exportledgerentries","routeSlug":"/apis/billing-ledger-service/exports/exportledgerentries","metadata":{"seo":{"title":"Export Ledger Entries to CSV","description":"Export journal entries and lines to CSV format for GL integration."}},"httpPath":"/exports/ledgerEntries"},{"label":"Export Outstanding Balances to CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/exports/exportoutstandingbalances","routeSlug":"/apis/billing-ledger-service/exports/exportoutstandingbalances","metadata":{"seo":{"title":"Export Outstanding Balances to CSV","description":"Export outstanding balances report to CSV format."}},"httpPath":"/exports/outstandingBalances"},{"label":"Export Charges by Status to CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/exports/exportchargesbystatus","routeSlug":"/apis/billing-ledger-service/exports/exportchargesbystatus","metadata":{"seo":{"title":"Export Charges by Status to CSV","description":"Export charges-by-status report to CSV format."}},"httpPath":"/exports/chargesByStatus"},{"label":"Generate Report PDF","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/exports/generateledgerreportpdf","routeSlug":"/apis/billing-ledger-service/exports/generateledgerreportpdf","metadata":{"seo":{"title":"Generate Report PDF","description":"Generate a formatted PDF document from a Billing & Ledger report's data (US-RPT-020)."}},"httpPath":"/exports/{reportType}/pdf"}]},{"type":"group","label":"Tags","link":"/apis/billing-ledger-service/tags","routeSlug":"/apis/billing-ledger-service/tags","items":[{"label":"Get Rate Tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/tags/getratetags","routeSlug":"/apis/billing-ledger-service/tags/getratetags","metadata":{"seo":{"title":"Get Rate Tags","description":"Retrieve all tags for a specific rate in nested namespace format."}},"httpPath":"/rates/{rateId}/tags"},{"label":"Replace Rate Tags","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/tags/replaceratetags","routeSlug":"/apis/billing-ledger-service/tags/replaceratetags","metadata":{"seo":{"title":"Replace Rate Tags","description":"Replace ALL tags on a rate. Any existing tags not included in the request body are removed. Maximum 50 tags per entity."}},"httpPath":"/rates/{rateId}/tags"},{"label":"Merge Rate Tags","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/tags/mergeratetags","routeSlug":"/apis/billing-ledger-service/tags/mergeratetags","metadata":{"seo":{"title":"Merge Rate Tags","description":"Merge (upsert) tags on a rate. Existing tags not in the request body are preserved. Tags in the request body are added or updated."}},"httpPath":"/rates/{rateId}/tags"},{"label":"Remove All Rate Tags","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/tags/deleteratetags","routeSlug":"/apis/billing-ledger-service/tags/deleteratetags","metadata":{"seo":{"title":"Remove All Rate Tags","description":"Remove all tags from a rate."}},"httpPath":"/rates/{rateId}/tags"},{"label":"Get Rate Card Tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/tags/getratecardtags","routeSlug":"/apis/billing-ledger-service/tags/getratecardtags","metadata":{"seo":{"title":"Get Rate Card Tags","description":"Retrieve all tags for a specific rate card in nested namespace format."}},"httpPath":"/rateCards/{rateCardId}/tags"},{"label":"Replace Rate Card Tags","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/tags/replaceratecardtags","routeSlug":"/apis/billing-ledger-service/tags/replaceratecardtags","metadata":{"seo":{"title":"Replace Rate Card Tags","description":"Replace ALL tags on a rate card. Any existing tags not included in the request body are removed. Maximum 50 tags per entity."}},"httpPath":"/rateCards/{rateCardId}/tags"},{"label":"Merge Rate Card Tags","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/tags/mergeratecardtags","routeSlug":"/apis/billing-ledger-service/tags/mergeratecardtags","metadata":{"seo":{"title":"Merge Rate Card Tags","description":"Merge (upsert) tags on a rate card. Existing tags not in the request body are preserved. Tags in the request body are added or updated."}},"httpPath":"/rateCards/{rateCardId}/tags"},{"label":"Remove All Rate Card Tags","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/tags/deleteratecardtags","routeSlug":"/apis/billing-ledger-service/tags/deleteratecardtags","metadata":{"seo":{"title":"Remove All Rate Card Tags","description":"Remove all tags from a rate card."}},"httpPath":"/rateCards/{rateCardId}/tags"},{"label":"Get Subscription Tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/tags/getsubscriptiontags","routeSlug":"/apis/billing-ledger-service/tags/getsubscriptiontags","metadata":{"seo":{"title":"Get Subscription Tags","description":"Retrieve all tags for a specific subscription in nested namespace format."}},"httpPath":"/subscriptions/{subscriptionId}/tags"},{"label":"Replace Subscription Tags","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/tags/replacesubscriptiontags","routeSlug":"/apis/billing-ledger-service/tags/replacesubscriptiontags","metadata":{"seo":{"title":"Replace Subscription Tags","description":"Replace ALL tags on a subscription. Any existing tags not included in the request body are removed. Maximum 50 tags per entity."}},"httpPath":"/subscriptions/{subscriptionId}/tags"},{"label":"Merge Subscription Tags","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/tags/mergesubscriptiontags","routeSlug":"/apis/billing-ledger-service/tags/mergesubscriptiontags","metadata":{"seo":{"title":"Merge Subscription Tags","description":"Merge (upsert) tags on a subscription. Existing tags not in the request body are preserved. Tags in the request body are added or updated."}},"httpPath":"/subscriptions/{subscriptionId}/tags"},{"label":"Remove All Subscription Tags","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/tags/deletesubscriptiontags","routeSlug":"/apis/billing-ledger-service/tags/deletesubscriptiontags","metadata":{"seo":{"title":"Remove All Subscription Tags","description":"Remove all tags from a subscription."}},"httpPath":"/subscriptions/{subscriptionId}/tags"},{"label":"Get Allocation Configuration Tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/tags/getallocationconfigtags","routeSlug":"/apis/billing-ledger-service/tags/getallocationconfigtags","metadata":{"seo":{"title":"Get Allocation Configuration Tags","description":"Retrieve all tags for a specific allocation configuration in nested namespace format."}},"httpPath":"/allocationConfigurations/{allocationConfigId}/tags"},{"label":"Replace Allocation Configuration Tags","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/tags/replaceallocationconfigtags","routeSlug":"/apis/billing-ledger-service/tags/replaceallocationconfigtags","metadata":{"seo":{"title":"Replace Allocation Configuration Tags","description":"Replace ALL tags on an allocation configuration. Any existing tags not included in the request body are removed. Maximum 50 tags per entity."}},"httpPath":"/allocationConfigurations/{allocationConfigId}/tags"},{"label":"Merge Allocation Configuration Tags","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/tags/mergeallocationconfigtags","routeSlug":"/apis/billing-ledger-service/tags/mergeallocationconfigtags","metadata":{"seo":{"title":"Merge Allocation Configuration Tags","description":"Merge (upsert) tags on an allocation configuration. Existing tags not in the request body are preserved. Tags in the request body are added or updated."}},"httpPath":"/allocationConfigurations/{allocationConfigId}/tags"},{"label":"Remove All Allocation Configuration Tags","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/tags/deleteallocationconfigtags","routeSlug":"/apis/billing-ledger-service/tags/deleteallocationconfigtags","metadata":{"seo":{"title":"Remove All Allocation Configuration Tags","description":"Remove all tags from an allocation configuration."}},"httpPath":"/allocationConfigurations/{allocationConfigId}/tags"},{"label":"Get Charge Tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/tags/getchargetags","routeSlug":"/apis/billing-ledger-service/tags/getchargetags","metadata":{"seo":{"title":"Get Charge Tags","description":"Retrieve all tags for a specific charge in nested namespace format."}},"httpPath":"/charges/{chargeId}/tags"},{"label":"Replace Charge Tags","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/tags/replacechargetags","routeSlug":"/apis/billing-ledger-service/tags/replacechargetags","metadata":{"seo":{"title":"Replace Charge Tags","description":"Replace ALL tags on a charge. Any existing tags not included in the request body are removed.Maximum 50 tags per entity."}},"httpPath":"/charges/{chargeId}/tags"},{"label":"Merge Charge Tags","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/tags/mergechargetags","routeSlug":"/apis/billing-ledger-service/tags/mergechargetags","metadata":{"seo":{"title":"Merge Charge Tags","description":"Merge (upsert) tags on a charge. Existing tags not in the request body are preserved.Tags in the request body are added or updated."}},"httpPath":"/charges/{chargeId}/tags"},{"label":"Remove All Charge Tags","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/tags/deletechargetags","routeSlug":"/apis/billing-ledger-service/tags/deletechargetags","metadata":{"seo":{"title":"Remove All Charge Tags","description":"Remove all tags from a charge."}},"httpPath":"/charges/{chargeId}/tags"},{"label":"Get Journal Entry Tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/tags/getjournalentrytags","routeSlug":"/apis/billing-ledger-service/tags/getjournalentrytags","metadata":{"seo":{"title":"Get Journal Entry Tags","description":"Retrieve all tags for a specific journal entry in nested namespace format."}},"httpPath":"/ledger/journalEntries/{journalEntryId}/tags"},{"label":"Replace Journal Entry Tags","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/tags/replacejournalentrytags","routeSlug":"/apis/billing-ledger-service/tags/replacejournalentrytags","metadata":{"seo":{"title":"Replace Journal Entry Tags","description":"Replace ALL tags on a journal entry. Any existing tags not included in the request body are removed. Maximum 50 tags per entity."}},"httpPath":"/ledger/journalEntries/{journalEntryId}/tags"},{"label":"Merge Journal Entry Tags","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/tags/mergejournalentrytags","routeSlug":"/apis/billing-ledger-service/tags/mergejournalentrytags","metadata":{"seo":{"title":"Merge Journal Entry Tags","description":"Merge (upsert) tags on a journal entry. Existing tags not in the request body are preserved. Tags in the request body are added or updated."}},"httpPath":"/ledger/journalEntries/{journalEntryId}/tags"},{"label":"Remove All Journal Entry Tags","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/tags/deletejournalentrytags","routeSlug":"/apis/billing-ledger-service/tags/deletejournalentrytags","metadata":{"seo":{"title":"Remove All Journal Entry Tags","description":"Remove all tags from a journal entry."}},"httpPath":"/ledger/journalEntries/{journalEntryId}/tags"},{"label":"Get Journal Line Tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/tags/getjournallinetags","routeSlug":"/apis/billing-ledger-service/tags/getjournallinetags","metadata":{"seo":{"title":"Get Journal Line Tags","description":"Retrieve all tags for a specific journal line in nested namespace format."}},"httpPath":"/ledger/journalEntries/{journalEntryId}/lines/{journalLineId}/tags"},{"label":"Replace Journal Line Tags","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/tags/replacejournallinetags","routeSlug":"/apis/billing-ledger-service/tags/replacejournallinetags","metadata":{"seo":{"title":"Replace Journal Line Tags","description":"Replace ALL tags on a journal line. Any existing tags not included in the request body are removed. Maximum 50 tags per entity."}},"httpPath":"/ledger/journalEntries/{journalEntryId}/lines/{journalLineId}/tags"},{"label":"Merge Journal Line Tags","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/tags/mergejournallinetags","routeSlug":"/apis/billing-ledger-service/tags/mergejournallinetags","metadata":{"seo":{"title":"Merge Journal Line Tags","description":"Merge (upsert) tags on a journal line. Existing tags not in the request body are preserved. Tags in the request body are added or updated."}},"httpPath":"/ledger/journalEntries/{journalEntryId}/lines/{journalLineId}/tags"},{"label":"Remove All Journal Line Tags","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/tags/deletejournallinetags","routeSlug":"/apis/billing-ledger-service/tags/deletejournallinetags","metadata":{"seo":{"title":"Remove All Journal Line Tags","description":"Remove all tags from a journal line."}},"httpPath":"/ledger/journalEntries/{journalEntryId}/lines/{journalLineId}/tags"}]},{"type":"group","label":"Configuration","link":"/apis/billing-ledger-service/configuration","routeSlug":"/apis/billing-ledger-service/configuration","items":[{"label":"Get Billing Configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/configuration/getbillingconfig","routeSlug":"/apis/billing-ledger-service/configuration/getbillingconfig","metadata":{"seo":{"title":"Get Billing Configuration","description":"Retrieve the billing configuration for the authenticated merchant."}},"httpPath":"/config/billing"},{"label":"Upsert Billing Configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-ledger-service/configuration/upsertbillingconfig","routeSlug":"/apis/billing-ledger-service/configuration/upsertbillingconfig","metadata":{"seo":{"title":"Upsert Billing Configuration","description":"Create or update the billing configuration for the authenticated merchant. Returns the persisted configuration."}},"httpPath":"/config/billing"}]}]},{"type":"group","label":"Recurring Billing","items":[{"type":"link","label":"Recurring Billing Service API","link":"/apis/billing-recurring","routeSlug":"/apis/billing-recurring"},{"type":"link","label":"Key Concepts","link":"/apis/billing-recurring/section/key-concepts","routeSlug":"/apis/billing-recurring/section/key-concepts"},{"type":"link","label":"BillingSchedule","link":"/apis/billing-recurring/section/billingschedule","routeSlug":"/apis/billing-recurring/section/billingschedule"},{"type":"link","label":"BillingRun","link":"/apis/billing-recurring/section/billingrun","routeSlug":"/apis/billing-recurring/section/billingrun"},{"type":"link","label":"Error Handling","link":"/apis/billing-recurring/section/error-handling","routeSlug":"/apis/billing-recurring/section/error-handling"},{"type":"link","label":"Authentication Note","link":"/apis/billing-recurring/section/authentication-note","routeSlug":"/apis/billing-recurring/section/authentication-note"},{"type":"group","label":"Automated billing schedules","link":"/apis/billing-recurring/billingschedules","routeSlug":"/apis/billing-recurring/billingschedules","items":[{"label":"List Billing Schedules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-recurring/billingschedules/listbillingschedules","routeSlug":"/apis/billing-recurring/billingschedules/listbillingschedules","metadata":{"seo":{"title":"List Billing Schedules","description":"List all billing schedules for the authenticated merchant"}},"httpPath":"/billingSchedules"},{"label":"Create Billing Schedule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-recurring/billingschedules/createbillingschedule","routeSlug":"/apis/billing-recurring/billingschedules/createbillingschedule","metadata":{"seo":{"title":"Create Billing Schedule","description":"Create a new billing schedule for automated charge creation.Requires a subscriptionId referencing a Subscription in the Billing & Ledger Service.The subscription defines the rate, allocation, discounts, and billing cycle (frequency,anchor day, timezone). The schedule inherits all of this configuration."}},"httpPath":"/billingSchedules"},{"label":"Get Billing Schedule Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-recurring/billingschedules/getbillingschedule","routeSlug":"/apis/billing-recurring/billingschedules/getbillingschedule","metadata":{"seo":{"title":"Get Billing Schedule Details","description":"Retrieve details of a specific billing schedule"}},"httpPath":"/billingSchedules/{scheduleId}"},{"label":"Update Billing Schedule","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-recurring/billingschedules/updatebillingschedule","routeSlug":"/apis/billing-recurring/billingschedules/updatebillingschedule","metadata":{"seo":{"title":"Update Billing Schedule","description":"Update a billing schedule (partial update). Changes are tracked in history.Since rate, allocation, and cadence are inherited from the linked subscription,the only mutable fields are endDate and status."}},"httpPath":"/billingSchedules/{scheduleId}"},{"label":"Delete Billing Schedule","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-recurring/billingschedules/deletebillingschedule","routeSlug":"/apis/billing-recurring/billingschedules/deletebillingschedule","metadata":{"seo":{"title":"Delete Billing Schedule","description":"Delete a billing schedule (sets status to CANCELLED)"}},"httpPath":"/billingSchedules/{scheduleId}"},{"label":"Get Schedule Change History","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-recurring/billingschedules/getschedulehistory","routeSlug":"/apis/billing-recurring/billingschedules/getschedulehistory","metadata":{"seo":{"title":"Get Schedule Change History","description":"Retrieve audit trail of changes to a billing schedule"}},"httpPath":"/billingSchedules/{scheduleId}/history"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Recurring Billing Subscription Expired","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/billing-recurring/billingschedules/webhooksubscriptionexpired","routeSlug":"/apis/billing-recurring/billingschedules/webhooksubscriptionexpired","metadata":{"seo":{"title":"Recurring Billing Subscription Expired","description":"The subscription.expired event (recurringBilling.subscription.expired) is reserved for future use."}},"httpPath":"recurringBillingSubscriptionExpired"}]},{"type":"group","label":"Billing run execution","link":"/apis/billing-recurring/billingruns","routeSlug":"/apis/billing-recurring/billingruns","items":[{"label":"List Billing Runs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-recurring/billingruns/listbillingruns","routeSlug":"/apis/billing-recurring/billingruns/listbillingruns","metadata":{"seo":{"title":"List Billing Runs","description":"List all billing runs for the authenticated merchant"}},"httpPath":"/billingRuns"},{"label":"Trigger Manual Billing Run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-recurring/billingruns/createbillingrun","routeSlug":"/apis/billing-recurring/billingruns/createbillingrun","metadata":{"seo":{"title":"Trigger Manual Billing Run","description":"Manually trigger a billing run to process schedules."}},"httpPath":"/billingRuns"},{"label":"Get Billing Run Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-recurring/billingruns/getbillingrun","routeSlug":"/apis/billing-recurring/billingruns/getbillingrun","metadata":{"seo":{"title":"Get Billing Run Details","description":"Retrieve details of a specific billing run including statistics"}},"httpPath":"/billingRuns/{billingRunId}"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Recurring Billing Charge Failed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/billing-recurring/billingruns/webhookchargefailed","routeSlug":"/apis/billing-recurring/billingruns/webhookchargefailed","metadata":{"seo":{"title":"Recurring Billing Charge Failed","description":"Fired when charge creation fails for a schedule."}},"httpPath":"recurringBillingChargeFailed"},{"label":"Recurring Billing Run Failed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/billing-recurring/billingruns/webhookrunfailed","routeSlug":"/apis/billing-recurring/billingruns/webhookrunfailed","metadata":{"seo":{"title":"Recurring Billing Run Failed","description":"Fired when an entire billing run fails."}},"httpPath":"recurringBillingRunFailed"},{"label":"Recurring Billing Run Partially Completed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/billing-recurring/billingruns/webhookrunpartiallycompleted","routeSlug":"/apis/billing-recurring/billingruns/webhookrunpartiallycompleted","metadata":{"seo":{"title":"Recurring Billing Run Partially Completed","description":"Fired when some schedules in a billing run fail."}},"httpPath":"recurringBillingRunPartiallyCompleted"}]},{"type":"group","label":"Schedule change history","link":"/apis/billing-recurring/schedulehistory","routeSlug":"/apis/billing-recurring/schedulehistory","items":[{"label":"Get Schedule Change History","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-recurring/schedulehistory/getschedulehistory","routeSlug":"/apis/billing-recurring/schedulehistory/getschedulehistory","metadata":{"seo":{"title":"Get Schedule Change History","description":"Retrieve audit trail of changes to a billing schedule"}},"httpPath":"/billingSchedules/{scheduleId}/history"}]},{"type":"group","label":"Configuration","link":"/apis/billing-recurring/configuration","routeSlug":"/apis/billing-recurring/configuration","items":[{"label":"Get Recurring Billing Configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-recurring/configuration/getrecurringbillingconfig","routeSlug":"/apis/billing-recurring/configuration/getrecurringbillingconfig","metadata":{"seo":{"title":"Get Recurring Billing Configuration","description":"Retrieve the per-merchant recurring billing configuration stored locally."}},"httpPath":"/config/recurringBilling"},{"label":"Upsert Recurring Billing Configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/billing-recurring/configuration/upsertrecurringbillingconfig","routeSlug":"/apis/billing-recurring/configuration/upsertrecurringbillingconfig","metadata":{"seo":{"title":"Upsert Recurring Billing Configuration","description":"Create or update the per-merchant recurring billing configuration."}},"httpPath":"/config/recurringBilling"}]}]},{"type":"group","label":"Invoicing","items":[{"type":"link","label":"Invoice Service API","link":"/apis/invoice-service","routeSlug":"/apis/invoice-service"},{"type":"link","label":"Key Concepts","link":"/apis/invoice-service/section/key-concepts","routeSlug":"/apis/invoice-service/section/key-concepts"},{"type":"link","label":"Invoice Lifecycle","link":"/apis/invoice-service/section/invoice-lifecycle","routeSlug":"/apis/invoice-service/section/invoice-lifecycle"},{"type":"link","label":"Sequential Invoice Numbering","link":"/apis/invoice-service/section/sequential-invoice-numbering","routeSlug":"/apis/invoice-service/section/sequential-invoice-numbering"},{"type":"link","label":"Dry-Run Mode","link":"/apis/invoice-service/section/dry-run-mode","routeSlug":"/apis/invoice-service/section/dry-run-mode"},{"type":"link","label":"Aging Buckets","link":"/apis/invoice-service/section/aging-buckets","routeSlug":"/apis/invoice-service/section/aging-buckets"},{"type":"link","label":"Payment Application","link":"/apis/invoice-service/section/payment-application","routeSlug":"/apis/invoice-service/section/payment-application"},{"type":"link","label":"Receipt Integration","link":"/apis/invoice-service/section/receipt-integration","routeSlug":"/apis/invoice-service/section/receipt-integration"},{"type":"link","label":"Response envelope (JSON APIs)","link":"/apis/invoice-service/section/response-envelope-(json-apis)","routeSlug":"/apis/invoice-service/section/response-envelope-(json-apis)"},{"type":"link","label":"Error handling (JSON APIs)","link":"/apis/invoice-service/section/error-handling-(json-apis)","routeSlug":"/apis/invoice-service/section/error-handling-(json-apis)"},{"type":"link","label":"Authentication Note","link":"/apis/invoice-service/section/authentication-note","routeSlug":"/apis/invoice-service/section/authentication-note"},{"type":"group","label":"Batch invoice generation","link":"/apis/invoice-service/invoiceruns","routeSlug":"/apis/invoice-service/invoiceruns","items":[{"label":"List Invoice Runs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/invoiceruns/listinvoiceruns","routeSlug":"/apis/invoice-service/invoiceruns/listinvoiceruns","metadata":{"seo":{"title":"List Invoice Runs","description":"List all invoice runs for the authenticated merchant"}},"httpPath":"/invoiceRuns"},{"label":"Create Invoice Run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/invoiceruns/createinvoicerun","routeSlug":"/apis/invoice-service/invoiceruns/createinvoicerun","metadata":{"seo":{"title":"Create Invoice Run","description":"Create a new invoice run to generate invoices from billable charges."}},"httpPath":"/invoiceRuns"},{"label":"Auto-Discover Billable Charges","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/invoiceruns/autodiscovercharges","routeSlug":"/apis/invoice-service/invoiceruns/autodiscovercharges","metadata":{"seo":{"title":"Auto-Discover Billable Charges","description":"Discover accounts with uninvoiced settled charges ready for invoicing.Supports preview mode (dryRun: true) to simulate results without persisting,and real execution (dryRun: false) to perform the discover run."}},"httpPath":"/invoiceRuns/autoDiscover"},{"label":"Get Invoice Run Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/invoiceruns/getinvoicerun","routeSlug":"/apis/invoice-service/invoiceruns/getinvoicerun","metadata":{"seo":{"title":"Get Invoice Run Details","description":"Retrieve details of a specific invoice run including statistics."}},"httpPath":"/invoiceRuns/{invoiceRunId}"},{"label":"List Invoices from Run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/invoiceruns/getinvoiceruninvoices","routeSlug":"/apis/invoice-service/invoiceruns/getinvoiceruninvoices","metadata":{"seo":{"title":"List Invoices from Run","description":"List all invoices generated by a specific invoice run"}},"httpPath":"/invoiceRuns/{invoiceRunId}/invoices"}]},{"type":"group","label":"Invoice management","link":"/apis/invoice-service/invoices","routeSlug":"/apis/invoice-service/invoices","items":[{"label":"List Invoices from Run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/invoices/getinvoiceruninvoices","routeSlug":"/apis/invoice-service/invoices/getinvoiceruninvoices","metadata":{"seo":{"title":"List Invoices from Run","description":"List all invoices generated by a specific invoice run"}},"httpPath":"/invoiceRuns/{invoiceRunId}/invoices"},{"label":"List Invoices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/invoices/listinvoices","routeSlug":"/apis/invoice-service/invoices/listinvoices","metadata":{"seo":{"title":"List Invoices","description":"List all invoices for the authenticated merchant with filtering and pagination."}},"httpPath":"/invoices"},{"label":"Create Direct Invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/invoices/createdirectinvoice","routeSlug":"/apis/invoice-service/invoices/createdirectinvoice","metadata":{"seo":{"title":"Create Direct Invoice","description":"Create an invoice directly without going through an invoice run. Useful for one-off invoices or manual adjustments."}},"httpPath":"/invoices"},{"label":"List Auto-Pay Eligible Invoices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/invoices/listautopayeligibleinvoices","routeSlug":"/apis/invoice-service/invoices/listautopayeligibleinvoices","metadata":{"seo":{"title":"List Auto-Pay Eligible Invoices","description":"List invoices eligible for auto-pay processing on the given due date. Returns approved/posted invoices with outstanding balances whose due date matches the filter."}},"httpPath":"/invoices/autoPayEligible"},{"label":"Get Invoice Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/invoices/getinvoice","routeSlug":"/apis/invoice-service/invoices/getinvoice","metadata":{"seo":{"title":"Get Invoice Details","description":"Retrieve details of a specific invoice including line items"}},"httpPath":"/invoices/{invoiceId}"},{"label":"Update Invoice","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/invoices/updateinvoice","routeSlug":"/apis/invoice-service/invoices/updateinvoice","metadata":{"seo":{"title":"Update Invoice","description":"Update invoice properties (partial update)."}},"httpPath":"/invoices/{invoiceId}"},{"label":"Approve Invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/invoices/approveinvoice","routeSlug":"/apis/invoice-service/invoices/approveinvoice","metadata":{"seo":{"title":"Approve Invoice","description":"Approve an invoice for posting. Transitions status from CREATED to APPROVED. Only applicable when merchant has manual approval enabled."}},"httpPath":"/invoices/{invoiceId}/approve"},{"label":"Get Invoice HTML","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/invoices/getinvoicehtml","routeSlug":"/apis/invoice-service/invoices/getinvoicehtml","metadata":{"seo":{"title":"Get Invoice HTML","description":"Generate and return the invoice as HTML for browser viewing."}},"httpPath":"/invoices/{invoiceId}/html"},{"label":"Create Invoice Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/invoices/createinvoicenotification","routeSlug":"/apis/invoice-service/invoices/createinvoicenotification","metadata":{"seo":{"title":"Create Invoice Notification","description":"Create and send invoice notification to all contacts for the account."}},"httpPath":"/invoices/{invoiceId}/notifications"},{"label":"List Invoice Lines","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/invoices/getinvoicelines","routeSlug":"/apis/invoice-service/invoices/getinvoicelines","metadata":{"seo":{"title":"List Invoice Lines","description":"List all line items for a specific invoice"}},"httpPath":"/invoices/{invoiceId}/lines"},{"label":"List Payments for Invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/invoices/getinvoicepayments","routeSlug":"/apis/invoice-service/invoices/getinvoicepayments","metadata":{"seo":{"title":"List Payments for Invoice","description":"List all payments applied to a specific invoice"}},"httpPath":"/invoices/{invoiceId}/payments"},{"label":"Apply Payment to Invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/invoices/applypaymenttoinvoice","routeSlug":"/apis/invoice-service/invoices/applypaymenttoinvoice","metadata":{"seo":{"title":"Apply Payment to Invoice","description":"Apply a payment to an invoice."}},"httpPath":"/invoices/{invoiceId}/payments"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Invoice Notification (generic)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/invoice-service/invoices/webhookinvoicenotification","routeSlug":"/apis/invoice-service/invoices/webhookinvoicenotification","metadata":{"seo":{"title":"Invoice Notification (generic)","description":"Generic notification emitted by the invoice service today. Specific lifecycle event types are not yet implemented."}},"httpPath":"invoiceNotification"},{"label":"Invoice Created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/invoice-service/invoices/webhookinvoicecreated","routeSlug":"/apis/invoice-service/invoices/webhookinvoicecreated","metadata":{"seo":{"title":"Invoice Created","description":"Fired when an invoice is generated (draft or from billing run)."}},"httpPath":"invoiceCreated"},{"label":"Invoice Approved","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/invoice-service/invoices/webhookinvoiceapproved","routeSlug":"/apis/invoice-service/invoices/webhookinvoiceapproved","metadata":{"seo":{"title":"Invoice Approved","description":"Fired when an invoice is approved for posting."}},"httpPath":"invoiceApproved"},{"label":"Invoice Posted","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/invoice-service/invoices/webhookinvoiceposted","routeSlug":"/apis/invoice-service/invoices/webhookinvoiceposted","metadata":{"seo":{"title":"Invoice Posted","description":"Fired when an invoice is posted and ledger entries created."}},"httpPath":"invoicePosted"},{"label":"Invoice Voided","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/invoice-service/invoices/webhookinvoicevoided","routeSlug":"/apis/invoice-service/invoices/webhookinvoicevoided","metadata":{"seo":{"title":"Invoice Voided","description":"Fired when an invoice is voided."}},"httpPath":"invoiceVoided"},{"label":"Invoice Paid In Full","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/invoice-service/invoices/webhookinvoicepaidinfull","routeSlug":"/apis/invoice-service/invoices/webhookinvoicepaidinfull","metadata":{"seo":{"title":"Invoice Paid In Full","description":"Fired when an invoice is fully paid."}},"httpPath":"invoicePaidInFull"},{"label":"Invoice Past Due","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/invoice-service/invoices/webhookinvoicepastdue","routeSlug":"/apis/invoice-service/invoices/webhookinvoicepastdue","metadata":{"seo":{"title":"Invoice Past Due","description":"Fired when an invoice passes its due date."}},"httpPath":"invoicePastDue"},{"label":"Invoice Late Fee Applied","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/invoice-service/invoices/webhookinvoicelatefeeapplied","routeSlug":"/apis/invoice-service/invoices/webhookinvoicelatefeeapplied","metadata":{"seo":{"title":"Invoice Late Fee Applied","description":"Fired when a late fee is applied to an invoice."}},"httpPath":"invoiceLateFeeApplied"}]},{"type":"group","label":"Invoice line items","link":"/apis/invoice-service/invoicelines","routeSlug":"/apis/invoice-service/invoicelines","items":[{"label":"List Invoice Lines","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/invoicelines/getinvoicelines","routeSlug":"/apis/invoice-service/invoicelines/getinvoicelines","metadata":{"seo":{"title":"List Invoice Lines","description":"List all line items for a specific invoice"}},"httpPath":"/invoices/{invoiceId}/lines"}]},{"type":"group","label":"Payment management","link":"/apis/invoice-service/payments","routeSlug":"/apis/invoice-service/payments","items":[{"label":"List Payments for Invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/payments/getinvoicepayments","routeSlug":"/apis/invoice-service/payments/getinvoicepayments","metadata":{"seo":{"title":"List Payments for Invoice","description":"List all payments applied to a specific invoice"}},"httpPath":"/invoices/{invoiceId}/payments"},{"label":"Apply Payment to Invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/payments/applypaymenttoinvoice","routeSlug":"/apis/invoice-service/payments/applypaymenttoinvoice","metadata":{"seo":{"title":"Apply Payment to Invoice","description":"Apply a payment to an invoice."}},"httpPath":"/invoices/{invoiceId}/payments"},{"label":"List All Payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/payments/listpayments","routeSlug":"/apis/invoice-service/payments/listpayments","metadata":{"seo":{"title":"List All Payments","description":"List all payments for the authenticated merchant"}},"httpPath":"/payments"},{"label":"Get Payment Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/payments/getpayment","routeSlug":"/apis/invoice-service/payments/getpayment","metadata":{"seo":{"title":"Get Payment Details","description":"Retrieve details of a specific payment"}},"httpPath":"/payments/{paymentId}"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Invoice Payment Received","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/invoice-service/payments/webhookinvoicepaymentreceived","routeSlug":"/apis/invoice-service/payments/webhookinvoicepaymentreceived","metadata":{"seo":{"title":"Invoice Payment Received","description":"Fired when a payment is applied to an invoice."}},"httpPath":"invoicePaymentReceived"},{"label":"Invoice Payment Failed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/invoice-service/payments/webhookinvoicepaymentfailed","routeSlug":"/apis/invoice-service/payments/webhookinvoicepaymentfailed","metadata":{"seo":{"title":"Invoice Payment Failed","description":"Fired when a payment attempt fails."}},"httpPath":"invoicePaymentFailed"}]},{"type":"group","label":"Configuration","link":"/apis/invoice-service/configuration","routeSlug":"/apis/invoice-service/configuration","items":[{"label":"Get Invoicing Configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/configuration/getinvoicingconfig","routeSlug":"/apis/invoice-service/configuration/getinvoicingconfig","metadata":{"seo":{"title":"Get Invoicing Configuration","description":"Retrieve the invoicing configuration for the authenticated merchant."}},"httpPath":"/config/invoicing"},{"label":"Upsert Invoicing Configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/configuration/upsertinvoicingconfig","routeSlug":"/apis/invoice-service/configuration/upsertinvoicingconfig","metadata":{"seo":{"title":"Upsert Invoicing Configuration","description":"Create or update the invoicing configuration for the authenticated merchant. Returns the persisted configuration."}},"httpPath":"/config/invoicing"},{"label":"Get Auto-Pay Configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/configuration/getautopayconfig","routeSlug":"/apis/invoice-service/configuration/getautopayconfig","metadata":{"seo":{"title":"Get Auto-Pay Configuration","description":"Retrieve the auto-pay configuration for the authenticated merchant."}},"httpPath":"/config/autoPay"},{"label":"Update Auto-Pay Configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/configuration/updateautopayconfig","routeSlug":"/apis/invoice-service/configuration/updateautopayconfig","metadata":{"seo":{"title":"Update Auto-Pay Configuration","description":"Create or update the auto-pay configuration for the authenticated merchant."}},"httpPath":"/config/autoPay"},{"label":"Get Write-Off Settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/configuration/getwriteoffsettings","routeSlug":"/apis/invoice-service/configuration/getwriteoffsettings","metadata":{"seo":{"title":"Get Write-Off Settings","description":"Retrieve the write-off policy settings for the authenticated merchant (US-INV-PMV-011): the auto-approval threshold and the reversal window."}},"httpPath":"/config/writeOff"},{"label":"Update Write-Off Settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/configuration/updatewriteoffsettings","routeSlug":"/apis/invoice-service/configuration/updatewriteoffsettings","metadata":{"seo":{"title":"Update Write-Off Settings","description":"Create or update the write-off policy settings for the authenticated merchant (US-INV-PMV-011)."}},"httpPath":"/config/writeOff"}]},{"type":"group","label":"Templates","link":"/apis/invoice-service/templates","routeSlug":"/apis/invoice-service/templates","items":[{"label":"List Templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/templates/listtemplates","routeSlug":"/apis/invoice-service/templates/listtemplates","metadata":{"seo":{"title":"List Templates","description":"List available templates for the authenticated merchant (paginated).The JSON body is an NpsResponse whose object property is a wrapperwith results (array of template objects for the current page) andpagination (page metadata). Returns both built-in system templatesand merchant-uploaded custom templates."}},"httpPath":"/templates"},{"label":"Create Template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/templates/createtemplate","routeSlug":"/apis/invoice-service/templates/createtemplate","metadata":{"seo":{"title":"Create Template","description":"Upload a new custom Liquid template for invoice or email rendering. The template is created in DRAFT status and must be activated before use. Liquid syntax is validated on creation."}},"httpPath":"/templates"},{"label":"Get Template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/templates/gettemplate","routeSlug":"/apis/invoice-service/templates/gettemplate","metadata":{"seo":{"title":"Get Template","description":"Retrieve a single template by ID, including its full Liquid content."}},"httpPath":"/templates/{templateId}"},{"label":"Update Template","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/templates/updatetemplate","routeSlug":"/apis/invoice-service/templates/updatetemplate","metadata":{"seo":{"title":"Update Template","description":"Update a custom template. System templates cannot be modified. Liquid syntax is re-validated on update. Increments the template version."}},"httpPath":"/templates/{templateId}"},{"label":"Delete Template","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/templates/deletetemplate","routeSlug":"/apis/invoice-service/templates/deletetemplate","metadata":{"seo":{"title":"Delete Template","description":"Soft-deletes a custom template. System templates cannot be deleted. If the deleted template was the merchant default, the system falls back to the built-in template."}},"httpPath":"/templates/{templateId}"},{"label":"Validate Template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/templates/validatetemplate","routeSlug":"/apis/invoice-service/templates/validatetemplate","metadata":{"seo":{"title":"Validate Template","description":"Validate Liquid template syntax without persisting. Returns validation results including any syntax errors and unrecognized variable references."}},"httpPath":"/templates/validate"},{"label":"Preview Template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/templates/previewtemplate","routeSlug":"/apis/invoice-service/templates/previewtemplate","metadata":{"seo":{"title":"Preview Template","description":"Render a template with sample data and return the resulting HTML. Useful for previewing how a template will look before activating it."}},"httpPath":"/templates/{templateId}/preview"}]},{"type":"group","label":"Reporting endpoints","link":"/apis/invoice-service/reports","routeSlug":"/apis/invoice-service/reports","items":[{"label":"Get A/R Aging Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/reports/getagingreport","routeSlug":"/apis/invoice-service/reports/getagingreport","metadata":{"seo":{"title":"Get A/R Aging Report","description":"Get accounts receivable aging report grouped by aging buckets. GET /reports/arAgingis an alias of this endpoint and behaves identically."}},"httpPath":"/reports/aging"},{"label":"Get A/R Aging Report (alias)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/reports/getaragingreport","routeSlug":"/apis/invoice-service/reports/getaragingreport","metadata":{"seo":{"title":"Get A/R Aging Report (alias)","description":"Alias for GET /reports/aging. Get accounts receivable aging report grouped by aging buckets."}},"httpPath":"/reports/arAging"},{"label":"Get Aging Bucket Configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/reports/getagingbucketconfiguration","routeSlug":"/apis/invoice-service/reports/getagingbucketconfiguration","metadata":{"seo":{"title":"Get Aging Bucket Configuration","description":"Retrieve the merchant's configurable day-based aging buckets (US-RPT-001). If the merchant hasno custom configuration, the system default buckets (30/60/90) are returned with isDefault: true."}},"httpPath":"/reports/aging/configuration"},{"label":"Upsert Aging Bucket Configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/reports/putagingbucketconfiguration","routeSlug":"/apis/invoice-service/reports/putagingbucketconfiguration","metadata":{"seo":{"title":"Upsert Aging Bucket Configuration","description":"Create or replace the merchant's configurable day-based aging buckets (US-RPT-001).Buckets must be contiguous and ordered by minDays; the final bucket is open-ended(maxDays: null). The implicit CURRENT bucket (not-yet-due) is always present and is not configured here."}},"httpPath":"/reports/aging/configuration"},{"label":"Invoices by Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/reports/getinvoicesbystatusreport","routeSlug":"/apis/invoice-service/reports/getinvoicesbystatusreport","metadata":{"seo":{"title":"Invoices by Status","description":"Aggregated summary of invoices grouped by status."}},"httpPath":"/reports/invoicesByStatus"},{"label":"Payment History Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/reports/getpaymenthistoryreport","routeSlug":"/apis/invoice-service/reports/getpaymenthistoryreport","metadata":{"seo":{"title":"Payment History Report","description":"Aggregated payment history with filtering by account, payment method, date range, tags, and invoice. Supports pagination."}},"httpPath":"/reports/paymentHistory"},{"label":"List Tag Keys","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/reports/gettagkeys","routeSlug":"/apis/invoice-service/reports/gettagkeys","metadata":{"seo":{"title":"List Tag Keys","description":"Returns all distinct consolidated tag keys available for the authenticated merchant. Useful for populating groupBy dimension selectors in reporting UIs."}},"httpPath":"/reports/tagKeys"},{"label":"Custom Report Schema","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/reports/getcustomreportschema","routeSlug":"/apis/invoice-service/reports/getcustomreportschema","metadata":{"seo":{"title":"Custom Report Schema","description":"Return the custom report field catalog, supported data types, filter operators,sort/group limits, and subtotal capabilities available to the authenticated merchant (US-RPT-023)."}},"httpPath":"/reports/custom/schema"},{"label":"Execute Ad-hoc Custom Report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/reports/executeadhoccustomreport","routeSlug":"/apis/invoice-service/reports/executeadhoccustomreport","metadata":{"seo":{"title":"Execute Ad-hoc Custom Report","description":"Execute an ad-hoc custom report definition against current data without saving it (US-RPT-023).JSON results are returned in the NPS envelope and support pagination. CSV results return rawtext/csv without the envelope and begin with a UTF-8 BOM (EF BB BF) for Excel compatibility."}},"httpPath":"/reports/custom/execute"},{"label":"Execute Saved Custom Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/reports/executesavedcustomreport","routeSlug":"/apis/invoice-service/reports/executesavedcustomreport","metadata":{"seo":{"title":"Execute Saved Custom Report","description":"Execute a saved custom report definition after tenant and visibility checks. The saved definition isloaded by ID, validated against the current field catalog, and executed against current data."}},"httpPath":"/reports/custom/execute/{id}"},{"label":"Get Custom Report Execution Job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/reports/getcustomreportexecutionjob","routeSlug":"/apis/invoice-service/reports/getcustomreportexecutionjob","metadata":{"seo":{"title":"Get Custom Report Execution Job","description":"Poll an asynchronous custom report CSV export job returned by POST /reports/custom/executeor GET /reports/custom/execute/{id}. Completed jobs include downloadUrl anddownloadExpiresAt; failed jobs include failureCode and failureMessage."}},"httpPath":"/reports/custom/executions/{executionId}"},{"label":"List Custom Report Definitions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/reports/listcustomreportdefinitions","routeSlug":"/apis/invoice-service/reports/listcustomreportdefinitions","metadata":{"seo":{"title":"List Custom Report Definitions","description":"List saved custom report definitions for the merchant. Results are tenant-isolated by entityId.Private definitions are visible only to their owner; merchant-visible definitions are visible toauthorized admins in the merchant hierarchy."}},"httpPath":"/reports/custom/definitions"},{"label":"Create Custom Report Definition","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/reports/createcustomreportdefinition","routeSlug":"/apis/invoice-service/reports/createcustomreportdefinition","metadata":{"seo":{"title":"Create Custom Report Definition","description":"Create a saved custom report definition, or duplicate an existing definition by passingsourceDefinitionId. The definition is validated against GET /reports/custom/schemabefore it is persisted."}},"httpPath":"/reports/custom/definitions"},{"label":"Get Custom Report Definition","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/reports/getcustomreportdefinition","routeSlug":"/apis/invoice-service/reports/getcustomreportdefinition","metadata":{"seo":{"title":"Get Custom Report Definition","description":"Retrieve one saved custom report definition after tenant and visibility checks."}},"httpPath":"/reports/custom/definitions/{id}"},{"label":"Update Custom Report Definition","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/reports/updatecustomreportdefinition","routeSlug":"/apis/invoice-service/reports/updatecustomreportdefinition","metadata":{"seo":{"title":"Update Custom Report Definition","description":"Replace a saved custom report definition. The full definition is validated against the currentcustom report schema. Callers should provide the latest version to support optimistic locking."}},"httpPath":"/reports/custom/definitions/{id}"},{"label":"Delete Custom Report Definition","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/reports/deletecustomreportdefinition","routeSlug":"/apis/invoice-service/reports/deletecustomreportdefinition","metadata":{"seo":{"title":"Delete Custom Report Definition","description":"Soft-delete a saved custom report definition after tenant and visibility checks."}},"httpPath":"/reports/custom/definitions/{id}"}]},{"type":"group","label":"CSV exports","link":"/apis/invoice-service/exports","routeSlug":"/apis/invoice-service/exports","items":[{"label":"Export Invoices to CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/exports/exportinvoices","routeSlug":"/apis/invoice-service/exports/exportinvoices","metadata":{"seo":{"title":"Export Invoices to CSV","description":"Export the invoices-by-status report as CSV."}},"httpPath":"/exports/invoices"},{"label":"Export A/R Aging Report to CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/exports/exportagingreport","routeSlug":"/apis/invoice-service/exports/exportagingreport","metadata":{"seo":{"title":"Export A/R Aging Report to CSV","description":"Export aging report to CSV format."}},"httpPath":"/exports/aging"},{"label":"Export Payments to CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/exports/exportpayments","routeSlug":"/apis/invoice-service/exports/exportpayments","metadata":{"seo":{"title":"Export Payments to CSV","description":"Export payments to CSV format with the same filters as the list endpoint."}},"httpPath":"/exports/payments"},{"label":"Generate Report PDF","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/exports/generatereportpdf","routeSlug":"/apis/invoice-service/exports/generatereportpdf","metadata":{"seo":{"title":"Generate Report PDF","description":"Generate a formatted PDF document from an Invoice Service report's data (US-RPT-020)."}},"httpPath":"/exports/{reportType}/pdf"}]},{"type":"group","label":"Late fee management","link":"/apis/invoice-service/latefees","routeSlug":"/apis/invoice-service/latefees","items":[{"label":"Assess Late Fees","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/latefees/assesslatefees","routeSlug":"/apis/invoice-service/latefees/assesslatefees","metadata":{"seo":{"title":"Assess Late Fees","description":"Assess late fees for overdue invoices based on the merchant's late fee rules.Creates late fee charges in the Billing & Ledger Service."}},"httpPath":"/lateFees/assess"}]},{"type":"group","label":"Auto-pay processing","link":"/apis/invoice-service/autopay","routeSlug":"/apis/invoice-service/autopay","items":[{"label":"List Auto-Pay Eligible Invoices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/autopay/listautopayeligibleinvoices","routeSlug":"/apis/invoice-service/autopay/listautopayeligibleinvoices","metadata":{"seo":{"title":"List Auto-Pay Eligible Invoices","description":"List invoices eligible for auto-pay processing on the given due date. Returns approved/posted invoices with outstanding balances whose due date matches the filter."}},"httpPath":"/invoices/autoPayEligible"},{"label":"Process Auto-Pay","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/autopay/processautopay","routeSlug":"/apis/invoice-service/autopay/processautopay","metadata":{"seo":{"title":"Process Auto-Pay","description":"Trigger auto-pay processing for eligible invoices. Processes payments using stored payment methods for accounts with auto-pay agreements."}},"httpPath":"/autoPay/process"}]},{"type":"group","label":"AchReturns","link":"/apis/invoice-service/achreturns","routeSlug":"/apis/invoice-service/achreturns","items":[{"label":"Receive ACH Return Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/achreturns/receiveachreturn","routeSlug":"/apis/invoice-service/achreturns/receiveachreturn","metadata":{"seo":{"title":"Receive ACH Return Notification","description":"Webhook endpoint receiving ACH return notifications from the Payments API.On first delivery the return reverses the original payment, reverts invoicestatus, posts the A/R reinstatement journal entry (DR A/R, CR Clearing),advances the return to PROCESSED, and notifies the merchant admin of thereturn + reason (US-ACH-001). The journal posts inside the return transaction(atomic with the reversal); the admin notification is best-effort. Idempotenton the payment: a replay returns the existing record."}},"httpPath":"/webhooks/achReturn"},{"label":"Apply NSF/Return Fee","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/achreturns/applyachreturnfee","routeSlug":"/apis/invoice-service/achreturns/applyachreturnfee","metadata":{"seo":{"title":"Apply NSF/Return Fee","description":"Apply an NSF or return fee for a processed ACH return. Creates a debit memoof type NSF_FEE using the account_adjustment table and posts the fee journalentry (DR A/R, CR fee revenue)."}},"httpPath":"/achReturns/{achReturnId}/fee"},{"label":"List ACH Returns for Account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/achreturns/listachreturnsforaccount","routeSlug":"/apis/invoice-service/achreturns/listachreturnsforaccount","metadata":{"seo":{"title":"List ACH Returns for Account","description":"List ACH return records for a specific account with pagination. Optionally filter by status, return-date range, and return-reason code (US-ACH-003)."}},"httpPath":"/accounts/{accountId}/paymentReversals"}]},{"type":"group","label":"AccountAdjustments","link":"/apis/invoice-service/accountadjustments","routeSlug":"/apis/invoice-service/accountadjustments","items":[{"label":"Create Credit Memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/accountadjustments/createcreditmemo","routeSlug":"/apis/invoice-service/accountadjustments/createcreditmemo","metadata":{"seo":{"title":"Create Credit Memo","description":"Create a credit memo for an account. Reduces A/R via a journal entry (DR Contra-Revenue, CR A/R). Generates a sequential memo number (CM-YYYY-NNNNN)."}},"httpPath":"/accounts/{accountId}/creditMemos"},{"label":"Create Debit Memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/accountadjustments/createdebitmemo","routeSlug":"/apis/invoice-service/accountadjustments/createdebitmemo","metadata":{"seo":{"title":"Create Debit Memo","description":"Create a debit memo for an account. Increases A/R via a journal entry (DR A/R, CR Revenue or Fee Revenue). Generates a sequential memo number (DM-YYYY-NNNNN)."}},"httpPath":"/accounts/{accountId}/debitMemos"},{"label":"Write Off Account Balance","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/accountadjustments/writeoffbalance","routeSlug":"/apis/invoice-service/accountadjustments/writeoffbalance","metadata":{"seo":{"title":"Write Off Account Balance","description":"Write off an account balance as uncollectible. Creates a journal entry(DR Bad Debt Expense, CR A/R) and transitions any linked invoice to WRITTEN_OFF.Generates a sequential memo number (WO-YYYY-NNNNN)."}},"httpPath":"/accounts/{accountId}/writeOffs"},{"label":"List Account Adjustments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/accountadjustments/listaccountadjustments","routeSlug":"/apis/invoice-service/accountadjustments/listaccountadjustments","metadata":{"seo":{"title":"List Account Adjustments","description":"List all adjustments (credit memos, debit memos, write-offs) for an account."}},"httpPath":"/accounts/{accountId}/adjustments"}]},{"type":"group","label":"PayerCredits","link":"/apis/invoice-service/payercredits","routeSlug":"/apis/invoice-service/payercredits","items":[{"label":"Create Payer Credit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/payercredits/createpayercredit","routeSlug":"/apis/invoice-service/payercredits/createpayercredit","metadata":{"seo":{"title":"Create Payer Credit","description":"Create a payer credit on an account. Immediately reduces A/R via a journal entry (DR Contra-Revenue, CR A/R) and creates an associated credit memo. Credits have no expiration and are never automatically applied."}},"httpPath":"/accounts/{accountId}/credits"},{"label":"List Payer Credits","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/payercredits/listpayercredits","routeSlug":"/apis/invoice-service/payercredits/listpayercredits","metadata":{"seo":{"title":"List Payer Credits","description":"List all credits for an account with balance summary."}},"httpPath":"/accounts/{accountId}/credits"},{"label":"Apply Credit to Invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/payercredits/applypayercredit","routeSlug":"/apis/invoice-service/payercredits/applypayercredit","metadata":{"seo":{"title":"Apply Credit to Invoice","description":"Apply a payer credit (or portion) to a specific invoice. Reduces the credit's remaining balance and the invoice's amount outstanding. No journal entry is created (the creation entry already reduced A/R). Updates invoice status if fully covered."}},"httpPath":"/accounts/{accountId}/credits/{creditId}/apply"}]},{"type":"group","label":"TaxStatements","link":"/apis/invoice-service/taxstatements","routeSlug":"/apis/invoice-service/taxstatements","items":[{"label":"Generate Tax Statement","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/taxstatements/generatetaxstatement","routeSlug":"/apis/invoice-service/taxstatements/generatetaxstatement","metadata":{"seo":{"title":"Generate Tax Statement","description":"Generate a year-end tax statement for one account. Accepts optional payerPersonId for split-payer statements (RPT-015). Includes monthly breakdown (RPT-014) and per-child payment totals."}},"httpPath":"/accounts/{accountId}/taxStatements"},{"label":"Batch Generate Tax Statements","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/taxstatements/batchgeneratetaxstatements","routeSlug":"/apis/invoice-service/taxstatements/batchgeneratetaxstatements","metadata":{"seo":{"title":"Batch Generate Tax Statements","description":"Batch generate tax statements for all accounts with payments in the specified tax year. Generates one statement per payer per account when multiple payers exist. Phase 11 enriches the request with consuming-application data for center name, center address, EIN, child DOB, and enrollment period. Reuses this endpoint instead of adding /export/taxStatements/bulk."}},"httpPath":"/taxStatements/batch"},{"label":"Get Tax Statement Batch Job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/taxstatements/gettaxstatementbatchjob","routeSlug":"/apis/invoice-service/taxstatements/gettaxstatementbatchjob","metadata":{"seo":{"title":"Get Tax Statement Batch Job","description":"Poll a tax statement batch generation, delivery, or export job. Large Phase 11 batches and archive/CSV downloads return this job shape until the archive is ready."}},"httpPath":"/taxStatements/batchJobs/{batchJobId}"},{"label":"Send Tax Statement","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/taxstatements/sendtaxstatement","routeSlug":"/apis/invoice-service/taxstatements/sendtaxstatement","metadata":{"seo":{"title":"Send Tax Statement","description":"Send a tax statement to contacts via email or push notification."}},"httpPath":"/taxStatements/{taxStatementId}/send"},{"label":"Batch Send Tax Statements","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/taxstatements/batchsendtaxstatements","routeSlug":"/apis/invoice-service/taxstatements/batchsendtaxstatements","metadata":{"seo":{"title":"Batch Send Tax Statements","description":"Batch send all generated statements for a tax year."}},"httpPath":"/taxStatements/batchSend"},{"label":"Get Tax Statement Send History","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/taxstatements/gettaxstatementsendhistory","routeSlug":"/apis/invoice-service/taxstatements/gettaxstatementsendhistory","metadata":{"seo":{"title":"Get Tax Statement Send History","description":"Retrieve send history for a specific tax statement."}},"httpPath":"/taxStatements/{taxStatementId}/sendHistory"},{"label":"Query Tax Statement Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/taxstatements/gettaxstatementstatus","routeSlug":"/apis/invoice-service/taxstatements/gettaxstatementstatus","metadata":{"seo":{"title":"Query Tax Statement Status","description":"Query per-family/payer tax statement status for a given year. Statuses: Not Yet Generated, Generated, Emailed, Downloaded."}},"httpPath":"/taxStatements/status"},{"label":"Download Tax Statements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/taxstatements/downloadtaxstatements","routeSlug":"/apis/invoice-service/taxstatements/downloadtaxstatements","metadata":{"seo":{"title":"Download Tax Statements","description":"Download all tax statements for a year as a ZIP file of PDFs or a consolidated CSV.Small centers (<=200 statements): synchronous 200 with ZIP or CSV body.Large centers: asynchronous 202 with status URL for polling.Exports over 10,000 statements are always asynchronous. ZIP file naming:{taxYear}{accountName}{payerName}.pdf. CSV exports include a UTF-8 BOM."}},"httpPath":"/taxStatements/download"}]},{"type":"group","label":"Reminders","link":"/apis/invoice-service/reminders","routeSlug":"/apis/invoice-service/reminders","items":[{"label":"Process Payment Reminders","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/reminders/processreminders","routeSlug":"/apis/invoice-service/reminders/processreminders","metadata":{"seo":{"title":"Process Payment Reminders","description":"Trigger reminder processing for upcoming due dates. Backoffice job endpoint (like /autoPay/process and /lateFees/assess). Scheduled daily at 6:00 AM, after auto-pay (4 AM)."}},"httpPath":"/reminders/process"}]},{"type":"group","label":"AuthorizationRecords","link":"/apis/invoice-service/authorizationrecords","routeSlug":"/apis/invoice-service/authorizationrecords","items":[{"label":"Store Authorization Language Record","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/authorizationrecords/createauthorizationrecord","routeSlug":"/apis/invoice-service/authorizationrecords/createauthorizationrecord","metadata":{"seo":{"title":"Store Authorization Language Record","description":"Store an authorization language artifact captured at payment confirmation time.Called by Payment Widget Backend. Not consumer-facing."}},"httpPath":"/authorizationRecords"},{"label":"Retrieve Authorization Records (internal - compliance/support)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/authorizationrecords/retrieveauthorizations","routeSlug":"/apis/invoice-service/authorizationrecords/retrieveauthorizations","metadata":{"seo":{"title":"Retrieve Authorization Records (internal - compliance/support)","description":"Retrieve stored one-time payment authorization records for compliance/support (US-AUTH-LANG-002).Supports the two business day SLA for banking partner requests - operational, non-batch access."}},"httpPath":"/authorizations"},{"label":"Authorization Linkage Verification Report (internal)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/invoice-service/authorizationrecords/getauthorizationverificationreport","routeSlug":"/apis/invoice-service/authorizationrecords/getauthorizationverificationreport","metadata":{"seo":{"title":"Authorization Linkage Verification Report (internal)","description":"Verify that one-time payments have a properly linked authorization record and that storedrecords meet NACHA content and affirmative-consent requirements (US-AUTH-LANG-003).Phase 11 extends this report so it can contribute Invoice Service evidence to theon-demand authorization compliance validation package (US-AUTH-LANG-005)."}},"httpPath":"/authorizations/verificationReport"}]}]},{"type":"group","label":"Receipts","items":[{"type":"link","label":"Receipt Service API","link":"/apis/receipts-service","routeSlug":"/apis/receipts-service"},{"type":"link","label":"Key Concepts","link":"/apis/receipts-service/section/key-concepts","routeSlug":"/apis/receipts-service/section/key-concepts"},{"type":"link","label":"Two Receipt Types","link":"/apis/receipts-service/section/two-receipt-types","routeSlug":"/apis/receipts-service/section/two-receipt-types"},{"type":"link","label":"Receipt Generation","link":"/apis/receipts-service/section/receipt-generation","routeSlug":"/apis/receipts-service/section/receipt-generation"},{"type":"link","label":"Error Handling","link":"/apis/receipts-service/section/error-handling","routeSlug":"/apis/receipts-service/section/error-handling"},{"type":"link","label":"Authentication Note","link":"/apis/receipts-service/section/authentication-note","routeSlug":"/apis/receipts-service/section/authentication-note"},{"type":"group","label":"Payment receipts","link":"/apis/receipts-service/receipts","routeSlug":"/apis/receipts-service/receipts","items":[{"label":"List Receipts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/receipts-service/receipts/listreceipts","routeSlug":"/apis/receipts-service/receipts/listreceipts","metadata":{"seo":{"title":"List Receipts","description":"List all receipts for the authenticated merchant"}},"httpPath":"/"},{"label":"Create Receipt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/receipts-service/receipts/createreceipt","routeSlug":"/apis/receipts-service/receipts/createreceipt","metadata":{"seo":{"title":"Create Receipt","description":"Create a new receipt for a payment."}},"httpPath":"/"},{"label":"Get Receipt Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/receipts-service/receipts/getreceipt","routeSlug":"/apis/receipts-service/receipts/getreceipt","metadata":{"seo":{"title":"Get Receipt Details","description":"Retrieve details of a specific receipt"}},"httpPath":"/{receiptId}"},{"label":"Get Receipt HTML","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/receipts-service/receipts/getreceipthtml","routeSlug":"/apis/receipts-service/receipts/getreceipthtml","metadata":{"seo":{"title":"Get Receipt HTML","description":"Generate and return the receipt as HTML for browser viewing."}},"httpPath":"/{receiptId}/html"},{"label":"Resend Receipt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/receipts-service/receipts/resendreceipt","routeSlug":"/apis/receipts-service/receipts/resendreceipt","metadata":{"seo":{"title":"Resend Receipt","description":"Resend a receipt notification to the original recipient, optionally with updated delivery options."}},"httpPath":"/{receiptId}/resend"},{"label":"Get Receipt PDF (Post-MVP)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/receipts-service/receipts/getreceiptpdf","routeSlug":"/apis/receipts-service/receipts/getreceiptpdf","metadata":{"seo":{"title":"Get Receipt PDF (Post-MVP)","description":"Post-MVP. Download the receipt as a PDF document.PDF generation and S3 storage are not included in the MVP release."}},"httpPath":"/{receiptId}/pdf"},{"label":"Create Receipt Delivery","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/receipts-service/receipts/createreceiptdelivery","routeSlug":"/apis/receipts-service/receipts/createreceiptdelivery","metadata":{"seo":{"title":"Create Receipt Delivery","description":"Send or resend a receipt to the original recipient or additional email addresses"}},"httpPath":"/{receiptId}/deliveries"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Receipt Created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/receipts-service/receipts/webhookreceiptcreated","routeSlug":"/apis/receipts-service/receipts/webhookreceiptcreated","metadata":{"seo":{"title":"Receipt Created","description":"Fired when a receipt is successfully generated."}},"httpPath":"receiptCreated"},{"label":"Receipt Sent","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/receipts-service/receipts/webhookreceiptsent","routeSlug":"/apis/receipts-service/receipts/webhookreceiptsent","metadata":{"seo":{"title":"Receipt Sent","description":"Fired when a receipt is delivered via configured channel."}},"httpPath":"receiptSent"},{"label":"Receipt Send Failed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/receipts-service/receipts/webhookreceiptsendfailed","routeSlug":"/apis/receipts-service/receipts/webhookreceiptsendfailed","metadata":{"seo":{"title":"Receipt Send Failed","description":"Fired when receipt delivery fails."}},"httpPath":"receiptSendFailed"}]},{"type":"group","label":"Configuration","link":"/apis/receipts-service/configuration","routeSlug":"/apis/receipts-service/configuration","items":[{"label":"Get Receipt Configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/receipts-service/configuration/getreceiptconfig","routeSlug":"/apis/receipts-service/configuration/getreceiptconfig","metadata":{"seo":{"title":"Get Receipt Configuration","description":"Retrieve the per-merchant receipt configuration stored locally by the Receipt Service."}},"httpPath":"/config"},{"label":"Upsert Receipt Configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/receipts-service/configuration/upsertreceiptconfig","routeSlug":"/apis/receipts-service/configuration/upsertreceiptconfig","metadata":{"seo":{"title":"Upsert Receipt Configuration","description":"Create or update the per-merchant receipt configuration."}},"httpPath":"/config"}]},{"type":"group","label":"Templates","link":"/apis/receipts-service/templates","routeSlug":"/apis/receipts-service/templates","items":[{"label":"List Templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/receipts-service/templates/listtemplates","routeSlug":"/apis/receipts-service/templates/listtemplates","metadata":{"seo":{"title":"List Templates","description":"List available templates for the authenticated merchant. Returns both built-in system templates and merchant-uploaded custom templates."}},"httpPath":"/templates"},{"label":"Create Template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/receipts-service/templates/createtemplate","routeSlug":"/apis/receipts-service/templates/createtemplate","metadata":{"seo":{"title":"Create Template","description":"Upload a new custom Liquid template for receipt or email rendering. The template is created in DRAFT status and must be activated before use. Liquid syntax is validated on creation."}},"httpPath":"/templates"},{"label":"Get Template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/receipts-service/templates/gettemplate","routeSlug":"/apis/receipts-service/templates/gettemplate","metadata":{"seo":{"title":"Get Template","description":"Retrieve a single template by ID, including its full Liquid content."}},"httpPath":"/templates/{templateId}"},{"label":"Update Template","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/receipts-service/templates/updatetemplate","routeSlug":"/apis/receipts-service/templates/updatetemplate","metadata":{"seo":{"title":"Update Template","description":"Update a custom template. System templates cannot be modified. Liquid syntax is re-validated on update. Increments the template version."}},"httpPath":"/templates/{templateId}"},{"label":"Delete Template","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/receipts-service/templates/deletetemplate","routeSlug":"/apis/receipts-service/templates/deletetemplate","metadata":{"seo":{"title":"Delete Template","description":"Delete a custom template. System templates cannot be deleted. If the template is set as the active template in the merchant's configuration, the response uses responseCode E409 in the NPS error envelope."}},"httpPath":"/templates/{templateId}"},{"label":"Validate Template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/receipts-service/templates/validatetemplate","routeSlug":"/apis/receipts-service/templates/validatetemplate","metadata":{"seo":{"title":"Validate Template","description":"Validate Liquid template syntax without persisting. Returns validation results including any syntax errors and unrecognized variable references."}},"httpPath":"/templates/validate"},{"label":"Preview Template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/receipts-service/templates/previewtemplate","routeSlug":"/apis/receipts-service/templates/previewtemplate","metadata":{"seo":{"title":"Preview Template","description":"Render a template with sample data and return the resulting HTML. Useful for previewing how a template will look before activating it."}},"httpPath":"/templates/{templateId}/preview"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Template Created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/receipts-service/templates/webhooktemplatecreated","routeSlug":"/apis/receipts-service/templates/webhooktemplatecreated","metadata":{"seo":{"title":"Template Created","description":"Fired when a new custom Liquid template is created."}},"httpPath":"templateCreated"},{"label":"Template Updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/receipts-service/templates/webhooktemplateupdated","routeSlug":"/apis/receipts-service/templates/webhooktemplateupdated","metadata":{"seo":{"title":"Template Updated","description":"Fired when a custom template is updated."}},"httpPath":"templateUpdated"},{"label":"Template Activated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/receipts-service/templates/webhooktemplateactivated","routeSlug":"/apis/receipts-service/templates/webhooktemplateactivated","metadata":{"seo":{"title":"Template Activated","description":"Fired when a template status changes to ACTIVE."}},"httpPath":"templateActivated"},{"label":"Template Archived","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/receipts-service/templates/webhooktemplatearchived","routeSlug":"/apis/receipts-service/templates/webhooktemplatearchived","metadata":{"seo":{"title":"Template Archived","description":"Fired when a template status changes to ARCHIVED."}},"httpPath":"templateArchived"},{"label":"Template Deleted","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/receipts-service/templates/webhooktemplatedeleted","routeSlug":"/apis/receipts-service/templates/webhooktemplatedeleted","metadata":{"seo":{"title":"Template Deleted","description":"Fired when a custom template is permanently deleted."}},"httpPath":"templateDeleted"}]}]}]},{"type":"group","label":"Standards & Compliance","items":[{"type":"link","fsPath":"docs/api-standards-consolidated.md","metadata":{"type":"markdown"},"label":"API Standards","link":"/docs/api-standards-consolidated","routeSlug":"/docs/api-standards-consolidated"},{"type":"link","fsPath":"docs/response-format.md","metadata":{"type":"markdown"},"label":"Response Format","link":"/docs/response-format","routeSlug":"/docs/response-format"}]},{"type":"group","label":"Webhooks","items":[{"type":"link","label":"Transaction Status Update","link":"/webhooks/transaction-status-update","routeSlug":"/webhooks/transaction-status-update"},{"type":"group","label":"webhooks","link":"/webhooks/transaction-status-update/webhooks","routeSlug":"/webhooks/transaction-status-update/webhooks","items":[{"label":"Transaction Status Update notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/webhooks/transaction-status-update/webhooks/ontransactionstatusupdate","routeSlug":"/webhooks/transaction-status-update/webhooks/ontransactionstatusupdate","metadata":{"seo":{"title":"Transaction Status Update notification","description":"Delivered whenever a payment transaction changes status. The webhook endpoint should return HTTP Response Code 200 to acknowledge receipt."}},"httpPath":"/"}]}]},{"type":"group","label":"Migration & Advanced Topics","items":[{"type":"link","fsPath":"docs/migration-guide-updated.md","metadata":{"type":"markdown"},"label":"Migration Guide (Existing Clients)","link":"/docs/migration-guide-updated","routeSlug":"/docs/migration-guide-updated"}]}]}