references/settings-schema.json

78.6 KB · Oct 2, 2026 · 00:30 UTC
[{"key":"AccountType","path":"/account-types","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"AccountingRules","path":"/accounting-rules","ops":{"GET=PUT":{"allowRevenueScheduleNegativeAmounts":{"type":"boolean"},"allowBlankAccountingCodes":{"type":"boolean"},"allowCreationInClosedPeriod":{"type":"boolean"},"allowUsageInClosedPeriod":{"type":"boolean"},"differentCurrencies":{"type":"boolean"},"useOriginalExchangeRateForCredits":{"type":"boolean"},"cashBasedAccountingStartDate":{"type":"string"},"createJournalEntriesForPendingPayments":{"type":"boolean"}}}},{"key":"AgingBuckets","path":"/aging-buckets","ops":{"GET=PUT":{"includeNegativeInvoice":{"type":"boolean"},"buckets":{"type":"array"}}}},{"key":"ApplicationRules","path":"/application-rules","ops":{"GET=PUT":{"applyItemAllocationRule":{"type":"string","enum":["ApplyProrationRule","ApplyFirstInFirstOut"]},"unapplyItemAllocationRule":{"type":"string","enum":["UnapplyFirstInFirstOut"]}}}},{"key":"ApprovalRule","path":"/approval-rule","ops":{"GET":{"success":{"type":"boolean","required":true}}}},{"key":"AuditTrailSettings","path":"/audit-trail-settings","ops":{"GET=PUT":{"campaignDefinition":{"type":"boolean","desc":"Specifies whether the HPM Campaign Definition object changes will be audited or not."},"advancedSMTPServerSetting":{"type":"boolean","desc":"Specifies whether the Advanced SMTP Server Setting object changes will be audited or not."},"notificationDefinition":{"type":"boolean","desc":"Specifies whether the Notification Definition object changes will be audited or not."},"emailTemplate":{"type":"boolean","desc":"Specifies whether the Email Template object changes will be audited or not."},"calloutTemplate":{"type":"boolean","desc":"Specifies whether the Callout Template object changes will be audited or not."},"productCatalog":{"type":"boolean","desc":"Specifies whether the Product Catalog object changes will be audited or not."},"calloutOption":{"type":"boolean","desc":"Specifies whether the Callout Option object changes will be audited or not."},"customScheduledEvent":{"type":"boolean","desc":"Specifies whether the Custom Scheduled Event object changes will be audited or not."},"customFieldDefinition":{"type":"boolean","desc":"Specifies whether the custom Field Definition object changes will be audited or not."},"communicationProfile":{"type":"boolean","desc":"Specifies whether the Communication Profile object changes will be audited or not."},"orderLineItem":{"type":"boolean","desc":"Specifies whether the order line item object changes will be audited or not."},"customEvent":{"type":"boolean","desc":"Specifies whether the Custom Event object changes will be audited or not."},"contact":{"type":"boolean","desc":"Specifies whether the contact object changes will be audited or not."},"paymentSchedule":{"type":"boolean","desc":"Specifies whether the payment Schedule object changes will be audited or not."},"paymentMethod":{"type":"boolean","desc":"Specifies whether the Payment Method object changes will be audited or not."},"payment":{"type":"boolean","desc":"Specifies whether the payment object changes will be audited or not."},"account":{"type":"boolean","desc":"Specifies whether the account object changes will be audited or not."},"refund":{"type":"boolean","desc":"Specifies whether the refund object changes will be audited or not."},"paymentGateway":{"type":"boolean","desc":"Specifies whether the payment Gateway object changes will be audited or not."},"hpmCaptchaCredential":{"type":"boolean","desc":"Specifies whether the HPM Captcha Credential object changes will be audited or not."},"oauth2Provider":{"type":"boolean","desc":"Specifies whether the Oauth2 Provider object changes will be audited or not."}}}},{"key":"AugmentationRule","path":"/augmentation-rules","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"BatchAliases","path":"/batch-aliases","ops":{"GET=PUT":{"aliases":{"type":"array"}}}},{"key":"BillingCycleType","path":"/billing-cycle-types","ops":{"GET=PUT":{"billingCycleTypes":{"type":"array"}}}},{"key":"BillingListPriceBase","path":"/billing-list-price-bases","ops":{"GET=PUT":{"listPriceBase":{"type":"array"}}}},{"key":"BillingPeriodStart","path":"/billing-period-starts","ops":{"GET=PUT":{"billingPeriodStartDays":{"type":"array"}}}},{"key":"BillingPeriod","path":"/billing-periods","ops":{"GET=PUT":{"billingPeriods":{"type":"array"}}}},{"key":"BillingRules","path":"/billing-rules","ops":{"GET=PUT":{"prepaymentChargeProrationRule":{"type":"string","enum":["ProrateAmount","ChargeFullAmount"]},"prorationUnit":{"type":"string","enum":["ProrateByDay","ProrateByMonthFirst"]},"prorateUsageWeeklyCharges":{"type":"boolean"},"ratingDetailGenerationTiming":{"type":"string","enum":["AfterInvoice","WithInvoice"]},"preGenerateInvoicePdf":{"type":"boolean"},"sequentialInvoiceNumber":{"type":"boolean","desc":"Enable Sequential Billing Document Number"},"availableToCreditValidationLevel":{"type":"string"},"timeOfDailyInvoice":{"type":"integer","min":0,"max":23},"taxInclusiveRoundingRule":{"type":"string","enum":["RoundingNetAmount","RoundingTaxAmount"]},"taxPreview":{"type":"boolean"},"billToTermEndWhenAutoRenew":{"type":"boolean","desc":"Invoice Past End-of-Term when Auto-Renew is ON"},"discountCreditProration":{"type":"boolean"},"customerHierarchy":{"type":"boolean"},"recurringChargeStyle":{"type":"string","enum":["Advanced","Arrears","DependsOnRatePlan"]},"takeContactSnapshot":{"type":"boolean"},"prorateRecurringMonthlyCharges":{"type":"boolean"},"proratePeriodOfRecurringCharge":{"type":"boolean","desc":"Prorate recurring charges for partial period"},"useAvalaraTaxCalculationForIIA":{"type":"boolean","desc":"Use Avalara to calculate taxes for invoice item adjustments"},"prorateRecurringWeeklyCharges":{"type":"boolean"},"consolidateInvoices":{"type":"boolean","desc":"Allow invoices consolidation"},"invoicePastTermEndWhenChargeEndDateOnOrBeforeTermEndDate":{"type":"string","enum":["BillFullWhenChargeEndDateOnOrBeforeTermEndDate","BillPartialWhenChargeEndDateOnOrBeforeTermEndDate"],"desc":"Options for creating invoicePastTermEndWhenChargeEndDateOnOrBeforeTermEndDate"},"availableToCreditIncludingRbeCreditMemo":{"type":"boolean"},"useSystemDefaultSuffixForCreditItems":{"type":"boolean"},"includeNegativeInvoice":{"type":"boolean"},"recurringCreditProrationOption":{"type":"string"},"discountConsolidated":{"type":"boolean"},"invoiceSplit":{"type":"boolean","desc":"Allow invoice splitting"},"notSendZeroItemsForTax":{"type":"boolean"},"copyBillingAttributesFromAccountForStandaloneInvoice":{"type":"boolean"},"zuoraNumberFormatForMergeField":{"type":"boolean","desc":"Format numeric merge fields based on communication profile locales"},"writeOffAllocationRule":{"type":"string"},"monthEndCleanup":{"type":"boolean"},"autoRenewalBillRun":{"type":"boolean"},"invoicePastEndOfTerm":{"type":"boolean","desc":"Invoice Past End-of-Term when Auto-Renew is OFF"},"oneTimeCreditBack":{"type":"boolean"},"debookRebookSupportable":{"type":"boolean","desc":"Apply new tax rate for additional units purchased and old tax rate for returns"},"includeChildUsage":{"type":"boolean"},"allowAutoPostBillRun":{"type":"boolean"},"taxAddressOwner":{"type":"string","enum":["SubscriptionOwner","InvoiceOwner"]},"copyBillingAttributesFromAccount":{"type":"boolean"},"prorateUsageMonthlyCharges":{"type":"boolean"},"allowIndistinctMapping":{"type":"boolean","desc":"Allow indistinct mapping from Memo / Invoice Item Adjustment tax item to invoice item tax"},"stackedDiscountClassApplyRule":{"type":"string","enum":["IgnoreDiscountClass","FollowDiscountClass"]},"autoPostBillRunDefaultValue":{"type":"boolean"},"creditMemoMirroringInvoiceItemsRule":{"type":"string","enum":["YesExceptForZeroItems","Yes","No"],"desc":"Options for creating credit memos mirroring invoice items"},"daysInMonth":{"type":"string","enum":["Assume30Days","UseActualDays","Assume30DaysStrict"]},"legalDocumentGeneratingRule":{"type":"string","enum":["GroupbyChargedAmountSign","GroupByOriginalSRPC","GroupByTotalAmountSign","GroupByChargedAmountSignWithZero"]},"transactionOnSubscription":{"type":"boolean"},"numberAssignmentTiming":{"type":"string"},"catchUpBillRun":{"type":"boolean"},"taxRateChangeOption":{"type":"string"},"zuoraTaxRoundingDiffDispersion":{"type":"boolean","desc":"Enable re-distribution of Zuora Tax Rounding difference"},"rateUsageIndividually":{"type":"boolean"},"taxGroupingRule":{"type":"string"}}}},{"key":"Book","path":"/books","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"Calendar","path":"/calendar","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"ChargeModels","path":"/charge-models","ops":{"GET=PUT":{"chargeModels":{"type":"array"}}}},{"key":"ChargeType","path":"/charge-types","ops":{"GET=PUT":{"chargeTypes":{"type":"array"}}}},{"key":"ChartOfAccounts","path":"/chart-of-accounts","ops":{"POST":{"segmentConstantValues":{"type":"object","desc":"Map of segment constant values for Accounting Code Item"},"glaccountNumber":{"type":"string","desc":"General Ledger Account Number"},"notes":{"type":"string","desc":"Any additional notes for Accounting Code Item"},"glaccountName":{"type":"string","desc":"General Ledger Account Name"},"customFieldsValues":{"type":"object","desc":"Map of custom fields for Accounting Code Item"},"name":{"type":"string","desc":"Name of Accounting Code Item"},"id":{"type":"string","desc":"Unique Id of Accounting Code Item"},"category":{"type":"string","desc":"Category of Accounting Code Item (Assets, Revenue, Liabilities etc)"},"type":{"type":"string","desc":"Type of Accounting Code Item (Cash, Sales Revenue, Other Assets etc)"},"status":{"type":"string","desc":"Status of Accounting Code Item"}}}},{"key":"ChartOfAccountsItem","path":"/chart-of-accounts/{id}","ops":{"GET=PUT":{"segmentConstantValues":{"type":"object","desc":"Map of segment constant values for Accounting Code Item"},"glaccountNumber":{"type":"string","desc":"General Ledger Account Number"},"notes":{"type":"string","desc":"Any additional notes for Accounting Code Item"},"glaccountName":{"type":"string","desc":"General Ledger Account Name"},"customFieldsValues":{"type":"object","desc":"Map of custom fields for Accounting Code Item"},"name":{"type":"string","desc":"Name of Accounting Code Item"},"id":{"type":"string","desc":"Unique Id of Accounting Code Item"},"category":{"type":"string","desc":"Category of Accounting Code Item (Assets, Revenue, Liabilities etc)"},"type":{"type":"string","desc":"Type of Accounting Code Item (Cash, Sales Revenue, Other Assets etc)"},"status":{"type":"string","enum":["Active","Inactive"],"desc":"Status of Accounting Code Item"}}}},{"key":"AllCommunicationProfiles","path":"/communication-profiles","ops":{"POST":{"number":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"locale":{"type":"string"},"muted":{"type":"boolean"}}}},{"key":"CommunicationProfileNotification","path":"/communication-profiles/notifications/{id}","ops":{"GET=PUT":{"hidden":{"type":"boolean"},"description":{"type":"string"},"httpMethod":{"type":"string"},"calloutOauth2Id":{"type":"string"},"filterRuleId":{"type":"string"},"calloutOption":{"type":"boolean"},"calloutAuthDomain":{"type":"string"},"calloutPreemptiveAuth":{"type":"boolean","desc":"Enable Preemptive Authentication"},"calloutPassword":{"type":"string"},"eventName":{"type":"string"},"id":{"type":"string"},"contentType":{"type":"string"},"eventId":{"type":"string"},"emailTemplate":{"type":"string"},"calloutAuth":{"type":"boolean"},"emailOption":{"type":"boolean"},"calloutRetriable":{"type":"boolean"},"active":{"type":"boolean"},"param3":{"type":"string"},"params":{"type":"object"},"param4":{"type":"string"},"calloutBaseUrl":{"type":"string"},"param1":{"type":"string"},"param2":{"type":"string"},"profileId":{"type":"string"},"name":{"type":"string"},"calloutUsername":{"type":"string"},"calloutParams":{"type":"string"},"calloutOauth2":{"type":"boolean"},"emailTemplateName":{"type":"string"}}}},{"key":"CommunicationProfile","path":"/communication-profiles/{id}","ops":{"GET":{"number":{"type":"string"},"isDefault":{"type":"boolean"},"name":{"type":"string"},"description":{"type":"string"},"id":{"type":"string"},"locale":{"type":"string"},"muted":{"type":"boolean"}},"PUT":{"number":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"locale":{"type":"string"},"muted":{"type":"boolean"}}}},{"key":"CommunicationProfileAssociatedObjects","path":"/communication-profiles/{id}/associated-objects","ops":{"GET":{"success":{"type":"boolean","desc":"Indicates whether the request was successful"},"associatedObjectCounts":{"type":"object"}}}},{"key":"AllCommunicationProfileNotifications","path":"/communication-profiles/{id}/notifications","ops":{"POST":{"hidden":{"type":"boolean"},"description":{"type":"string"},"httpMethod":{"type":"string"},"calloutOauth2Id":{"type":"string"},"filterRuleId":{"type":"string"},"calloutOption":{"type":"boolean"},"calloutAuthDomain":{"type":"string"},"calloutPreemptiveAuth":{"type":"boolean","desc":"Enable Preemptive Authentication"},"calloutPassword":{"type":"string"},"eventName":{"type":"string"},"id":{"type":"string"},"contentType":{"type":"string"},"muted":{"type":"boolean"},"eventId":{"type":"string"},"emailTemplate":{"type":"string"},"calloutAuth":{"type":"boolean"},"emailOption":{"type":"boolean"},"calloutRetriable":{"type":"boolean"},"active":{"type":"boolean"},"param3":{"type":"string"},"params":{"type":"object"},"param4":{"type":"string"},"calloutBaseUrl":{"type":"string"},"param1":{"type":"string"},"param2":{"type":"string"},"profileId":{"type":"string"},"name":{"type":"string"},"calloutUsername":{"type":"string"},"calloutParams":{"type":"string"},"calloutOauth2":{"type":"boolean"},"emailTemplateName":{"type":"string"}}}},{"key":"ConfigurableUISetting","path":"/configurable-ui-enabled","ops":{}},{"key":"ConfigurableUIHomepage","path":"/configurable-ui-homepage-enabled","ops":{}},{"key":"ConfigurableUIListView","path":"/configurable-ui-list-view-enabled","ops":{}},{"key":"ContractModification","path":"/contract-modification","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}},"PUT":{"timeline":{"type":"object","desc":"Contract modification timeline settings (RPRO_CT_MOD_TIMELINE)."},"rules":{"type":"array","required":true}}}},{"key":"CostField","path":"/cost-fields","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"CostFormula","path":"/cost-formulas","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"CostRule","path":"/cost-rules","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"CostStrat","path":"/cost-strats","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"CostType","path":"/cost-types","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"AllCreditMemoTemplates","path":"/credit-memo-templates","ops":{"POST":{"templateCategory":{"type":"string","enum":["Old","New"],"desc":"The category of the template"},"base64EncodedTemplateFileContent":{"type":"string","desc":"The template file contents as a base64 encoded string","required":true},"templateNumber":{"type":"string"},"suppressZeroValueLine":{"type":"boolean","desc":"Should zero valued lines be suppressed and not shown in the eventual Credit Memo"},"name":{"type":"string","desc":"The name of the template","required":true},"defaultTemplate":{"type":"boolean","desc":"Is this template the default template."},"templateFileName":{"type":"string","desc":"The name of the template file."},"templateFormat":{"type":"string","enum":["WORD","HTML"],"desc":"The format of the template file."}}}},{"key":"CreditMemoTemplatesReplacements","path":"/credit-memo-templates-replacements","ops":{"POST":{"newTemplateId":{"type":"string"},"currentTemplateId":{"type":"string"}}}},{"key":"CreditMemoTemplate","path":"/credit-memo-templates/{id}","ops":{"GET":{"templateCategory":{"type":"string","enum":["Old","New"],"desc":"The category of the template"},"base64EncodedTemplateFileContent":{"type":"string","desc":"The template file contents as a base64 encoded string"},"templateNumber":{"type":"string"},"suppressZeroValueLine":{"type":"boolean","desc":"Should zero valued lines be suppressed and not shown in the eventual Credit Memo"},"name":{"type":"string","desc":"The name of the template"},"defaultTemplate":{"type":"boolean","desc":"Is this template the default template."},"templateFileName":{"type":"string","desc":"The name of the template file."},"id":{"type":"string","desc":"The unique identifier of the template"},"updatedOn":{"type":"string"},"associatedToBillingAccount":{"type":"boolean"},"templateFormat":{"type":"string","enum":["WORD","HTML"],"desc":"The format of the template file."}},"PUT":{"base64EncodedTemplateFileContent":{"type":"string","desc":"The template file contents as a base64 encoded string"},"templateNumber":{"type":"string"},"suppressZeroValueLine":{"type":"boolean","desc":"Should zero valued lines be suppressed and not shown in the eventual Invoice"},"name":{"type":"string","desc":"The name of the template"},"defaultTemplate":{"type":"boolean","desc":"Is this template the default template."},"templateFileName":{"type":"string","desc":"The name of the template file."}}}},{"key":"Currency","path":"/currencies","ops":{"GET=PUT":{"currencies":{"type":"array"}}}},{"key":"CurrencySetup","path":"/currency","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"AllCustomFields","path":"/custom-fields/{namespace}","ops":{"GET":{"count":{"type":"integer"},"definitions":{"type":"object"}}}},{"key":"CustomField","path":"/custom-fields/{namespace}/{type}","ops":{"GET":{"schema":{"type":"object"},"createdDate":{"type":"string"},"id":{"type":"string"},"updatedDate":{"type":"string"},"type":{"type":"string"},"updatedById":{"type":"string"},"createdById":{"type":"string"}}}},{"key":"CustomFileUpload","path":"/custom-file-upload","ops":{}},{"key":"AllCustomObjectNamespaces","path":"/custom-object-namespaces","ops":{"GET":{"count":{"type":"integer"},"namespaces":{"type":"array"}},"POST":{"origin":{"type":"string"},"name":{"type":"string"}}}},{"key":"CustomObjectNamespace","path":"/custom-object-namespaces/{namespace}","ops":{"GET":{"CreatedById":{"type":"string"},"UpdatedDate":{"type":"string"},"UpdatedById":{"type":"string"},"origin":{"type":"string"},"name":{"type":"string"},"CreatedDate":{"type":"string"},"Id":{"type":"string"}}}},{"key":"AllCustomObjects","path":"/custom-objects/{namespace}","ops":{"GET":{"count":{"type":"integer"},"definitions":{"type":"object"}}}},{"key":"CustomObject","path":"/custom-objects/{namespace}/{type}","ops":{"GET":{"schema":{"type":"object"},"CreatedById":{"type":"string"},"UpdatedDate":{"type":"string"},"UpdatedById":{"type":"string"},"CreatedDate":{"type":"string"},"Id":{"type":"string"},"type":{"type":"string"}}}},{"key":"DataAccessControl","path":"/data-access-controls","ops":{"GET":{"hierarchyDefinition":{"type":"object"},"hierarchyInfo":{"type":"object"}}}},{"key":"DataAccessInfo","path":"/data-access-info","ops":{"GET=PUT":{"apiName":{"type":"string"},"active":{"type":"boolean"},"description":{"type":"string"},"label":{"type":"string"}}}},{"key":"DataAccessHierarchy","path":"/data-access-tags","ops":{"GET":{"children":{"type":"array"},"name":{"type":"string"},"id":{"type":"string"}},"POST":{"children":{"type":"array"},"name":{"type":"string"}}}},{"key":"DataAccessTag","path":"/data-access-tags/{id}","ops":{"GET":{"children":{"type":"array"},"name":{"type":"string"},"id":{"type":"string"},"parentId":{"type":"string"}}}},{"key":"AllDebitMemoTemplates","path":"/debit-memo-templates","ops":{"POST":{"templateCategory":{"type":"string","enum":["Old","New"],"desc":"The category of the template"},"base64EncodedTemplateFileContent":{"type":"string","desc":"The template file contents as a base64 encoded string","required":true},"templateNumber":{"type":"string"},"suppressZeroValueLine":{"type":"boolean","desc":"Should zero valued lines be suppressed and not shown in the eventual Debit Memo"},"name":{"type":"string","desc":"The name of the template","required":true},"defaultTemplate":{"type":"boolean","desc":"Is this template the default template."},"templateFileName":{"type":"string","desc":"The name of the template file."},"templateFormat":{"type":"string","enum":["WORD","HTML"],"desc":"The format of the template file."}}}},{"key":"DebitMemoTemplatesReplacements","path":"/debit-memo-templates-replacements","ops":{"POST":{"newTemplateId":{"type":"string"},"currentTemplateId":{"type":"string"}}}},{"key":"DebitMemoTemplate","path":"/debit-memo-templates/{id}","ops":{"GET":{"templateCategory":{"type":"string","enum":["Old","New"],"desc":"The category of the template"},"base64EncodedTemplateFileContent":{"type":"string","desc":"The template file contents as a base64 encoded string"},"templateNumber":{"type":"string"},"suppressZeroValueLine":{"type":"boolean","desc":"Should zero valued lines be suppressed and not shown in the eventual Debit Memo"},"name":{"type":"string","desc":"The name of the template"},"defaultTemplate":{"type":"boolean","desc":"Is this template the default template."},"templateFileName":{"type":"string","desc":"The name of the template file."},"id":{"type":"string","desc":"The unique identifier of the template"},"updatedOn":{"type":"string"},"associatedToBillingAccount":{"type":"boolean"},"templateFormat":{"type":"string","enum":["WORD","HTML"],"desc":"The format of the template file."}},"PUT":{"base64EncodedTemplateFileContent":{"type":"string","desc":"The template file contents as a base64 encoded string"},"templateNumber":{"type":"string"},"suppressZeroValueLine":{"type":"boolean","desc":"Should zero valued lines be suppressed and not shown in the eventual Invoice"},"name":{"type":"string","desc":"The name of the template"},"defaultTemplate":{"type":"boolean","desc":"Is this template the default template."},"templateFileName":{"type":"string","desc":"The name of the template file."}}}},{"key":"DefaultAccountingCodes","path":"/default-accounting-codes","ops":{"GET=PUT":{"adjustmentLiabilityAccountingCode":{"type":"string"},"contractLiabilityAccountingCode":{"type":"string"},"unbilledReceivablesAccountingCode":{"type":"string"},"contractAssetAccountingCode":{"type":"string"},"recognizedRevenueAccountingCode":{"type":"string"},"deferredRevenueAccountingCode":{"type":"string"},"contractRecognizedRevenueAccountingCode":{"type":"string"},"accountsReceivableAccountingCode":{"type":"string"},"salesTaxPayableAccountingCode":{"type":"string"},"revenueRecognitionRuleName":{"type":"string"},"adjustmentRevenueAccountingCode":{"type":"string"}}}},{"key":"DefaultPaymentGateway","path":"/default-payment-gateways","ops":{}},{"key":"DisclosureAggregation","path":"/disclosure-aggregation","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"AllDiscountSettings","path":"/discount-settings","ops":{"GET":{"discounts":{"type":"array"}},"POST":{"name":{"type":"string"},"active":{"type":"boolean"},"id":{"type":"string"},"priority":{"type":"integer"}}}},{"key":"DiscountSettings","path":"/discount-settings/{id}","ops":{"GET=PUT":{"name":{"type":"string"},"active":{"type":"boolean"},"id":{"type":"string"},"priority":{"type":"integer"}}}},{"key":"DocPrefix","path":"/doc-prefixes","ops":{"GET=PUT":{"refundPrefix":{"type":"object"},"paymentPrefix":{"type":"object"},"creditMemo":{"type":"object"},"invoice":{"type":"object"},"debitMemo":{"type":"object"}}}},{"key":"DocumentFilenamePatterns","path":"/document-filename-patterns","ops":{"GET=PUT":{"creditMemo":{"type":"string"},"invoice":{"type":"string"},"debitMemo":{"type":"string"}}}},{"key":"DocumentGenerationSetting","path":"/document-generation-setting","ops":{"GET":{"success":{"type":"boolean"},"enabled":{"type":"boolean"}},"PUT":{"enabled":{"type":"boolean"}}}},{"key":"DocumentTemplateAttachment","path":"/document-template-attachments","ops":{"POST":{"fileName":{"type":"string","desc":"The name of the file","required":true},"attachmentType":{"type":"string","enum":["Image"],"desc":"The type of the attachment","required":true},"fileContent":{"type":"string","desc":"The image file contents as a base64 encoded string","required":true}}}},{"key":"AllDocumentTemplateAttachment","path":"/document-template-attachments/{id}","ops":{}},{"key":"EmailTemplate","path":"/email-template","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"AllEntityNodes","path":"/entity-nodes","ops":{"GET":{"nodes":{"type":"array"}},"POST":{"displayName":{"type":"string"},"timezone":{"type":"string"},"name":{"type":"string"},"locale":{"type":"string"},"parentId":{"type":"string"}}}},{"key":"EntityNode","path":"/entity-nodes/{entityId}","ops":{"GET=PUT":{"provisioned":{"type":"boolean"},"displayName":{"type":"string"},"timezone":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"},"locale":{"type":"string"},"parentId":{"type":"string"}}}},{"key":"EntityProfileAttachment","path":"/entity-profile-attachments","ops":{"GET":{"availableStorage":{"type":"string"},"maxAttachments":{"type":"integer"},"storageLimit":{"type":"string"}}}},{"key":"EntityProfileChangeHistory","path":"/entity-profile-change-history","ops":{"GET":{"changeHistory":{"type":"array"}}}},{"key":"EntityProfileInfo","path":"/entity-profile-info","ops":{"GET":{"country":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"address1":{"type":"string"},"postalCode":{"type":"string"},"timeZone":{"type":"string"},"displayEnvironmentBanner":{"type":"boolean"},"entityID":{"type":"string"},"entityDisplayName":{"type":"string"},"bannerLabel":{"type":"string"},"locale":{"type":"string"},"tenantName":{"type":"string"},"entityName":{"type":"string"},"tenantId":{"type":"string"},"state":{"type":"string"},"bannerColor":{"type":"string"},"email":{"type":"string"},"status":{"type":"string"},"expirationDate":{"type":"string"}},"PUT":{"country":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"address1":{"type":"string"},"postalCode":{"type":"string"},"displayEnvironmentBanner":{"type":"boolean"},"state":{"type":"string"},"bannerLabel":{"type":"string"},"locale":{"type":"string"},"bannerColor":{"type":"string","enum":["Rose","Teal","Aqua","Navy","Blue_Grey"]},"email":{"type":"string"}}}},{"key":"Event","path":"/event","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"ExternalSmtp","path":"/external-smtp","ops":{"GET=PUT":{"externalSmtp":{"type":"object"},"smtpServerType":{"type":"string"}}}},{"key":"ForecastTemplate","path":"/fcst-template","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"FileUploadBundle","path":"/file-upload-bundle","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"FileUploadCustom","path":"/file-upload-custom","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"FileUploadEvents","path":"/file-upload-events","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"FileUploadForecast","path":"/file-upload-forecast","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"FileUploadTransactions","path":"/file-upload-transactions","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"fileUploadVc","path":"/file-upload-vc","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"AllFinanceSegmentationRules","path":"/finance-segmentation-rules","ops":{"POST":{"specificTransactionTypesSegments":{"type":"array"},"defaultSegments":{"type":"array"},"name":{"type":"string"},"description":{"type":"string"},"active":{"type":"boolean"},"id":{"type":"string","desc":"Unique Id of the segmentation rule "}}}},{"key":"FinanceSegmentationRule","path":"/finance-segmentation-rules/{id}","ops":{"GET=PUT":{"specificTransactionTypesSegments":{"type":"array"},"defaultSegments":{"type":"array"},"name":{"type":"string"},"description":{"type":"string"},"active":{"type":"boolean"},"id":{"type":"string","desc":"Unique Id of the segmentation rule "}}}},{"key":"StandaloneOrders","path":"/finance/standalone-orders","ops":{"GET=PUT":{"adjustmentLiabilityAccountingCode":{"type":"string"},"contractLiabilityAccountingCode":{"type":"string"},"unbilledReceivablesAccountingCode":{"type":"string"},"contractAssetAccountingCode":{"type":"string"},"recognizedRevenueAccountingCode":{"type":"string"},"deferredRevenueAccountingCode":{"type":"string"},"contractRecognizedRevenueAccountingCode":{"type":"string"},"accountsReceivableAccountingCode":{"type":"string"},"salesTaxPayableAccountingCode":{"type":"string"},"revenueRecognitionRuleName":{"type":"string"},"adjustmentRevenueAccountingCode":{"type":"string"}}}},{"key":"AllFunctions","path":"/functions/{namespace}","ops":{"GET":{"functions":{"type":"array"},"count":{"type":"integer"}},"POST":{"output":{"type":"array"},"input":{"type":"array"},"service":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"hook_points":{"type":"array"},"label":{"type":"string"},"tag":{"type":"string"},"type":{"type":"string","enum":["VALIDATION","RECORD_UPDATE","NONE"]},"script":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","INACTIVE","DRAFT"]}}}},{"key":"Functions","path":"/functions/{namespace}/{name}","ops":{"GET":{"description":{"type":"string"},"label":{"type":"string"},"updatedOn":{"type":"string"},"type":{"type":"string","enum":["VALIDATION","RECORD_UPDATE","NONE"]},"createdOn":{"type":"string"},"script":{"type":"string"},"output":{"type":"array"},"input":{"type":"array"},"service":{"type":"string"},"name":{"type":"string"},"hook_points":{"type":"array"},"tag":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","INACTIVE","DRAFT"]}},"PUT":{"output":{"type":"array"},"input":{"type":"array"},"service":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"hook_points":{"type":"array"},"label":{"type":"string"},"tag":{"type":"string"},"type":{"type":"string","enum":["VALIDATION","RECORD_UPDATE","NONE"]},"script":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","INACTIVE","DRAFT"]}}}},{"key":"FxCurrency","path":"/fx-currencies","ops":{"GET=PUT":{"roundingMode":{"enum":["RoundDown","RoundHalfUp"]},"customRateEnabled":{"type":"boolean"},"dayOfMonth":{"type":"integer","min":1,"max":31},"rateSetName":{"type":"string"},"rateDateType":{"enum":["Daily","Monthly"]},"homeCurrencyCode":{"type":"string"},"useInverseRate":{"type":"boolean"},"exportEnabled":{"type":"boolean"},"reportingCurrencyCode":{"type":"string","desc":"Support reporting currency for finance reports"},"rateOffset":{"type":"integer","min":0,"max":2}}}},{"key":"GlMapping","path":"/gl-mapping","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"GLSegments","path":"/gl-segments","ops":{"GET=PUT":{"revenueOwnerSegmentValue":{"type":"string","enum":["useSubscriptionOwner","useInvoiceOwner"]},"segmentDelimiterValue":{"type":"string"},"discountSegmentValue":{"type":"string","enum":["AlwaysUseOwnSegment","AlwaysUseAppliedSegment","UseSegmentBaseOnChargeFlag"]},"defaultBlankSegmentValue":{"type":"string"},"invoiceOwnerSegmentValue":{"type":"string","enum":["useSubscriptionOwner","useInvoiceOwner"]},"segments":{"type":"array"}}}},{"key":"AllHostedPaymentMethodPages","path":"/hosted-payment-method-pages","ops":{"POST":{"css":{"type":"string"},"enableMandatePage":{"type":"boolean"},"pageTitle":{"type":"string"},"pageTitleEnabled":{"type":"boolean"},"enable3ds":{"type":"boolean"},"invalidCvvMessage":{"type":"string"},"type":{"type":"string"},"pageName":{"type":"string"},"stopServeThreshold":{"type":"integer"},"callbackPath":{"type":"string"},"pageDescription":{"type":"string"},"invalidCreditCardNumberMessage":{"type":"string"},"pageVersion":{"type":"number"},"creditCardNumberClientValidationEnabled":{"type":"boolean"},"invalidRequiredMessage":{"type":"string"},"captchaThreshold":{"type":"integer"},"fieldDefinitions":{"type":"array"},"creditCardTypeAutomaticDetectionEnabled":{"type":"boolean"},"pageDescriptionEnabled":{"type":"boolean"},"domain":{"type":"string"},"invalidCreditCardTypeMessage":{"type":"string"},"allowSubDomain":{"type":"boolean"},"subType":{"type":"string"},"mandatePageTemplate":{"type":"string"},"paymentGateway":{"type":"string"}}}},{"key":"HostedPaymentMethodPage","path":"/hosted-payment-method-pages/{id}","ops":{"GET":{"css":{"type":"string"},"enableMandatePage":{"type":"boolean"},"pageTitle":{"type":"string"},"pageTitleEnabled":{"type":"boolean"},"enable3ds":{"type":"boolean"},"invalidCvvMessage":{"type":"string"},"type":{"type":"string"},"pageName":{"type":"string"},"stopServeThreshold":{"type":"integer"},"callbackPath":{"type":"string"},"pageDescription":{"type":"string"},"id":{"type":"string"},"invalidCreditCardNumberMessage":{"type":"string"},"pageVersion":{"type":"number"},"creditCardNumberClientValidationEnabled":{"type":"boolean"},"invalidRequiredMessage":{"type":"string"},"captchaThreshold":{"type":"integer"},"fieldDefinitions":{"type":"array"},"creditCardTypeAutomaticDetectionEnabled":{"type":"boolean"},"pageDescriptionEnabled":{"type":"boolean"},"domain":{"type":"string"},"invalidCreditCardTypeMessage":{"type":"string"},"allowSubDomain":{"type":"boolean"},"subType":{"type":"string"},"mandatePageTemplate":{"type":"string"},"paymentGateway":{"type":"string"}}}},{"key":"AllInboundEntityConnections","path":"/inbound-entity-connections","ops":{"GET":{"currentId":{"type":"string"},"connections":{"type":"array"}}}},{"key":"InboundEntityConnection","path":"/inbound-entity-connections/{entityId}","ops":{"GET":{"otherId":{"type":"string"},"status":{"enum":["connected","pending","requested","notConnected"]}},"PUT":{"reply":{"enum":["accept","deny"]}}}},{"key":"InsightsConnection","path":"/insights-connections","ops":{"GET=PUT":{"domain":{"type":"string"}}}},{"key":"InvoiceGroups","path":"/invoice-groups","ops":{"POST":{"meta":{"type":"object","desc":"Invoice Group Meta. It is updated atomically as a whole. Partial updates are not supported, as the groups must be considered as a complete unit.","required":true},"name":{"type":"string","desc":"Group Name, less than 255 characters. Allowed are letters, numbers, spaces, and the following special characters: - _ ( ) . &","required":true}}}},{"key":"InvoiceGroup","path":"/invoice-groups/{id}","ops":{"GET":{"number":{"type":"string","desc":"Auto-generated natural key"},"meta":{"type":"object","desc":"Invoice Group Meta. It is updated atomically as a whole. Partial updates are not supported, as the groups must be considered as a complete unit."},"name":{"type":"string","desc":"Group Name"},"id":{"type":"string","desc":"Auto-generated uuid"}},"PUT":{"meta":{"type":"object","desc":"Invoice Group Meta. It is updated atomically as a whole. Partial updates are not supported, as the groups must be considered as a complete unit.","required":true},"name":{"type":"string","desc":"Group Name, less than 255 characters. Allowed are letters, numbers, spaces, and the following special characters: - _ ( ) . &","required":true}}}},{"key":"AllInvoiceTemplates","path":"/invoice-templates","ops":{"POST":{"templateCategory":{"type":"string","enum":["Old","New"],"desc":"The category of the template"},"base64EncodedTemplateFileContent":{"type":"string","desc":"The template file contents as a base64 encoded string","required":true},"templateNumber":{"type":"string"},"suppressZeroValueLine":{"type":"boolean","desc":"Should zero valued lines be suppressed and not shown in the eventual Invoice"},"name":{"type":"string","desc":"The name of the template","required":true},"defaultTemplate":{"type":"boolean","desc":"Is this template the default template."},"templateFileName":{"type":"string","desc":"The name of the template file."},"templateFormat":{"type":"string","enum":["WORD","HTML"],"desc":"The format of the template file."}}}},{"key":"InvoiceTemplatesReplacements","path":"/invoice-templates-replacements","ops":{"POST":{"newTemplateId":{"type":"string"},"currentTemplateId":{"type":"string"}}}},{"key":"InvoiceTemplate","path":"/invoice-templates/{id}","ops":{"GET":{"templateCategory":{"type":"string","enum":["Old","New"],"desc":"The category of the template"},"base64EncodedTemplateFileContent":{"type":"string","desc":"The template file contents as a base64 encoded string"},"templateNumber":{"type":"string"},"suppressZeroValueLine":{"type":"boolean","desc":"Should zero valued lines be suppressed and not shown in the eventual Invoice"},"name":{"type":"string","desc":"The name of the template"},"defaultTemplate":{"type":"boolean","desc":"Is this template the default template."},"templateFileName":{"type":"string","desc":"The name of the template file."},"id":{"type":"string","desc":"The unique identifier of the template"},"updatedOn":{"type":"string"},"associatedToBillingAccount":{"type":"boolean"},"templateFormat":{"type":"string","enum":["WORD","HTML"],"desc":"The format of the template file."}},"PUT":{"base64EncodedTemplateFileContent":{"type":"string","desc":"The template file contents as a base64 encoded string"},"templateNumber":{"type":"string"},"suppressZeroValueLine":{"type":"boolean","desc":"Should zero valued lines be suppressed and not shown in the eventual Invoice"},"name":{"type":"string","desc":"The name of the template"},"defaultTemplate":{"type":"boolean","desc":"Is this template the default template."},"templateFileName":{"type":"string","desc":"The name of the template file."}}}},{"key":"JobGroup","path":"/job-groups","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"Label","path":"/label","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"LabelFind","path":"/label/find","ops":{"POST":{"virtual_flag":{"type":"string"},"tbl_name":{"type":"string","required":true},"default_label":{"type":"string"},"col_name":{"type":"string","required":true}}}},{"key":"LabelById","path":"/label/id/{id}","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"LabelLookupById","path":"/label/lookup-by-id","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"LabelLookupByKey","path":"/label/lookup-by-key","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"LabelByTable","path":"/label/table/{tblName}","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"LabelTables","path":"/label/tables","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"Layout","path":"/layouts","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"LayoutCategories","path":"/layouts/categories","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"LayoutByCategory","path":"/layouts/category","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"LayoutSubCategories","path":"/layouts/category/sub-categories","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"LayoutByReport","path":"/layouts/report/{reportId}","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"LayoutWorkbench","path":"/layouts/workbench","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"LayoutWorkbenchSubCategories","path":"/layouts/workbench/sub-categories","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"LayoutById","path":"/layouts/{id}","ops":{"GET":{"layout_name":{"type":"string","required":true},"drill_layouts":{"type":"array"},"rep_name":{"type":"string","desc":"Report name for cross-environment resolution. On POST/PUT: use instead of rep_id to identify the parent report. On GET: name of the parent report."},"filters":{"type":"array"},"indicators":{"type":"object"},"created_by":{"type":"string"},"client_id":{"type":"integer"},"rep_id":{"type":"integer","desc":"Report ID. Returned on GET. On POST/PUT: use rep_name instead for cross-environment compatibility."},"filename_prefix":{"type":"string"},"translations":{"type":"array"},"field_details":{"type":"array"},"updated_by":{"type":"string"},"layout_desc":{"type":"string"},"id":{"type":"integer","required":true},"created_date":{"type":"string"},"updated_date":{"type":"string"},"filter_json":{"type":"string"}}}},{"key":"LayoutDrillLayout","path":"/layouts/{id}/drill-layouts","ops":{"GET":{"data":{"type":"array"},"success":{"type":"boolean"}}}},{"key":"Lookup","path":"/lookup","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"NumberAndSku","path":"/numbers-and-skus","ops":{"GET=PUT":{"debitMemoTemplateNumberPrefix":{"type":"string"},"skuPrefix":{"type":"string"},"productRatePlanNumberPrefix":{"type":"string"},"eInvoiceBusinessRegionNumberPrefix":{"type":"string"},"amendmentNumberPrefix":{"type":"string"},"chargeNumberPrefix":{"type":"string"},"productNumberPrefix":{"type":"string"},"creditMemoTemplateNumberPrefix":{"type":"string"},"productRatePlanChargeNumberPrefix":{"type":"string"},"invoiceTemplateNumberPrefix":{"type":"string"},"customerNumberPrefix":{"type":"string"},"billingAccountprefix":{"type":"string"},"subscriptionRatePlanNumberPrefix":{"type":"string"},"eInvoiceServiceProviderNumberPrefix":{"type":"string"},"subscriptionNumberPrefix":{"type":"string"},"sequenceSetNumberPrefix":{"type":"string"},"eInvoiceTemplateNumberPrefix":{"type":"string"}}}},{"key":"CustomObjectMigration","path":"/objects/migrations","ops":{"POST":{"actions":{"type":"array","required":true},"instant":{"type":"boolean"}}}},{"key":"AllOutboundEntityConnections","path":"/outbound-entity-connections","ops":{"GET":{"currentId":{"type":"string"},"connections":{"type":"array"}},"POST":{"otherId":{"type":"string"}}}},{"key":"OutboundEntityConnection","path":"/outbound-entity-connections/{entityId}","ops":{"GET":{"otherId":{"type":"string"},"status":{"enum":["connected","pending","requested","notConnected"]}}}},{"key":"AllPaymentGateways","path":"/payment-gateways","ops":{"GET":{"gateways":{"type":"array"}},"POST":{"verifyPaymentMethodUpdated":{"type":"boolean"},"cardsAccepted":{"type":"array"},"gatewayName":{"type":"string"},"verifyPaymentMethodNew":{"type":"boolean"},"paymentGatewayType":{"type":"string"},"active":{"type":"boolean"},"authDefaultAmount":{"type":"number","min":0}}}},{"key":"PaymentGateway","path":"/payment-gateways/{id}","ops":{"GET=PUT":{"verifyPaymentMethodUpdated":{"type":"boolean"},"cardsAccepted":{"type":"array"},"gatewayName":{"type":"string"},"verifyPaymentMethodNew":{"type":"boolean"},"warning":{"type":"string"},"paymentGatewayType":{"type":"string"},"active":{"type":"boolean"},"id":{"type":"string"},"cardsAllowed":{"type":"array"},"authDefaultAmount":{"type":"number","min":0}}}},{"key":"PaymentMethods","path":"/payment-methods","ops":{"GET=PUT":{"paymentMethodTypes":{"type":"array"}}}},{"key":"PaymentRetryRules","path":"/payment-retry-rules","ops":{"GET=PUT":{"paymentRetryWindow":{"type":"integer","desc":"You can use the retry interval setting to prevent a payment attempt if the last failed payment was within the last 'number' of hours","required":true},"maxConsecutivePaymentFailures":{"type":"integer","desc":"You can use the maximum payment failures setting to prevent a payment attempt if the number of consecutive failures on a payment method has reached the configured number","required":true},"isEnabled":{"type":"boolean","desc":"Enable Payment Run retry rules","required":true}}}},{"key":"PaymentRules","path":"/payment-rules","ops":{"GET=PUT":{"enableTransactionFutureDateFeature":{"type":"boolean"},"displayUnapplyWhenCancelPayment":{"type":"boolean"},"enableCreditCardDateValidation":{"type":"boolean","desc":"Validate credit card expiration date"},"enableCBRefundInGR":{"type":"boolean"},"enableCustomPaymentNumber":{"type":"boolean"},"enableUnapplyWhenCancelPayment":{"type":"boolean"}}}},{"key":"AllPaymentTerms","path":"/payment-terms","ops":{"POST":{"intervalNumber":{"type":"number","desc":"This property defines 'Number of days' for NetPaymentTerm type, and 'Number of months' for ProxPaymentTerm type"},"isDefault":{"type":"boolean","desc":"Flag to indicate if it is a default PaymentTerm"},"paymentDueDay":{"type":"number","desc":"Due date of the Payment (1-31)"},"name":{"type":"string","desc":"Unique Name of the PaymentTerm"},"invoiceCutoffDay":{"type":"number","desc":"Invoice Cutoff date (1-31)"},"isActive":{"type":"boolean","desc":"Flag to indicate if PaymentTerm is Active"},"type":{"type":"string","enum":["NetPaymentTerm","ProxPaymentTerm"],"desc":"PaymentTerm type"}}}},{"key":"PaymentTerm","path":"/payment-terms/{id}","ops":{"GET":{"intervalNumber":{"type":"number","desc":"This property defines 'Number of days' for NetPaymentTerm type, and 'Number of months' for ProxPaymentTerm type"},"isDefault":{"type":"boolean","desc":"Flag to indicate if it is a default PaymentTerm"},"paymentDueDay":{"type":"number","desc":"Due date of the Payment (1-31)"},"intervalUnit":{"type":"string","desc":"Unit of interval (Days, Months)"},"name":{"type":"string","desc":"Unique Name of the PaymentTerm"},"invoiceCutoffDay":{"type":"number","desc":"Invoice Cutoff date (1-31)"},"id":{"type":"string","desc":"Unique Id of the PaymentTerm"},"isActive":{"type":"boolean","desc":"Flag to indicate if PaymentTerm is Active"},"type":{"type":"string","enum":["NetPaymentTerm","ProxPaymentTerm"],"desc":"PaymentTerm type"}},"PUT":{"intervalNumber":{"type":"number","desc":"This property defines 'Number of days' for NetPaymentTerm type, and 'Number of months' for ProxPaymentTerm type"},"isDefault":{"type":"boolean","desc":"Flag to indicate if it is a default PaymentTerm"},"paymentDueDay":{"type":"number","desc":"Due date of the Payment (1-31)"},"name":{"type":"string","desc":"Unique Name of the PaymentTerm"},"invoiceCutoffDay":{"type":"number","desc":"Invoice Cutoff date (1-31)"},"isActive":{"type":"boolean","desc":"Flag to indicate if PaymentTerm is Active"},"type":{"type":"string","enum":["NetPaymentTerm","ProxPaymentTerm"],"desc":"PaymentTerm type"}}}},{"key":"PeriodActivityTask","path":"/period-activity-tasks","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"PeriodActivityTemplate","path":"/period-activity-template","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"PobTemplate","path":"/pob-tmpl","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"Processor","path":"/processor","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"ProductAttributesConfigurable","path":"/product-attribute-configurable","ops":{}},{"key":"AllProductAttributes","path":"/product-attributes","ops":{"GET=PUT":{"attributes":{"type":"array"}}}},{"key":"ProductAttribute","path":"/product-attributes/{attribute}","ops":{"GET":{"immutable":{"type":"boolean"},"productLevel":{"type":"string","enum":["AccountingPeriod","Product","RatePlan","RatePlanComponent","ProductRatePlanChargeTier","CustomField","CustomFieldPicklistValue"]},"controlLevel":{"type":"string","enum":["Target","Source"]},"attribute":{"type":"string"}},"PUT":{"controlLevel":{"type":"string","enum":["Target","Source"]}}}},{"key":"Profile","path":"/profile","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"Program","path":"/program","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"AllQuoteTemplates","path":"/quote-templates","ops":{"POST":{"templateCategory":{"type":"string","enum":["Old","New"],"desc":"The category of the template"},"base64EncodedTemplateFileContent":{"type":"string","desc":"The template file contents as a base64 encoded string","required":true},"suppressZeroValueLine":{"type":"boolean","desc":"Should zero valued lines be suppressed and not shown in the eventual Invoice"},"name":{"type":"string","desc":"The name of the template","required":true},"defaultTemplate":{"type":"boolean","desc":"Is this template the default template."},"templateFileName":{"type":"string","desc":"The name of the template file.","required":true},"templateFormat":{"type":"string","enum":["WORD","HTML"],"desc":"The format of the template file."}}}},{"key":"QuoteTemplate","path":"/quote-templates/{id}","ops":{"GET":{"templateCategory":{"type":"string","enum":["Old","New"],"desc":"The category of the template"},"base64EncodedTemplateFileContent":{"type":"string","desc":"The template file contents as a base64 encoded string"},"suppressZeroValueLine":{"type":"boolean","desc":"Should zero valued lines be suppressed and not shown in the eventual Invoice"},"name":{"type":"string","desc":"The name of the template"},"defaultTemplate":{"type":"boolean","desc":"Is this template the default template."},"templateFileName":{"type":"string","desc":"The name of the template file."},"updatedOn":{"type":"string"},"id":{"type":"string","desc":"The unique identifier of the template"},"templateFormat":{"type":"string","enum":["WORD","HTML"],"desc":"The format of the template file."}}}},{"key":"RCGroupingTemplate","path":"/rc-grouping-template","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"AllReasonCodes","path":"/reason-codes","ops":{"POST":{"reasonCodeName":{"type":"string","desc":"Unique name for the Reason code"},"reasonCodeTransactionType":{"type":"string","enum":["RefundPayment","RefundCreditBalance","InvoiceItemAdjustment","InvoiceAdjustment","CreditBalanceAdjustment","CreditMemo","DebitMemo","RefundCreditMemo","ReturnOrder"],"desc":"Type of Transaction (RefundPayment, InvoiceAdjustment etc)"},"isActive":{"type":"boolean","desc":"Flag to indicate if Reason Code is active"}}}},{"key":"ReasonCode","path":"/reason-codes/{id}","ops":{"GET":{"reasonCodeName":{"type":"string","desc":"Unique name for the Reason code"},"isDefault":{"type":"boolean","desc":"Flag to indicate if it is default Reason Code"},"reasonCodeTransactionType":{"type":"string","enum":["RefundPayment","RefundCreditBalance","InvoiceItemAdjustment","InvoiceAdjustment","CreditBalanceAdjustment","CreditMemo","DebitMemo","RefundCreditMemo","ReturnOrder"],"desc":"Type of Transaction (RefundPayment, InvoiceAdjustment etc)"},"id":{"type":"string","desc":"Unique Id of the Reason Code"},"isActive":{"type":"boolean","desc":"Flag to indicate if Reason Code is active"}},"PUT":{"reasonCodeName":{"type":"string","desc":"Unique name for the Reason code"},"isDefault":{"type":"boolean","desc":"Flag to indicate if it is default Reason Code"},"isActive":{"type":"boolean","desc":"Flag to indicate if Reason Code is active"}}}},{"key":"AllTenantRegions","path":"/regions","ops":{"POST":{"alphaThree":{"type":"string"},"localizations":{"type":"array"},"alphaTwo":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"},"status":{"type":"string"}}}},{"key":"TenantRegion","path":"/regions/{id}","ops":{"GET":{"seed":{"type":"boolean"},"alphaThree":{"type":"string"},"localizations":{"type":"array"},"alphaTwo":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"},"status":{"type":"string"}},"PUT":{"alphaThree":{"type":"string"},"localizations":{"type":"array"},"alphaTwo":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"},"status":{"type":"string"}}}},{"key":"AllTenantSubRegions","path":"/regions/{regionId}/sub-regions","ops":{"POST":{"code":{"type":"string"},"localizations":{"type":"array"},"name":{"type":"string"},"id":{"type":"string"},"status":{"type":"string"}}}},{"key":"TenantSubRegion","path":"/regions/{regionId}/sub-regions/{id}","ops":{"GET":{"code":{"type":"string"},"seed":{"type":"boolean"},"localizations":{"type":"array"},"name":{"type":"string"},"id":{"type":"string"},"status":{"type":"string"}},"PUT":{"code":{"type":"string"},"localizations":{"type":"array"},"name":{"type":"string"},"id":{"type":"string"},"status":{"type":"string"}}}},{"key":"Report","path":"/reports","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"ReportAccessAssignments","path":"/reports/access","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"ReportAggregateBulk","path":"/reports/aggregate","ops":{"POST":{"summ_view":{"type":"string"},"access":{"type":"array","desc":"Either role_id or role_name is required per entry"},"rep_name":{"type":"string","required":true},"indicators":{"type":"object"},"layouts":{"type":"array"},"client_id":{"type":"integer"},"display_rep_desc":{"type":"string"},"translations":{"type":"array"},"share_outputs":{"type":"array","desc":"Either role_id or role_name is required per entry"},"fields":{"type":"array"},"display_category":{"type":"string"},"seq":{"type":"integer"},"view_name":{"type":"string"},"func_name":{"type":"string"}},"PUT":{"summ_view":{"type":"string"},"access":{"type":"array","desc":"Either role_id or role_name is required per entry"},"rep_name":{"type":"string"},"indicators":{"type":"object"},"layouts":{"type":"array"},"client_id":{"type":"integer"},"display_rep_desc":{"type":"string"},"translations":{"type":"array"},"share_outputs":{"type":"array","desc":"Either role_id or role_name is required per entry"},"id":{"type":"integer","required":true},"fields":{"type":"array"},"display_category":{"type":"string"},"seq":{"type":"integer"},"view_name":{"type":"string"},"func_name":{"type":"string"}}}},{"key":"ReportCategories","path":"/reports/categories","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"ReportFieldSummary","path":"/reports/fields-summary","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"ReportShareOutputAssignments","path":"/reports/share-outputs","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"ReportAccess","path":"/reports/{reportId}/access","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"ReportAggregate","path":"/reports/{reportId}/aggregate","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"ReportField","path":"/reports/{reportId}/fields","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"ReportLayout","path":"/reports/{reportId}/layouts","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"ReportShareOutput","path":"/reports/{reportId}/share-outputs","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"AllReusableBlocks","path":"/reusable-blocks","ops":{"GET":{"next":{"type":"string"},"data":{"type":"array"}},"POST":{"reusableBlocks":{"type":"array"},"allowPartialSuccess":{"type":"boolean"}}}},{"key":"ReusableBlock","path":"/reusable-blocks/{key}","ops":{"GET":{"number":{"type":"string"},"updatedBy":{"type":"string"},"createdBy":{"type":"string"},"name":{"type":"string"},"active":{"type":"boolean"},"unlayerJson":{"type":"string"},"id":{"type":"string"},"updatedOn":{"type":"string"},"category":{"type":"string"},"createdOn":{"type":"string"},"content":{"type":"string"},"tags":{"type":"array"}},"PUT":{"number":{"type":"string"},"name":{"type":"string"},"active":{"type":"boolean"},"category":{"type":"string"},"content":{"type":"string"},"tags":{"type":"array"}}}},{"key":"AllRevenueEventTypes","path":"/revenue-event-types","ops":{"POST":{"systemId":{"type":"string"},"active":{"type":"boolean"},"id":{"type":"string","desc":"Unique Id of Revenue Event Type"},"label":{"type":"string"}}}},{"key":"RevenueEventType","path":"/revenue-event-types/{id}","ops":{"GET=PUT":{"systemId":{"type":"string"},"active":{"type":"boolean"},"id":{"type":"string","desc":"Unique Id of Revenue Event Type"},"label":{"type":"string"}}}},{"key":"RevenueHold","path":"/revenue-holds","ops":{"GET":{"success":{"type":"boolean","required":true}}}},{"key":"RevenueOrg","path":"/revenue-org","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"RevenueRecognitionCodeStatus","path":"/revenue-recognition-code-status","ops":{"GET=PUT":{"enabled":{"type":"boolean","required":true}}}},{"key":"AllRevenueRecognitionCodes","path":"/revenue-recognition-codes","ops":{"GET":{"codes":{"type":"array"},"enabled":{"type":"boolean"}},"POST":{"code":{"type":"string"},"active":{"type":"boolean"},"id":{"type":"string"}}}},{"key":"RevenueRecognitionCode","path":"/revenue-recognition-codes/{id}","ops":{"GET=PUT":{"code":{"type":"string"},"active":{"type":"boolean"},"id":{"type":"string"}}}},{"key":"AllRevenueRecognitionModels","path":"/revenue-recognition-models","ops":{"GET=PUT":{"monthlyRecognitionOverTime":{"type":"boolean"},"fullRecognitionUponInvoicing":{"type":"boolean"},"dailyRecognitionOverTime":{"type":"boolean"},"unlimitedRecognition":{"type":"boolean"},"manualRecognition":{"type":"boolean"},"fullRecognitionOnASpecificDate":{"type":"boolean"}}}},{"key":"AllRevenueRecognitionRules","path":"/revenue-recognition-rules","ops":{"GET":{"revenueRecognitionRuleDtos":{"type":"array"}},"POST":{"invoiceItemAdjustmentTransactionRule":{"type":"object"},"description":{"type":"string"},"active":{"type":"boolean"},"apClosedDistributionRule":{"type":"string","enum":["MergeToNextOpen"]},"creditMemoTransactionRules":{"type":"array"},"debitMemoTransactionRules":{"type":"array"},"transactionDateRule":{"type":"string","enum":["RecognizeWithoutImpact","AccumulateToTransactionDate"]},"name":{"type":"string"},"roundingRule":{"type":"string","enum":["RoundLast","RoundTrailing"]},"id":{"type":"string","desc":"Unique Id of the revenue recognition rule "},"invoiceItemTransactionRule":{"type":"object"},"recognitionModel":{"type":"string","enum":["UponInvoicing","Daily","Monthly","SpecificDate","Manually","Unlimited"]}}}},{"key":"RevenueRecognitionRule","path":"/revenue-recognition-rules/{id}","ops":{"GET=PUT":{"transactionDateRule":{"type":"string","enum":["RecognizeWithoutImpact","AccumulateToTransactionDate"]},"invoiceItemAdjustmentTransactionRule":{"type":"object"},"name":{"type":"string"},"roundingRule":{"type":"string","enum":["RoundLast","RoundTrailing"]},"description":{"type":"string"},"active":{"type":"boolean"},"apClosedDistributionRule":{"type":"string","enum":["MergeToNextOpen"]},"id":{"type":"string","desc":"Unique Id of the revenue recognition rule "},"invoiceItemTransactionRule":{"type":"object"},"recognitionModel":{"type":"string","enum":["UponInvoicing","Daily","Monthly","SpecificDate","Manually","Unlimited"]},"creditMemoTransactionRules":{"type":"array"},"debitMemoTransactionRules":{"type":"array"}}}},{"key":"RevenueRecognitionRuleActivationStatus","path":"/revenue-recognition-rules/{id}/activation","ops":{"PUT":{"active":{"type":"boolean"}}}},{"key":"RevenueStartDate","path":"/revenue-start-date","ops":{"GET":{"revenueStartDate":{"type":"string","desc":"the date of Revenue Start"}},"PUT":{"accountingPeriodName":{"type":"string","desc":"the accounting period that revenue start"},"userName":{"type":"string","desc":"the name of user who set the Revenue Start Date"}}}},{"key":"Roles","path":"/roles","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"SafeHtmlSetting","path":"/safe-html-setting","ops":{"GET":{"success":{"type":"boolean"},"enabled":{"type":"boolean"}},"PUT":{"enabled":{"type":"boolean"}}}},{"key":"SecurityPolicy","path":"/security-policies","ops":{"GET=PUT":{"lockoutEffectivePeriod":{"type":"integer","enum":[20,30,60]},"twoFactor":{"type":"boolean"},"twoFactorRememberTime":{"type":"integer"},"passwordExpiration":{"type":"integer","enum":[0,30,60,90]},"minimumPasswordLength":{"type":"integer","enum":[7,8,10,12]},"passwordComplexityRequirement":{"type":"string","enum":["None","Characters","ContainAll"]},"maximumInvalidLoginAttempts":{"type":"integer","min":3,"max":10},"enforcePasswordHistory":{"type":"integer","enum":[0,4,7]},"sessionTimeout":{"type":"integer","enum":[15,30,60,120,240,480]}}}},{"key":"Segment","path":"/segments","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"SharingAttribute","path":"/sharing-attributes","ops":{"GET=PUT":{"attributes":{"type":"array"},"enabled":{"type":"boolean"}}}},{"key":"SSPTemplate","path":"/ssp-template","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"StageValidationRule","path":"/stage-validation-rules","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"SubscriptionSettings","path":"/subscription-settings","ops":{"GET=PUT":{"autoRenewJobScheduleId":{"type":"string"},"acceptanceOfOrders":{"type":"boolean"},"increasePriceRenewSubscription":{"type":"boolean"},"subscriptionsInvoicedSeparately":{"type":"boolean"},"termType":{"enum":["TERMED","EVERGREEN"]},"updateChargeTriggerCondition":{"type":"boolean","desc":"This field controls whether to enable the users to update the trigger condition of rate plan charge or not"},"description":{"type":"string"},"renewNoChargeSubscription":{"type":"boolean"},"enableOrderCpq":{"type":"boolean","desc":"The field enableOrderCpq controls whether the CPQ  can use order or not. So the CPQ will create subscriptions, amendments and orders based on this"},"skipAmendmentGenerationBySubscribe":{"type":"boolean","desc":"The field skipAmendmentGenerationBySubscribe where customers can control the order asynchronously generated when creating subscriptions via subscription UI or API for version -1"},"turnOffAmendmentsInTheUI":{"type":"boolean","desc":"This field controls whether to enable Amendment features from UI for a tenant"},"initialTerm":{"type":"integer","min":0,"max":999},"productFeatureOfSubscription":{"type":"boolean"},"implementationPeriod":{"type":"boolean"},"priceChangeOption":{"enum":["NoChange","SpecificPercentageValue","UseLatestProductCatalogPricing"]},"contractRenewal":{"type":"boolean"},"invoicePastEndOfTerm":{"type":"boolean"},"enableOrderUI":{"type":"boolean","desc":"This field controls whether to enable Order features from UI for a tenant"},"autoRenewJobRunTime":{"type":"integer","min":0,"max":23},"orderMetricsTaxationOption":{"type":"string","enum":["YES","NO","ONLY_FOR_TAX_INCLUSIVE_CHARGES"],"desc":"This field controls whether to calculate Tax for Order TCB and ELP Metrics or not"},"autoRenewByOrder":{"type":"boolean","desc":"The field autoRenewByOrder controls which notification to be sent for auto-renew on all subscriptions for OH customers"},"priceIncreasePercentage":{"type":"number"},"skipOwnerTransferValidationForDeletionAccount":{"type":"boolean","desc":"This field controls whether to allow users to force delete billing account without the owner transfer validation"},"updateSubscriptionActivationDate":{"type":"boolean","desc":"This field controls whether users can update Subscription trigger dates or not."},"autoRenewJobRunTimeType":{"enum":["SystemDefault","TenantSpecified"]},"enableAccountLevelDiscount":{"type":"boolean","desc":"This field controls whether to allow the users to use the account level discount charge or not"},"renewalTerm":{"type":"integer","min":0,"max":999}}}},{"key":"AllSummaryStatementTemplates","path":"/summary-statement-templates","ops":{"POST":{"base64EncodedTemplateFileContent":{"type":"string","desc":"The template file contents as a base64 encoded string","required":true},"name":{"type":"string","desc":"The name of the template","required":true},"defaultTemplate":{"type":"boolean","desc":"Is this template the default template."},"templateFileName":{"type":"string","desc":"The name of the template file.","required":true},"templateFormat":{"type":"string","enum":["WORD","HTML"],"desc":"The format of the template file."}}}},{"key":"SummaryStatementTemplatesReplacements","path":"/summary-statement-templates-replacements","ops":{"POST":{"newTemplateId":{"type":"string"},"currentTemplateId":{"type":"string"}}}},{"key":"SummaryStatementTemplate","path":"/summary-statement-templates/{templateId}","ops":{"GET":{"base64EncodedTemplateFileContent":{"type":"string","desc":"The template file contents as a base64 encoded string"},"templateNumber":{"type":"string"},"name":{"type":"string","desc":"MySummaryStatementTemplate"},"defaultTemplate":{"type":"boolean","desc":"Is this template the default template."},"associatedToBillingAccount":{"type":"boolean"},"id":{"type":"string","desc":"The unique identifier of the template"},"updatedOn":{"type":"string"},"templateFormat":{"type":"string","enum":["WORD","HTML"],"desc":"The format of the template file."}},"PUT":{"base64EncodedTemplateFileContent":{"type":"string","desc":"The template file contents as a base64 encoded string"},"name":{"type":"string","desc":"The name of the template"},"defaultTemplate":{"type":"boolean","desc":"Is this template the default template."}}}},{"key":"AllTaxCode","path":"/tax-codes","ops":{"GET":{"taxCodes":{"type":"array"}}}},{"key":"CreateAvalaraTaxCode","path":"/tax-codes/avalara","ops":{"POST":{"externalTaxCode":{"type":"string"},"taxCompanyId":{"type":"string"},"name":{"type":"string"},"active":{"type":"boolean"},"description":{"type":"string"},"taxEngineId":{"type":"string"}}}},{"key":"AvalaraTaxCode","path":"/tax-codes/avalara/{id}","ops":{"GET=PUT":{"externalTaxCode":{"type":"string"},"taxCompanyId":{"type":"string"},"name":{"type":"string"},"active":{"type":"boolean"},"description":{"type":"string"},"id":{"type":"string"},"taxEngineId":{"type":"string"}}}},{"key":"CreateConnectorTaxCode","path":"/tax-codes/connector","ops":{"POST":{"taxCompanyId":{"type":"string"},"name":{"type":"string"},"active":{"type":"boolean"},"description":{"type":"string"},"taxEngineId":{"type":"string"}}}},{"key":"ConnectorTaxCode","path":"/tax-codes/connector/{id}","ops":{"GET=PUT":{"taxCompanyId":{"type":"string"},"name":{"type":"string"},"active":{"type":"boolean"},"description":{"type":"string"},"id":{"type":"string"},"taxEngineId":{"type":"string"}}}},{"key":"CreateGlobalTaxHubTaxCode","path":"/tax-codes/global-tax-hub","ops":{"POST":{"taxCompanyId":{"type":"string"},"name":{"type":"string"},"active":{"type":"boolean"},"taxEngineId":{"type":"string"}}}},{"key":"GlobalTaxHubTaxCode","path":"/tax-codes/global-tax-hub/{id}","ops":{"GET=PUT":{"taxCompanyId":{"type":"string"},"name":{"type":"string"},"active":{"type":"boolean"},"id":{"type":"string"},"taxEngineId":{"type":"string"}}}},{"key":"CreateZuoraTaxCode","path":"/tax-codes/ztax","ops":{"POST":{"name":{"type":"string"},"active":{"type":"boolean"},"description":{"type":"string"},"taxEngineId":{"type":"string"}}}},{"key":"ZuoraTaxCode","path":"/tax-codes/ztax/{id}","ops":{"GET=PUT":{"name":{"type":"string"},"active":{"type":"boolean"},"description":{"type":"string"},"id":{"type":"string"},"taxEngineId":{"type":"string"}}}},{"key":"TaxCompanies","path":"/tax-companies","ops":{"GET":{"taxCompanies":{"type":"array"}},"POST":{"companyCode":{"type":"string"},"country":{"type":"string"},"companyId":{"type":"string"},"taxRegion":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"address1":{"type":"string"},"postalCode":{"type":"string"},"county":{"type":"string"},"id":{"type":"string"},"state":{"type":"string"},"taxEngineId":{"type":"string"}}}},{"key":"TaxCompany","path":"/tax-companies/{id}","ops":{"GET=PUT":{"companyCode":{"type":"string"},"country":{"type":"string"},"companyId":{"type":"string"},"taxRegion":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"address1":{"type":"string"},"postalCode":{"type":"string"},"county":{"type":"string"},"id":{"type":"string"},"state":{"type":"string"},"taxEngineId":{"type":"string"}}}},{"key":"AllTaxDateOptions","path":"/tax-date-options","ops":{"GET":{"taxDateSettings":{"type":"array"},"success":{"type":"boolean"}}}},{"key":"TaxDateOption","path":"/tax-date-options/{id}","ops":{"PUT":{"taxDateOption":{"type":"string","enum":["DocumentDate","ServicePeriodStartDate","ServicePeriodEndDate"]},"countryCode":{"type":"string"}}}},{"key":"AllTaxEngines","path":"/tax-engines","ops":{"POST":{"isTestEnvironment":{"type":"boolean"},"jsonFields":{"type":"object"},"customFieldMetas":{"type":"array"},"useAdvanceSettings":{"type":"boolean"},"clientId":{"type":"string"},"voidUrl":{"type":"string"},"requestTemplate":{"type":"string"},"networkReadTimeoutInSeconds":{"type":"number"},"url":{"type":"string"},"securityToken":{"type":"string"},"password":{"type":"string"},"responseMappings":{"type":"object"},"requestHeaders":{"type":"object"},"voidTemplate":{"type":"string"},"vendor":{"type":"string","enum":["Z-Tax","ONESOURCE","VertexAdvancedTax","AvalaraForBrazil","AvaTaxForCommunication","VertexOSeries","ONESOURCESOAP","VertexAdvancedTaxSOAP","CCHSureTax","Sovos","Avalara","Anrok"]},"accessTokenUrl":{"type":"string"},"name":{"type":"string"},"clientSecret":{"type":"string"},"authenticationType":{"type":"string","enum":["BasicAuth","OAuth2","PrivateToken"]},"username":{"type":"string"},"networkOpenTimeoutInSeconds":{"type":"number"}}}},{"key":"CreateAvalaraTaxEngine","path":"/tax-engines/avalara","ops":{"POST":{"licenseKey":{"type":"string"},"password":{"type":"string"},"isTest":{"type":"boolean"},"name":{"type":"string"},"accountNumber":{"type":"string"},"taxEngineType":{"type":"string","enum":["Avalara"]},"username":{"type":"string"}}}},{"key":"AvalaraTaxEngine","path":"/tax-engines/avalara/{id}","ops":{"GET":{"isTest":{"type":"boolean"},"name":{"type":"string"},"id":{"type":"string"},"accountNumber":{"type":"string"},"taxEngineType":{"type":"string","enum":["Avalara"]},"username":{"type":"string"}},"PUT":{"licenseKey":{"type":"string"},"password":{"type":"string"},"isTest":{"type":"boolean"},"name":{"type":"string"},"accountNumber":{"type":"string"},"taxEngineType":{"type":"string","enum":["Avalara"]},"username":{"type":"string"}}}},{"key":"CreateConnectorTaxEngine","path":"/tax-engines/connector","ops":{"POST":{"password":{"type":"string","required":true},"customFieldMetas":{"type":"array"},"name":{"type":"string","required":true},"taxEngineType":{"type":"string","enum":["ConnectTaxEngine"],"required":true}}}},{"key":"ConnectorTaxEngine","path":"/tax-engines/connector/{id}","ops":{"GET":{"customFieldMetas":{"type":"array"},"name":{"type":"string"},"id":{"type":"string"},"taxEngineType":{"type":"string","enum":["ConnectTaxEngine"]}},"PUT":{"password":{"type":"string"},"customFieldMetas":{"type":"array"},"name":{"type":"string"}}}},{"key":"CreateGlobalTaxHubTaxEngine","path":"/tax-engines/global-tax-hub","ops":{"POST":{"jsonFields":{"type":"object"},"customFieldMetas":{"type":"array"},"clientId":{"type":"string"},"voidUrl":{"type":"string"},"requestTemplate":{"type":"string"},"oauthScope":{"type":"string"},"networkReadTimeoutInSeconds":{"type":"number"},"sellerInfo":{"type":"object"},"taxEngineType":{"type":"string","enum":["ConnectTaxEngine","GlobalTaxHub"],"required":true},"url":{"type":"string","required":true},"securityToken":{"type":"string"},"password":{"type":"string"},"responseMappings":{"type":"object"},"requestHeaders":{"type":"object"},"voidTemplate":{"type":"string"},"vendor":{"type":"string","enum":["AvalaraTelco","AvalaraBrazil","AvaTax","Vertex_SOAP","OneSource_SOAP","Vertex_REST","Anrok","Sphere","Taxamo","SureTax_REST","SureTax_SOAP","SovosTaxware","OneSource_REST"],"required":true},"accessTokenUrl":{"type":"string"},"name":{"type":"string","required":true},"clientSecret":{"type":"string"},"authenticationType":{"type":"string","enum":["BasicAuth","OAuth2","PrivateToken"],"required":true},"username":{"type":"string"},"networkOpenTimeoutInSeconds":{"type":"number"}}}},{"key":"GlobalTaxHubTaxEngine","path":"/tax-engines/global-tax-hub/{id}","ops":{"GET":{"jsonFields":{"type":"object"},"customFieldMetas":{"type":"array"},"clientId":{"type":"string"},"voidUrl":{"type":"string"},"requestTemplate":{"type":"string"},"oauthScope":{"type":"string"},"networkReadTimeoutInSeconds":{"type":"number"},"sellerInfo":{"type":"object"},"taxEngineType":{"type":"string","enum":["ConnectTaxEngine","GlobalTaxHub"]},"url":{"type":"string"},"responseMappings":{"type":"object"},"requestHeaders":{"type":"object"},"voidTemplate":{"type":"string"},"vendor":{"type":"string","enum":["AvalaraTelco","AvalaraBrazil","AvaTax","Vertex_SOAP","OneSource_SOAP","Vertex_REST","Anrok","Sphere","Taxamo","SureTax_REST","SureTax_SOAP","SovosTaxware","OneSource_REST"]},"accessTokenUrl":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"},"authenticationType":{"type":"string","enum":["BasicAuth","OAuth2","PrivateToken"]},"username":{"type":"string"},"networkOpenTimeoutInSeconds":{"type":"number"}},"PUT":{"jsonFields":{"type":"object"},"customFieldMetas":{"type":"array"},"clientId":{"type":"string"},"voidUrl":{"type":"string"},"requestTemplate":{"type":"string"},"oauthScope":{"type":"string"},"networkReadTimeoutInSeconds":{"type":"number"},"sellerInfo":{"type":"object"},"url":{"type":"string"},"securityToken":{"type":"string"},"password":{"type":"string"},"responseMappings":{"type":"object"},"requestHeaders":{"type":"object"},"voidTemplate":{"type":"string"},"vendor":{"type":"string","enum":["AvalaraTelco","AvalaraBrazil","AvaTax","Vertex_SOAP","OneSource_SOAP","Vertex_REST","Anrok","Sphere","Taxamo","SureTax_REST","SureTax_SOAP","SovosTaxware","OneSource_REST"]},"accessTokenUrl":{"type":"string"},"name":{"type":"string"},"clientSecret":{"type":"string"},"authenticationType":{"type":"string","enum":["BasicAuth","OAuth2","PrivateToken"]},"username":{"type":"string"},"networkOpenTimeoutInSeconds":{"type":"number"}}}},{"key":"ZuoraTaxEngine","path":"/tax-engines/ztax/{id}","ops":{"GET":{"name":{"type":"string"},"id":{"type":"string"},"taxEngineType":{"type":"string","enum":["Z_Tax"]}},"PUT":{"name":{"type":"string"}}}},{"key":"TaxEngines","path":"/tax-engines/{id}","ops":{"GET":{"isTestEnvironment":{"type":"boolean"},"jsonFields":{"type":"object"},"customFieldMetas":{"type":"array"},"useAdvanceSettings":{"type":"boolean"},"clientId":{"type":"string"},"voidUrl":{"type":"string"},"requestTemplate":{"type":"string"},"networkReadTimeoutInSeconds":{"type":"number"},"url":{"type":"string"},"securityToken":{"type":"string"},"password":{"type":"string"},"responseMappings":{"type":"object"},"requestHeaders":{"type":"object"},"voidTemplate":{"type":"string"},"success":{"type":"boolean"},"vendor":{"type":"string","enum":["Z-Tax","ONESOURCE","VertexAdvancedTax","AvalaraForBrazil","AvaTaxForCommunication","VertexOSeries","ONESOURCESOAP","VertexAdvancedTaxSOAP","CCHSureTax","Sovos","Avalara","Anrok"]},"accessTokenUrl":{"type":"string"},"name":{"type":"string"},"clientSecret":{"type":"string"},"id":{"type":"string"},"authenticationType":{"type":"string","enum":["BasicAuth","OAuth2","PrivateToken"]},"username":{"type":"string"},"networkOpenTimeoutInSeconds":{"type":"number"}},"PUT":{"isTestEnvironment":{"type":"boolean"},"jsonFields":{"type":"object"},"customFieldMetas":{"type":"array"},"useAdvanceSettings":{"type":"boolean"},"clientId":{"type":"string"},"voidUrl":{"type":"string"},"requestTemplate":{"type":"string"},"networkReadTimeoutInSeconds":{"type":"number"},"url":{"type":"string"},"securityToken":{"type":"string"},"password":{"type":"string"},"responseMappings":{"type":"object"},"requestHeaders":{"type":"object"},"voidTemplate":{"type":"string"},"vendor":{"type":"string","enum":["Z-Tax","ONESOURCE","VertexAdvancedTax","AvalaraForBrazil","AvaTaxForCommunication","VertexOSeries","ONESOURCESOAP","VertexAdvancedTaxSOAP","CCHSureTax","Sovos","Avalara","Anrok"]},"accessTokenUrl":{"type":"string"},"name":{"type":"string"},"clientSecret":{"type":"string"},"authenticationType":{"type":"string","enum":["BasicAuth","OAuth2","PrivateToken"]},"username":{"type":"string"},"networkOpenTimeoutInSeconds":{"type":"number"}}}},{"key":"AllTaxRatePeriod","path":"/tax-rate-periods","ops":{"POST":{"endDate":{"type":"string"},"id":{"type":"string"},"taxCodeId":{"type":"string"},"startDate":{"type":"string"}}}},{"key":"TaxRatePeriod","path":"/tax-rate-periods/{id}","ops":{"GET=PUT":{"endDate":{"type":"string"},"id":{"type":"string"},"taxCodeId":{"type":"string"},"startDate":{"type":"string"}}}},{"key":"TaxRates","path":"/tax-rate-periods/{taxRatePeriodId}/tax-rates","ops":{"GET":{"taxRates":{"type":"array"}},"POST":{"taxRates":{"type":"array"}}}},{"key":"TranslationProfile","path":"/translation-profiles/presentment-translation","ops":{"GET":{"success":{"type":"boolean"},"enabled":{"type":"boolean"}},"PUT":{"enabled":{"type":"boolean"}}}},{"key":"AllUnitsOfMeasure","path":"/units-of-measure","ops":{"GET":{"unitsOfMeasure":{"type":"array"}},"POST":{"usageLogFileLabel":{"type":"string"},"roundingMode":{"type":"string"},"displayAs":{"type":"string"},"precision":{"type":"number"},"name":{"type":"string"},"active":{"type":"boolean"}}}},{"key":"UnitOfMeasure","path":"/units-of-measure/{id}","ops":{"GET=PUT":{"usageLogFileLabel":{"type":"string"},"roundingMode":{"type":"string","enum":["Up","Down"]},"displayAs":{"type":"string"},"precision":{"type":"number","min":0},"name":{"type":"string"},"active":{"type":"boolean"},"id":{"type":"string"}}}},{"key":"UserRoles","path":"/user-roles","ops":{"GET":{"size":{"type":"integer"},"last":{"type":"boolean"},"contents":{"type":"array"},"page":{"type":"integer"}}}},{"key":"VcField","path":"/vc-fields","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"VcFormula","path":"/vc-formulas","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"VcRule","path":"/vc-rules","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"VcStrat","path":"/vc-strats","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}},{"key":"VcType","path":"/vc-types","ops":{"GET":{"reasons":{"type":"array"},"data":{"type":"array"},"success":{"type":"boolean","required":true}}}}]
SHA-256: b10966d43573aa686310d6f7563996a3253fe63d2c39fd873e2151cd8cdd2fbd