{ "settings": [ { "key": "AccountingRules", "description": "Accounting Rules settings", "context": "Entity", "pathPattern": "/accounting-rules", "httpOperations": [ { "method": "GET", "url": "/settings/accounting-rules", "parameters": [], "responseType": { "$ref": "#/definitions/AccountingRules", "definitions": { "AccountingRules": { "additionalProperties": false, "type": "object", "properties": { "allowRevenueScheduleNegativeAmounts": { "type": "boolean" }, "allowBlankAccountingCodes": { "type": "boolean" }, "allowCreationInClosedPeriod": { "type": "boolean" }, "allowUsageInClosedPeriod": { "type": "boolean" }, "differentCurrencies": { "type": "boolean" }, "useOriginalExchangeRateForCredits": { "type": "boolean" }, "cashBasedAccountingStartDate": { "type": [ "string", "null" ] }, "createJournalEntriesForPendingPayments": { "type": "boolean" } } } } } }, { "method": "PUT", "url": "/settings/accounting-rules", "parameters": [], "requestType": { "$ref": "#/definitions/AccountingRules", "definitions": { "AccountingRules": { "additionalProperties": false, "type": "object", "properties": { "allowRevenueScheduleNegativeAmounts": { "type": "boolean" }, "allowBlankAccountingCodes": { "type": "boolean" }, "allowCreationInClosedPeriod": { "type": "boolean" }, "allowUsageInClosedPeriod": { "type": "boolean" }, "differentCurrencies": { "type": "boolean" }, "useOriginalExchangeRateForCredits": { "type": "boolean" }, "cashBasedAccountingStartDate": { "type": [ "string", "null" ] }, "createJournalEntriesForPendingPayments": { "type": "boolean" } } } } }, "responseType": { "$ref": "#/definitions/AccountingRules", "definitions": { "AccountingRules": { "additionalProperties": false, "type": "object", "properties": { "allowRevenueScheduleNegativeAmounts": { "type": "boolean" }, "allowBlankAccountingCodes": { "type": "boolean" }, "allowCreationInClosedPeriod": { "type": "boolean" }, "allowUsageInClosedPeriod": { "type": "boolean" }, "differentCurrencies": { "type": "boolean" }, "useOriginalExchangeRateForCredits": { "type": "boolean" }, "cashBasedAccountingStartDate": { "type": [ "string", "null" ] }, "createJournalEntriesForPendingPayments": { "type": "boolean" } } } } } } ] }, { "key": "AgingBuckets", "description": "Aging Buckets", "context": "Entity", "pathPattern": "/aging-buckets", "httpOperations": [ { "method": "GET", "url": "/settings/aging-buckets", "parameters": [], "responseType": { "$ref": "#/definitions/AgingBucket", "definitions": { "Bucket": { "additionalProperties": false, "type": "object", "properties": { "name": { "type": "string", "maxLength": 100 }, "fromDaysPastDue": { "type": "integer" }, "toDaysPastDue": { "type": "integer" } }, "required": [ "name" ] }, "AgingBucket": { "additionalProperties": false, "type": "object", "properties": { "includeNegativeInvoice": { "type": "boolean" }, "buckets": { "type": "array", "items": { "$ref": "#/definitions/Bucket" } } } } } } }, { "method": "PUT", "url": "/settings/aging-buckets", "parameters": [], "requestType": { "$ref": "#/definitions/AgingBucket", "definitions": { "Bucket": { "additionalProperties": false, "type": "object", "properties": { "name": { "type": "string", "maxLength": 100 }, "fromDaysPastDue": { "type": "integer" }, "toDaysPastDue": { "type": "integer" } }, "required": [ "name" ] }, "AgingBucket": { "additionalProperties": false, "type": "object", "properties": { "includeNegativeInvoice": { "type": "boolean" }, "buckets": { "type": "array", "items": { "$ref": "#/definitions/Bucket" } } } } } }, "responseType": { "$ref": "#/definitions/AgingBucket", "definitions": { "Bucket": { "additionalProperties": false, "type": "object", "properties": { "name": { "type": "string", "maxLength": 100 }, "fromDaysPastDue": { "type": "integer" }, "toDaysPastDue": { "type": "integer" } }, "required": [ "name" ] }, "AgingBucket": { "additionalProperties": false, "type": "object", "properties": { "includeNegativeInvoice": { "type": "boolean" }, "buckets": { "type": "array", "items": { "$ref": "#/definitions/Bucket" } } } } } } } ] }, { "key": "ApplicationRules", "description": "Application Rules settings", "context": "Entity", "pathPattern": "/application-rules", "httpOperations": [ { "method": "GET", "url": "/settings/application-rules", "parameters": [], "responseType": { "$ref": "#/definitions/ApplicationRules", "definitions": { "ApplicationRules": { "additionalProperties": false, "type": "object", "properties": { "applyItemAllocationRule": { "type": "string", "enum": [ "ApplyProrationRule", "ApplyFirstInFirstOut" ] }, "unapplyItemAllocationRule": { "type": "string", "enum": [ "UnapplyFirstInFirstOut" ] } } } } } }, { "method": "PUT", "url": "/settings/application-rules", "parameters": [], "requestType": { "$ref": "#/definitions/ApplicationRules", "definitions": { "ApplicationRules": { "additionalProperties": false, "type": "object", "properties": { "applyItemAllocationRule": { "type": "string", "enum": [ "ApplyProrationRule", "ApplyFirstInFirstOut" ] }, "unapplyItemAllocationRule": { "type": "string", "enum": [ "UnapplyFirstInFirstOut" ] } } } } }, "responseType": { "$ref": "#/definitions/ApplicationRules", "definitions": { "ApplicationRules": { "additionalProperties": false, "type": "object", "properties": { "applyItemAllocationRule": { "type": "string", "enum": [ "ApplyProrationRule", "ApplyFirstInFirstOut" ] }, "unapplyItemAllocationRule": { "type": "string", "enum": [ "UnapplyFirstInFirstOut" ] } } } } } } ] }, { "key": "AuditTrail", "description": "Audit Trail Settings", "context": "Entity", "pathPattern": "/audit-trail", "httpOperations": [ { "method": "GET", "url": "/settings/audit-trail", "parameters": [], "responseType": { "$ref": "#/definitions/AuditTrail", "definitions": { "AuditTrail": { "additionalProperties": false, "type": "object", "properties": { "contact": { "type": "boolean" }, "paymentMethod": { "type": "boolean" }, "payment": { "type": "boolean" }, "account": { "type": "boolean" }, "productCatalog": { "type": "boolean" }, "refund": { "type": "boolean" } } } } } }, { "method": "PUT", "url": "/settings/audit-trail", "parameters": [], "requestType": { "$ref": "#/definitions/AuditTrail", "definitions": { "AuditTrail": { "additionalProperties": false, "type": "object", "properties": { "contact": { "type": "boolean" }, "paymentMethod": { "type": "boolean" }, "payment": { "type": "boolean" }, "account": { "type": "boolean" }, "productCatalog": { "type": "boolean" }, "refund": { "type": "boolean" } } } } }, "responseType": { "$ref": "#/definitions/AuditTrail", "definitions": { "AuditTrail": { "additionalProperties": false, "type": "object", "properties": { "contact": { "type": "boolean" }, "paymentMethod": { "type": "boolean" }, "payment": { "type": "boolean" }, "account": { "type": "boolean" }, "productCatalog": { "type": "boolean" }, "refund": { "type": "boolean" } } } } } } ] }, { "key": "AuditTrailSettings", "description": "Audit Trail Settings", "context": "Entity", "pathPattern": "/audit-trail-settings", "httpOperations": [ { "method": "GET", "url": "/settings/audit-trail-settings", "parameters": [], "responseType": { "$ref": "#/definitions/AuditTrail", "definitions": { "AuditTrail": { "additionalProperties": false, "type": "object", "properties": { "campaignDefinition": { "description": "Specifies whether the HPM Campaign Definition object changes will be audited or not.", "type": "boolean" }, "advancedSMTPServerSetting": { "description": "Specifies whether the Advanced SMTP Server Setting object changes will be audited or not.", "type": "boolean" }, "notificationDefinition": { "description": "Specifies whether the Notification Definition object changes will be audited or not.", "type": "boolean" }, "emailTemplate": { "description": "Specifies whether the Email Template object changes will be audited or not.", "type": "boolean" }, "calloutTemplate": { "description": "Specifies whether the Callout Template object changes will be audited or not.", "type": "boolean" }, "productCatalog": { "description": "Specifies whether the Product Catalog object changes will be audited or not.", "type": "boolean" }, "calloutOption": { "description": "Specifies whether the Callout Option object changes will be audited or not.", "type": "boolean" }, "customScheduledEvent": { "description": "Specifies whether the Custom Scheduled Event object changes will be audited or not.", "type": "boolean" }, "customFieldDefinition": { "description": "Specifies whether the custom Field Definition object changes will be audited or not.", "type": [ "boolean", "null" ] }, "communicationProfile": { "description": "Specifies whether the Communication Profile object changes will be audited or not.", "type": "boolean" }, "orderLineItem": { "description": "Specifies whether the order line item object changes will be audited or not.", "type": "boolean" }, "customEvent": { "description": "Specifies whether the Custom Event object changes will be audited or not.", "type": "boolean" }, "contact": { "description": "Specifies whether the contact object changes will be audited or not.", "type": "boolean" }, "paymentSchedule": { "description": "Specifies whether the payment Schedule object changes will be audited or not.", "type": [ "boolean", "null" ] }, "paymentMethod": { "description": "Specifies whether the Payment Method object changes will be audited or not.", "type": "boolean" }, "payment": { "description": "Specifies whether the payment object changes will be audited or not.", "type": "boolean" }, "account": { "description": "Specifies whether the account object changes will be audited or not.", "type": "boolean" }, "refund": { "description": "Specifies whether the refund object changes will be audited or not.", "type": "boolean" }, "paymentGateway": { "description": "Specifies whether the payment Gateway object changes will be audited or not.", "type": [ "boolean", "null" ] }, "hpmCaptchaCredential": { "description": "Specifies whether the HPM Captcha Credential object changes will be audited or not.", "type": "boolean" }, "oauth2Provider": { "description": "Specifies whether the Oauth2 Provider object changes will be audited or not.", "type": "boolean" } } } } } }, { "method": "PUT", "url": "/settings/audit-trail-settings", "parameters": [], "requestType": { "$ref": "#/definitions/AuditTrail", "definitions": { "AuditTrail": { "additionalProperties": false, "type": "object", "properties": { "campaignDefinition": { "description": "Specifies whether the HPM Campaign Definition object changes will be audited or not.", "type": "boolean" }, "advancedSMTPServerSetting": { "description": "Specifies whether the Advanced SMTP Server Setting object changes will be audited or not.", "type": "boolean" }, "notificationDefinition": { "description": "Specifies whether the Notification Definition object changes will be audited or not.", "type": "boolean" }, "emailTemplate": { "description": "Specifies whether the Email Template object changes will be audited or not.", "type": "boolean" }, "calloutTemplate": { "description": "Specifies whether the Callout Template object changes will be audited or not.", "type": "boolean" }, "productCatalog": { "description": "Specifies whether the Product Catalog object changes will be audited or not.", "type": "boolean" }, "calloutOption": { "description": "Specifies whether the Callout Option object changes will be audited or not.", "type": "boolean" }, "customScheduledEvent": { "description": "Specifies whether the Custom Scheduled Event object changes will be audited or not.", "type": "boolean" }, "customFieldDefinition": { "description": "Specifies whether the custom Field Definition object changes will be audited or not.", "type": [ "boolean", "null" ] }, "communicationProfile": { "description": "Specifies whether the Communication Profile object changes will be audited or not.", "type": "boolean" }, "orderLineItem": { "description": "Specifies whether the order line item object changes will be audited or not.", "type": "boolean" }, "customEvent": { "description": "Specifies whether the Custom Event object changes will be audited or not.", "type": "boolean" }, "contact": { "description": "Specifies whether the contact object changes will be audited or not.", "type": "boolean" }, "paymentSchedule": { "description": "Specifies whether the payment Schedule object changes will be audited or not.", "type": [ "boolean", "null" ] }, "paymentMethod": { "description": "Specifies whether the Payment Method object changes will be audited or not.", "type": "boolean" }, "payment": { "description": "Specifies whether the payment object changes will be audited or not.", "type": "boolean" }, "account": { "description": "Specifies whether the account object changes will be audited or not.", "type": "boolean" }, "refund": { "description": "Specifies whether the refund object changes will be audited or not.", "type": "boolean" }, "paymentGateway": { "description": "Specifies whether the payment Gateway object changes will be audited or not.", "type": [ "boolean", "null" ] }, "hpmCaptchaCredential": { "description": "Specifies whether the HPM Captcha Credential object changes will be audited or not.", "type": "boolean" }, "oauth2Provider": { "description": "Specifies whether the Oauth2 Provider object changes will be audited or not.", "type": "boolean" } } } } }, "responseType": { "$ref": "#/definitions/AuditTrail", "definitions": { "AuditTrail": { "additionalProperties": false, "type": "object", "properties": { "campaignDefinition": { "description": "Specifies whether the HPM Campaign Definition object changes will be audited or not.", "type": "boolean" }, "advancedSMTPServerSetting": { "description": "Specifies whether the Advanced SMTP Server Setting object changes will be audited or not.", "type": "boolean" }, "notificationDefinition": { "description": "Specifies whether the Notification Definition object changes will be audited or not.", "type": "boolean" }, "emailTemplate": { "description": "Specifies whether the Email Template object changes will be audited or not.", "type": "boolean" }, "calloutTemplate": { "description": "Specifies whether the Callout Template object changes will be audited or not.", "type": "boolean" }, "productCatalog": { "description": "Specifies whether the Product Catalog object changes will be audited or not.", "type": "boolean" }, "calloutOption": { "description": "Specifies whether the Callout Option object changes will be audited or not.", "type": "boolean" }, "customScheduledEvent": { "description": "Specifies whether the Custom Scheduled Event object changes will be audited or not.", "type": "boolean" }, "customFieldDefinition": { "description": "Specifies whether the custom Field Definition object changes will be audited or not.", "type": [ "boolean", "null" ] }, "communicationProfile": { "description": "Specifies whether the Communication Profile object changes will be audited or not.", "type": "boolean" }, "orderLineItem": { "description": "Specifies whether the order line item object changes will be audited or not.", "type": "boolean" }, "customEvent": { "description": "Specifies whether the Custom Event object changes will be audited or not.", "type": "boolean" }, "contact": { "description": "Specifies whether the contact object changes will be audited or not.", "type": "boolean" }, "paymentSchedule": { "description": "Specifies whether the payment Schedule object changes will be audited or not.", "type": [ "boolean", "null" ] }, "paymentMethod": { "description": "Specifies whether the Payment Method object changes will be audited or not.", "type": "boolean" }, "payment": { "description": "Specifies whether the payment object changes will be audited or not.", "type": "boolean" }, "account": { "description": "Specifies whether the account object changes will be audited or not.", "type": "boolean" }, "refund": { "description": "Specifies whether the refund object changes will be audited or not.", "type": "boolean" }, "paymentGateway": { "description": "Specifies whether the payment Gateway object changes will be audited or not.", "type": [ "boolean", "null" ] }, "hpmCaptchaCredential": { "description": "Specifies whether the HPM Captcha Credential object changes will be audited or not.", "type": "boolean" }, "oauth2Provider": { "description": "Specifies whether the Oauth2 Provider object changes will be audited or not.", "type": "boolean" } } } } } } ] }, { "key": "BatchAliases", "description": "Customize Batch Names", "context": "Entity", "pathPattern": "/batch-aliases", "httpOperations": [ { "method": "GET", "url": "/settings/batch-aliases", "parameters": [], "responseType": { "$ref": "#/definitions/BatchAlias", "definitions": { "BatchAlias": { "additionalProperties": false, "type": "object", "properties": { "aliases": { "type": "array", "items": { "$ref": "#/definitions/SingleAlias" } } } }, "SingleAlias": { "type": "object", "properties": { "displayName": { "minLength": 1, "type": "string", "maxLength": 50 }, "batch": { "pattern": "^Batch([1-9][0-9]{0,2}|1000)$", "type": "string" } } } } } }, { "method": "PUT", "url": "/settings/batch-aliases", "parameters": [], "requestType": { "$ref": "#/definitions/BatchAlias", "definitions": { "BatchAlias": { "additionalProperties": false, "type": "object", "properties": { "aliases": { "type": "array", "items": { "$ref": "#/definitions/SingleAlias" } } } }, "SingleAlias": { "type": "object", "properties": { "displayName": { "minLength": 1, "type": "string", "maxLength": 50 }, "batch": { "pattern": "^Batch([1-9][0-9]{0,2}|1000)$", "type": "string" } } } } }, "responseType": { "$ref": "#/definitions/BatchAlias", "definitions": { "BatchAlias": { "additionalProperties": false, "type": "object", "properties": { "aliases": { "type": "array", "items": { "$ref": "#/definitions/SingleAlias" } } } }, "SingleAlias": { "type": "object", "properties": { "displayName": { "minLength": 1, "type": "string", "maxLength": 50 }, "batch": { "pattern": "^Batch([1-9][0-9]{0,2}|1000)$", "type": "string" } } } } } } ] }, { "key": "BillingCycleType", "description": "Define the billing day that your organization uses to charge for service.", "context": "Entity", "pathPattern": "/billing-cycle-types", "httpOperations": [ { "method": "GET", "url": "/settings/billing-cycle-types", "parameters": [], "responseType": { "$ref": "#/definitions/BillingCycleType", "definitions": { "BillingCycleType": { "additionalProperties": false, "type": "object", "properties": { "billingCycleTypes": { "type": "array", "items": { "type": "string", "enum": [ "DefaultFromCustomer", "SpecificDayofMonth", "SubscriptionStartDay", "ChargeTriggerDay", "SpecificDayofWeek", "TermStartDay", "TermEndDay" ] } } } } } } }, { "method": "PUT", "url": "/settings/billing-cycle-types", "parameters": [], "requestType": { "$ref": "#/definitions/BillingCycleType", "definitions": { "BillingCycleType": { "additionalProperties": false, "type": "object", "properties": { "billingCycleTypes": { "type": "array", "items": { "type": "string", "enum": [ "DefaultFromCustomer", "SpecificDayofMonth", "SubscriptionStartDay", "ChargeTriggerDay", "SpecificDayofWeek", "TermStartDay", "TermEndDay" ] } } } } } }, "responseType": { "$ref": "#/definitions/BillingCycleType", "definitions": { "BillingCycleType": { "additionalProperties": false, "type": "object", "properties": { "billingCycleTypes": { "type": "array", "items": { "type": "string", "enum": [ "DefaultFromCustomer", "SpecificDayofMonth", "SubscriptionStartDay", "ChargeTriggerDay", "SpecificDayofWeek", "TermStartDay", "TermEndDay" ] } } } } } } } ] }, { "key": "BillingListPriceBase", "description": "Define how your organization specifies list price (e.g. $5 / month, $20 / billing period).", "context": "Entity", "pathPattern": "/billing-list-price-bases", "httpOperations": [ { "method": "GET", "url": "/settings/billing-list-price-bases", "parameters": [], "responseType": { "$ref": "#/definitions/BillingListPriceBase", "definitions": { "BillingListPriceBase": { "additionalProperties": false, "type": "object", "properties": { "listPriceBase": { "type": "array", "items": { "type": "string", "enum": [ "Per_Billing_Period", "Per_Month", "Per_Week", "Per_Specific_Months", "Per_Year", "Per_Validity_Period" ] } } } } } } }, { "method": "PUT", "url": "/settings/billing-list-price-bases", "parameters": [], "requestType": { "$ref": "#/definitions/BillingListPriceBase", "definitions": { "BillingListPriceBase": { "additionalProperties": false, "type": "object", "properties": { "listPriceBase": { "type": "array", "items": { "type": "string", "enum": [ "Per_Billing_Period", "Per_Month", "Per_Week", "Per_Specific_Months", "Per_Year", "Per_Validity_Period" ] } } } } } }, "responseType": { "$ref": "#/definitions/BillingListPriceBase", "definitions": { "BillingListPriceBase": { "additionalProperties": false, "type": "object", "properties": { "listPriceBase": { "type": "array", "items": { "type": "string", "enum": [ "Per_Billing_Period", "Per_Month", "Per_Week", "Per_Specific_Months", "Per_Year", "Per_Validity_Period" ] } } } } } } } ] }, { "key": "BillingPeriodStart", "description": "Define which day in the month you allow your billing periods to start (applicable for billing periods that are integral number of month(s))", "context": "Entity", "pathPattern": "/billing-period-starts", "httpOperations": [ { "method": "GET", "url": "/settings/billing-period-starts", "parameters": [], "responseType": { "$ref": "#/definitions/BillingPeriodStart", "definitions": { "BillingPeriodStart": { "additionalProperties": false, "type": "object", "properties": { "billingPeriodStartDays": { "type": "array", "items": { "type": "string", "enum": [ "AutoSet", "1st", "2nd", "3rd", "4th", "5th", "6th", "7th", "8th", "9th", "10th", "11th", "12th", "13th", "14th", "15th", "16th", "17th", "18th", "19th", "20th", "21st", "22nd", "23rd", "24th", "25th", "26th", "27th", "28th", "29th", "30th", "EndOfMonth" ] } } } } } } }, { "method": "PUT", "url": "/settings/billing-period-starts", "parameters": [], "requestType": { "$ref": "#/definitions/BillingPeriodStart", "definitions": { "BillingPeriodStart": { "additionalProperties": false, "type": "object", "properties": { "billingPeriodStartDays": { "type": "array", "items": { "type": "string", "enum": [ "AutoSet", "1st", "2nd", "3rd", "4th", "5th", "6th", "7th", "8th", "9th", "10th", "11th", "12th", "13th", "14th", "15th", "16th", "17th", "18th", "19th", "20th", "21st", "22nd", "23rd", "24th", "25th", "26th", "27th", "28th", "29th", "30th", "EndOfMonth" ] } } } } } }, "responseType": { "$ref": "#/definitions/BillingPeriodStart", "definitions": { "BillingPeriodStart": { "additionalProperties": false, "type": "object", "properties": { "billingPeriodStartDays": { "type": "array", "items": { "type": "string", "enum": [ "AutoSet", "1st", "2nd", "3rd", "4th", "5th", "6th", "7th", "8th", "9th", "10th", "11th", "12th", "13th", "14th", "15th", "16th", "17th", "18th", "19th", "20th", "21st", "22nd", "23rd", "24th", "25th", "26th", "27th", "28th", "29th", "30th", "EndOfMonth" ] } } } } } } } ] }, { "key": "BillingPeriod", "description": "Define the Billing Periods that your organization uses to charge for service.", "context": "Entity", "pathPattern": "/billing-periods", "httpOperations": [ { "method": "GET", "url": "/settings/billing-periods", "parameters": [], "responseType": { "$ref": "#/definitions/BillingPeriod", "definitions": { "BillingPeriod": { "additionalProperties": false, "type": "object", "properties": { "billingPeriods": { "type": "array", "items": { "type": "string", "enum": [ "Month", "Quarter", "Semi_Annual", "Annual", "Eighteen_Months", "Two_Years", "Three_Years", "Five_Years", "Specific_Months", "Subscription_Term", "Week", "Specific_Weeks", "Specific_Days" ] } } } } } } }, { "method": "PUT", "url": "/settings/billing-periods", "parameters": [], "requestType": { "$ref": "#/definitions/BillingPeriod", "definitions": { "BillingPeriod": { "additionalProperties": false, "type": "object", "properties": { "billingPeriods": { "type": "array", "items": { "type": "string", "enum": [ "Month", "Quarter", "Semi_Annual", "Annual", "Eighteen_Months", "Two_Years", "Three_Years", "Five_Years", "Specific_Months", "Subscription_Term", "Week", "Specific_Weeks", "Specific_Days" ] } } } } } }, "responseType": { "$ref": "#/definitions/BillingPeriod", "definitions": { "BillingPeriod": { "additionalProperties": false, "type": "object", "properties": { "billingPeriods": { "type": "array", "items": { "type": "string", "enum": [ "Month", "Quarter", "Semi_Annual", "Annual", "Eighteen_Months", "Two_Years", "Three_Years", "Five_Years", "Specific_Months", "Subscription_Term", "Week", "Specific_Weeks", "Specific_Days" ] } } } } } } } ] }, { "key": "BillingRules", "description": "Billing Rules settings", "context": "Entity", "pathPattern": "/billing-rules", "httpOperations": [ { "method": "GET", "url": "/settings/billing-rules", "parameters": [], "responseType": { "$ref": "#/definitions/BillingRules", "definitions": { "BillingRules": { "additionalProperties": false, "type": "object", "properties": { "prorationUnit": { "type": "string", "enum": [ "ProrateByDay", "ProrateByMonthFirst" ] }, "prorateUsageWeeklyCharges": { "type": "boolean" }, "preGenerateInvoicePdf": { "type": "boolean" }, "sequentialInvoiceNumber": { "description": "Enable Sequential Billing Document Number", "type": "boolean" }, "availableToCreditValidationLevel": { "type": "string" }, "timeOfDailyInvoice": { "maximum": 23, "type": "integer", "minimum": 0 }, "taxInclusiveRoundingRule": { "type": "string", "enum": [ "RoundingNetAmount", "RoundingTaxAmount" ] }, "taxPreview": { "default": "false", "type": "boolean" }, "billToTermEndWhenAutoRenew": { "description": "Invoice Past End-of-Term when Auto-Renew is ON", "type": "boolean" }, "discountCreditProration": { "default": "false", "type": "boolean" }, "customerHierarchy": { "default": "false", "type": "boolean" }, "recurringChargeStyle": { "type": "string", "enum": [ "Advanced", "Arrears", "DependsOnRatePlan" ] }, "takeContactSnapshot": { "type": "boolean" }, "prorateRecurringMonthlyCharges": { "type": "boolean" }, "proratePeriodOfRecurringCharge": { "description": "Prorate recurring charges for partial period", "type": "boolean" }, "useAvalaraTaxCalculationForIIA": { "description": "Use Avalara to calculate taxes for invoice item adjustments", "type": "boolean" }, "prorateRecurringWeeklyCharges": { "type": "boolean" }, "consolidateInvoices": { "default": "false", "description": "Allow invoices consolidation", "type": "boolean" }, "invoicePastTermEndWhenChargeEndDateOnOrBeforeTermEndDate": { "description": "Options for creating invoicePastTermEndWhenChargeEndDateOnOrBeforeTermEndDate", "type": "string", "enum": [ "BillFullWhenChargeEndDateOnOrBeforeTermEndDate", "BillPartialWhenChargeEndDateOnOrBeforeTermEndDate" ] }, "availableToCreditIncludingRbeCreditMemo": { "default": "false", "type": "boolean" }, "useSystemDefaultSuffixForCreditItems": { "default": "false", "type": "boolean" }, "includeNegativeInvoice": { "type": "boolean" }, "recurringCreditProrationOption": { "default": "BasedOnChargePeriod", "type": "string" }, "discountConsolidated": { "default": "false", "type": "boolean" }, "invoiceSplit": { "description": "Allow invoice splitting", "type": "boolean" }, "notSendZeroItemsForTax": { "type": "boolean" }, "copyBillingAttributesFromAccountForStandaloneInvoice": { "default": "false", "type": "boolean" }, "zuoraNumberFormatForMergeField": { "description": "Format numeric merge fields based on communication profile locales", "type": "boolean" }, "writeOffAllocationRule": { "default": "PRORATION", "type": "string" }, "monthEndCleanup": { "default": "false", "type": "boolean" }, "autoRenewalBillRun": { "default": "true", "type": "boolean" }, "invoicePastEndOfTerm": { "description": "Invoice Past End-of-Term when Auto-Renew is OFF", "type": "boolean" }, "oneTimeCreditBack": { "type": "boolean" }, "debookRebookSupportable": { "description": "Apply new tax rate for additional units purchased and old tax rate for returns", "type": "boolean" }, "includeChildUsage": { "type": "boolean" }, "allowAutoPostBillRun": { "type": "boolean" }, "taxAddressOwner": { "type": "string", "enum": [ "SubscriptionOwner", "InvoiceOwner" ] }, "copyBillingAttributesFromAccount": { "default": "true", "type": "boolean" }, "prorateUsageMonthlyCharges": { "type": "boolean" }, "allowIndistinctMapping": { "description": "Allow indistinct mapping from Memo / Invoice Item Adjustment tax item to invoice item tax", "type": "boolean" }, "stackedDiscountClassApplyRule": { "type": "string", "enum": [ "IgnoreDiscountClass", "FollowDiscountClass" ] }, "autoPostBillRunDefaultValue": { "type": "boolean" }, "creditMemoMirroringInvoiceItemsRule": { "description": "Options for creating credit memos mirroring invoice items", "type": "string", "enum": [ "YesExceptForZeroItems", "Yes", "No" ] }, "daysInMonth": { "type": "string", "enum": [ "Assume30Days", "UseActualDays", "Assume30DaysStrict" ] }, "legalDocumentGeneratingRule": { "type": "string", "enum": [ "GroupbyChargedAmountSign", "GroupByOriginalSRPC", "GroupByTotalAmountSign", "GroupByChargedAmountSignWithZero" ] }, "transactionOnSubscription": { "type": "boolean" }, "numberAssignmentTiming": { "type": "string" }, "catchUpBillRun": { "default": "false", "type": "boolean" }, "taxRateChangeOption": { "type": "string" }, "zuoraTaxRoundingDiffDispersion": { "description": "Enable re-distribution of Zuora Tax Rounding difference", "type": "boolean" }, "rateUsageIndividually": { "type": "boolean" }, "taxGroupingRule": { "type": "string" } } } } } }, { "method": "PUT", "url": "/settings/billing-rules", "parameters": [], "requestType": { "$ref": "#/definitions/BillingRules", "definitions": { "BillingRules": { "additionalProperties": false, "type": "object", "properties": { "prorationUnit": { "type": "string", "enum": [ "ProrateByDay", "ProrateByMonthFirst" ] }, "prorateUsageWeeklyCharges": { "type": "boolean" }, "preGenerateInvoicePdf": { "type": "boolean" }, "sequentialInvoiceNumber": { "description": "Enable Sequential Billing Document Number", "type": "boolean" }, "availableToCreditValidationLevel": { "type": "string" }, "timeOfDailyInvoice": { "maximum": 23, "type": "integer", "minimum": 0 }, "taxInclusiveRoundingRule": { "type": "string", "enum": [ "RoundingNetAmount", "RoundingTaxAmount" ] }, "taxPreview": { "default": "false", "type": "boolean" }, "billToTermEndWhenAutoRenew": { "description": "Invoice Past End-of-Term when Auto-Renew is ON", "type": "boolean" }, "discountCreditProration": { "default": "false", "type": "boolean" }, "customerHierarchy": { "default": "false", "type": "boolean" }, "recurringChargeStyle": { "type": "string", "enum": [ "Advanced", "Arrears", "DependsOnRatePlan" ] }, "takeContactSnapshot": { "type": "boolean" }, "prorateRecurringMonthlyCharges": { "type": "boolean" }, "proratePeriodOfRecurringCharge": { "description": "Prorate recurring charges for partial period", "type": "boolean" }, "useAvalaraTaxCalculationForIIA": { "description": "Use Avalara to calculate taxes for invoice item adjustments", "type": "boolean" }, "prorateRecurringWeeklyCharges": { "type": "boolean" }, "consolidateInvoices": { "default": "false", "description": "Allow invoices consolidation", "type": "boolean" }, "invoicePastTermEndWhenChargeEndDateOnOrBeforeTermEndDate": { "description": "Options for creating invoicePastTermEndWhenChargeEndDateOnOrBeforeTermEndDate", "type": "string", "enum": [ "BillFullWhenChargeEndDateOnOrBeforeTermEndDate", "BillPartialWhenChargeEndDateOnOrBeforeTermEndDate" ] }, "availableToCreditIncludingRbeCreditMemo": { "default": "false", "type": "boolean" }, "useSystemDefaultSuffixForCreditItems": { "default": "false", "type": "boolean" }, "includeNegativeInvoice": { "type": "boolean" }, "recurringCreditProrationOption": { "default": "BasedOnChargePeriod", "type": "string" }, "discountConsolidated": { "default": "false", "type": "boolean" }, "invoiceSplit": { "description": "Allow invoice splitting", "type": "boolean" }, "notSendZeroItemsForTax": { "type": "boolean" }, "copyBillingAttributesFromAccountForStandaloneInvoice": { "default": "false", "type": "boolean" }, "zuoraNumberFormatForMergeField": { "description": "Format numeric merge fields based on communication profile locales", "type": "boolean" }, "writeOffAllocationRule": { "default": "PRORATION", "type": "string" }, "monthEndCleanup": { "default": "false", "type": "boolean" }, "autoRenewalBillRun": { "default": "true", "type": "boolean" }, "invoicePastEndOfTerm": { "description": "Invoice Past End-of-Term when Auto-Renew is OFF", "type": "boolean" }, "oneTimeCreditBack": { "type": "boolean" }, "debookRebookSupportable": { "description": "Apply new tax rate for additional units purchased and old tax rate for returns", "type": "boolean" }, "includeChildUsage": { "type": "boolean" }, "allowAutoPostBillRun": { "type": "boolean" }, "taxAddressOwner": { "type": "string", "enum": [ "SubscriptionOwner", "InvoiceOwner" ] }, "copyBillingAttributesFromAccount": { "default": "true", "type": "boolean" }, "prorateUsageMonthlyCharges": { "type": "boolean" }, "allowIndistinctMapping": { "description": "Allow indistinct mapping from Memo / Invoice Item Adjustment tax item to invoice item tax", "type": "boolean" }, "stackedDiscountClassApplyRule": { "type": "string", "enum": [ "IgnoreDiscountClass", "FollowDiscountClass" ] }, "autoPostBillRunDefaultValue": { "type": "boolean" }, "creditMemoMirroringInvoiceItemsRule": { "description": "Options for creating credit memos mirroring invoice items", "type": "string", "enum": [ "YesExceptForZeroItems", "Yes", "No" ] }, "daysInMonth": { "type": "string", "enum": [ "Assume30Days", "UseActualDays", "Assume30DaysStrict" ] }, "legalDocumentGeneratingRule": { "type": "string", "enum": [ "GroupbyChargedAmountSign", "GroupByOriginalSRPC", "GroupByTotalAmountSign", "GroupByChargedAmountSignWithZero" ] }, "transactionOnSubscription": { "type": "boolean" }, "numberAssignmentTiming": { "type": "string" }, "catchUpBillRun": { "default": "false", "type": "boolean" }, "taxRateChangeOption": { "type": "string" }, "zuoraTaxRoundingDiffDispersion": { "description": "Enable re-distribution of Zuora Tax Rounding difference", "type": "boolean" }, "rateUsageIndividually": { "type": "boolean" }, "taxGroupingRule": { "type": "string" } } } } }, "responseType": { "$ref": "#/definitions/BillingRules", "definitions": { "BillingRules": { "additionalProperties": false, "type": "object", "properties": { "prorationUnit": { "type": "string", "enum": [ "ProrateByDay", "ProrateByMonthFirst" ] }, "prorateUsageWeeklyCharges": { "type": "boolean" }, "preGenerateInvoicePdf": { "type": "boolean" }, "sequentialInvoiceNumber": { "description": "Enable Sequential Billing Document Number", "type": "boolean" }, "availableToCreditValidationLevel": { "type": "string" }, "timeOfDailyInvoice": { "maximum": 23, "type": "integer", "minimum": 0 }, "taxInclusiveRoundingRule": { "type": "string", "enum": [ "RoundingNetAmount", "RoundingTaxAmount" ] }, "taxPreview": { "default": "false", "type": "boolean" }, "billToTermEndWhenAutoRenew": { "description": "Invoice Past End-of-Term when Auto-Renew is ON", "type": "boolean" }, "discountCreditProration": { "default": "false", "type": "boolean" }, "customerHierarchy": { "default": "false", "type": "boolean" }, "recurringChargeStyle": { "type": "string", "enum": [ "Advanced", "Arrears", "DependsOnRatePlan" ] }, "takeContactSnapshot": { "type": "boolean" }, "prorateRecurringMonthlyCharges": { "type": "boolean" }, "proratePeriodOfRecurringCharge": { "description": "Prorate recurring charges for partial period", "type": "boolean" }, "useAvalaraTaxCalculationForIIA": { "description": "Use Avalara to calculate taxes for invoice item adjustments", "type": "boolean" }, "prorateRecurringWeeklyCharges": { "type": "boolean" }, "consolidateInvoices": { "default": "false", "description": "Allow invoices consolidation", "type": "boolean" }, "invoicePastTermEndWhenChargeEndDateOnOrBeforeTermEndDate": { "description": "Options for creating invoicePastTermEndWhenChargeEndDateOnOrBeforeTermEndDate", "type": "string", "enum": [ "BillFullWhenChargeEndDateOnOrBeforeTermEndDate", "BillPartialWhenChargeEndDateOnOrBeforeTermEndDate" ] }, "availableToCreditIncludingRbeCreditMemo": { "default": "false", "type": "boolean" }, "useSystemDefaultSuffixForCreditItems": { "default": "false", "type": "boolean" }, "includeNegativeInvoice": { "type": "boolean" }, "recurringCreditProrationOption": { "default": "BasedOnChargePeriod", "type": "string" }, "discountConsolidated": { "default": "false", "type": "boolean" }, "invoiceSplit": { "description": "Allow invoice splitting", "type": "boolean" }, "notSendZeroItemsForTax": { "type": "boolean" }, "copyBillingAttributesFromAccountForStandaloneInvoice": { "default": "false", "type": "boolean" }, "zuoraNumberFormatForMergeField": { "description": "Format numeric merge fields based on communication profile locales", "type": "boolean" }, "writeOffAllocationRule": { "default": "PRORATION", "type": "string" }, "monthEndCleanup": { "default": "false", "type": "boolean" }, "autoRenewalBillRun": { "default": "true", "type": "boolean" }, "invoicePastEndOfTerm": { "description": "Invoice Past End-of-Term when Auto-Renew is OFF", "type": "boolean" }, "oneTimeCreditBack": { "type": "boolean" }, "debookRebookSupportable": { "description": "Apply new tax rate for additional units purchased and old tax rate for returns", "type": "boolean" }, "includeChildUsage": { "type": "boolean" }, "allowAutoPostBillRun": { "type": "boolean" }, "taxAddressOwner": { "type": "string", "enum": [ "SubscriptionOwner", "InvoiceOwner" ] }, "copyBillingAttributesFromAccount": { "default": "true", "type": "boolean" }, "prorateUsageMonthlyCharges": { "type": "boolean" }, "allowIndistinctMapping": { "description": "Allow indistinct mapping from Memo / Invoice Item Adjustment tax item to invoice item tax", "type": "boolean" }, "stackedDiscountClassApplyRule": { "type": "string", "enum": [ "IgnoreDiscountClass", "FollowDiscountClass" ] }, "autoPostBillRunDefaultValue": { "type": "boolean" }, "creditMemoMirroringInvoiceItemsRule": { "description": "Options for creating credit memos mirroring invoice items", "type": "string", "enum": [ "YesExceptForZeroItems", "Yes", "No" ] }, "daysInMonth": { "type": "string", "enum": [ "Assume30Days", "UseActualDays", "Assume30DaysStrict" ] }, "legalDocumentGeneratingRule": { "type": "string", "enum": [ "GroupbyChargedAmountSign", "GroupByOriginalSRPC", "GroupByTotalAmountSign", "GroupByChargedAmountSignWithZero" ] }, "transactionOnSubscription": { "type": "boolean" }, "numberAssignmentTiming": { "type": "string" }, "catchUpBillRun": { "default": "false", "type": "boolean" }, "taxRateChangeOption": { "type": "string" }, "zuoraTaxRoundingDiffDispersion": { "description": "Enable re-distribution of Zuora Tax Rounding difference", "type": "boolean" }, "rateUsageIndividually": { "type": "boolean" }, "taxGroupingRule": { "type": "string" } } } } } } ] }, { "key": "ChargeModels", "description": "Setting for Charge Models", "context": "Entity", "pathPattern": "/charge-models", "httpOperations": [ { "method": "GET", "url": "/settings/charge-models", "parameters": [], "responseType": { "$ref": "#/definitions/ChargeModel", "definitions": { "ChargeModel": { "additionalProperties": false, "type": "object", "properties": { "chargeModels": { "type": "array", "items": { "type": "string" } } } } } } }, { "method": "PUT", "url": "/settings/charge-models", "parameters": [], "requestType": { "$ref": "#/definitions/ChargeModel", "definitions": { "ChargeModel": { "additionalProperties": false, "type": "object", "properties": { "chargeModels": { "type": "array", "items": { "type": "string" } } } } } }, "responseType": { "$ref": "#/definitions/ChargeModel", "definitions": { "ChargeModel": { "additionalProperties": false, "type": "object", "properties": { "chargeModels": { "type": "array", "items": { "type": "string" } } } } } } } ] }, { "key": "ChargeType", "description": "Setting for Charge Types", "context": "Entity", "pathPattern": "/charge-types", "httpOperations": [ { "method": "GET", "url": "/settings/charge-types", "parameters": [], "responseType": { "$ref": "#/definitions/ChargeType", "definitions": { "ChargeType": { "additionalProperties": false, "type": "object", "properties": { "chargeTypes": { "type": "array", "items": { "type": "string", "enum": [ "OneTime", "Recurring", "Usage" ] } } } } } } }, { "method": "PUT", "url": "/settings/charge-types", "parameters": [], "requestType": { "$ref": "#/definitions/ChargeType", "definitions": { "ChargeType": { "additionalProperties": false, "type": "object", "properties": { "chargeTypes": { "type": "array", "items": { "type": "string", "enum": [ "OneTime", "Recurring", "Usage" ] } } } } } }, "responseType": { "$ref": "#/definitions/ChargeType", "definitions": { "ChargeType": { "additionalProperties": false, "type": "object", "properties": { "chargeTypes": { "type": "array", "items": { "type": "string", "enum": [ "OneTime", "Recurring", "Usage" ] } } } } } } } ] }, { "key": "ChartOfAccounts", "description": "Manage Finance Chart Of Accounts", "context": "Entity", "pathPattern": "/chart-of-accounts", "httpOperations": [ { "method": "GET", "url": "/settings/chart-of-accounts", "parameters": [], "responseType": { "$ref": "#/definitions/AccountingCodeItems", "definitions": { "AccountingCodeItems": { "type": "array", "items": { "$ref": "#/definitions/AccountingCodeItem" } }, "AccountingCodeItem": { "additionalProperties": false, "type": "object", "properties": { "segmentConstantValues": { "description": "Map of segment constant values for Accounting Code Item", "additionalProperties": { "type": "string" }, "type": [ "object", "null" ] }, "glaccountNumber": { "description": "General Ledger Account Number", "type": "string" }, "notes": { "description": "Any additional notes for Accounting Code Item", "type": "string" }, "glaccountName": { "description": "General Ledger Account Name", "type": "string" }, "customFieldsValues": { "description": "Map of custom fields for Accounting Code Item", "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "description": "Name of Accounting Code Item", "type": "string" }, "id": { "description": "Unique Id of Accounting Code Item", "type": "string" }, "category": { "description": "Category of Accounting Code Item (Assets, Revenue, Liabilities etc)", "type": "string" }, "type": { "description": "Type of Accounting Code Item (Cash, Sales Revenue, Other Assets etc)", "type": "string" }, "status": { "description": "Status of Accounting Code Item", "type": "string" } } } } } }, { "method": "POST", "url": "/settings/chart-of-accounts", "parameters": [], "requestType": { "$ref": "#/definitions/AccountingCodeItem", "definitions": { "AccountingCodeItems": { "type": "array", "items": { "$ref": "#/definitions/AccountingCodeItem" } }, "AccountingCodeItem": { "additionalProperties": false, "type": "object", "properties": { "segmentConstantValues": { "description": "Map of segment constant values for Accounting Code Item", "additionalProperties": { "type": "string" }, "type": [ "object", "null" ] }, "glaccountNumber": { "description": "General Ledger Account Number", "type": "string" }, "notes": { "description": "Any additional notes for Accounting Code Item", "type": "string" }, "glaccountName": { "description": "General Ledger Account Name", "type": "string" }, "customFieldsValues": { "description": "Map of custom fields for Accounting Code Item", "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "description": "Name of Accounting Code Item", "type": "string" }, "id": { "description": "Unique Id of Accounting Code Item", "type": "string" }, "category": { "description": "Category of Accounting Code Item (Assets, Revenue, Liabilities etc)", "type": "string" }, "type": { "description": "Type of Accounting Code Item (Cash, Sales Revenue, Other Assets etc)", "type": "string" }, "status": { "description": "Status of Accounting Code Item", "type": "string" } } } } }, "responseType": { "$ref": "#/definitions/AccountingCodeItem", "definitions": { "AccountingCodeItems": { "type": "array", "items": { "$ref": "#/definitions/AccountingCodeItem" } }, "AccountingCodeItem": { "additionalProperties": false, "type": "object", "properties": { "segmentConstantValues": { "description": "Map of segment constant values for Accounting Code Item", "additionalProperties": { "type": "string" }, "type": [ "object", "null" ] }, "glaccountNumber": { "description": "General Ledger Account Number", "type": "string" }, "notes": { "description": "Any additional notes for Accounting Code Item", "type": "string" }, "glaccountName": { "description": "General Ledger Account Name", "type": "string" }, "customFieldsValues": { "description": "Map of custom fields for Accounting Code Item", "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "description": "Name of Accounting Code Item", "type": "string" }, "id": { "description": "Unique Id of Accounting Code Item", "type": "string" }, "category": { "description": "Category of Accounting Code Item (Assets, Revenue, Liabilities etc)", "type": "string" }, "type": { "description": "Type of Accounting Code Item (Cash, Sales Revenue, Other Assets etc)", "type": "string" }, "status": { "description": "Status of Accounting Code Item", "type": "string" } } } } } } ] }, { "key": "ChartOfAccountsItem", "description": "Manage Finance Chart Of Account", "context": "Entity", "pathPattern": "/chart-of-accounts/{id}", "httpOperations": [ { "method": "GET", "url": "/settings/chart-of-accounts/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Chart of Account code" } ], "responseType": { "$ref": "#/definitions/AccountingCodeItem", "definitions": { "AccountingCodeItem": { "additionalProperties": false, "type": "object", "properties": { "segmentConstantValues": { "description": "Map of segment constant values for Accounting Code Item", "additionalProperties": { "type": "string" }, "type": [ "object", "null" ] }, "glaccountNumber": { "description": "General Ledger Account Number", "type": "string" }, "notes": { "description": "Any additional notes for Accounting Code Item", "type": "string" }, "glaccountName": { "description": "General Ledger Account Name", "type": "string" }, "customFieldsValues": { "description": "Map of custom fields for Accounting Code Item", "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "description": "Name of Accounting Code Item", "type": "string" }, "id": { "description": "Unique Id of Accounting Code Item", "type": "string" }, "category": { "description": "Category of Accounting Code Item (Assets, Revenue, Liabilities etc)", "type": "string" }, "type": { "description": "Type of Accounting Code Item (Cash, Sales Revenue, Other Assets etc)", "type": "string" }, "status": { "description": "Status of Accounting Code Item", "type": "string", "enum": [ "Active", "Inactive" ] } } } } } }, { "method": "PUT", "url": "/settings/chart-of-accounts/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Chart of Account code" } ], "requestType": { "$ref": "#/definitions/AccountingCodeItem", "definitions": { "AccountingCodeItem": { "additionalProperties": false, "type": "object", "properties": { "segmentConstantValues": { "description": "Map of segment constant values for Accounting Code Item", "additionalProperties": { "type": "string" }, "type": [ "object", "null" ] }, "glaccountNumber": { "description": "General Ledger Account Number", "type": "string" }, "notes": { "description": "Any additional notes for Accounting Code Item", "type": "string" }, "glaccountName": { "description": "General Ledger Account Name", "type": "string" }, "customFieldsValues": { "description": "Map of custom fields for Accounting Code Item", "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "description": "Name of Accounting Code Item", "type": "string" }, "id": { "description": "Unique Id of Accounting Code Item", "type": "string" }, "category": { "description": "Category of Accounting Code Item (Assets, Revenue, Liabilities etc)", "type": "string" }, "type": { "description": "Type of Accounting Code Item (Cash, Sales Revenue, Other Assets etc)", "type": "string" }, "status": { "description": "Status of Accounting Code Item", "type": "string", "enum": [ "Active", "Inactive" ] } } } } }, "responseType": { "$ref": "#/definitions/AccountingCodeItem", "definitions": { "AccountingCodeItem": { "additionalProperties": false, "type": "object", "properties": { "segmentConstantValues": { "description": "Map of segment constant values for Accounting Code Item", "additionalProperties": { "type": "string" }, "type": [ "object", "null" ] }, "glaccountNumber": { "description": "General Ledger Account Number", "type": "string" }, "notes": { "description": "Any additional notes for Accounting Code Item", "type": "string" }, "glaccountName": { "description": "General Ledger Account Name", "type": "string" }, "customFieldsValues": { "description": "Map of custom fields for Accounting Code Item", "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "description": "Name of Accounting Code Item", "type": "string" }, "id": { "description": "Unique Id of Accounting Code Item", "type": "string" }, "category": { "description": "Category of Accounting Code Item (Assets, Revenue, Liabilities etc)", "type": "string" }, "type": { "description": "Type of Accounting Code Item (Cash, Sales Revenue, Other Assets etc)", "type": "string" }, "status": { "description": "Status of Accounting Code Item", "type": "string", "enum": [ "Active", "Inactive" ] } } } } } }, { "method": "DELETE", "url": "/settings/chart-of-accounts/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Chart of Account code" } ] } ] }, { "key": "AllCommunicationProfiles", "description": "Communication profile settings for Notifications and Callouts", "context": "Entity", "pathPattern": "/communication-profiles", "httpOperations": [ { "method": "GET", "url": "/settings/communication-profiles", "parameters": [], "responseType": { "$ref": "#/definitions/CommunicationProfiles", "definitions": { "CommunicationProfile": { "additionalProperties": false, "type": "object", "properties": { "number": { "type": "string" }, "isDefault": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "locale": { "type": "string" }, "muted": { "type": "boolean" } } }, "PostCommunicationProfile": { "additionalProperties": false, "type": "object", "properties": { "number": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "locale": { "type": "string" }, "muted": { "type": "boolean" } } }, "CommunicationProfiles": { "type": "array", "items": { "$ref": "#/definitions/CommunicationProfile" } } } } }, { "method": "POST", "url": "/settings/communication-profiles", "parameters": [], "requestType": { "$ref": "#/definitions/PostCommunicationProfile", "definitions": { "CommunicationProfile": { "additionalProperties": false, "type": "object", "properties": { "number": { "type": "string" }, "isDefault": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "locale": { "type": "string" }, "muted": { "type": "boolean" } } }, "PostCommunicationProfile": { "additionalProperties": false, "type": "object", "properties": { "number": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "locale": { "type": "string" }, "muted": { "type": "boolean" } } }, "CommunicationProfiles": { "type": "array", "items": { "$ref": "#/definitions/CommunicationProfile" } } } }, "responseType": { "$ref": "#/definitions/CommunicationProfile", "definitions": { "CommunicationProfile": { "additionalProperties": false, "type": "object", "properties": { "number": { "type": "string" }, "isDefault": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "locale": { "type": "string" }, "muted": { "type": "boolean" } } }, "PostCommunicationProfile": { "additionalProperties": false, "type": "object", "properties": { "number": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "locale": { "type": "string" }, "muted": { "type": "boolean" } } }, "CommunicationProfiles": { "type": "array", "items": { "$ref": "#/definitions/CommunicationProfile" } } } } } ] }, { "key": "CommunicationProfileNotification", "description": "Settings to create/update/delete Notifications for events", "context": "Entity", "pathPattern": "/communication-profiles/notifications/{id}", "httpOperations": [ { "method": "GET", "url": "/settings/communication-profiles/notifications/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Notification" } ], "responseType": { "$ref": "#/definitions/Notification", "definitions": { "Notification": { "type": "object", "properties": { "hidden": { "type": "boolean" }, "description": { "type": "string" }, "httpMethod": { "type": "string" }, "calloutOauth2Id": { "type": "string" }, "filterRuleId": { "type": "string" }, "calloutOption": { "type": "boolean" }, "calloutAuthDomain": { "type": "string" }, "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": { "additionalProperties": { "type": "string" }, "type": "object" }, "param4": { "type": "string" }, "calloutBaseUrl": { "type": "string" }, "param1": { "type": "string" }, "param2": { "type": "string" }, "profileId": { "type": "string" }, "name": { "type": "string" }, "calloutUsername": { "type": "string" }, "additionalProperties": false, "calloutParams": { "type": "string" }, "calloutOauth2": { "type": "boolean" }, "calloutPreemptiveAuth": { "type": "boolean" }, "emailTemplateName": { "type": "string" } } } } } }, { "method": "PUT", "url": "/settings/communication-profiles/notifications/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Notification" } ], "requestType": { "$ref": "#/definitions/Notification", "definitions": { "Notification": { "type": "object", "properties": { "hidden": { "type": "boolean" }, "description": { "type": "string" }, "httpMethod": { "type": "string" }, "calloutOauth2Id": { "type": "string" }, "filterRuleId": { "type": "string" }, "calloutOption": { "type": "boolean" }, "calloutAuthDomain": { "type": "string" }, "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": { "additionalProperties": { "type": "string" }, "type": "object" }, "param4": { "type": "string" }, "calloutBaseUrl": { "type": "string" }, "param1": { "type": "string" }, "param2": { "type": "string" }, "profileId": { "type": "string" }, "name": { "type": "string" }, "calloutUsername": { "type": "string" }, "additionalProperties": false, "calloutParams": { "type": "string" }, "calloutOauth2": { "type": "boolean" }, "calloutPreemptiveAuth": { "type": "boolean" }, "emailTemplateName": { "type": "string" } } } } }, "responseType": { "$ref": "#/definitions/Notification", "definitions": { "Notification": { "type": "object", "properties": { "hidden": { "type": "boolean" }, "description": { "type": "string" }, "httpMethod": { "type": "string" }, "calloutOauth2Id": { "type": "string" }, "filterRuleId": { "type": "string" }, "calloutOption": { "type": "boolean" }, "calloutAuthDomain": { "type": "string" }, "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": { "additionalProperties": { "type": "string" }, "type": "object" }, "param4": { "type": "string" }, "calloutBaseUrl": { "type": "string" }, "param1": { "type": "string" }, "param2": { "type": "string" }, "profileId": { "type": "string" }, "name": { "type": "string" }, "calloutUsername": { "type": "string" }, "additionalProperties": false, "calloutParams": { "type": "string" }, "calloutOauth2": { "type": "boolean" }, "calloutPreemptiveAuth": { "type": "boolean" }, "emailTemplateName": { "type": "string" } } } } } }, { "method": "DELETE", "url": "/settings/communication-profiles/notifications/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Notification" } ] } ] }, { "key": "CommunicationProfile", "description": "Communication profile settings for Notifications and Callouts", "context": "Entity", "pathPattern": "/communication-profiles/{id}", "httpOperations": [ { "method": "GET", "url": "/settings/communication-profiles/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Communication Profile" } ], "responseType": { "$ref": "#/definitions/GetCommunicationProfile", "definitions": { "GetCommunicationProfile": { "additionalProperties": false, "type": "object", "properties": { "number": { "type": "string" }, "isDefault": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "locale": { "type": "string" }, "muted": { "type": "boolean" } } }, "CommunicationProfile": { "additionalProperties": false, "type": "object", "properties": { "number": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "locale": { "type": "string" }, "muted": { "type": "boolean" } } } } } }, { "method": "PUT", "url": "/settings/communication-profiles/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Communication Profile" } ], "requestType": { "$ref": "#/definitions/CommunicationProfile", "definitions": { "GetCommunicationProfile": { "additionalProperties": false, "type": "object", "properties": { "number": { "type": "string" }, "isDefault": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "locale": { "type": "string" }, "muted": { "type": "boolean" } } }, "CommunicationProfile": { "additionalProperties": false, "type": "object", "properties": { "number": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "locale": { "type": "string" }, "muted": { "type": "boolean" } } } } }, "responseType": { "$ref": "#/definitions/GetCommunicationProfile", "definitions": { "GetCommunicationProfile": { "additionalProperties": false, "type": "object", "properties": { "number": { "type": "string" }, "isDefault": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "locale": { "type": "string" }, "muted": { "type": "boolean" } } }, "CommunicationProfile": { "additionalProperties": false, "type": "object", "properties": { "number": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "locale": { "type": "string" }, "muted": { "type": "boolean" } } } } } }, { "method": "DELETE", "url": "/settings/communication-profiles/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Communication Profile" } ] } ] }, { "key": "AllCommunicationProfileNotifications", "description": "All notifications belonging to a Communication Profile", "context": "Entity", "pathPattern": "/communication-profiles/{id}/notifications", "httpOperations": [ { "method": "GET", "url": "/settings/communication-profiles/{id}/notifications", "parameters": [ { "name": "id", "description": "Unique Id of the Communication Profile" } ], "responseType": { "$ref": "#/definitions/AllNotifications", "definitions": { "AllNotifications": { "type": "array", "items": { "$ref": "#/definitions/Notification" } }, "Notification": { "type": "object", "properties": { "hidden": { "type": "boolean" }, "description": { "type": "string" }, "httpMethod": { "type": "string" }, "calloutOauth2Id": { "type": "string" }, "filterRuleId": { "type": "string" }, "calloutOption": { "type": "boolean" }, "calloutAuthDomain": { "type": "string" }, "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": { "additionalProperties": { "type": "string" }, "type": "object" }, "param4": { "type": "string" }, "calloutBaseUrl": { "type": "string" }, "param1": { "type": "string" }, "param2": { "type": "string" }, "profileId": { "type": "string" }, "name": { "type": "string" }, "calloutUsername": { "type": "string" }, "additionalProperties": false, "calloutParams": { "type": "string" }, "calloutOauth2": { "type": "boolean" }, "calloutPreemptiveAuth": { "type": "boolean" }, "emailTemplateName": { "type": "string" }, "useCustomRequestBody": { "type": "boolean" } } } } } }, { "method": "POST", "url": "/settings/communication-profiles/{id}/notifications", "parameters": [ { "name": "id", "description": "Unique Id of the Communication Profile" } ], "requestType": { "$ref": "#/definitions/Notification", "definitions": { "AllNotifications": { "type": "array", "items": { "$ref": "#/definitions/Notification" } }, "Notification": { "type": "object", "properties": { "hidden": { "type": "boolean" }, "description": { "type": "string" }, "httpMethod": { "type": "string" }, "calloutOauth2Id": { "type": "string" }, "filterRuleId": { "type": "string" }, "calloutOption": { "type": "boolean" }, "calloutAuthDomain": { "type": "string" }, "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": { "additionalProperties": { "type": "string" }, "type": "object" }, "param4": { "type": "string" }, "calloutBaseUrl": { "type": "string" }, "param1": { "type": "string" }, "param2": { "type": "string" }, "profileId": { "type": "string" }, "name": { "type": "string" }, "calloutUsername": { "type": "string" }, "additionalProperties": false, "calloutParams": { "type": "string" }, "calloutOauth2": { "type": "boolean" }, "calloutPreemptiveAuth": { "type": "boolean" }, "emailTemplateName": { "type": "string" }, "useCustomRequestBody": { "type": "boolean" } } } } }, "responseType": { "$ref": "#/definitions/Notification", "definitions": { "AllNotifications": { "type": "array", "items": { "$ref": "#/definitions/Notification" } }, "Notification": { "type": "object", "properties": { "hidden": { "type": "boolean" }, "description": { "type": "string" }, "httpMethod": { "type": "string" }, "calloutOauth2Id": { "type": "string" }, "filterRuleId": { "type": "string" }, "calloutOption": { "type": "boolean" }, "calloutAuthDomain": { "type": "string" }, "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": { "additionalProperties": { "type": "string" }, "type": "object" }, "param4": { "type": "string" }, "calloutBaseUrl": { "type": "string" }, "param1": { "type": "string" }, "param2": { "type": "string" }, "profileId": { "type": "string" }, "name": { "type": "string" }, "calloutUsername": { "type": "string" }, "additionalProperties": false, "calloutParams": { "type": "string" }, "calloutOauth2": { "type": "boolean" }, "calloutPreemptiveAuth": { "type": "boolean" }, "emailTemplateName": { "type": "string" }, "useCustomRequestBody": { "type": "boolean" } } } } } } ] }, { "key": "ConfigurableUI", "description": "Feature flag to enable Configurable UI experience", "context": "Tenant", "pathPattern": "/configurable-ui", "httpOperations": [ { "method": "GET", "url": "/settings/configurable-ui", "parameters": [], "responseType": { "type": "boolean" } }, { "method": "POST", "url": "/settings/configurable-ui", "parameters": [], "requestType": { "type": "boolean" }, "responseType": { "type": "boolean" } }, { "method": "PUT", "url": "/settings/configurable-ui", "parameters": [], "requestType": { "type": "boolean" }, "responseType": { "type": "boolean" } }, { "method": "DELETE", "url": "/settings/configurable-ui", "parameters": [] } ] }, { "key": "ConfigurableUISetting", "description": "Feature flag to enable Configurable UI experience", "context": "Tenant", "pathPattern": "/configurable-ui-enabled", "httpOperations": [ { "method": "GET", "url": "/settings/configurable-ui-enabled", "parameters": [], "responseType": { "type": "boolean" } }, { "method": "POST", "url": "/settings/configurable-ui-enabled", "parameters": [], "requestType": { "type": "boolean" }, "responseType": { "type": "boolean" } }, { "method": "PUT", "url": "/settings/configurable-ui-enabled", "parameters": [], "requestType": { "type": "boolean" }, "responseType": { "type": "boolean" } }, { "method": "DELETE", "url": "/settings/configurable-ui-enabled", "parameters": [] } ] }, { "key": "ConfigurableUIHomepage", "description": "Feature flag to enable Configurable UI experience for Homepage", "context": "Tenant", "pathPattern": "/configurable-ui-homepage-enabled", "httpOperations": [ { "method": "GET", "url": "/settings/configurable-ui-homepage-enabled", "parameters": [], "responseType": { "type": "boolean" } }, { "method": "POST", "url": "/settings/configurable-ui-homepage-enabled", "parameters": [], "requestType": { "type": "boolean" }, "responseType": { "type": "boolean" } }, { "method": "PUT", "url": "/settings/configurable-ui-homepage-enabled", "parameters": [], "requestType": { "type": "boolean" }, "responseType": { "type": "boolean" } }, { "method": "DELETE", "url": "/settings/configurable-ui-homepage-enabled", "parameters": [] } ] }, { "key": "AllCreditMemoTemplates", "description": "Setting for all Credit Memo Templates", "context": "Tenant", "pathPattern": "/credit-memo-templates", "httpOperations": [ { "method": "GET", "url": "/settings/credit-memo-templates", "parameters": [], "responseType": { "type": "array", "items": { "$ref": "#/definitions/Template" }, "definitions": { "TemplatePostDto": { "additionalProperties": false, "type": "object", "properties": { "templateCategory": { "description": "The category of the template", "type": "string", "enum": [ "Old", "New" ] }, "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Credit Memo", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] } }, "required": [ "name", "base64EncodedTemplateFileContent" ] }, "Template": { "additionalProperties": false, "type": "object", "properties": { "templateCategory": { "description": "The category of the template", "type": "string", "enum": [ "Old", "New" ] }, "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Credit Memo", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "updatedOn": { "type": "string" }, "id": { "description": "The unique identifier of the template", "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] }, "associatedToBillingAccount": { "type": "boolean" } } } } } }, { "method": "POST", "url": "/settings/credit-memo-templates", "parameters": [], "requestType": { "$ref": "#/definitions/TemplatePostDto", "definitions": { "TemplatePostDto": { "additionalProperties": false, "type": "object", "properties": { "templateCategory": { "description": "The category of the template", "type": "string", "enum": [ "Old", "New" ] }, "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Credit Memo", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] } }, "required": [ "name", "base64EncodedTemplateFileContent" ] }, "Template": { "additionalProperties": false, "type": "object", "properties": { "templateCategory": { "description": "The category of the template", "type": "string", "enum": [ "Old", "New" ] }, "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Credit Memo", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "updatedOn": { "type": "string" }, "id": { "description": "The unique identifier of the template", "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] }, "associatedToBillingAccount": { "type": "boolean" } } } } }, "responseType": { "$ref": "#/definitions/Template", "definitions": { "TemplatePostDto": { "additionalProperties": false, "type": "object", "properties": { "templateCategory": { "description": "The category of the template", "type": "string", "enum": [ "Old", "New" ] }, "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Credit Memo", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] } }, "required": [ "name", "base64EncodedTemplateFileContent" ] }, "Template": { "additionalProperties": false, "type": "object", "properties": { "templateCategory": { "description": "The category of the template", "type": "string", "enum": [ "Old", "New" ] }, "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Credit Memo", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "updatedOn": { "type": "string" }, "id": { "description": "The unique identifier of the template", "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] }, "associatedToBillingAccount": { "type": "boolean" } } } } } } ] }, { "key": "CreditMemoTemplate", "description": "Setting for Credit Memo Template", "context": "Tenant", "pathPattern": "/credit-memo-templates/{id}", "httpOperations": [ { "method": "GET", "url": "/settings/credit-memo-templates/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Credit Memo Template" } ], "responseType": { "$ref": "#/definitions/Template", "definitions": { "Template": { "additionalProperties": false, "type": "object", "properties": { "templateCategory": { "description": "The category of the template", "type": "string", "enum": [ "Old", "New" ] }, "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Credit Memo", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "updatedOn": { "type": "string" }, "id": { "description": "The unique identifier of the template", "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] }, "associatedToBillingAccount": { "type": "boolean" } } } } } }, { "method": "PUT", "url": "/settings/credit-memo-templates/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Credit Memo Template" } ], "requestType": { "$ref": "#/definitions/CreditTemplate", "definitions": { "CreditTemplate": { "additionalProperties": false, "type": "object", "properties": { "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Invoice", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" } } }, "Template": { "additionalProperties": false, "type": "object", "properties": { "templateCategory": { "description": "The category of the template", "type": "string", "enum": [ "Old", "New" ] }, "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Credit Memo", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "id": { "description": "The unique identifier of the template", "type": "string" }, "updatedOn": { "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] }, "associatedToBillingAccount": { "type": "boolean" } } } } }, "responseType": { "$ref": "#/definitions/Template", "definitions": { "CreditTemplate": { "additionalProperties": false, "type": "object", "properties": { "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Invoice", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" } } }, "Template": { "additionalProperties": false, "type": "object", "properties": { "templateCategory": { "description": "The category of the template", "type": "string", "enum": [ "Old", "New" ] }, "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Credit Memo", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "id": { "description": "The unique identifier of the template", "type": "string" }, "updatedOn": { "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] }, "associatedToBillingAccount": { "type": "boolean" } } } } } }, { "method": "DELETE", "url": "/settings/credit-memo-templates/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Credit Memo Template" } ] } ] }, { "key": "Currency", "description": "Setting for Currency", "context": "Entity", "pathPattern": "/currencies", "httpOperations": [ { "method": "GET", "url": "/settings/currencies", "parameters": [], "responseType": { "$ref": "#/definitions/Currencies", "definitions": { "Currency": { "additionalProperties": false, "type": "object", "properties": { "defaultIncrementForInclusiveTax": { "default": false, "type": "boolean" }, "roundingMode": { "type": "string", "enum": [ "Up", "Down", "HalfUp" ] }, "default": { "default": false, "type": "boolean" }, "rate": { "type": "number" }, "roundingIncrement": { "type": "number" }, "incrementForInvoiceTotal": { "default": false, "type": "boolean" }, "active": { "default": true, "type": "boolean" }, "currencyCode": { "pattern": "^[A-Z]{3}$", "type": "string" } }, "required": [ "currencyCode" ] }, "Currencies": { "additionalProperties": false, "type": "object", "properties": { "currencies": { "type": "array", "items": { "$ref": "#/definitions/Currency" } } } } } } }, { "method": "PUT", "url": "/settings/currencies", "parameters": [], "requestType": { "$ref": "#/definitions/Currencies", "definitions": { "Currency": { "additionalProperties": false, "type": "object", "properties": { "defaultIncrementForInclusiveTax": { "default": false, "type": "boolean" }, "roundingMode": { "type": "string", "enum": [ "Up", "Down", "HalfUp" ] }, "default": { "default": false, "type": "boolean" }, "rate": { "type": "number" }, "roundingIncrement": { "type": "number" }, "incrementForInvoiceTotal": { "default": false, "type": "boolean" }, "active": { "default": true, "type": "boolean" }, "currencyCode": { "pattern": "^[A-Z]{3}$", "type": "string" } }, "required": [ "currencyCode" ] }, "Currencies": { "additionalProperties": false, "type": "object", "properties": { "currencies": { "type": "array", "items": { "$ref": "#/definitions/Currency" } } } } } }, "responseType": { "$ref": "#/definitions/Currencies", "definitions": { "Currency": { "additionalProperties": false, "type": "object", "properties": { "defaultIncrementForInclusiveTax": { "default": false, "type": "boolean" }, "roundingMode": { "type": "string", "enum": [ "Up", "Down", "HalfUp" ] }, "default": { "default": false, "type": "boolean" }, "rate": { "type": "number" }, "roundingIncrement": { "type": "number" }, "incrementForInvoiceTotal": { "default": false, "type": "boolean" }, "active": { "default": true, "type": "boolean" }, "currencyCode": { "pattern": "^[A-Z]{3}$", "type": "string" } }, "required": [ "currencyCode" ] }, "Currencies": { "additionalProperties": false, "type": "object", "properties": { "currencies": { "type": "array", "items": { "$ref": "#/definitions/Currency" } } } } } } } ] }, { "key": "AllCustomFields", "description": "Murano custom fields (not legacy custom fields)", "context": "Entity", "pathPattern": "/custom-fields/{namespace}", "httpOperations": [ { "method": "GET", "url": "/settings/custom-fields/{namespace}", "parameters": [ { "name": "namespace", "description": "Name of the custom field namespace" } ], "responseType": { "$ref": "#/definitions/CustomFields", "definitions": { "CustomFields": { "additionalProperties": false, "type": "object", "properties": { "count": { "type": "integer" }, "definitions": { "patternProperties": { ".+": { "additionalProperties": false, "type": "object", "properties": { "schema": { "type": "object" }, "createdDate": { "type": "string" }, "id": { "type": "string", "maxLength": 36 }, "updatedDate": { "type": "string" }, "type": { "type": "string" }, "updatedById": { "type": "string", "maxLength": 36 }, "createdById": { "type": "string", "maxLength": 36 } } } }, "type": "object" } } } } } } ] }, { "key": "CustomField", "description": "Murano custom fields (not legacy custom fields) for given namespace", "context": "Entity", "pathPattern": "/custom-fields/{namespace}/{type}", "httpOperations": [ { "method": "GET", "url": "/settings/custom-fields/{namespace}/{type}", "parameters": [ { "name": "namespace", "description": "Namespace of the Custom Field" }, { "name": "type", "description": "Type of Custom Field" } ], "responseType": { "$ref": "#/definitions/CustomFieldGet", "definitions": { "CustomFieldPut": { "type": "object" }, "CustomFieldGet": { "additionalProperties": false, "type": "object", "properties": { "schema": { "type": "object" }, "createdDate": { "type": "string" }, "id": { "type": "string", "maxLength": 36 }, "updatedDate": { "type": "string" }, "type": { "type": "string" }, "updatedById": { "type": "string", "maxLength": 36 }, "createdById": { "type": "string", "maxLength": 36 } } } } } }, { "method": "PUT", "url": "/settings/custom-fields/{namespace}/{type}", "parameters": [ { "name": "namespace", "description": "Namespace of the Custom Field" }, { "name": "type", "description": "Type of Custom Field" } ], "requestType": { "$ref": "#/definitions/CustomFieldPut", "definitions": { "CustomFieldPut": { "type": "object" }, "CustomFieldGet": { "additionalProperties": false, "type": "object", "properties": { "schema": { "type": "object" }, "createdDate": { "type": "string" }, "id": { "type": "string", "maxLength": 36 }, "updatedDate": { "type": "string" }, "type": { "type": "string" }, "updatedById": { "type": "string", "maxLength": 36 }, "createdById": { "type": "string", "maxLength": 36 } } } } }, "responseType": { "type": "string", "definitions": { "CustomFieldPut": { "type": "object" }, "CustomFieldGet": { "additionalProperties": false, "type": "object", "properties": { "schema": { "type": "object" }, "createdDate": { "type": "string" }, "id": { "type": "string", "maxLength": 36 }, "updatedDate": { "type": "string" }, "type": { "type": "string" }, "updatedById": { "type": "string", "maxLength": 36 }, "createdById": { "type": "string", "maxLength": 36 } } } } } } ] }, { "key": "CustomObjectMigration", "description": "Migration of custom object definitions", "context": "Entity", "pathPattern": "/objects/migrations", "httpOperations": [ { "method": "POST", "url": "/settings/objects/migrations", "parameters": [], "requestType": { "$ref": "#/definitions/CustomObjectDefinitionUpdateActionRequest", "definitions": { "CustomObjectDefinitionUpdateActionResponse": { "additionalProperties": false, "type": "object", "properties": { "actions": { "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "enableCreateRecordAuditing": { "type": "boolean" }, "enableRecordMigration": { "type": [ "boolean", "null" ] }, "enableDeleteRecordAuditing": { "type": "boolean" }, "legacy": { "type": "boolean" }, "field": { "type": "object", "properties": { "filterable": { "type": "boolean" }, "targetName": { "type": "string" }, "auditable": { "type": "boolean" }, "unique": { "type": "boolean" }, "name": { "type": "string" }, "definition": { "type": "object", "properties": { "multiselect": { "type": "boolean" }, "default": { "type": [ "string", "integer", "boolean", "null" ] }, "createdDate": { "type": "string" }, "displayName": { "type": "boolean" }, "origin": { "type": "string", "enum": [ "custom" ] }, "format": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "updatedDate": { "type": "string" }, "type": { "type": "string" }, "maxLength": { "type": "integer" } } }, "required": { "type": "boolean" } } }, "namespace": { "type": "string" }, "description": { "type": "string" }, "label": { "type": "string" }, "relationship": { "type": "object", "properties": { "namespace": { "type": "string" }, "fields": { "description": "Field mappings in the form of : ", "additionalProperties": { "type": "string" }, "type": "object" }, "recordConstraints": { "type": "object", "properties": { "create": { "type": "object", "properties": { "enforceValidMapping": { "default": true, "type": "boolean" } } } } }, "cardinality": { "type": "string", "enum": [ "manyToOne", "oneToMany" ] }, "object": { "type": "string" } } }, "type": { "type": "string", "enum": [ "addField", "deleteField", "updateField", "updateObject", "renameField", "addRelationship", "deleteRelationship" ] }, "object": { "type": "string" } } } }, "instant": { "default": true, "type": "boolean" } } }, "CustomObjectDefinitionUpdateActionRequest": { "additionalProperties": false, "type": "object", "properties": { "actions": { "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "enableCreateRecordAuditing": { "type": "boolean" }, "enableRecordMigration": { "type": [ "boolean", "null" ] }, "legacy": { "type": "boolean" }, "enableDeleteRecordAuditing": { "type": "boolean" }, "field": { "type": "object", "properties": { "filterable": { "type": "boolean" }, "targetName": { "type": "string" }, "auditable": { "type": "boolean" }, "unique": { "type": "boolean" }, "name": { "type": "string" }, "definition": { "type": "object", "properties": { "multiselect": { "type": "boolean" }, "default": { "type": [ "string", "integer", "boolean", "null" ] }, "displayName": { "type": "boolean" }, "origin": { "type": "string", "enum": [ "custom" ] }, "format": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "type": { "type": "string" }, "maxLength": { "type": "integer" } } }, "required": { "type": "boolean" } } }, "namespace": { "type": "string" }, "description": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string", "enum": [ "addField", "deleteField", "updateField", "updateObject", "renameField", "addRelationship", "deleteRelationship" ] }, "relationship": { "type": "object", "properties": { "namespace": { "type": "string" }, "fields": { "description": "Field mappings in the form of : ", "additionalProperties": { "type": "string" }, "type": "object" }, "recordConstraints": { "type": "object", "properties": { "create": { "type": "object", "properties": { "enforceValidMapping": { "default": true, "type": "boolean" } } } } }, "cardinality": { "type": "string", "enum": [ "manyToOne", "oneToMany" ] }, "object": { "type": "string" } }, "required": [ "namespace", "object", "fields" ] }, "object": { "type": "string" } }, "required": [ "type", "namespace", "object" ] } }, "instant": { "default": true, "type": "boolean" } }, "required": [ "actions" ] } } }, "responseType": { "$ref": "#/definitions/CustomObjectDefinitionUpdateActionResponse", "definitions": { "CustomObjectDefinitionUpdateActionResponse": { "additionalProperties": false, "type": "object", "properties": { "actions": { "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "enableCreateRecordAuditing": { "type": "boolean" }, "enableRecordMigration": { "type": [ "boolean", "null" ] }, "enableDeleteRecordAuditing": { "type": "boolean" }, "legacy": { "type": "boolean" }, "field": { "type": "object", "properties": { "filterable": { "type": "boolean" }, "targetName": { "type": "string" }, "auditable": { "type": "boolean" }, "unique": { "type": "boolean" }, "name": { "type": "string" }, "definition": { "type": "object", "properties": { "multiselect": { "type": "boolean" }, "default": { "type": [ "string", "integer", "boolean", "null" ] }, "createdDate": { "type": "string" }, "displayName": { "type": "boolean" }, "origin": { "type": "string", "enum": [ "custom" ] }, "format": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "updatedDate": { "type": "string" }, "type": { "type": "string" }, "maxLength": { "type": "integer" } } }, "required": { "type": "boolean" } } }, "namespace": { "type": "string" }, "description": { "type": "string" }, "label": { "type": "string" }, "relationship": { "type": "object", "properties": { "namespace": { "type": "string" }, "fields": { "description": "Field mappings in the form of : ", "additionalProperties": { "type": "string" }, "type": "object" }, "recordConstraints": { "type": "object", "properties": { "create": { "type": "object", "properties": { "enforceValidMapping": { "default": true, "type": "boolean" } } } } }, "cardinality": { "type": "string", "enum": [ "manyToOne", "oneToMany" ] }, "object": { "type": "string" } } }, "type": { "type": "string", "enum": [ "addField", "deleteField", "updateField", "updateObject", "renameField", "addRelationship", "deleteRelationship" ] }, "object": { "type": "string" } } } }, "instant": { "default": true, "type": "boolean" } } }, "CustomObjectDefinitionUpdateActionRequest": { "additionalProperties": false, "type": "object", "properties": { "actions": { "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "enableCreateRecordAuditing": { "type": "boolean" }, "enableRecordMigration": { "type": [ "boolean", "null" ] }, "legacy": { "type": "boolean" }, "enableDeleteRecordAuditing": { "type": "boolean" }, "field": { "type": "object", "properties": { "filterable": { "type": "boolean" }, "targetName": { "type": "string" }, "auditable": { "type": "boolean" }, "unique": { "type": "boolean" }, "name": { "type": "string" }, "definition": { "type": "object", "properties": { "multiselect": { "type": "boolean" }, "default": { "type": [ "string", "integer", "boolean", "null" ] }, "displayName": { "type": "boolean" }, "origin": { "type": "string", "enum": [ "custom" ] }, "format": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "type": { "type": "string" }, "maxLength": { "type": "integer" } } }, "required": { "type": "boolean" } } }, "namespace": { "type": "string" }, "description": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string", "enum": [ "addField", "deleteField", "updateField", "updateObject", "renameField", "addRelationship", "deleteRelationship" ] }, "relationship": { "type": "object", "properties": { "namespace": { "type": "string" }, "fields": { "description": "Field mappings in the form of : ", "additionalProperties": { "type": "string" }, "type": "object" }, "recordConstraints": { "type": "object", "properties": { "create": { "type": "object", "properties": { "enforceValidMapping": { "default": true, "type": "boolean" } } } } }, "cardinality": { "type": "string", "enum": [ "manyToOne", "oneToMany" ] }, "object": { "type": "string" } }, "required": [ "namespace", "object", "fields" ] }, "object": { "type": "string" } }, "required": [ "type", "namespace", "object" ] } }, "instant": { "default": true, "type": "boolean" } }, "required": [ "actions" ] } } } } ] }, { "key": "AllCustomObjectNamespaces", "description": "Read/create namespaces for Custom Objects", "context": "Entity", "pathPattern": "/custom-object-namespaces", "httpOperations": [ { "method": "GET", "url": "/settings/custom-object-namespaces", "parameters": [], "responseType": { "$ref": "#/definitions/AllCustomObjectNamespaces", "definitions": { "CustomObjectNamespace": { "additionalProperties": false, "type": "object", "properties": { "createdDate": { "type": "string" }, "origin": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "string", "maxLength": 36 }, "updatedDate": { "type": "string" }, "updatedById": { "type": "string", "maxLength": 36 }, "createdById": { "type": "string", "maxLength": 36 } } }, "AllCustomObjectNamespaces": { "additionalProperties": false, "type": "object", "properties": { "count": { "type": "integer" }, "namespaces": { "type": "array", "items": { "$ref": "#/definitions/CustomObjectNamespace" } } } }, "CustomObjectNamespacePost": { "additionalProperties": false, "type": "object", "properties": { "origin": { "type": "string" }, "name": { "type": "string" } } } } } }, { "method": "POST", "url": "/settings/custom-object-namespaces", "parameters": [], "requestType": { "$ref": "#/definitions/CustomObjectNamespacePost", "definitions": { "CustomObjectNamespace": { "additionalProperties": false, "type": "object", "properties": { "createdDate": { "type": "string" }, "origin": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "string", "maxLength": 36 }, "updatedDate": { "type": "string" }, "updatedById": { "type": "string", "maxLength": 36 }, "createdById": { "type": "string", "maxLength": 36 } } }, "AllCustomObjectNamespaces": { "additionalProperties": false, "type": "object", "properties": { "count": { "type": "integer" }, "namespaces": { "type": "array", "items": { "$ref": "#/definitions/CustomObjectNamespace" } } } }, "CustomObjectNamespacePost": { "additionalProperties": false, "type": "object", "properties": { "origin": { "type": "string" }, "name": { "type": "string" } } } } }, "responseType": { "$ref": "#/definitions/CustomObjectNamespace", "definitions": { "CustomObjectNamespace": { "additionalProperties": false, "type": "object", "properties": { "createdDate": { "type": "string" }, "origin": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "string", "maxLength": 36 }, "updatedDate": { "type": "string" }, "updatedById": { "type": "string", "maxLength": 36 }, "createdById": { "type": "string", "maxLength": 36 } } }, "AllCustomObjectNamespaces": { "additionalProperties": false, "type": "object", "properties": { "count": { "type": "integer" }, "namespaces": { "type": "array", "items": { "$ref": "#/definitions/CustomObjectNamespace" } } } }, "CustomObjectNamespacePost": { "additionalProperties": false, "type": "object", "properties": { "origin": { "type": "string" }, "name": { "type": "string" } } } } } } ] }, { "key": "CustomObjectNamespace", "description": "Read/delete a namespace for Custom Objects", "context": "Entity", "pathPattern": "/custom-object-namespaces/{namespace}", "httpOperations": [ { "method": "GET", "url": "/settings/custom-object-namespaces/{namespace}", "parameters": [ { "name": "namespace", "description": "The name of the custom object namespace" } ], "responseType": { "$ref": "#/definitions/CustomObjectNamespace", "definitions": { "CustomObjectNamespace": { "additionalProperties": false, "type": "object", "properties": { "createdDate": { "type": "string" }, "origin": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "string", "maxLength": 36 }, "updatedDate": { "type": "string" }, "updatedById": { "type": "string", "maxLength": 36 }, "createdById": { "type": "string", "maxLength": 36 } } } } } }, { "method": "DELETE", "url": "/settings/custom-object-namespaces/{namespace}", "parameters": [ { "name": "namespace", "description": "The name of the custom object namespace" } ] } ] }, { "key": "AllCustomObjects", "description": "Read/Create Custom Object definitions", "context": "Entity", "pathPattern": "/custom-objects/{namespace}", "httpOperations": [ { "method": "GET", "url": "/settings/custom-objects/{namespace}", "parameters": [ { "name": "namespace", "description": "The name of the custom object namespace" } ], "responseType": { "$ref": "#/definitions/AllCustomObjectDefinitions", "definitions": { "AllCustomObjectDefinitions": { "additionalProperties": false, "type": "object", "properties": { "count": { "type": "integer" }, "definitions": { "patternProperties": { ".+": { "$ref": "#/definitions/CustomObjectDefinition" } }, "type": "object" } } }, "CustomObjectDefinitionPost": { "type": "object" }, "CustomObjectDefinition": { "additionalProperties": false, "type": "object", "properties": { "schema": { "type": "object" }, "CreatedDate": { "type": "string" }, "Id": { "type": "string", "maxLength": 36 }, "UpdatedDate": { "type": "string" }, "type": { "type": "string" }, "UpdatedById": { "type": "string", "maxLength": 36 }, "CreatedById": { "type": "string", "maxLength": 36 } } } } } }, { "method": "POST", "url": "/settings/custom-objects/{namespace}", "parameters": [ { "name": "namespace", "description": "The name of the custom object namespace" } ], "requestType": { "$ref": "#/definitions/CustomObjectDefinitionPost", "definitions": { "AllCustomObjectDefinitions": { "additionalProperties": false, "type": "object", "properties": { "count": { "type": "integer" }, "definitions": { "patternProperties": { ".+": { "$ref": "#/definitions/CustomObjectDefinition" } }, "type": "object" } } }, "CustomObjectDefinitionPost": { "type": "object" }, "CustomObjectDefinition": { "additionalProperties": false, "type": "object", "properties": { "schema": { "type": "object" }, "CreatedDate": { "type": "string" }, "Id": { "type": "string", "maxLength": 36 }, "UpdatedDate": { "type": "string" }, "type": { "type": "string" }, "UpdatedById": { "type": "string", "maxLength": 36 }, "CreatedById": { "type": "string", "maxLength": 36 } } } } }, "responseType": { "$ref": "#/definitions/CustomObjectDefinition", "definitions": { "AllCustomObjectDefinitions": { "additionalProperties": false, "type": "object", "properties": { "count": { "type": "integer" }, "definitions": { "patternProperties": { ".+": { "$ref": "#/definitions/CustomObjectDefinition" } }, "type": "object" } } }, "CustomObjectDefinitionPost": { "type": "object" }, "CustomObjectDefinition": { "additionalProperties": false, "type": "object", "properties": { "schema": { "type": "object" }, "CreatedDate": { "type": "string" }, "Id": { "type": "string", "maxLength": 36 }, "UpdatedDate": { "type": "string" }, "type": { "type": "string" }, "UpdatedById": { "type": "string", "maxLength": 36 }, "CreatedById": { "type": "string", "maxLength": 36 } } } } } } ] }, { "key": "CustomObject", "description": "Read/Delete a Custom Object Definition", "context": "Entity", "pathPattern": "/custom-objects/{namespace}/{type}", "httpOperations": [ { "method": "GET", "url": "/settings/custom-objects/{namespace}/{type}", "parameters": [ { "name": "namespace", "description": "The name of the custom object namespace" }, { "name": "type", "description": "The type of the custom object definition" } ], "responseType": { "$ref": "#/definitions/CustomObjectDefinition", "definitions": { "CustomObjectDefinition": { "additionalProperties": false, "type": "object", "properties": { "schema": { "type": "object" }, "CreatedDate": { "type": "string" }, "Id": { "type": "string", "maxLength": 36 }, "UpdatedDate": { "type": "string" }, "type": { "type": "string" }, "UpdatedById": { "type": "string", "maxLength": 36 }, "CreatedById": { "type": "string", "maxLength": 36 } } } } } }, { "method": "DELETE", "url": "/settings/custom-objects/{namespace}/{type}", "parameters": [ { "name": "namespace", "description": "The name of the custom object namespace" }, { "name": "type", "description": "The type of the custom object definition" } ], "responseType": { "type": "string", "definitions": { "CustomObjectDefinition": { "additionalProperties": false, "type": "object", "properties": { "schema": { "type": "object" }, "CreatedDate": { "type": "string" }, "Id": { "type": "string", "maxLength": 36 }, "UpdatedDate": { "type": "string" }, "type": { "type": "string" }, "UpdatedById": { "type": "string", "maxLength": 36 }, "CreatedById": { "type": "string", "maxLength": 36 } } } } } } ] }, { "key": "DataAccessControl", "description": "Manage hierarchies and control what users can access within your tenant.", "context": "Entity", "pathPattern": "/data-access-controls", "httpOperations": [ { "method": "GET", "url": "/settings/data-access-controls", "parameters": [], "responseType": { "$ref": "#/definitions/DataAccess", "definitions": { "HierarchyDefinition": { "type": "object", "properties": { "children": { "type": "array", "items": { "$ref": "#/definitions/HierarchyDefinition" } }, "name": { "type": "string" }, "id": { "type": "string" } } }, "HierarchyInfo": { "type": "object", "properties": { "apiName": { "type": "string" }, "active": { "type": "boolean" }, "description": { "type": "string" }, "label": { "type": "string" } } }, "DataAccess": { "additionalProperties": false, "type": "object", "properties": { "hierarchyDefinition": { "$ref": "#/definitions/HierarchyDefinition" }, "hierarchyInfo": { "$ref": "#/definitions/HierarchyInfo" } } } } } } ] }, { "key": "DataAccessInfo", "description": "Manage hierarchies info (Subset of DataAccess).", "context": "Entity", "pathPattern": "/data-access-info", "httpOperations": [ { "method": "GET", "url": "/settings/data-access-info", "parameters": [], "responseType": { "$ref": "#/definitions/HierarchyInfo", "definitions": { "HierarchyInfo": { "additionalProperties": false, "type": "object", "properties": { "apiName": { "type": "string" }, "active": { "type": "boolean" }, "description": { "type": "string" }, "label": { "type": "string" } } } } } }, { "method": "PUT", "url": "/settings/data-access-info", "parameters": [], "requestType": { "$ref": "#/definitions/HierarchyInfo", "definitions": { "HierarchyInfo": { "additionalProperties": false, "type": "object", "properties": { "apiName": { "type": "string" }, "active": { "type": "boolean" }, "description": { "type": "string" }, "label": { "type": "string" } } } } }, "responseType": { "$ref": "#/definitions/HierarchyInfo", "definitions": { "HierarchyInfo": { "additionalProperties": false, "type": "object", "properties": { "apiName": { "type": "string" }, "active": { "type": "boolean" }, "description": { "type": "string" }, "label": { "type": "string" } } } } } } ] }, { "key": "DataAccessHierarchy", "description": "Manage hierarchies definitions (Subset of DataAccess).", "context": "Entity", "pathPattern": "/data-access-tags", "httpOperations": [ { "method": "GET", "url": "/settings/data-access-tags", "parameters": [], "responseType": { "$ref": "#/definitions/HierarchyDefinition", "definitions": { "HierarchyDefinition": { "additionalProperties": false, "type": "object", "properties": { "children": { "type": "array", "items": { "$ref": "#/definitions/HierarchyDefinition" } }, "name": { "type": "string" }, "id": { "type": "string" } } }, "PostHierarchyDefinition": { "additionalProperties": false, "type": "object", "properties": { "children": { "type": "array", "items": { "$ref": "#/definitions/PostHierarchyDefinition" } }, "name": { "type": "string" } } } } } }, { "method": "POST", "url": "/settings/data-access-tags", "parameters": [], "requestType": { "$ref": "#/definitions/PostHierarchyDefinition", "definitions": { "HierarchyDefinition": { "additionalProperties": false, "type": "object", "properties": { "children": { "type": "array", "items": { "$ref": "#/definitions/HierarchyDefinition" } }, "name": { "type": "string" }, "id": { "type": "string" } } }, "PostHierarchyDefinition": { "additionalProperties": false, "type": "object", "properties": { "children": { "type": "array", "items": { "$ref": "#/definitions/PostHierarchyDefinition" } }, "name": { "type": "string" } } } } }, "responseType": { "$ref": "#/definitions/HierarchyDefinition", "definitions": { "HierarchyDefinition": { "additionalProperties": false, "type": "object", "properties": { "children": { "type": "array", "items": { "$ref": "#/definitions/HierarchyDefinition" } }, "name": { "type": "string" }, "id": { "type": "string" } } }, "PostHierarchyDefinition": { "additionalProperties": false, "type": "object", "properties": { "children": { "type": "array", "items": { "$ref": "#/definitions/PostHierarchyDefinition" } }, "name": { "type": "string" } } } } } } ] }, { "key": "DataAccessTag", "description": "Manage hierarchies definitions (Subset of DataAccess).", "context": "Tenant", "pathPattern": "/data-access-tags/{id}", "httpOperations": [ { "method": "GET", "url": "/settings/data-access-tags/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Hierarchy Definition" } ], "responseType": { "$ref": "#/definitions/HierarchyDefinition", "definitions": { "HierarchyDefinition": { "additionalProperties": false, "type": "object", "properties": { "children": { "type": "array", "items": { "$ref": "#/definitions/HierarchyDefinition" } }, "name": { "type": "string" }, "id": { "type": "string" }, "parentId": { "type": "string" } } } } } }, { "method": "PUT", "url": "/settings/data-access-tags/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Hierarchy Definition" } ], "requestType": { "type": "string", "definitions": { "HierarchyDefinition": { "additionalProperties": false, "type": "object", "properties": { "children": { "type": "array", "items": { "$ref": "#/definitions/HierarchyDefinition" } }, "name": { "type": "string" }, "id": { "type": "string" }, "parentId": { "type": "string" } } } } }, "responseType": { "$ref": "#/definitions/HierarchyDefinition", "definitions": { "HierarchyDefinition": { "additionalProperties": false, "type": "object", "properties": { "children": { "type": "array", "items": { "$ref": "#/definitions/HierarchyDefinition" } }, "name": { "type": "string" }, "id": { "type": "string" }, "parentId": { "type": "string" } } } } } }, { "method": "DELETE", "url": "/settings/data-access-tags/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Hierarchy Definition" } ] } ] }, { "key": "AllDebitMemoTemplates", "description": "Setting for all Debit Memo Templates", "context": "Tenant", "pathPattern": "/debit-memo-templates", "httpOperations": [ { "method": "GET", "url": "/settings/debit-memo-templates", "parameters": [], "responseType": { "type": "array", "items": { "$ref": "#/definitions/Template" }, "definitions": { "TemplatePostDto": { "additionalProperties": false, "type": "object", "properties": { "templateCategory": { "description": "The category of the template", "type": "string", "enum": [ "Old", "New" ] }, "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Debit Memo", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] } }, "required": [ "name", "base64EncodedTemplateFileContent" ] }, "Template": { "additionalProperties": false, "type": "object", "properties": { "templateCategory": { "description": "The category of the template", "type": "string", "enum": [ "Old", "New" ] }, "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Debit Memo", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "updatedOn": { "type": "string" }, "id": { "description": "The unique identifier of the template", "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] }, "associatedToBillingAccount": { "type": "boolean" } } } } } }, { "method": "POST", "url": "/settings/debit-memo-templates", "parameters": [], "requestType": { "$ref": "#/definitions/TemplatePostDto", "definitions": { "TemplatePostDto": { "additionalProperties": false, "type": "object", "properties": { "templateCategory": { "description": "The category of the template", "type": "string", "enum": [ "Old", "New" ] }, "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Debit Memo", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] } }, "required": [ "name", "base64EncodedTemplateFileContent" ] }, "Template": { "additionalProperties": false, "type": "object", "properties": { "templateCategory": { "description": "The category of the template", "type": "string", "enum": [ "Old", "New" ] }, "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Debit Memo", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "updatedOn": { "type": "string" }, "id": { "description": "The unique identifier of the template", "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] }, "associatedToBillingAccount": { "type": "boolean" } } } } }, "responseType": { "$ref": "#/definitions/Template", "definitions": { "TemplatePostDto": { "additionalProperties": false, "type": "object", "properties": { "templateCategory": { "description": "The category of the template", "type": "string", "enum": [ "Old", "New" ] }, "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Debit Memo", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] } }, "required": [ "name", "base64EncodedTemplateFileContent" ] }, "Template": { "additionalProperties": false, "type": "object", "properties": { "templateCategory": { "description": "The category of the template", "type": "string", "enum": [ "Old", "New" ] }, "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Debit Memo", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "updatedOn": { "type": "string" }, "id": { "description": "The unique identifier of the template", "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] }, "associatedToBillingAccount": { "type": "boolean" } } } } } } ] }, { "key": "DebitMemoTemplate", "description": "Setting for Debit Memo Template", "context": "Tenant", "pathPattern": "/debit-memo-templates/{id}", "httpOperations": [ { "method": "GET", "url": "/settings/debit-memo-templates/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Debit Memo Template" } ], "responseType": { "$ref": "#/definitions/Template", "definitions": { "Template": { "additionalProperties": false, "type": "object", "properties": { "templateCategory": { "description": "The category of the template", "type": "string", "enum": [ "Old", "New" ] }, "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Debit Memo", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "updatedOn": { "type": "string" }, "id": { "description": "The unique identifier of the template", "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] }, "associatedToBillingAccount": { "type": "boolean" } } } } } }, { "method": "PUT", "url": "/settings/debit-memo-templates/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Debit Memo Template" } ], "requestType": { "$ref": "#/definitions/DebitTemplate", "definitions": { "DebitTemplate": { "additionalProperties": false, "type": "object", "properties": { "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Invoice", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" } } }, "Template": { "additionalProperties": false, "type": "object", "properties": { "templateCategory": { "description": "The category of the template", "type": "string", "enum": [ "Old", "New" ] }, "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Debit Memo", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "id": { "description": "The unique identifier of the template", "type": "string" }, "updatedOn": { "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] }, "associatedToBillingAccount": { "type": "boolean" } } } } }, "responseType": { "$ref": "#/definitions/Template", "definitions": { "DebitTemplate": { "additionalProperties": false, "type": "object", "properties": { "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Invoice", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" } } }, "Template": { "additionalProperties": false, "type": "object", "properties": { "templateCategory": { "description": "The category of the template", "type": "string", "enum": [ "Old", "New" ] }, "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Debit Memo", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "id": { "description": "The unique identifier of the template", "type": "string" }, "updatedOn": { "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] }, "associatedToBillingAccount": { "type": "boolean" } } } } } }, { "method": "DELETE", "url": "/settings/debit-memo-templates/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Debit Memo Template" } ] } ] }, { "key": "DefaultAccountingCodes", "description": "API for default rev rec rules and accounting codes", "context": "Entity", "pathPattern": "/default-accounting-codes", "httpOperations": [ { "method": "GET", "url": "/settings/default-accounting-codes", "parameters": [], "responseType": { "$ref": "#/definitions/DefaultAccountingCodes", "definitions": { "DefaultAccountingCodes": { "additionalProperties": false, "type": "object", "properties": { "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" } } } } } }, { "method": "PUT", "url": "/settings/default-accounting-codes", "parameters": [], "requestType": { "$ref": "#/definitions/DefaultAccountingCodes", "definitions": { "DefaultAccountingCodes": { "additionalProperties": false, "type": "object", "properties": { "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" } } } } }, "responseType": { "$ref": "#/definitions/DefaultAccountingCodes", "definitions": { "DefaultAccountingCodes": { "additionalProperties": false, "type": "object", "properties": { "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", "description": "Manage Payment Gateways", "context": "Entity", "pathPattern": "/default-payment-gateways", "httpOperations": [ { "method": "GET", "url": "/settings/default-payment-gateways", "parameters": [], "responseType": { "type": "string" } }, { "method": "PUT", "url": "/settings/default-payment-gateways", "parameters": [], "requestType": { "type": "string" }, "responseType": { "type": "string" } } ] }, { "key": "AllDiscountSettings", "description": "List of all Discount settings", "context": "Entity", "pathPattern": "/discount-settings", "httpOperations": [ { "method": "GET", "url": "/settings/discount-settings", "parameters": [], "responseType": { "$ref": "#/definitions/DiscountSettings", "definitions": { "DiscountSettings": { "additionalProperties": false, "type": "object", "properties": { "discounts": { "type": "array", "items": { "$ref": "#/definitions/DiscountSetting" } } } }, "DiscountSetting": { "additionalProperties": false, "type": "object", "properties": { "name": { "type": "string" }, "active": { "default": true, "type": "boolean" }, "id": { "type": "string" }, "priority": { "type": "integer" } } } } } }, { "method": "POST", "url": "/settings/discount-settings", "parameters": [], "requestType": { "$ref": "#/definitions/DiscountSetting", "definitions": { "DiscountSettings": { "additionalProperties": false, "type": "object", "properties": { "discounts": { "type": "array", "items": { "$ref": "#/definitions/DiscountSetting" } } } }, "DiscountSetting": { "additionalProperties": false, "type": "object", "properties": { "name": { "type": "string" }, "active": { "default": true, "type": "boolean" }, "id": { "type": "string" }, "priority": { "type": "integer" } } } } }, "responseType": { "$ref": "#/definitions/DiscountSetting", "definitions": { "DiscountSettings": { "additionalProperties": false, "type": "object", "properties": { "discounts": { "type": "array", "items": { "$ref": "#/definitions/DiscountSetting" } } } }, "DiscountSetting": { "additionalProperties": false, "type": "object", "properties": { "name": { "type": "string" }, "active": { "default": true, "type": "boolean" }, "id": { "type": "string" }, "priority": { "type": "integer" } } } } } } ] }, { "key": "DiscountSettings", "description": "Setting for Discounts", "context": "Entity", "pathPattern": "/discount-settings/{id}", "httpOperations": [ { "method": "GET", "url": "/settings/discount-settings/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Discount setting" } ], "responseType": { "$ref": "#/definitions/DiscountSetting", "definitions": { "DiscountSetting": { "additionalProperties": false, "type": "object", "properties": { "name": { "type": "string" }, "active": { "default": true, "type": "boolean" }, "id": { "type": "string" }, "priority": { "type": "integer" } } } } } }, { "method": "PUT", "url": "/settings/discount-settings/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Discount setting" } ], "requestType": { "$ref": "#/definitions/DiscountSetting", "definitions": { "DiscountSetting": { "additionalProperties": false, "type": "object", "properties": { "name": { "type": "string" }, "active": { "default": true, "type": "boolean" }, "id": { "type": "string" }, "priority": { "type": "integer" } } } } }, "responseType": { "$ref": "#/definitions/DiscountSetting", "definitions": { "DiscountSetting": { "additionalProperties": false, "type": "object", "properties": { "name": { "type": "string" }, "active": { "default": true, "type": "boolean" }, "id": { "type": "string" }, "priority": { "type": "integer" } } } } } }, { "method": "DELETE", "url": "/settings/discount-settings/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Discount setting" } ] } ] }, { "key": "DocPrefix", "description": "Settings for Document Prefix", "context": "Entity", "pathPattern": "/doc-prefixes", "httpOperations": [ { "method": "GET", "url": "/settings/doc-prefixes", "parameters": [], "responseType": { "$ref": "#/definitions/DocPrefix", "definitions": { "DocPrefix": { "additionalProperties": false, "type": "object", "properties": { "refundPrefix": { "$ref": "#/definitions/PrefixAndNum" }, "paymentPrefix": { "$ref": "#/definitions/PrefixAndNum" }, "creditMemo": { "$ref": "#/definitions/PrefixAndNum" }, "invoice": { "$ref": "#/definitions/PrefixAndNum" }, "debitMemo": { "$ref": "#/definitions/PrefixAndNum" } } }, "PrefixAndNum": { "additionalProperties": false, "type": "object", "properties": { "prefix": { "type": "string", "maxLength": 16 }, "startNum": { "type": "number" } } } } } }, { "method": "PUT", "url": "/settings/doc-prefixes", "parameters": [], "requestType": { "$ref": "#/definitions/DocPrefix", "definitions": { "DocPrefix": { "additionalProperties": false, "type": "object", "properties": { "refundPrefix": { "$ref": "#/definitions/PrefixAndNum" }, "paymentPrefix": { "$ref": "#/definitions/PrefixAndNum" }, "creditMemo": { "$ref": "#/definitions/PrefixAndNum" }, "invoice": { "$ref": "#/definitions/PrefixAndNum" }, "debitMemo": { "$ref": "#/definitions/PrefixAndNum" } } }, "PrefixAndNum": { "additionalProperties": false, "type": "object", "properties": { "prefix": { "type": "string", "maxLength": 16 }, "startNum": { "type": "number" } } } } }, "responseType": { "$ref": "#/definitions/DocPrefix", "definitions": { "DocPrefix": { "additionalProperties": false, "type": "object", "properties": { "refundPrefix": { "$ref": "#/definitions/PrefixAndNum" }, "paymentPrefix": { "$ref": "#/definitions/PrefixAndNum" }, "creditMemo": { "$ref": "#/definitions/PrefixAndNum" }, "invoice": { "$ref": "#/definitions/PrefixAndNum" }, "debitMemo": { "$ref": "#/definitions/PrefixAndNum" } } }, "PrefixAndNum": { "additionalProperties": false, "type": "object", "properties": { "prefix": { "type": "string", "maxLength": 16 }, "startNum": { "type": "number" } } } } } } ] }, { "key": "DocumentFilenamePatterns", "description": "Setting for document filename patterns", "context": "Entity", "pathPattern": "/document-filename-patterns", "httpOperations": [ { "method": "GET", "url": "/settings/document-filename-patterns", "parameters": [], "responseType": { "$ref": "#/definitions/DocumentFilenamePatternsResponse", "definitions": { "DocumentFilenamePatternsRequest": { "type": "object", "properties": { "creditMemo": { "type": "string" }, "invoice": { "type": "string" }, "debitMemo": { "type": "string" } } }, "DocumentFilenamePatternsResponse": { "type": "object", "properties": { "creditMemo": { "type": "string" }, "invoice": { "type": "string" }, "debitMemo": { "type": "string" } } } } } }, { "method": "PUT", "url": "/settings/document-filename-patterns", "parameters": [], "requestType": { "$ref": "#/definitions/DocumentFilenamePatternsRequest", "definitions": { "DocumentFilenamePatternsRequest": { "type": "object", "properties": { "creditMemo": { "type": "string" }, "invoice": { "type": "string" }, "debitMemo": { "type": "string" } } }, "DocumentFilenamePatternsResponse": { "type": "object", "properties": { "creditMemo": { "type": "string" }, "invoice": { "type": "string" }, "debitMemo": { "type": "string" } } } } }, "responseType": { "$ref": "#/definitions/DocumentFilenamePatternsResponse", "definitions": { "DocumentFilenamePatternsRequest": { "type": "object", "properties": { "creditMemo": { "type": "string" }, "invoice": { "type": "string" }, "debitMemo": { "type": "string" } } }, "DocumentFilenamePatternsResponse": { "type": "object", "properties": { "creditMemo": { "type": "string" }, "invoice": { "type": "string" }, "debitMemo": { "type": "string" } } } } } } ] }, { "key": "DocumentGenerationSetting", "description": "Setting to enable/disable OOTB document generation ", "context": "Entity", "pathPattern": "/document-generation-setting", "httpOperations": [ { "method": "GET", "url": "/settings/document-generation-setting", "parameters": [], "responseType": { "$ref": "#/definitions/DocumentGenerationSettingResponse", "definitions": { "DocumentGenerationSettingResponse": { "additionalProperties": false, "type": "object", "properties": { "success": { "type": "boolean" }, "enabled": { "type": "boolean" } } }, "DocumentGenerationSetting": { "additionalProperties": false, "type": "object", "properties": { "enabled": { "type": "boolean" } } } } } }, { "method": "PUT", "url": "/settings/document-generation-setting", "parameters": [], "requestType": { "$ref": "#/definitions/DocumentGenerationSetting", "definitions": { "DocumentGenerationSettingResponse": { "additionalProperties": false, "type": "object", "properties": { "success": { "type": "boolean" }, "enabled": { "type": "boolean" } } }, "DocumentGenerationSetting": { "additionalProperties": false, "type": "object", "properties": { "enabled": { "type": "boolean" } } } } }, "responseType": { "$ref": "#/definitions/DocumentGenerationSettingResponse", "definitions": { "DocumentGenerationSettingResponse": { "additionalProperties": false, "type": "object", "properties": { "success": { "type": "boolean" }, "enabled": { "type": "boolean" } } }, "DocumentGenerationSetting": { "additionalProperties": false, "type": "object", "properties": { "enabled": { "type": "boolean" } } } } } } ] }, { "key": "DocumentTemplateAttachment", "description": "Document Template Attachment ", "context": "Entity", "pathPattern": "/document-template-attachments", "httpOperations": [ { "method": "GET", "url": "/settings/document-template-attachments", "parameters": [], "responseType": { "type": "array", "items": { "$ref": "#/definitions/Attachment" }, "definitions": { "AttachmentPostDto": { "additionalProperties": false, "type": "object", "properties": { "fileName": { "description": "The name of the file", "type": "string" }, "attachmentType": { "description": "The type of the attachment", "type": "string", "enum": [ "Image" ] }, "fileContent": { "description": "The image file contents as a base64 encoded string", "type": "string" } }, "required": [ "attachmentType", "fileName", "fileContent" ] }, "Attachment": { "additionalProperties": false, "type": "object", "properties": { "fileName": { "description": "The name of the file", "type": "string" }, "attachmentType": { "description": "The type of the attachment", "type": "string", "enum": [ "Image" ] }, "id": { "description": "The unique identifier of the uploaded image", "type": "string" }, "fileContent": { "description": "The image file contents as a base64 encoded string", "type": "string" }, "fileId": { "description": "Identifier for the uploaded file", "type": "string" } } } } } }, { "method": "POST", "url": "/settings/document-template-attachments", "parameters": [], "requestType": { "$ref": "#/definitions/AttachmentPostDto", "definitions": { "AttachmentPostDto": { "additionalProperties": false, "type": "object", "properties": { "fileName": { "description": "The name of the file", "type": "string" }, "attachmentType": { "description": "The type of the attachment", "type": "string", "enum": [ "Image" ] }, "fileContent": { "description": "The image file contents as a base64 encoded string", "type": "string" } }, "required": [ "attachmentType", "fileName", "fileContent" ] }, "Attachment": { "additionalProperties": false, "type": "object", "properties": { "fileName": { "description": "The name of the file", "type": "string" }, "attachmentType": { "description": "The type of the attachment", "type": "string", "enum": [ "Image" ] }, "id": { "description": "The unique identifier of the uploaded image", "type": "string" }, "fileContent": { "description": "The image file contents as a base64 encoded string", "type": "string" }, "fileId": { "description": "Identifier for the uploaded file", "type": "string" } } } } }, "responseType": { "$ref": "#/definitions/Attachment", "definitions": { "AttachmentPostDto": { "additionalProperties": false, "type": "object", "properties": { "fileName": { "description": "The name of the file", "type": "string" }, "attachmentType": { "description": "The type of the attachment", "type": "string", "enum": [ "Image" ] }, "fileContent": { "description": "The image file contents as a base64 encoded string", "type": "string" } }, "required": [ "attachmentType", "fileName", "fileContent" ] }, "Attachment": { "additionalProperties": false, "type": "object", "properties": { "fileName": { "description": "The name of the file", "type": "string" }, "attachmentType": { "description": "The type of the attachment", "type": "string", "enum": [ "Image" ] }, "id": { "description": "The unique identifier of the uploaded image", "type": "string" }, "fileContent": { "description": "The image file contents as a base64 encoded string", "type": "string" }, "fileId": { "description": "Identifier for the uploaded file", "type": "string" } } } } } } ] }, { "key": "AllDocumentTemplateAttachment", "description": "Document Template Attachment", "context": "Entity", "pathPattern": "/document-template-attachments/{id}", "httpOperations": [ { "method": "DELETE", "url": "/settings/document-template-attachments/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Document Template Attachment" } ] } ] }, { "key": "EmailTemplate", "description": "List of all Email Templates", "context": "Entity", "pathPattern": "/email-templates", "httpOperations": [ { "method": "GET", "url": "/settings/email-templates", "parameters": [], "responseType": { "$ref": "#/definitions/EmailTemplatesList", "definitions": { "PostPayload": { "type": "object", "properties": { "allowPartialSuccess": { "type": "boolean" }, "emailTemplates": { "type": "array", "items": { "$ref": "#/definitions/EmailTemplatePostPayload" } } } }, "EmailTemplatePostPayload": { "additionalProperties": false, "type": "object", "properties": { "eventCategory": { "type": "integer" }, "emailBody": { "type": [ "string", "null" ] }, "eventTypeNamespace": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "active": { "type": "boolean" }, "emailSubject": { "type": [ "string", "null" ] }, "useAdditionalAddresses": { "type": "boolean" }, "replyToEmailType": { "type": [ "string", "null" ] }, "replyToEmailAddress": { "type": [ "string", "null" ] }, "toEmailType": { "type": [ "string", "null" ] }, "toEmailAddress": { "type": [ "string", "null" ] }, "isHtml": { "type": "boolean" }, "encodingType": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "fromName": { "type": [ "string", "null" ] }, "fromEmailType": { "type": [ "string", "null" ] }, "eventTypeName": { "type": [ "string", "null" ] }, "ccEmailType": { "type": [ "string", "null" ] }, "fromEmailAddress": { "type": [ "string", "null" ] }, "ccEmailAddress": { "type": [ "string", "null" ] }, "bccEmailAddress": { "type": [ "string", "null" ] } } }, "PostResponsePayload": { "type": "object", "properties": { "reasons": { "type": "array", "items": { "$ref": "#/definitions/Reason" } } } }, "EmailTemplate": { "additionalProperties": false, "type": "object", "properties": { "eventCategory": { "type": "integer" }, "emailBody": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "createdOn": { "type": [ "string", "null" ] }, "emailSubject": { "type": [ "string", "null" ] }, "replyToEmailAddress": { "type": [ "string", "null" ] }, "toEmailAddress": { "type": [ "string", "null" ] }, "isHtml": { "type": "boolean" }, "fromName": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "ccEmailType": { "type": [ "string", "null" ] }, "ccEmailAddress": { "type": [ "string", "null" ] }, "updatedBy": { "type": [ "string", "null" ] }, "active": { "type": "boolean" }, "updatedOn": { "type": [ "string", "null" ] }, "eventType": { "type": "object", "properties": { "namespace": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] } } }, "useAdditionalAddresses": { "type": "boolean" }, "replyToEmailType": { "type": [ "string", "null" ] }, "createdBy": { "type": [ "string", "null" ] }, "toEmailType": { "type": [ "string", "null" ] }, "encodingType": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "fromEmailType": { "type": [ "string", "null" ] }, "fromEmailAddress": { "type": [ "string", "null" ] }, "bccEmailAddress": { "type": [ "string", "null" ] } } }, "EmailTemplatesList": { "additionalProperties": false, "type": "object", "properties": { "next": { "type": [ "string", "null" ] }, "data": { "type": "array", "items": { "$ref": "#/definitions/EmailTemplate" } } } }, "Reason": { "type": "object", "properties": { "code": { "type": [ "string", "null" ] }, "message": { "type": [ "string", "null" ] } } } } } }, { "method": "POST", "url": "/settings/email-templates", "parameters": [], "requestType": { "$ref": "#/definitions/PostPayload", "definitions": { "PostPayload": { "type": "object", "properties": { "allowPartialSuccess": { "type": "boolean" }, "emailTemplates": { "type": "array", "items": { "$ref": "#/definitions/EmailTemplatePostPayload" } } } }, "EmailTemplatePostPayload": { "additionalProperties": false, "type": "object", "properties": { "eventCategory": { "type": "integer" }, "emailBody": { "type": [ "string", "null" ] }, "eventTypeNamespace": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "active": { "type": "boolean" }, "emailSubject": { "type": [ "string", "null" ] }, "useAdditionalAddresses": { "type": "boolean" }, "replyToEmailType": { "type": [ "string", "null" ] }, "replyToEmailAddress": { "type": [ "string", "null" ] }, "toEmailType": { "type": [ "string", "null" ] }, "toEmailAddress": { "type": [ "string", "null" ] }, "isHtml": { "type": "boolean" }, "encodingType": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "fromName": { "type": [ "string", "null" ] }, "fromEmailType": { "type": [ "string", "null" ] }, "eventTypeName": { "type": [ "string", "null" ] }, "ccEmailType": { "type": [ "string", "null" ] }, "fromEmailAddress": { "type": [ "string", "null" ] }, "ccEmailAddress": { "type": [ "string", "null" ] }, "bccEmailAddress": { "type": [ "string", "null" ] } } }, "PostResponsePayload": { "type": "object", "properties": { "reasons": { "type": "array", "items": { "$ref": "#/definitions/Reason" } } } }, "EmailTemplate": { "additionalProperties": false, "type": "object", "properties": { "eventCategory": { "type": "integer" }, "emailBody": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "createdOn": { "type": [ "string", "null" ] }, "emailSubject": { "type": [ "string", "null" ] }, "replyToEmailAddress": { "type": [ "string", "null" ] }, "toEmailAddress": { "type": [ "string", "null" ] }, "isHtml": { "type": "boolean" }, "fromName": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "ccEmailType": { "type": [ "string", "null" ] }, "ccEmailAddress": { "type": [ "string", "null" ] }, "updatedBy": { "type": [ "string", "null" ] }, "active": { "type": "boolean" }, "updatedOn": { "type": [ "string", "null" ] }, "eventType": { "type": "object", "properties": { "namespace": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] } } }, "useAdditionalAddresses": { "type": "boolean" }, "replyToEmailType": { "type": [ "string", "null" ] }, "createdBy": { "type": [ "string", "null" ] }, "toEmailType": { "type": [ "string", "null" ] }, "encodingType": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "fromEmailType": { "type": [ "string", "null" ] }, "fromEmailAddress": { "type": [ "string", "null" ] }, "bccEmailAddress": { "type": [ "string", "null" ] } } }, "EmailTemplatesList": { "additionalProperties": false, "type": "object", "properties": { "next": { "type": [ "string", "null" ] }, "data": { "type": "array", "items": { "$ref": "#/definitions/EmailTemplate" } } } }, "Reason": { "type": "object", "properties": { "code": { "type": [ "string", "null" ] }, "message": { "type": [ "string", "null" ] } } } } }, "responseType": { "$ref": "#/definitions/PostResponsePayload", "definitions": { "PostPayload": { "type": "object", "properties": { "allowPartialSuccess": { "type": "boolean" }, "emailTemplates": { "type": "array", "items": { "$ref": "#/definitions/EmailTemplatePostPayload" } } } }, "EmailTemplatePostPayload": { "additionalProperties": false, "type": "object", "properties": { "eventCategory": { "type": "integer" }, "emailBody": { "type": [ "string", "null" ] }, "eventTypeNamespace": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "active": { "type": "boolean" }, "emailSubject": { "type": [ "string", "null" ] }, "useAdditionalAddresses": { "type": "boolean" }, "replyToEmailType": { "type": [ "string", "null" ] }, "replyToEmailAddress": { "type": [ "string", "null" ] }, "toEmailType": { "type": [ "string", "null" ] }, "toEmailAddress": { "type": [ "string", "null" ] }, "isHtml": { "type": "boolean" }, "encodingType": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "fromName": { "type": [ "string", "null" ] }, "fromEmailType": { "type": [ "string", "null" ] }, "eventTypeName": { "type": [ "string", "null" ] }, "ccEmailType": { "type": [ "string", "null" ] }, "fromEmailAddress": { "type": [ "string", "null" ] }, "ccEmailAddress": { "type": [ "string", "null" ] }, "bccEmailAddress": { "type": [ "string", "null" ] } } }, "PostResponsePayload": { "type": "object", "properties": { "reasons": { "type": "array", "items": { "$ref": "#/definitions/Reason" } } } }, "EmailTemplate": { "additionalProperties": false, "type": "object", "properties": { "eventCategory": { "type": "integer" }, "emailBody": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "createdOn": { "type": [ "string", "null" ] }, "emailSubject": { "type": [ "string", "null" ] }, "replyToEmailAddress": { "type": [ "string", "null" ] }, "toEmailAddress": { "type": [ "string", "null" ] }, "isHtml": { "type": "boolean" }, "fromName": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "ccEmailType": { "type": [ "string", "null" ] }, "ccEmailAddress": { "type": [ "string", "null" ] }, "updatedBy": { "type": [ "string", "null" ] }, "active": { "type": "boolean" }, "updatedOn": { "type": [ "string", "null" ] }, "eventType": { "type": "object", "properties": { "namespace": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] } } }, "useAdditionalAddresses": { "type": "boolean" }, "replyToEmailType": { "type": [ "string", "null" ] }, "createdBy": { "type": [ "string", "null" ] }, "toEmailType": { "type": [ "string", "null" ] }, "encodingType": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "fromEmailType": { "type": [ "string", "null" ] }, "fromEmailAddress": { "type": [ "string", "null" ] }, "bccEmailAddress": { "type": [ "string", "null" ] } } }, "EmailTemplatesList": { "additionalProperties": false, "type": "object", "properties": { "next": { "type": [ "string", "null" ] }, "data": { "type": "array", "items": { "$ref": "#/definitions/EmailTemplate" } } } }, "Reason": { "type": "object", "properties": { "code": { "type": [ "string", "null" ] }, "message": { "type": [ "string", "null" ] } } } } } } ] }, { "key": "AllEntityNodes", "description": "Setting for all Entity Nodes", "context": "Tenant", "pathPattern": "/entity-nodes", "httpOperations": [ { "method": "GET", "url": "/settings/entity-nodes", "parameters": [], "responseType": { "$ref": "#/definitions/EntityNodes", "definitions": { "EntityNodes": { "additionalProperties": false, "type": "object", "properties": { "nodes": { "type": "array", "items": { "$ref": "#/definitions/GetEntityNode" } } } }, "PostEntityNode": { "additionalProperties": false, "type": "object", "properties": { "displayName": { "minLength": 1, "type": "string", "maxLength": 255 }, "timezone": { "type": "string" }, "name": { "pattern": "^[- .a-zA-Z0-9]{1,255}$", "type": "string" }, "locale": { "type": "string" }, "parentId": { "type": "string" } } }, "GetEntityNode": { "additionalProperties": false, "type": "object", "properties": { "provisioned": { "type": "boolean" }, "displayName": { "minLength": 1, "type": "string", "maxLength": 255 }, "timezone": { "type": "string" }, "name": { "pattern": "^[- .a-zA-Z0-9]{1,255}$", "type": "string" }, "id": { "type": "string" }, "locale": { "type": "string" }, "parentId": { "type": "string" } } } } } }, { "method": "POST", "url": "/settings/entity-nodes", "parameters": [], "requestType": { "$ref": "#/definitions/PostEntityNode", "required": [ "name", "displayName", "parentId", "locale", "timezone" ], "definitions": { "EntityNodes": { "additionalProperties": false, "type": "object", "properties": { "nodes": { "type": "array", "items": { "$ref": "#/definitions/GetEntityNode" } } } }, "PostEntityNode": { "additionalProperties": false, "type": "object", "properties": { "displayName": { "minLength": 1, "type": "string", "maxLength": 255 }, "timezone": { "type": "string" }, "name": { "pattern": "^[- .a-zA-Z0-9]{1,255}$", "type": "string" }, "locale": { "type": "string" }, "parentId": { "type": "string" } } }, "GetEntityNode": { "additionalProperties": false, "type": "object", "properties": { "provisioned": { "type": "boolean" }, "displayName": { "minLength": 1, "type": "string", "maxLength": 255 }, "timezone": { "type": "string" }, "name": { "pattern": "^[- .a-zA-Z0-9]{1,255}$", "type": "string" }, "id": { "type": "string" }, "locale": { "type": "string" }, "parentId": { "type": "string" } } } } }, "responseType": { "$ref": "#/definitions/GetEntityNode", "definitions": { "EntityNodes": { "additionalProperties": false, "type": "object", "properties": { "nodes": { "type": "array", "items": { "$ref": "#/definitions/GetEntityNode" } } } }, "PostEntityNode": { "additionalProperties": false, "type": "object", "properties": { "displayName": { "minLength": 1, "type": "string", "maxLength": 255 }, "timezone": { "type": "string" }, "name": { "pattern": "^[- .a-zA-Z0-9]{1,255}$", "type": "string" }, "locale": { "type": "string" }, "parentId": { "type": "string" } } }, "GetEntityNode": { "additionalProperties": false, "type": "object", "properties": { "provisioned": { "type": "boolean" }, "displayName": { "minLength": 1, "type": "string", "maxLength": 255 }, "timezone": { "type": "string" }, "name": { "pattern": "^[- .a-zA-Z0-9]{1,255}$", "type": "string" }, "id": { "type": "string" }, "locale": { "type": "string" }, "parentId": { "type": "string" } } } } } } ] }, { "key": "EntityNode", "description": "Setting for an Entity Node", "context": "Tenant", "pathPattern": "/entity-nodes/{entityId}", "httpOperations": [ { "method": "GET", "url": "/settings/entity-nodes/{entityId}", "parameters": [ { "name": "entityId", "description": "Unique Id of the Entity to which the setting belongs" } ], "responseType": { "$ref": "#/definitions/EntityNode", "definitions": { "EntityNode": { "additionalProperties": false, "type": "object", "properties": { "provisioned": { "type": "boolean" }, "displayName": { "minLength": 1, "type": "string", "maxLength": 255 }, "timezone": { "type": "string" }, "name": { "pattern": "^[- .a-zA-Z0-9]{1,255}$", "type": "string" }, "id": { "type": "string" }, "locale": { "type": "string" }, "parentId": { "type": "string" } } } } } }, { "method": "PUT", "url": "/settings/entity-nodes/{entityId}", "parameters": [ { "name": "entityId", "description": "Unique Id of the Entity to which the setting belongs" } ], "requestType": { "$ref": "#/definitions/EntityNode", "definitions": { "EntityNode": { "additionalProperties": false, "type": "object", "properties": { "provisioned": { "type": "boolean" }, "displayName": { "minLength": 1, "type": "string", "maxLength": 255 }, "timezone": { "type": "string" }, "name": { "pattern": "^[- .a-zA-Z0-9]{1,255}$", "type": "string" }, "id": { "type": "string" }, "locale": { "type": "string" }, "parentId": { "type": "string" } } } } }, "responseType": { "$ref": "#/definitions/EntityNode", "definitions": { "EntityNode": { "additionalProperties": false, "type": "object", "properties": { "provisioned": { "type": "boolean" }, "displayName": { "minLength": 1, "type": "string", "maxLength": 255 }, "timezone": { "type": "string" }, "name": { "pattern": "^[- .a-zA-Z0-9]{1,255}$", "type": "string" }, "id": { "type": "string" }, "locale": { "type": "string" }, "parentId": { "type": "string" } } } } } }, { "method": "DELETE", "url": "/settings/entity-nodes/{entityId}", "parameters": [ { "name": "entityId", "description": "Unique Id of the Entity to which the setting belongs" } ] } ] }, { "key": "EntityProfileAttachment", "description": "Setting for Getting Attachment Limits for Tenant/Entity", "context": "Entity", "pathPattern": "/entity-profile-attachments", "httpOperations": [ { "method": "GET", "url": "/settings/entity-profile-attachments", "parameters": [], "responseType": { "$ref": "#/definitions/AttachmentLimitResponse", "definitions": { "AttachmentLimitResponse": { "additionalProperties": false, "type": "object", "properties": { "availableStorage": { "type": "string" }, "maxAttachments": { "type": "integer" }, "storageLimit": { "type": "string" } } } } } } ] }, { "key": "EntityProfileChangeHistory", "description": "Setting for Getting change history for Tenant/Entity Profile", "context": "Entity", "pathPattern": "/entity-profile-change-history", "httpOperations": [ { "method": "GET", "url": "/settings/entity-profile-change-history", "parameters": [], "responseType": { "$ref": "#/definitions/TenantProfileChangeHistories", "definitions": { "TenantProfileChangeHistory": { "additionalProperties": false, "type": "object", "properties": { "updatedBy": { "type": "string" }, "description": { "type": "string" }, "updatedOn": { "type": "string" } } }, "TenantProfileChangeHistories": { "additionalProperties": false, "type": "object", "properties": { "changeHistory": { "type": "array", "items": { "$ref": "#/definitions/TenantProfileChangeHistory" } } } } } } } ] }, { "key": "EntityProfileInfo", "description": "Setting for Tenant/Entity Profile", "context": "Entity", "pathPattern": "/entity-profile-info", "httpOperations": [ { "method": "GET", "url": "/settings/entity-profile-info", "parameters": [], "responseType": { "$ref": "#/definitions/TenantProfileResponse", "definitions": { "TenantProfileRequest": { "additionalProperties": false, "type": "object", "properties": { "country": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "address1": { "type": "string" }, "postalCode": { "type": "string" }, "displayBanner": { "type": "boolean" }, "state": { "type": "string" }, "bannerLabel": { "type": "string" }, "locale": { "type": "string" }, "bannerColor": { "type": "string", "enum": [ "Rose", "Teal", "Aqua", "Navy", "Blue_Grey" ] }, "email": { "type": "string" } } }, "TenantProfileResponse": { "additionalProperties": false, "type": "object", "properties": { "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" } } } } } }, { "method": "PUT", "url": "/settings/entity-profile-info", "parameters": [], "requestType": { "$ref": "#/definitions/TenantProfileRequest", "definitions": { "TenantProfileRequest": { "additionalProperties": false, "type": "object", "properties": { "country": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "address1": { "type": "string" }, "postalCode": { "type": "string" }, "displayBanner": { "type": "boolean" }, "state": { "type": "string" }, "bannerLabel": { "type": "string" }, "locale": { "type": "string" }, "bannerColor": { "type": "string", "enum": [ "Rose", "Teal", "Aqua", "Navy", "Blue_Grey" ] }, "email": { "type": "string" } } }, "TenantProfileResponse": { "additionalProperties": false, "type": "object", "properties": { "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" } } } } }, "responseType": { "$ref": "#/definitions/TenantProfileResponse", "definitions": { "TenantProfileRequest": { "additionalProperties": false, "type": "object", "properties": { "country": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "address1": { "type": "string" }, "postalCode": { "type": "string" }, "displayBanner": { "type": "boolean" }, "state": { "type": "string" }, "bannerLabel": { "type": "string" }, "locale": { "type": "string" }, "bannerColor": { "type": "string", "enum": [ "Rose", "Teal", "Aqua", "Navy", "Blue_Grey" ] }, "email": { "type": "string" } } }, "TenantProfileResponse": { "additionalProperties": false, "type": "object", "properties": { "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" } } } } } } ] }, { "key": "ExternalSmtp", "description": "Setting for an External SMTP", "context": "Entity", "pathPattern": "/external-smtp", "httpOperations": [ { "method": "GET", "url": "/settings/external-smtp", "parameters": [], "responseType": { "$ref": "#/definitions/ExternalSmtp", "definitions": { "ExternalSettings": { "type": "object", "properties": { "password": { "type": "string" }, "port": { "type": "integer" }, "socketFactoryClass": { "type": "string", "enum": [ "JavaxSSLSocketFactory", "NONE" ] }, "socketFactoryFallback": { "type": "boolean" }, "enableStartTls": { "type": "boolean" }, "serverName": { "type": "string" }, "socketFactoryPort": { "type": "integer" }, "authentication": { "type": "boolean" }, "username": { "type": "string" } } }, "ExternalSmtp": { "additionalProperties": false, "type": "object", "properties": { "externalSmtp": { "$ref": "#/definitions/ExternalSettings" }, "smtpServerType": { "type": "string" } } } } } }, { "method": "PUT", "url": "/settings/external-smtp", "parameters": [], "requestType": { "$ref": "#/definitions/ExternalSmtp", "definitions": { "ExternalSettings": { "type": "object", "properties": { "password": { "type": "string" }, "port": { "type": "integer" }, "socketFactoryClass": { "type": "string", "enum": [ "JavaxSSLSocketFactory", "NONE" ] }, "socketFactoryFallback": { "type": "boolean" }, "enableStartTls": { "type": "boolean" }, "serverName": { "type": "string" }, "socketFactoryPort": { "type": "integer" }, "authentication": { "type": "boolean" }, "username": { "type": "string" } } }, "ExternalSmtp": { "additionalProperties": false, "type": "object", "properties": { "externalSmtp": { "$ref": "#/definitions/ExternalSettings" }, "smtpServerType": { "type": "string" } } } } }, "responseType": { "$ref": "#/definitions/ExternalSmtp", "definitions": { "ExternalSettings": { "type": "object", "properties": { "password": { "type": "string" }, "port": { "type": "integer" }, "socketFactoryClass": { "type": "string", "enum": [ "JavaxSSLSocketFactory", "NONE" ] }, "socketFactoryFallback": { "type": "boolean" }, "enableStartTls": { "type": "boolean" }, "serverName": { "type": "string" }, "socketFactoryPort": { "type": "integer" }, "authentication": { "type": "boolean" }, "username": { "type": "string" } } }, "ExternalSmtp": { "additionalProperties": false, "type": "object", "properties": { "externalSmtp": { "$ref": "#/definitions/ExternalSettings" }, "smtpServerType": { "type": "string" } } } } } } ] }, { "key": "AllFinanceSegmentationRules", "description": "List or create Finance Segmentation Rule", "context": "Entity", "pathPattern": "/finance-segmentation-rules", "httpOperations": [ { "method": "GET", "url": "/settings/finance-segmentation-rules", "parameters": [], "responseType": { "$ref": "#/definitions/SegmentationRules", "definitions": { "SegmentationRules": { "type": "array", "items": { "$ref": "#/definitions/SegmentationRule" } }, "SegmentationRule": { "type": "object", "properties": { "specificTransactionTypesSegments": { "type": "array", "items": { "$ref": "#/definitions/RuleDetail" } }, "defaultSegments": { "type": "array", "items": { "$ref": "#/definitions/RuleDetail" } }, "name": { "minLength": 1, "type": "string", "maxLength": 100 }, "description": { "default": "", "type": "string", "maxLength": 2000 }, "active": { "default": false, "type": "boolean" }, "id": { "description": "Unique Id of the segmentation rule ", "type": "string" }, "additionalProperties": false } }, "RuleDetail": { "type": "object", "prpperties": { "transactionType": { "description": "Journal Entry Tranaction Type: Invoice, Tax, DebitMemoItem_Charge, DebitMemoItem_Tax etc", "type": "string" }, "segmentId": { "description": "the id of GL segment that the rule used", "type": "string" }, "segmentName": { "description": "the name of GL segment that the rule used", "type": "string" } } } } } }, { "method": "POST", "url": "/settings/finance-segmentation-rules", "parameters": [], "requestType": { "$ref": "#/definitions/SegmentationRule", "definitions": { "SegmentationRules": { "type": "array", "items": { "$ref": "#/definitions/SegmentationRule" } }, "SegmentationRule": { "type": "object", "properties": { "specificTransactionTypesSegments": { "type": "array", "items": { "$ref": "#/definitions/RuleDetail" } }, "defaultSegments": { "type": "array", "items": { "$ref": "#/definitions/RuleDetail" } }, "name": { "minLength": 1, "type": "string", "maxLength": 100 }, "description": { "default": "", "type": "string", "maxLength": 2000 }, "active": { "default": false, "type": "boolean" }, "id": { "description": "Unique Id of the segmentation rule ", "type": "string" }, "additionalProperties": false } }, "RuleDetail": { "type": "object", "prpperties": { "transactionType": { "description": "Journal Entry Tranaction Type: Invoice, Tax, DebitMemoItem_Charge, DebitMemoItem_Tax etc", "type": "string" }, "segmentId": { "description": "the id of GL segment that the rule used", "type": "string" }, "segmentName": { "description": "the name of GL segment that the rule used", "type": "string" } } } } }, "responseType": { "$ref": "#/definitions/SegmentationRule", "definitions": { "SegmentationRules": { "type": "array", "items": { "$ref": "#/definitions/SegmentationRule" } }, "SegmentationRule": { "type": "object", "properties": { "specificTransactionTypesSegments": { "type": "array", "items": { "$ref": "#/definitions/RuleDetail" } }, "defaultSegments": { "type": "array", "items": { "$ref": "#/definitions/RuleDetail" } }, "name": { "minLength": 1, "type": "string", "maxLength": 100 }, "description": { "default": "", "type": "string", "maxLength": 2000 }, "active": { "default": false, "type": "boolean" }, "id": { "description": "Unique Id of the segmentation rule ", "type": "string" }, "additionalProperties": false } }, "RuleDetail": { "type": "object", "prpperties": { "transactionType": { "description": "Journal Entry Tranaction Type: Invoice, Tax, DebitMemoItem_Charge, DebitMemoItem_Tax etc", "type": "string" }, "segmentId": { "description": "the id of GL segment that the rule used", "type": "string" }, "segmentName": { "description": "the name of GL segment that the rule used", "type": "string" } } } } } } ] }, { "key": "FinanceSegmentationRule", "description": "Finance segmentation rule", "context": "Entity", "pathPattern": "/finance-segmentation-rules/{id}", "httpOperations": [ { "method": "GET", "url": "/settings/finance-segmentation-rules/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the segmentation rule" } ], "responseType": { "$ref": "#/definitions/SegmentationRule", "definitions": { "SegmentationRule": { "type": "object", "properties": { "specificTransactionTypesSegments": { "type": "array", "items": { "$ref": "#/definitions/RuleDetail" } }, "defaultSegments": { "type": "array", "items": { "$ref": "#/definitions/RuleDetail" } }, "name": { "minLength": 1, "type": "string", "maxLength": 100 }, "description": { "default": "", "type": "string", "maxLength": 2000 }, "active": { "default": false, "type": "boolean" }, "id": { "description": "Unique Id of the segmentation rule ", "type": "string" }, "additionalProperties": false } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } }, "RuleDetail": { "type": "object", "prpperties": { "transactionType": { "description": "Journal Entry Tranaction Type: Invoice, Tax, DebitMemoItem_Charge, DebitMemoItem_Tax etc", "type": "string" }, "segmentId": { "description": "the id of GL segment that the rule used", "type": "string" }, "segmentName": { "description": "the name of GL segment that the rule used", "type": "string" } } } } } }, { "method": "PUT", "url": "/settings/finance-segmentation-rules/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the segmentation rule" } ], "requestType": { "$ref": "#/definitions/SegmentationRule", "definitions": { "SegmentationRule": { "type": "object", "properties": { "specificTransactionTypesSegments": { "type": "array", "items": { "$ref": "#/definitions/RuleDetail" } }, "defaultSegments": { "type": "array", "items": { "$ref": "#/definitions/RuleDetail" } }, "name": { "minLength": 1, "type": "string", "maxLength": 100 }, "description": { "default": "", "type": "string", "maxLength": 2000 }, "active": { "default": false, "type": "boolean" }, "id": { "description": "Unique Id of the segmentation rule ", "type": "string" }, "additionalProperties": false } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } }, "RuleDetail": { "type": "object", "prpperties": { "transactionType": { "description": "Journal Entry Tranaction Type: Invoice, Tax, DebitMemoItem_Charge, DebitMemoItem_Tax etc", "type": "string" }, "segmentId": { "description": "the id of GL segment that the rule used", "type": "string" }, "segmentName": { "description": "the name of GL segment that the rule used", "type": "string" } } } } }, "responseType": { "$ref": "#/definitions/SegmentationRule", "definitions": { "SegmentationRule": { "type": "object", "properties": { "specificTransactionTypesSegments": { "type": "array", "items": { "$ref": "#/definitions/RuleDetail" } }, "defaultSegments": { "type": "array", "items": { "$ref": "#/definitions/RuleDetail" } }, "name": { "minLength": 1, "type": "string", "maxLength": 100 }, "description": { "default": "", "type": "string", "maxLength": 2000 }, "active": { "default": false, "type": "boolean" }, "id": { "description": "Unique Id of the segmentation rule ", "type": "string" }, "additionalProperties": false } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } }, "RuleDetail": { "type": "object", "prpperties": { "transactionType": { "description": "Journal Entry Tranaction Type: Invoice, Tax, DebitMemoItem_Charge, DebitMemoItem_Tax etc", "type": "string" }, "segmentId": { "description": "the id of GL segment that the rule used", "type": "string" }, "segmentName": { "description": "the name of GL segment that the rule used", "type": "string" } } } } } }, { "method": "DELETE", "url": "/settings/finance-segmentation-rules/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the segmentation rule" } ], "responseType": { "$ref": "#/definitions/CommonResponse", "definitions": { "SegmentationRule": { "type": "object", "properties": { "specificTransactionTypesSegments": { "type": "array", "items": { "$ref": "#/definitions/RuleDetail" } }, "defaultSegments": { "type": "array", "items": { "$ref": "#/definitions/RuleDetail" } }, "name": { "minLength": 1, "type": "string", "maxLength": 100 }, "description": { "default": "", "type": "string", "maxLength": 2000 }, "active": { "default": false, "type": "boolean" }, "id": { "description": "Unique Id of the segmentation rule ", "type": "string" }, "additionalProperties": false } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } }, "RuleDetail": { "type": "object", "prpperties": { "transactionType": { "description": "Journal Entry Tranaction Type: Invoice, Tax, DebitMemoItem_Charge, DebitMemoItem_Tax etc", "type": "string" }, "segmentId": { "description": "the id of GL segment that the rule used", "type": "string" }, "segmentName": { "description": "the name of GL segment that the rule used", "type": "string" } } } } } } ] }, { "key": "StandaloneOrders", "description": "Setting API to configure rev rec rules and accounting codes for FNR Standalone Order setting", "context": "Tenant", "pathPattern": "/finance/standalone-orders", "httpOperations": [ { "method": "GET", "url": "/settings/finance/standalone-orders", "parameters": [], "responseType": { "$ref": "#/definitions/StandaloneOrders", "definitions": { "StandaloneOrders": { "additionalProperties": false, "type": "object", "properties": { "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" } } } } } }, { "method": "PUT", "url": "/settings/finance/standalone-orders", "parameters": [], "requestType": { "$ref": "#/definitions/StandaloneOrders", "definitions": { "StandaloneOrders": { "additionalProperties": false, "type": "object", "properties": { "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" } } } } }, "responseType": { "$ref": "#/definitions/StandaloneOrders", "definitions": { "StandaloneOrders": { "additionalProperties": false, "type": "object", "properties": { "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": "FxCurrency", "description": "Setting for an FX Currency", "context": "Entity", "pathPattern": "/fx-currencies", "httpOperations": [ { "method": "GET", "url": "/settings/fx-currencies", "parameters": [], "responseType": { "$ref": "#/definitions/FxCurrency", "definitions": { "FxCurrency": { "additionalProperties": false, "type": "object", "properties": { "roundingMode": { "enum": [ "RoundDown", "RoundHalfUp" ] }, "customRateEnabled": { "type": "boolean" }, "dayOfMonth": { "maximum": 31, "type": "integer", "minimum": 1 }, "rateSetName": { "type": [ "string", "null" ] }, "rateDateType": { "enum": [ "Daily", "Monthly" ] }, "homeCurrencyCode": { "type": "string" }, "useInverseRate": { "type": "boolean" }, "exportEnabled": { "type": "boolean" }, "reportingCurrencyCode": { "description": "Support reporting currency for finance reports", "type": [ "string", "null" ] }, "rateOffset": { "maximum": 2, "type": "integer", "minimum": 0 } } } } } }, { "method": "PUT", "url": "/settings/fx-currencies", "parameters": [], "requestType": { "$ref": "#/definitions/FxCurrency", "definitions": { "FxCurrency": { "additionalProperties": false, "type": "object", "properties": { "roundingMode": { "enum": [ "RoundDown", "RoundHalfUp" ] }, "customRateEnabled": { "type": "boolean" }, "dayOfMonth": { "maximum": 31, "type": "integer", "minimum": 1 }, "rateSetName": { "type": [ "string", "null" ] }, "rateDateType": { "enum": [ "Daily", "Monthly" ] }, "homeCurrencyCode": { "type": "string" }, "useInverseRate": { "type": "boolean" }, "exportEnabled": { "type": "boolean" }, "reportingCurrencyCode": { "description": "Support reporting currency for finance reports", "type": [ "string", "null" ] }, "rateOffset": { "maximum": 2, "type": "integer", "minimum": 0 } } } } }, "responseType": { "$ref": "#/definitions/FxCurrency", "definitions": { "FxCurrency": { "additionalProperties": false, "type": "object", "properties": { "roundingMode": { "enum": [ "RoundDown", "RoundHalfUp" ] }, "customRateEnabled": { "type": "boolean" }, "dayOfMonth": { "maximum": 31, "type": "integer", "minimum": 1 }, "rateSetName": { "type": [ "string", "null" ] }, "rateDateType": { "enum": [ "Daily", "Monthly" ] }, "homeCurrencyCode": { "type": "string" }, "useInverseRate": { "type": "boolean" }, "exportEnabled": { "type": "boolean" }, "reportingCurrencyCode": { "description": "Support reporting currency for finance reports", "type": [ "string", "null" ] }, "rateOffset": { "maximum": 2, "type": "integer", "minimum": 0 } } } } } } ] }, { "key": "GLSegments", "description": "Setting for GL Segments", "context": "Entity", "pathPattern": "/gl-segments", "httpOperations": [ { "method": "GET", "url": "/settings/gl-segments", "parameters": [], "responseType": { "$ref": "#/definitions/GlSegments", "definitions": { "GlSegments": { "additionalProperties": false, "type": "object", "properties": { "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", "items": { "$ref": "#/definitions/Segment" } } } }, "Segment": { "type": "object", "properties": { "systemId": { "type": "string" }, "field": { "type": "string" }, "labelIndex": { "type": "integer" }, "segmentName": { "type": "string" }, "object": { "type": "string" } } } } } }, { "method": "PUT", "url": "/settings/gl-segments", "parameters": [], "requestType": { "$ref": "#/definitions/GlSegments", "definitions": { "GlSegments": { "additionalProperties": false, "type": "object", "properties": { "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", "items": { "$ref": "#/definitions/Segment" } } } }, "Segment": { "type": "object", "properties": { "systemId": { "type": "string" }, "field": { "type": "string" }, "labelIndex": { "type": "integer" }, "segmentName": { "type": "string" }, "object": { "type": "string" } } } } }, "responseType": { "$ref": "#/definitions/GlSegments", "definitions": { "GlSegments": { "additionalProperties": false, "type": "object", "properties": { "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", "items": { "$ref": "#/definitions/Segment" } } } }, "Segment": { "type": "object", "properties": { "systemId": { "type": "string" }, "field": { "type": "string" }, "labelIndex": { "type": "integer" }, "segmentName": { "type": "string" }, "object": { "type": "string" } } } } } } ] }, { "key": "AllHostedPaymentMethodPages", "description": "All Hosted Payment Method Pages", "context": "Tenant", "pathPattern": "/hosted-payment-method-pages", "httpOperations": [ { "method": "GET", "url": "/settings/hosted-payment-method-pages", "parameters": [], "responseType": { "$ref": "#/definitions/HostedPaymentPages", "definitions": { "HostedPaymentPages": { "type": "array", "items": { "$ref": "#/definitions/HostedPaymentPage" } }, "HostedPaymentMethodPageGetDto": { "additionalProperties": false, "type": "object", "properties": { "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", "items": { "$ref": "#/definitions/HostedPageFieldDefinition" } }, "creditCardTypeAutomaticDetectionEnabled": { "type": "boolean" }, "pageDescriptionEnabled": { "type": "boolean" }, "domain": { "type": "string" }, "invalidCreditCardTypeMessage": { "type": "string" }, "allowSubDomain": { "type": "boolean" }, "subType": { "type": "string" }, "mandatePageTemplate": { "type": "string" }, "paymentGateway": { "type": "string" } } }, "HostedPaymentMethodPagePostDto": { "additionalProperties": false, "type": "object", "properties": { "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", "items": { "$ref": "#/definitions/HostedPageFieldDefinition" } }, "creditCardTypeAutomaticDetectionEnabled": { "type": "boolean" }, "pageDescriptionEnabled": { "type": "boolean" }, "domain": { "type": "string" }, "invalidCreditCardTypeMessage": { "type": "string" }, "allowSubDomain": { "type": "boolean" }, "subType": { "type": "string" }, "mandatePageTemplate": { "type": "string" }, "paymentGateway": { "type": "string" } } }, "HostedPaymentPage": { "type": "object", "properties": { "string": { "type": "string" }, "id": { "type": "string" }, "type": { "type": "string" }, "pageName": { "type": "string" } } }, "HostedPageFieldDefinition": { "additionalProperties": false, "type": "object", "properties": { "associatedField": { "type": "string" }, "fieldName": { "type": "string" }, "isSystemFieldDefinition": { "type": "boolean" }, "defaultValue": { "type": "string" }, "cookieRetainable": { "type": "boolean" }, "fieldNumber": { "type": "integer" }, "encryptionRequired": { "type": "boolean" }, "fieldGroup": { "type": "string" }, "fieldOrder": { "type": "integer" }, "fieldEnabled": { "type": "boolean" }, "fieldReturnable": { "type": "boolean" }, "fieldMaxlength": { "type": "integer" }, "fieldResourceKey": { "type": "string" }, "mapsToDestination": { "type": "string" }, "fieldGroupKey": { "type": "string" }, "fieldGroupOrder": { "type": "integer" }, "fieldLabel": { "type": "string" }, "fieldRequired": { "type": "boolean" }, "fieldReadOnly": { "type": "boolean" }, "groupResourceKey": { "type": "string" }, "fieldType": { "type": "string" }, "createdOn": { "type": "integer" }, "updatedBy": { "type": "string" }, "updatedOn": { "type": "integer" }, "createdBy": { "type": "string" } } } } } }, { "method": "POST", "url": "/settings/hosted-payment-method-pages", "parameters": [], "requestType": { "$ref": "#/definitions/HostedPaymentMethodPagePostDto", "definitions": { "HostedPaymentPages": { "type": "array", "items": { "$ref": "#/definitions/HostedPaymentPage" } }, "HostedPaymentMethodPageGetDto": { "additionalProperties": false, "type": "object", "properties": { "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", "items": { "$ref": "#/definitions/HostedPageFieldDefinition" } }, "creditCardTypeAutomaticDetectionEnabled": { "type": "boolean" }, "pageDescriptionEnabled": { "type": "boolean" }, "domain": { "type": "string" }, "invalidCreditCardTypeMessage": { "type": "string" }, "allowSubDomain": { "type": "boolean" }, "subType": { "type": "string" }, "mandatePageTemplate": { "type": "string" }, "paymentGateway": { "type": "string" } } }, "HostedPaymentMethodPagePostDto": { "additionalProperties": false, "type": "object", "properties": { "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", "items": { "$ref": "#/definitions/HostedPageFieldDefinition" } }, "creditCardTypeAutomaticDetectionEnabled": { "type": "boolean" }, "pageDescriptionEnabled": { "type": "boolean" }, "domain": { "type": "string" }, "invalidCreditCardTypeMessage": { "type": "string" }, "allowSubDomain": { "type": "boolean" }, "subType": { "type": "string" }, "mandatePageTemplate": { "type": "string" }, "paymentGateway": { "type": "string" } } }, "HostedPaymentPage": { "type": "object", "properties": { "string": { "type": "string" }, "id": { "type": "string" }, "type": { "type": "string" }, "pageName": { "type": "string" } } }, "HostedPageFieldDefinition": { "additionalProperties": false, "type": "object", "properties": { "associatedField": { "type": "string" }, "fieldName": { "type": "string" }, "isSystemFieldDefinition": { "type": "boolean" }, "defaultValue": { "type": "string" }, "cookieRetainable": { "type": "boolean" }, "fieldNumber": { "type": "integer" }, "encryptionRequired": { "type": "boolean" }, "fieldGroup": { "type": "string" }, "fieldOrder": { "type": "integer" }, "fieldEnabled": { "type": "boolean" }, "fieldReturnable": { "type": "boolean" }, "fieldMaxlength": { "type": "integer" }, "fieldResourceKey": { "type": "string" }, "mapsToDestination": { "type": "string" }, "fieldGroupKey": { "type": "string" }, "fieldGroupOrder": { "type": "integer" }, "fieldLabel": { "type": "string" }, "fieldRequired": { "type": "boolean" }, "fieldReadOnly": { "type": "boolean" }, "groupResourceKey": { "type": "string" }, "fieldType": { "type": "string" }, "createdOn": { "type": "integer" }, "updatedBy": { "type": "string" }, "updatedOn": { "type": "integer" }, "createdBy": { "type": "string" } } } } }, "responseType": { "$ref": "#/definitions/HostedPaymentMethodPageGetDto", "definitions": { "HostedPaymentPages": { "type": "array", "items": { "$ref": "#/definitions/HostedPaymentPage" } }, "HostedPaymentMethodPageGetDto": { "additionalProperties": false, "type": "object", "properties": { "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", "items": { "$ref": "#/definitions/HostedPageFieldDefinition" } }, "creditCardTypeAutomaticDetectionEnabled": { "type": "boolean" }, "pageDescriptionEnabled": { "type": "boolean" }, "domain": { "type": "string" }, "invalidCreditCardTypeMessage": { "type": "string" }, "allowSubDomain": { "type": "boolean" }, "subType": { "type": "string" }, "mandatePageTemplate": { "type": "string" }, "paymentGateway": { "type": "string" } } }, "HostedPaymentMethodPagePostDto": { "additionalProperties": false, "type": "object", "properties": { "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", "items": { "$ref": "#/definitions/HostedPageFieldDefinition" } }, "creditCardTypeAutomaticDetectionEnabled": { "type": "boolean" }, "pageDescriptionEnabled": { "type": "boolean" }, "domain": { "type": "string" }, "invalidCreditCardTypeMessage": { "type": "string" }, "allowSubDomain": { "type": "boolean" }, "subType": { "type": "string" }, "mandatePageTemplate": { "type": "string" }, "paymentGateway": { "type": "string" } } }, "HostedPaymentPage": { "type": "object", "properties": { "string": { "type": "string" }, "id": { "type": "string" }, "type": { "type": "string" }, "pageName": { "type": "string" } } }, "HostedPageFieldDefinition": { "additionalProperties": false, "type": "object", "properties": { "associatedField": { "type": "string" }, "fieldName": { "type": "string" }, "isSystemFieldDefinition": { "type": "boolean" }, "defaultValue": { "type": "string" }, "cookieRetainable": { "type": "boolean" }, "fieldNumber": { "type": "integer" }, "encryptionRequired": { "type": "boolean" }, "fieldGroup": { "type": "string" }, "fieldOrder": { "type": "integer" }, "fieldEnabled": { "type": "boolean" }, "fieldReturnable": { "type": "boolean" }, "fieldMaxlength": { "type": "integer" }, "fieldResourceKey": { "type": "string" }, "mapsToDestination": { "type": "string" }, "fieldGroupKey": { "type": "string" }, "fieldGroupOrder": { "type": "integer" }, "fieldLabel": { "type": "string" }, "fieldRequired": { "type": "boolean" }, "fieldReadOnly": { "type": "boolean" }, "groupResourceKey": { "type": "string" }, "fieldType": { "type": "string" }, "createdOn": { "type": "integer" }, "updatedBy": { "type": "string" }, "updatedOn": { "type": "integer" }, "createdBy": { "type": "string" } } } } } } ] }, { "key": "HostedPaymentMethodPage", "description": "Hosted Payment Method Page", "context": "Tenant", "pathPattern": "/hosted-payment-method-pages/{id}", "httpOperations": [ { "method": "GET", "url": "/settings/hosted-payment-method-pages/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Hosted Payment Method page" } ], "responseType": { "$ref": "#/definitions/HostedPaymentMethodPageGetDto", "definitions": { "HostedPaymentMethodPageGetDto": { "additionalProperties": false, "type": "object", "properties": { "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", "items": { "$ref": "#/definitions/HostedPageFieldDefinition" } }, "creditCardTypeAutomaticDetectionEnabled": { "type": "boolean" }, "pageDescriptionEnabled": { "type": "boolean" }, "domain": { "type": "string" }, "invalidCreditCardTypeMessage": { "type": "string" }, "allowSubDomain": { "type": "boolean" }, "subType": { "type": "string" }, "mandatePageTemplate": { "type": "string" }, "paymentGateway": { "type": "string" } } }, "HostedPageFieldDefinition": { "additionalProperties": false, "type": "object", "properties": { "associatedField": { "type": "string" }, "fieldName": { "type": "string" }, "isSystemFieldDefinition": { "type": "boolean" }, "defaultValue": { "type": "string" }, "cookieRetainable": { "type": "boolean" }, "fieldNumber": { "type": "integer" }, "encryptionRequired": { "type": "boolean" }, "fieldGroup": { "type": "string" }, "fieldOrder": { "type": "integer" }, "fieldEnabled": { "type": "boolean" }, "fieldReturnable": { "type": "boolean" }, "fieldMaxlength": { "type": "integer" }, "fieldResourceKey": { "type": "string" }, "mapsToDestination": { "type": "string" }, "fieldGroupKey": { "type": "string" }, "fieldGroupOrder": { "type": "integer" }, "fieldLabel": { "type": "string" }, "fieldRequired": { "type": "boolean" }, "fieldReadOnly": { "type": "boolean" }, "groupResourceKey": { "type": "string" }, "fieldType": { "type": "string" }, "createdOn": { "type": "integer" }, "updatedBy": { "type": "string" }, "updatedOn": { "type": "integer" }, "createdBy": { "type": "string" } } } } } }, { "method": "DELETE", "url": "/settings/hosted-payment-method-pages/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Hosted Payment Method page" } ] } ] }, { "key": "AllInboundEntityConnections", "description": "Settings for All Inbound Entity Connections", "context": "Entity", "pathPattern": "/inbound-entity-connections", "httpOperations": [ { "method": "GET", "url": "/settings/inbound-entity-connections", "parameters": [], "responseType": { "$ref": "#/definitions/EntityConnections", "definitions": { "EntityConnections": { "additionalProperties": false, "type": "object", "properties": { "currentId": { "type": "string" }, "connections": { "type": "array", "items": { "$ref": "#/definitions/Connection" } } } }, "Connection": { "type": "object", "properties": { "otherId": { "type": "string" }, "status": { "enum": [ "connected", "pending", "requested", "notConnected" ] } } } } } } ] }, { "key": "InboundEntityConnection", "description": "Settings for an Inbound Entity Connection", "context": "Entity", "pathPattern": "/inbound-entity-connections/{entityId}", "httpOperations": [ { "method": "GET", "url": "/settings/inbound-entity-connections/{entityId}", "parameters": [ { "name": "entityId", "description": "Unique Id of the Entity to which the setting belongs" } ], "responseType": { "$ref": "#/definitions/Connection", "definitions": { "InboundResponse": { "additionalProperties": false, "type": "object", "properties": { "reply": { "$ref": "#/definitions/ConnectionResponse" } } }, "Connection": { "additionalProperties": false, "type": "object", "properties": { "otherId": { "type": "string" }, "status": { "enum": [ "connected", "pending", "requested", "notConnected" ] } } }, "ConnectionResponse": { "enum": [ "accept", "deny" ] } } } }, { "method": "PUT", "url": "/settings/inbound-entity-connections/{entityId}", "parameters": [ { "name": "entityId", "description": "Unique Id of the Entity to which the setting belongs" } ], "requestType": { "$ref": "#/definitions/InboundResponse", "definitions": { "InboundResponse": { "additionalProperties": false, "type": "object", "properties": { "reply": { "$ref": "#/definitions/ConnectionResponse" } } }, "Connection": { "additionalProperties": false, "type": "object", "properties": { "otherId": { "type": "string" }, "status": { "enum": [ "connected", "pending", "requested", "notConnected" ] } } }, "ConnectionResponse": { "enum": [ "accept", "deny" ] } } }, "responseType": { "$ref": "#/definitions/Connection", "definitions": { "InboundResponse": { "additionalProperties": false, "type": "object", "properties": { "reply": { "$ref": "#/definitions/ConnectionResponse" } } }, "Connection": { "additionalProperties": false, "type": "object", "properties": { "otherId": { "type": "string" }, "status": { "enum": [ "connected", "pending", "requested", "notConnected" ] } } }, "ConnectionResponse": { "enum": [ "accept", "deny" ] } } } } ] }, { "key": "InsightsConnection", "description": "Setting for Insights Connection", "context": "Entity", "pathPattern": "/insights-connections", "httpOperations": [ { "method": "GET", "url": "/settings/insights-connections", "parameters": [], "responseType": { "$ref": "#/definitions/InsightsConnection", "definitions": { "InsightsConnection": { "additionalProperties": false, "type": "object", "properties": { "domain": { "type": "string" } } } } } }, { "method": "PUT", "url": "/settings/insights-connections", "parameters": [], "requestType": { "$ref": "#/definitions/InsightsConnection", "definitions": { "InsightsConnection": { "additionalProperties": false, "type": "object", "properties": { "domain": { "type": "string" } } } } }, "responseType": { "$ref": "#/definitions/InsightsConnection", "definitions": { "InsightsConnection": { "additionalProperties": false, "type": "object", "properties": { "domain": { "type": "string" } } } } } } ] }, { "key": "AllInvoiceTemplates", "description": "Setting for all Invoice Templates", "context": "Tenant", "pathPattern": "/invoice-templates", "httpOperations": [ { "method": "GET", "url": "/settings/invoice-templates", "parameters": [], "responseType": { "type": "array", "items": { "$ref": "#/definitions/Template" }, "definitions": { "TemplatePostDto": { "additionalProperties": false, "type": "object", "properties": { "templateCategory": { "description": "The category of the template", "type": "string", "enum": [ "Old", "New" ] }, "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Invoice", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] } }, "required": [ "name", "base64EncodedTemplateFileContent" ] }, "Template": { "additionalProperties": false, "type": "object", "properties": { "templateCategory": { "description": "The category of the template", "type": "string", "enum": [ "Old", "New" ] }, "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "updatedOn": { "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Invoice", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "id": { "description": "The unique identifier of the template", "type": "string" }, "associatedToBillingAccount": { "type": "boolean" } } } } } }, { "method": "POST", "url": "/settings/invoice-templates", "parameters": [], "requestType": { "$ref": "#/definitions/TemplatePostDto", "definitions": { "TemplatePostDto": { "additionalProperties": false, "type": "object", "properties": { "templateCategory": { "description": "The category of the template", "type": "string", "enum": [ "Old", "New" ] }, "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Invoice", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] } }, "required": [ "name", "base64EncodedTemplateFileContent" ] }, "Template": { "additionalProperties": false, "type": "object", "properties": { "templateCategory": { "description": "The category of the template", "type": "string", "enum": [ "Old", "New" ] }, "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "updatedOn": { "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Invoice", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "id": { "description": "The unique identifier of the template", "type": "string" }, "associatedToBillingAccount": { "type": "boolean" } } } } }, "responseType": { "$ref": "#/definitions/Template", "definitions": { "TemplatePostDto": { "additionalProperties": false, "type": "object", "properties": { "templateCategory": { "description": "The category of the template", "type": "string", "enum": [ "Old", "New" ] }, "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Invoice", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] } }, "required": [ "name", "base64EncodedTemplateFileContent" ] }, "Template": { "additionalProperties": false, "type": "object", "properties": { "templateCategory": { "description": "The category of the template", "type": "string", "enum": [ "Old", "New" ] }, "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "updatedOn": { "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Invoice", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "id": { "description": "The unique identifier of the template", "type": "string" }, "associatedToBillingAccount": { "type": "boolean" } } } } } } ] }, { "key": "InvoiceTemplate", "description": "Setting for Invoice Template", "context": "Tenant", "pathPattern": "/invoice-templates/{id}", "httpOperations": [ { "method": "GET", "url": "/settings/invoice-templates/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Invoice Template" } ], "responseType": { "$ref": "#/definitions/Template", "definitions": { "Template": { "additionalProperties": false, "type": "object", "properties": { "templateCategory": { "description": "The category of the template", "type": "string", "enum": [ "Old", "New" ] }, "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "updatedOn": { "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Invoice", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "id": { "description": "The unique identifier of the template", "type": "string" }, "associatedToBillingAccount": { "type": "boolean" } } } } } }, { "method": "PUT", "url": "/settings/invoice-templates/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Invoice Template" } ], "requestType": { "$ref": "#/definitions/InvoiceTemplate", "definitions": { "InvoiceTemplate": { "additionalProperties": false, "type": "object", "properties": { "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Invoice", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" } } }, "Template": { "additionalProperties": false, "type": "object", "properties": { "templateCategory": { "description": "The category of the template", "type": "string", "enum": [ "Old", "New" ] }, "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "updatedOn": { "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Invoice", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "id": { "description": "The unique identifier of the template", "type": "string" }, "associatedToBillingAccount": { "type": "boolean" } } } } }, "responseType": { "$ref": "#/definitions/Template", "definitions": { "InvoiceTemplate": { "additionalProperties": false, "type": "object", "properties": { "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Invoice", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" } } }, "Template": { "additionalProperties": false, "type": "object", "properties": { "templateCategory": { "description": "The category of the template", "type": "string", "enum": [ "Old", "New" ] }, "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "updatedOn": { "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Invoice", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "id": { "description": "The unique identifier of the template", "type": "string" }, "associatedToBillingAccount": { "type": "boolean" } } } } } }, { "method": "DELETE", "url": "/settings/invoice-templates/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Invoice Template" } ] } ] }, { "key": "NumberAndSku", "description": "Setting for Number and SKU", "context": "Entity", "pathPattern": "/numbers-and-skus", "httpOperations": [ { "method": "GET", "url": "/settings/numbers-and-skus", "parameters": [], "responseType": { "$ref": "#/definitions/NumberAndSku", "definitions": { "NumberAndSku": { "additionalProperties": false, "type": "object", "properties": { "debitMemoTemplateNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "skuPrefix": { "type": "string" }, "productRatePlanNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "eInvoiceBusinessRegionNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "amendmentNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "chargeNumberPrefix": { "default": "C-", "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "productNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "creditMemoTemplateNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "productRatePlanChargeNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "invoiceTemplateNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "customerNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "billingAccountprefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "subscriptionRatePlanNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "eInvoiceServiceProviderNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "subscriptionNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "sequenceSetNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "eInvoiceTemplateNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 } } } } } }, { "method": "PUT", "url": "/settings/numbers-and-skus", "parameters": [], "requestType": { "$ref": "#/definitions/NumberAndSku", "definitions": { "NumberAndSku": { "additionalProperties": false, "type": "object", "properties": { "debitMemoTemplateNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "skuPrefix": { "type": "string" }, "productRatePlanNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "eInvoiceBusinessRegionNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "amendmentNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "chargeNumberPrefix": { "default": "C-", "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "productNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "creditMemoTemplateNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "productRatePlanChargeNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "invoiceTemplateNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "customerNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "billingAccountprefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "subscriptionRatePlanNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "eInvoiceServiceProviderNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "subscriptionNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "sequenceSetNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "eInvoiceTemplateNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 } } } } }, "responseType": { "$ref": "#/definitions/NumberAndSku", "definitions": { "NumberAndSku": { "additionalProperties": false, "type": "object", "properties": { "debitMemoTemplateNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "skuPrefix": { "type": "string" }, "productRatePlanNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "eInvoiceBusinessRegionNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "amendmentNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "chargeNumberPrefix": { "default": "C-", "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "productNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "creditMemoTemplateNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "productRatePlanChargeNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "invoiceTemplateNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "customerNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "billingAccountprefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "subscriptionRatePlanNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "eInvoiceServiceProviderNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "subscriptionNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "sequenceSetNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 }, "eInvoiceTemplateNumberPrefix": { "minLength": 1, "pattern": "^(?!\\s*$).{1,40}$", "type": "string", "maxLength": 40 } } } } } } ] }, { "key": "AllOutboundEntityConnections", "description": "Settings for All Outbound Entity Connections", "context": "Entity", "pathPattern": "/outbound-entity-connections", "httpOperations": [ { "method": "GET", "url": "/settings/outbound-entity-connections", "parameters": [], "responseType": { "$ref": "#/definitions/EntityConnections", "definitions": { "EntityConnections": { "additionalProperties": false, "type": "object", "properties": { "currentId": { "type": "string" }, "connections": { "type": "array", "items": { "$ref": "#/definitions/Connection" } } } }, "Connection": { "type": "object", "properties": { "otherId": { "type": "string" }, "status": { "enum": [ "connected", "pending", "requested", "notConnected" ] } } }, "OutboundRequest": { "type": "object", "properties": { "otherId": { "type": "string", "maxLength": 32 } } } } } }, { "method": "POST", "url": "/settings/outbound-entity-connections", "parameters": [], "requestType": { "$ref": "#/definitions/OutboundRequest", "definitions": { "EntityConnections": { "additionalProperties": false, "type": "object", "properties": { "currentId": { "type": "string" }, "connections": { "type": "array", "items": { "$ref": "#/definitions/Connection" } } } }, "Connection": { "type": "object", "properties": { "otherId": { "type": "string" }, "status": { "enum": [ "connected", "pending", "requested", "notConnected" ] } } }, "OutboundRequest": { "type": "object", "properties": { "otherId": { "type": "string", "maxLength": 32 } } } } }, "responseType": { "$ref": "#/definitions/Connection", "definitions": { "EntityConnections": { "additionalProperties": false, "type": "object", "properties": { "currentId": { "type": "string" }, "connections": { "type": "array", "items": { "$ref": "#/definitions/Connection" } } } }, "Connection": { "type": "object", "properties": { "otherId": { "type": "string" }, "status": { "enum": [ "connected", "pending", "requested", "notConnected" ] } } }, "OutboundRequest": { "type": "object", "properties": { "otherId": { "type": "string", "maxLength": 32 } } } } } } ] }, { "key": "OutboundEntityConnection", "description": "Settings for an Outbound Entity Connection", "context": "Entity", "pathPattern": "/outbound-entity-connections/{entityId}", "httpOperations": [ { "method": "GET", "url": "/settings/outbound-entity-connections/{entityId}", "parameters": [ { "name": "entityId", "description": "Unique Id of the Entity to which the Setting belongs" } ], "responseType": { "$ref": "#/definitions/Connection", "definitions": { "Connection": { "additionalProperties": false, "type": "object", "properties": { "otherId": { "type": "string", "maxLength": 32 }, "status": { "enum": [ "connected", "pending", "requested", "notConnected" ] } } } } } } ] }, { "key": "AllPaymentGateways", "description": "Manage Payment Gateways", "context": "Entity", "pathPattern": "/payment-gateways", "httpOperations": [ { "method": "GET", "url": "/settings/payment-gateways", "parameters": [], "responseType": { "$ref": "#/definitions/PaymentGateways", "definitions": { "PaymentGateways": { "type": "object", "properties": { "gateways": { "type": "array", "items": { "$ref": "#/definitions/Gateway" } } } }, "Gateway": { "additionalProperties": false, "type": "object", "properties": { "verifyPaymentMethodUpdated": { "type": "boolean" }, "cardsAccepted": { "type": "array", "items": { "type": "string" } }, "gatewayName": { "type": "string", "maxLength": 40 }, "verifyPaymentMethodNew": { "type": "boolean" }, "warning": { "type": "string" }, "paymentGatewayType": { "type": "string" }, "active": { "type": "boolean" }, "id": { "type": "string", "maxLength": 32 }, "cardsAllowed": { "type": "array", "items": { "type": "string" } }, "authDefaultAmount": { "type": "number", "minimum": 0 } } }, "PostGateway": { "additionalProperties": false, "type": "object", "properties": { "verifyPaymentMethodUpdated": { "type": "boolean" }, "cardsAccepted": { "$ref": "#/definitions/Cards" }, "gatewayName": { "type": "string", "maxLength": 40 }, "verifyPaymentMethodNew": { "type": "boolean" }, "paymentGatewayType": { "type": "string" }, "active": { "type": "boolean" }, "authDefaultAmount": { "type": "number", "minimum": 0 } } }, "Cards": { "type": "array", "items": { "type": "string", "enum": [ "Diners", "Cabal", "Argencard", "Maestro", "Visa", "Hipercard", "AmericanExpress", "JCB", "Elo", "Naranja", "Nativa", "CUP", "TarjetaShopping", "MasterCard", "Discover", "Cencosud", "Electron", "AppleVisa", "AppleMasterCard", "AppleAmericanExpress", "AppleDiscover", "AppleJCB", "MercadoLibre" ] } } } } }, { "method": "POST", "url": "/settings/payment-gateways", "parameters": [], "requestType": { "$ref": "#/definitions/PostGateway", "definitions": { "PaymentGateways": { "type": "object", "properties": { "gateways": { "type": "array", "items": { "$ref": "#/definitions/Gateway" } } } }, "Gateway": { "additionalProperties": false, "type": "object", "properties": { "verifyPaymentMethodUpdated": { "type": "boolean" }, "cardsAccepted": { "type": "array", "items": { "type": "string" } }, "gatewayName": { "type": "string", "maxLength": 40 }, "verifyPaymentMethodNew": { "type": "boolean" }, "warning": { "type": "string" }, "paymentGatewayType": { "type": "string" }, "active": { "type": "boolean" }, "id": { "type": "string", "maxLength": 32 }, "cardsAllowed": { "type": "array", "items": { "type": "string" } }, "authDefaultAmount": { "type": "number", "minimum": 0 } } }, "PostGateway": { "additionalProperties": false, "type": "object", "properties": { "verifyPaymentMethodUpdated": { "type": "boolean" }, "cardsAccepted": { "$ref": "#/definitions/Cards" }, "gatewayName": { "type": "string", "maxLength": 40 }, "verifyPaymentMethodNew": { "type": "boolean" }, "paymentGatewayType": { "type": "string" }, "active": { "type": "boolean" }, "authDefaultAmount": { "type": "number", "minimum": 0 } } }, "Cards": { "type": "array", "items": { "type": "string", "enum": [ "Diners", "Cabal", "Argencard", "Maestro", "Visa", "Hipercard", "AmericanExpress", "JCB", "Elo", "Naranja", "Nativa", "CUP", "TarjetaShopping", "MasterCard", "Discover", "Cencosud", "Electron", "AppleVisa", "AppleMasterCard", "AppleAmericanExpress", "AppleDiscover", "AppleJCB", "MercadoLibre" ] } } } }, "responseType": { "$ref": "#/definitions/Gateway", "definitions": { "PaymentGateways": { "type": "object", "properties": { "gateways": { "type": "array", "items": { "$ref": "#/definitions/Gateway" } } } }, "Gateway": { "additionalProperties": false, "type": "object", "properties": { "verifyPaymentMethodUpdated": { "type": "boolean" }, "cardsAccepted": { "type": "array", "items": { "type": "string" } }, "gatewayName": { "type": "string", "maxLength": 40 }, "verifyPaymentMethodNew": { "type": "boolean" }, "warning": { "type": "string" }, "paymentGatewayType": { "type": "string" }, "active": { "type": "boolean" }, "id": { "type": "string", "maxLength": 32 }, "cardsAllowed": { "type": "array", "items": { "type": "string" } }, "authDefaultAmount": { "type": "number", "minimum": 0 } } }, "PostGateway": { "additionalProperties": false, "type": "object", "properties": { "verifyPaymentMethodUpdated": { "type": "boolean" }, "cardsAccepted": { "$ref": "#/definitions/Cards" }, "gatewayName": { "type": "string", "maxLength": 40 }, "verifyPaymentMethodNew": { "type": "boolean" }, "paymentGatewayType": { "type": "string" }, "active": { "type": "boolean" }, "authDefaultAmount": { "type": "number", "minimum": 0 } } }, "Cards": { "type": "array", "items": { "type": "string", "enum": [ "Diners", "Cabal", "Argencard", "Maestro", "Visa", "Hipercard", "AmericanExpress", "JCB", "Elo", "Naranja", "Nativa", "CUP", "TarjetaShopping", "MasterCard", "Discover", "Cencosud", "Electron", "AppleVisa", "AppleMasterCard", "AppleAmericanExpress", "AppleDiscover", "AppleJCB", "MercadoLibre" ] } } } } } ] }, { "key": "PaymentGateway", "description": "Manage Payment Gateways", "context": "Entity", "pathPattern": "/payment-gateways/{id}", "httpOperations": [ { "method": "GET", "url": "/settings/payment-gateways/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Payment Gateway" } ], "responseType": { "$ref": "#/definitions/GatewayResponse", "definitions": { "GatewayResponse": { "additionalProperties": false, "type": "object", "properties": { "verifyPaymentMethodUpdated": { "type": "boolean" }, "cardsAccepted": { "type": "array", "items": { "type": "string" } }, "gatewayName": { "type": "string", "maxLength": 40 }, "verifyPaymentMethodNew": { "type": "boolean" }, "warning": { "type": "string" }, "paymentGatewayType": { "type": "string" }, "active": { "type": "boolean" }, "id": { "type": "string", "maxLength": 32 }, "cardsAllowed": { "type": "array", "items": { "type": "string" } }, "authDefaultAmount": { "type": "number", "minimum": 0 } } }, "Gateway": { "additionalProperties": false, "type": "object", "properties": { "verifyPaymentMethodUpdated": { "type": "boolean" }, "cardsAccepted": { "$ref": "#/definitions/Cards" }, "gatewayName": { "type": "string", "maxLength": 40 }, "verifyPaymentMethodNew": { "type": "boolean" }, "warning": { "type": "string" }, "paymentGatewayType": { "type": "string" }, "active": { "type": "boolean" }, "id": { "type": "string", "maxLength": 32 }, "cardsAllowed": { "$ref": "#/definitions/Cards" }, "authDefaultAmount": { "type": "number", "minimum": 0 } } }, "Cards": { "type": "array", "items": { "type": "string", "enum": [ "Diners", "Cabal", "Argencard", "Maestro", "Visa", "Hipercard", "AmericanExpress", "JCB", "Elo", "Naranja", "Nativa", "CUP", "TarjetaShopping", "MasterCard", "Discover", "Cencosud", "Electron", "AppleVisa", "AppleMasterCard", "AppleAmericanExpress", "AppleDiscover", "AppleJCB", "MercadoLibre" ] } } } } }, { "method": "PUT", "url": "/settings/payment-gateways/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Payment Gateway" } ], "requestType": { "$ref": "#/definitions/Gateway", "definitions": { "GatewayResponse": { "additionalProperties": false, "type": "object", "properties": { "verifyPaymentMethodUpdated": { "type": "boolean" }, "cardsAccepted": { "type": "array", "items": { "type": "string" } }, "gatewayName": { "type": "string", "maxLength": 40 }, "verifyPaymentMethodNew": { "type": "boolean" }, "warning": { "type": "string" }, "paymentGatewayType": { "type": "string" }, "active": { "type": "boolean" }, "id": { "type": "string", "maxLength": 32 }, "cardsAllowed": { "type": "array", "items": { "type": "string" } }, "authDefaultAmount": { "type": "number", "minimum": 0 } } }, "Gateway": { "additionalProperties": false, "type": "object", "properties": { "verifyPaymentMethodUpdated": { "type": "boolean" }, "cardsAccepted": { "$ref": "#/definitions/Cards" }, "gatewayName": { "type": "string", "maxLength": 40 }, "verifyPaymentMethodNew": { "type": "boolean" }, "warning": { "type": "string" }, "paymentGatewayType": { "type": "string" }, "active": { "type": "boolean" }, "id": { "type": "string", "maxLength": 32 }, "cardsAllowed": { "$ref": "#/definitions/Cards" }, "authDefaultAmount": { "type": "number", "minimum": 0 } } }, "Cards": { "type": "array", "items": { "type": "string", "enum": [ "Diners", "Cabal", "Argencard", "Maestro", "Visa", "Hipercard", "AmericanExpress", "JCB", "Elo", "Naranja", "Nativa", "CUP", "TarjetaShopping", "MasterCard", "Discover", "Cencosud", "Electron", "AppleVisa", "AppleMasterCard", "AppleAmericanExpress", "AppleDiscover", "AppleJCB", "MercadoLibre" ] } } } }, "responseType": { "$ref": "#/definitions/GatewayResponse", "definitions": { "GatewayResponse": { "additionalProperties": false, "type": "object", "properties": { "verifyPaymentMethodUpdated": { "type": "boolean" }, "cardsAccepted": { "type": "array", "items": { "type": "string" } }, "gatewayName": { "type": "string", "maxLength": 40 }, "verifyPaymentMethodNew": { "type": "boolean" }, "warning": { "type": "string" }, "paymentGatewayType": { "type": "string" }, "active": { "type": "boolean" }, "id": { "type": "string", "maxLength": 32 }, "cardsAllowed": { "type": "array", "items": { "type": "string" } }, "authDefaultAmount": { "type": "number", "minimum": 0 } } }, "Gateway": { "additionalProperties": false, "type": "object", "properties": { "verifyPaymentMethodUpdated": { "type": "boolean" }, "cardsAccepted": { "$ref": "#/definitions/Cards" }, "gatewayName": { "type": "string", "maxLength": 40 }, "verifyPaymentMethodNew": { "type": "boolean" }, "warning": { "type": "string" }, "paymentGatewayType": { "type": "string" }, "active": { "type": "boolean" }, "id": { "type": "string", "maxLength": 32 }, "cardsAllowed": { "$ref": "#/definitions/Cards" }, "authDefaultAmount": { "type": "number", "minimum": 0 } } }, "Cards": { "type": "array", "items": { "type": "string", "enum": [ "Diners", "Cabal", "Argencard", "Maestro", "Visa", "Hipercard", "AmericanExpress", "JCB", "Elo", "Naranja", "Nativa", "CUP", "TarjetaShopping", "MasterCard", "Discover", "Cencosud", "Electron", "AppleVisa", "AppleMasterCard", "AppleAmericanExpress", "AppleDiscover", "AppleJCB", "MercadoLibre" ] } } } } } ] }, { "key": "PaymentMethods", "description": "Setting for Payment Methods", "context": "Entity", "pathPattern": "/payment-methods", "httpOperations": [ { "method": "GET", "url": "/settings/payment-methods", "parameters": [], "responseType": { "$ref": "#/definitions/PaymentMethods", "definitions": { "PaymentMethods": { "additionalProperties": false, "type": "object", "properties": { "paymentMethodTypes": { "type": "array", "items": { "type": "string", "enum": [ "ACH", "Cash", "Check", "CreditCard", "PayPal", "WireTransfer", "DebitCard", "CreditCardReferenceTransaction", "BankTransfer", "Other" ] } } } } } } }, { "method": "PUT", "url": "/settings/payment-methods", "parameters": [], "requestType": { "$ref": "#/definitions/PaymentMethods", "definitions": { "PaymentMethods": { "additionalProperties": false, "type": "object", "properties": { "paymentMethodTypes": { "type": "array", "items": { "type": "string", "enum": [ "ACH", "Cash", "Check", "CreditCard", "PayPal", "WireTransfer", "DebitCard", "CreditCardReferenceTransaction", "BankTransfer", "Other" ] } } } } } }, "responseType": { "$ref": "#/definitions/PaymentMethods", "definitions": { "PaymentMethods": { "additionalProperties": false, "type": "object", "properties": { "paymentMethodTypes": { "type": "array", "items": { "type": "string", "enum": [ "ACH", "Cash", "Check", "CreditCard", "PayPal", "WireTransfer", "DebitCard", "CreditCardReferenceTransaction", "BankTransfer", "Other" ] } } } } } } } ] }, { "key": "PaymentRetryRules", "description": "Setting for managing Payment Retry Rules", "context": "Tenant", "pathPattern": "/payment-retry-rules", "httpOperations": [ { "method": "GET", "url": "/settings/payment-retry-rules", "parameters": [], "responseType": { "$ref": "#/definitions/PaymentRetryRules", "definitions": { "PaymentRetryRules": { "additionalProperties": false, "type": "object", "properties": { "paymentRetryWindow": { "description": "You can use the retry interval setting to prevent a payment attempt if the last failed payment was within the last 'number' of hours", "type": "integer" }, "maxConsecutivePaymentFailures": { "description": "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", "type": "integer" }, "isEnabled": { "description": "Enable Payment Run retry rules", "type": "boolean" } }, "required": [ "isEnabled", "maxConsecutivePaymentFailures", "paymentRetryWindow" ] } } } }, { "method": "PUT", "url": "/settings/payment-retry-rules", "parameters": [], "requestType": { "$ref": "#/definitions/PaymentRetryRules", "definitions": { "PaymentRetryRules": { "additionalProperties": false, "type": "object", "properties": { "paymentRetryWindow": { "description": "You can use the retry interval setting to prevent a payment attempt if the last failed payment was within the last 'number' of hours", "type": "integer" }, "maxConsecutivePaymentFailures": { "description": "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", "type": "integer" }, "isEnabled": { "description": "Enable Payment Run retry rules", "type": "boolean" } }, "required": [ "isEnabled", "maxConsecutivePaymentFailures", "paymentRetryWindow" ] } } }, "responseType": { "$ref": "#/definitions/PaymentRetryRules", "definitions": { "PaymentRetryRules": { "additionalProperties": false, "type": "object", "properties": { "paymentRetryWindow": { "description": "You can use the retry interval setting to prevent a payment attempt if the last failed payment was within the last 'number' of hours", "type": "integer" }, "maxConsecutivePaymentFailures": { "description": "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", "type": "integer" }, "isEnabled": { "description": "Enable Payment Run retry rules", "type": "boolean" } }, "required": [ "isEnabled", "maxConsecutivePaymentFailures", "paymentRetryWindow" ] } } } } ] }, { "key": "PaymentRules", "description": "Payment Rules settings", "context": "Entity", "pathPattern": "/payment-rules", "httpOperations": [ { "method": "GET", "url": "/settings/payment-rules", "parameters": [], "responseType": { "$ref": "#/definitions/PaymentRules", "definitions": { "PaymentRules": { "additionalProperties": false, "type": "object", "properties": { "enableTransactionFutureDateFeature": { "type": "boolean" }, "enableCreditCardDateValidation": { "type": "boolean" }, "enableCBRefundInGR": { "type": "boolean" }, "enableCustomPaymentNumber": { "type": "boolean" }, "displayUnapplyWhenCancelPayment": { "default": "false", "type": "boolean" }, "enableUnapplyWhenCancelPayment": { "default": "true", "type": "boolean" } } } } } }, { "method": "PUT", "url": "/settings/payment-rules", "parameters": [], "requestType": { "$ref": "#/definitions/PaymentRules", "definitions": { "PaymentRules": { "additionalProperties": false, "type": "object", "properties": { "enableTransactionFutureDateFeature": { "type": "boolean" }, "enableCreditCardDateValidation": { "type": "boolean" }, "enableCBRefundInGR": { "type": "boolean" }, "enableCustomPaymentNumber": { "type": "boolean" }, "displayUnapplyWhenCancelPayment": { "default": "false", "type": "boolean" }, "enableUnapplyWhenCancelPayment": { "default": "true", "type": "boolean" } } } } }, "responseType": { "$ref": "#/definitions/PaymentRules", "definitions": { "PaymentRules": { "additionalProperties": false, "type": "object", "properties": { "enableTransactionFutureDateFeature": { "type": "boolean" }, "enableCreditCardDateValidation": { "type": "boolean" }, "enableCBRefundInGR": { "type": "boolean" }, "enableCustomPaymentNumber": { "type": "boolean" }, "displayUnapplyWhenCancelPayment": { "default": "false", "type": "boolean" }, "enableUnapplyWhenCancelPayment": { "default": "true", "type": "boolean" } } } } } } ] }, { "key": "AllPaymentTerms", "description": "Setting to get All Payment Terms", "context": "Entity", "pathPattern": "/payment-terms", "httpOperations": [ { "method": "GET", "url": "/settings/payment-terms", "parameters": [], "responseType": { "$ref": "#/definitions/AllPaymentTerms", "definitions": { "GetPaymentTerm": { "type": "object", "properties": { "intervalNumber": { "description": "This property defines 'Number of days' for NetPaymentTerm type, and 'Number of months' for ProxPaymentTerm type", "type": "number" }, "isDefault": { "description": "Flag to indicate if it is a default PaymentTerm", "type": "boolean" }, "paymentDueDay": { "description": "Due date of the Payment (1-31)", "type": "number" }, "intervalUnit": { "description": "Unit of interval (Days, Months)", "type": "string" }, "name": { "description": "Unique Name of the PaymentTerm", "type": "string" }, "invoiceCutoffDay": { "description": "Invoice Cutoff date (1-31)", "type": "number" }, "id": { "description": "Unique Id of the PaymentTerm", "type": "string" }, "isActive": { "description": "Flag to indicate if PaymentTerm is Active", "type": "boolean" }, "type": { "description": "PaymentTerm type", "type": "string", "enum": [ "NetPaymentTerm", "ProxPaymentTerm" ] } } }, "AllPaymentTerms": { "type": "array", "items": { "$ref": "#/definitions/PaymentTerm" } }, "PaymentTerm": { "type": "object", "properties": { "intervalNumber": { "description": "This property defines 'Number of days' for NetPaymentTerm type, and 'Number of months' for ProxPaymentTerm type", "type": "number" }, "isDefault": { "description": "Flag to indicate if it is a default PaymentTerm", "type": "boolean" }, "paymentDueDay": { "description": "Due date of the Payment (1-31)", "type": "number" }, "intervalUnit": { "description": "Unit of interval (Days, Months)", "type": "string" }, "name": { "description": "Unique Name of the PaymentTerm", "type": "string" }, "invoiceCutoffDay": { "description": "Invoice Cutoff date (1-31)", "type": "number" }, "id": { "description": "Unique Id of the PaymentTerm", "type": "string" }, "isActive": { "description": "Flag to indicate if PaymentTerm is Active", "type": "boolean" }, "type": { "description": "PaymentTerm type", "type": "string", "enum": [ "NetPaymentTerm", "ProxPaymentTerm" ] } } }, "PostPaymentTerm": { "additionalProperties": false, "type": "object", "properties": { "intervalNumber": { "description": "This property defines 'Number of days' for NetPaymentTerm type, and 'Number of months' for ProxPaymentTerm type", "type": "number" }, "isDefault": { "description": "Flag to indicate if it is a default PaymentTerm", "type": "boolean" }, "paymentDueDay": { "description": "Due date of the Payment (1-31)", "type": "number" }, "name": { "description": "Unique Name of the PaymentTerm", "type": "string" }, "invoiceCutoffDay": { "description": "Invoice Cutoff date (1-31)", "type": "number" }, "isActive": { "description": "Flag to indicate if PaymentTerm is Active", "type": "boolean" }, "type": { "description": "PaymentTerm type", "type": "string", "enum": [ "NetPaymentTerm", "ProxPaymentTerm" ] } } } } } }, { "method": "POST", "url": "/settings/payment-terms", "parameters": [], "requestType": { "$ref": "#/definitions/PostPaymentTerm", "definitions": { "GetPaymentTerm": { "type": "object", "properties": { "intervalNumber": { "description": "This property defines 'Number of days' for NetPaymentTerm type, and 'Number of months' for ProxPaymentTerm type", "type": "number" }, "isDefault": { "description": "Flag to indicate if it is a default PaymentTerm", "type": "boolean" }, "paymentDueDay": { "description": "Due date of the Payment (1-31)", "type": "number" }, "intervalUnit": { "description": "Unit of interval (Days, Months)", "type": "string" }, "name": { "description": "Unique Name of the PaymentTerm", "type": "string" }, "invoiceCutoffDay": { "description": "Invoice Cutoff date (1-31)", "type": "number" }, "id": { "description": "Unique Id of the PaymentTerm", "type": "string" }, "isActive": { "description": "Flag to indicate if PaymentTerm is Active", "type": "boolean" }, "type": { "description": "PaymentTerm type", "type": "string", "enum": [ "NetPaymentTerm", "ProxPaymentTerm" ] } } }, "AllPaymentTerms": { "type": "array", "items": { "$ref": "#/definitions/PaymentTerm" } }, "PaymentTerm": { "type": "object", "properties": { "intervalNumber": { "description": "This property defines 'Number of days' for NetPaymentTerm type, and 'Number of months' for ProxPaymentTerm type", "type": "number" }, "isDefault": { "description": "Flag to indicate if it is a default PaymentTerm", "type": "boolean" }, "paymentDueDay": { "description": "Due date of the Payment (1-31)", "type": "number" }, "intervalUnit": { "description": "Unit of interval (Days, Months)", "type": "string" }, "name": { "description": "Unique Name of the PaymentTerm", "type": "string" }, "invoiceCutoffDay": { "description": "Invoice Cutoff date (1-31)", "type": "number" }, "id": { "description": "Unique Id of the PaymentTerm", "type": "string" }, "isActive": { "description": "Flag to indicate if PaymentTerm is Active", "type": "boolean" }, "type": { "description": "PaymentTerm type", "type": "string", "enum": [ "NetPaymentTerm", "ProxPaymentTerm" ] } } }, "PostPaymentTerm": { "additionalProperties": false, "type": "object", "properties": { "intervalNumber": { "description": "This property defines 'Number of days' for NetPaymentTerm type, and 'Number of months' for ProxPaymentTerm type", "type": "number" }, "isDefault": { "description": "Flag to indicate if it is a default PaymentTerm", "type": "boolean" }, "paymentDueDay": { "description": "Due date of the Payment (1-31)", "type": "number" }, "name": { "description": "Unique Name of the PaymentTerm", "type": "string" }, "invoiceCutoffDay": { "description": "Invoice Cutoff date (1-31)", "type": "number" }, "isActive": { "description": "Flag to indicate if PaymentTerm is Active", "type": "boolean" }, "type": { "description": "PaymentTerm type", "type": "string", "enum": [ "NetPaymentTerm", "ProxPaymentTerm" ] } } } } }, "responseType": { "$ref": "#/definitions/GetPaymentTerm", "definitions": { "GetPaymentTerm": { "type": "object", "properties": { "intervalNumber": { "description": "This property defines 'Number of days' for NetPaymentTerm type, and 'Number of months' for ProxPaymentTerm type", "type": "number" }, "isDefault": { "description": "Flag to indicate if it is a default PaymentTerm", "type": "boolean" }, "paymentDueDay": { "description": "Due date of the Payment (1-31)", "type": "number" }, "intervalUnit": { "description": "Unit of interval (Days, Months)", "type": "string" }, "name": { "description": "Unique Name of the PaymentTerm", "type": "string" }, "invoiceCutoffDay": { "description": "Invoice Cutoff date (1-31)", "type": "number" }, "id": { "description": "Unique Id of the PaymentTerm", "type": "string" }, "isActive": { "description": "Flag to indicate if PaymentTerm is Active", "type": "boolean" }, "type": { "description": "PaymentTerm type", "type": "string", "enum": [ "NetPaymentTerm", "ProxPaymentTerm" ] } } }, "AllPaymentTerms": { "type": "array", "items": { "$ref": "#/definitions/PaymentTerm" } }, "PaymentTerm": { "type": "object", "properties": { "intervalNumber": { "description": "This property defines 'Number of days' for NetPaymentTerm type, and 'Number of months' for ProxPaymentTerm type", "type": "number" }, "isDefault": { "description": "Flag to indicate if it is a default PaymentTerm", "type": "boolean" }, "paymentDueDay": { "description": "Due date of the Payment (1-31)", "type": "number" }, "intervalUnit": { "description": "Unit of interval (Days, Months)", "type": "string" }, "name": { "description": "Unique Name of the PaymentTerm", "type": "string" }, "invoiceCutoffDay": { "description": "Invoice Cutoff date (1-31)", "type": "number" }, "id": { "description": "Unique Id of the PaymentTerm", "type": "string" }, "isActive": { "description": "Flag to indicate if PaymentTerm is Active", "type": "boolean" }, "type": { "description": "PaymentTerm type", "type": "string", "enum": [ "NetPaymentTerm", "ProxPaymentTerm" ] } } }, "PostPaymentTerm": { "additionalProperties": false, "type": "object", "properties": { "intervalNumber": { "description": "This property defines 'Number of days' for NetPaymentTerm type, and 'Number of months' for ProxPaymentTerm type", "type": "number" }, "isDefault": { "description": "Flag to indicate if it is a default PaymentTerm", "type": "boolean" }, "paymentDueDay": { "description": "Due date of the Payment (1-31)", "type": "number" }, "name": { "description": "Unique Name of the PaymentTerm", "type": "string" }, "invoiceCutoffDay": { "description": "Invoice Cutoff date (1-31)", "type": "number" }, "isActive": { "description": "Flag to indicate if PaymentTerm is Active", "type": "boolean" }, "type": { "description": "PaymentTerm type", "type": "string", "enum": [ "NetPaymentTerm", "ProxPaymentTerm" ] } } } } } } ] }, { "key": "PaymentTerm", "description": "Setting for Payment Term", "context": "Entity", "pathPattern": "/payment-terms/{id}", "httpOperations": [ { "method": "GET", "url": "/settings/payment-terms/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Payment Term" } ], "responseType": { "$ref": "#/definitions/GetPaymentTerm", "definitions": { "GetPaymentTerm": { "type": "object", "properties": { "intervalNumber": { "description": "This property defines 'Number of days' for NetPaymentTerm type, and 'Number of months' for ProxPaymentTerm type", "type": "number" }, "isDefault": { "description": "Flag to indicate if it is a default PaymentTerm", "type": "boolean" }, "paymentDueDay": { "description": "Due date of the Payment (1-31)", "type": "number" }, "intervalUnit": { "description": "Unit of interval (Days, Months)", "type": "string" }, "name": { "description": "Unique Name of the PaymentTerm", "type": "string" }, "invoiceCutoffDay": { "description": "Invoice Cutoff date (1-31)", "type": "number" }, "id": { "description": "Unique Id of the PaymentTerm", "type": "string" }, "isActive": { "description": "Flag to indicate if PaymentTerm is Active", "type": "boolean" }, "type": { "description": "PaymentTerm type", "type": "string", "enum": [ "NetPaymentTerm", "ProxPaymentTerm" ] } } }, "PaymentTerm": { "additionalProperties": false, "type": "object", "properties": { "intervalNumber": { "description": "This property defines 'Number of days' for NetPaymentTerm type, and 'Number of months' for ProxPaymentTerm type", "type": "number" }, "isDefault": { "description": "Flag to indicate if it is a default PaymentTerm", "type": "boolean" }, "paymentDueDay": { "description": "Due date of the Payment (1-31)", "type": "number" }, "name": { "description": "Unique Name of the PaymentTerm", "type": "string" }, "invoiceCutoffDay": { "description": "Invoice Cutoff date (1-31)", "type": "number" }, "isActive": { "description": "Flag to indicate if PaymentTerm is Active", "type": "boolean" }, "type": { "description": "PaymentTerm type", "type": "string", "enum": [ "NetPaymentTerm", "ProxPaymentTerm" ] } } } } } }, { "method": "PUT", "url": "/settings/payment-terms/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Payment Term" } ], "requestType": { "$ref": "#/definitions/PaymentTerm", "definitions": { "GetPaymentTerm": { "type": "object", "properties": { "intervalNumber": { "description": "This property defines 'Number of days' for NetPaymentTerm type, and 'Number of months' for ProxPaymentTerm type", "type": "number" }, "isDefault": { "description": "Flag to indicate if it is a default PaymentTerm", "type": "boolean" }, "paymentDueDay": { "description": "Due date of the Payment (1-31)", "type": "number" }, "intervalUnit": { "description": "Unit of interval (Days, Months)", "type": "string" }, "name": { "description": "Unique Name of the PaymentTerm", "type": "string" }, "invoiceCutoffDay": { "description": "Invoice Cutoff date (1-31)", "type": "number" }, "id": { "description": "Unique Id of the PaymentTerm", "type": "string" }, "isActive": { "description": "Flag to indicate if PaymentTerm is Active", "type": "boolean" }, "type": { "description": "PaymentTerm type", "type": "string", "enum": [ "NetPaymentTerm", "ProxPaymentTerm" ] } } }, "PaymentTerm": { "additionalProperties": false, "type": "object", "properties": { "intervalNumber": { "description": "This property defines 'Number of days' for NetPaymentTerm type, and 'Number of months' for ProxPaymentTerm type", "type": "number" }, "isDefault": { "description": "Flag to indicate if it is a default PaymentTerm", "type": "boolean" }, "paymentDueDay": { "description": "Due date of the Payment (1-31)", "type": "number" }, "name": { "description": "Unique Name of the PaymentTerm", "type": "string" }, "invoiceCutoffDay": { "description": "Invoice Cutoff date (1-31)", "type": "number" }, "isActive": { "description": "Flag to indicate if PaymentTerm is Active", "type": "boolean" }, "type": { "description": "PaymentTerm type", "type": "string", "enum": [ "NetPaymentTerm", "ProxPaymentTerm" ] } } } } }, "responseType": { "$ref": "#/definitions/GetPaymentTerm", "definitions": { "GetPaymentTerm": { "type": "object", "properties": { "intervalNumber": { "description": "This property defines 'Number of days' for NetPaymentTerm type, and 'Number of months' for ProxPaymentTerm type", "type": "number" }, "isDefault": { "description": "Flag to indicate if it is a default PaymentTerm", "type": "boolean" }, "paymentDueDay": { "description": "Due date of the Payment (1-31)", "type": "number" }, "intervalUnit": { "description": "Unit of interval (Days, Months)", "type": "string" }, "name": { "description": "Unique Name of the PaymentTerm", "type": "string" }, "invoiceCutoffDay": { "description": "Invoice Cutoff date (1-31)", "type": "number" }, "id": { "description": "Unique Id of the PaymentTerm", "type": "string" }, "isActive": { "description": "Flag to indicate if PaymentTerm is Active", "type": "boolean" }, "type": { "description": "PaymentTerm type", "type": "string", "enum": [ "NetPaymentTerm", "ProxPaymentTerm" ] } } }, "PaymentTerm": { "additionalProperties": false, "type": "object", "properties": { "intervalNumber": { "description": "This property defines 'Number of days' for NetPaymentTerm type, and 'Number of months' for ProxPaymentTerm type", "type": "number" }, "isDefault": { "description": "Flag to indicate if it is a default PaymentTerm", "type": "boolean" }, "paymentDueDay": { "description": "Due date of the Payment (1-31)", "type": "number" }, "name": { "description": "Unique Name of the PaymentTerm", "type": "string" }, "invoiceCutoffDay": { "description": "Invoice Cutoff date (1-31)", "type": "number" }, "isActive": { "description": "Flag to indicate if PaymentTerm is Active", "type": "boolean" }, "type": { "description": "PaymentTerm type", "type": "string", "enum": [ "NetPaymentTerm", "ProxPaymentTerm" ] } } } } } }, { "method": "DELETE", "url": "/settings/payment-terms/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Payment Term" } ] } ] }, { "key": "ProductAttributesConfigurable", "description": "Manage Product Attributes", "context": "Tenant", "pathPattern": "/product-attribute-configurable", "httpOperations": [ { "method": "GET", "url": "/settings/product-attribute-configurable", "parameters": [], "responseType": { "type": "boolean" } }, { "method": "PUT", "url": "/settings/product-attribute-configurable", "parameters": [], "requestType": { "type": "boolean" }, "responseType": { "type": "boolean" } } ] }, { "key": "AllProductAttributes", "description": "Manage Product Attributes", "context": "Tenant", "pathPattern": "/product-attributes", "httpOperations": [ { "method": "GET", "url": "/settings/product-attributes", "parameters": [], "responseType": { "$ref": "#/definitions/ProductAttribute", "definitions": { "Attribute": { "type": "object", "properties": { "immutable": { "type": "boolean" }, "productLevel": { "type": "string", "enum": [ "AccountingPeriod", "Product", "RatePlan", "RatePlanComponent", "ProductRatePlanChargeTier", "CustomField", "CustomFieldPicklistValue" ] }, "controlLevel": { "type": "string", "enum": [ "Target", "Source" ] }, "attribute": { "type": "string" } } }, "ProductAttribute": { "additionalProperties": false, "type": "object", "properties": { "attributes": { "type": "array", "items": { "$ref": "#/definitions/Attribute" } } } } } } }, { "method": "PUT", "url": "/settings/product-attributes", "parameters": [], "requestType": { "$ref": "#/definitions/ProductAttribute", "definitions": { "Attribute": { "type": "object", "properties": { "immutable": { "type": "boolean" }, "productLevel": { "type": "string", "enum": [ "AccountingPeriod", "Product", "RatePlan", "RatePlanComponent", "ProductRatePlanChargeTier", "CustomField", "CustomFieldPicklistValue" ] }, "controlLevel": { "type": "string", "enum": [ "Target", "Source" ] }, "attribute": { "type": "string" } } }, "ProductAttribute": { "additionalProperties": false, "type": "object", "properties": { "attributes": { "type": "array", "items": { "$ref": "#/definitions/Attribute" } } } } } }, "responseType": { "$ref": "#/definitions/ProductAttribute", "definitions": { "Attribute": { "type": "object", "properties": { "immutable": { "type": "boolean" }, "productLevel": { "type": "string", "enum": [ "AccountingPeriod", "Product", "RatePlan", "RatePlanComponent", "ProductRatePlanChargeTier", "CustomField", "CustomFieldPicklistValue" ] }, "controlLevel": { "type": "string", "enum": [ "Target", "Source" ] }, "attribute": { "type": "string" } } }, "ProductAttribute": { "additionalProperties": false, "type": "object", "properties": { "attributes": { "type": "array", "items": { "$ref": "#/definitions/Attribute" } } } } } } } ] }, { "key": "ProductAttribute", "description": "Manage Product Attributes", "context": "Tenant", "pathPattern": "/product-attributes/{attribute}", "httpOperations": [ { "method": "GET", "url": "/settings/product-attributes/{attribute}", "parameters": [ { "name": "attribute", "description": "The product attribute key" } ], "responseType": { "$ref": "#/definitions/Attribute", "definitions": { "Attribute": { "additionalProperties": false, "type": "object", "properties": { "immutable": { "type": "boolean" }, "productLevel": { "type": "string", "enum": [ "AccountingPeriod", "Product", "RatePlan", "RatePlanComponent", "ProductRatePlanChargeTier", "CustomField", "CustomFieldPicklistValue" ] }, "controlLevel": { "type": "string", "enum": [ "Target", "Source" ] }, "attribute": { "type": "string" } } }, "ControlLevel": { "additionalProperties": false, "type": "object", "properties": { "controlLevel": { "type": "string", "enum": [ "Target", "Source" ] } } } } } }, { "method": "PUT", "url": "/settings/product-attributes/{attribute}", "parameters": [ { "name": "attribute", "description": "The product attribute key" } ], "requestType": { "$ref": "#/definitions/ControlLevel", "definitions": { "Attribute": { "additionalProperties": false, "type": "object", "properties": { "immutable": { "type": "boolean" }, "productLevel": { "type": "string", "enum": [ "AccountingPeriod", "Product", "RatePlan", "RatePlanComponent", "ProductRatePlanChargeTier", "CustomField", "CustomFieldPicklistValue" ] }, "controlLevel": { "type": "string", "enum": [ "Target", "Source" ] }, "attribute": { "type": "string" } } }, "ControlLevel": { "additionalProperties": false, "type": "object", "properties": { "controlLevel": { "type": "string", "enum": [ "Target", "Source" ] } } } } }, "responseType": { "$ref": "#/definitions/Attribute", "definitions": { "Attribute": { "additionalProperties": false, "type": "object", "properties": { "immutable": { "type": "boolean" }, "productLevel": { "type": "string", "enum": [ "AccountingPeriod", "Product", "RatePlan", "RatePlanComponent", "ProductRatePlanChargeTier", "CustomField", "CustomFieldPicklistValue" ] }, "controlLevel": { "type": "string", "enum": [ "Target", "Source" ] }, "attribute": { "type": "string" } } }, "ControlLevel": { "additionalProperties": false, "type": "object", "properties": { "controlLevel": { "type": "string", "enum": [ "Target", "Source" ] } } } } } } ] }, { "key": "AllQuoteTemplates", "description": "Setting for all Quote Templates", "context": "Tenant", "pathPattern": "/quote-templates", "httpOperations": [ { "method": "GET", "url": "/settings/quote-templates", "parameters": [], "responseType": { "type": "array", "items": { "$ref": "#/definitions/Template" }, "definitions": { "TemplatePostDto": { "additionalProperties": false, "type": "object", "properties": { "templateCategory": { "description": "The category of the template", "type": "string", "enum": [ "Old", "New" ] }, "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Invoice", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] } }, "required": [ "name", "templateFileName", "base64EncodedTemplateFileContent" ] }, "Template": { "additionalProperties": false, "type": "object", "properties": { "templateCategory": { "description": "The category of the template", "type": "string", "enum": [ "Old", "New" ] }, "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Invoice", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "updatedOn": { "type": "string" }, "id": { "description": "The unique identifier of the template", "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] } } } } } }, { "method": "POST", "url": "/settings/quote-templates", "parameters": [], "requestType": { "$ref": "#/definitions/TemplatePostDto", "definitions": { "TemplatePostDto": { "additionalProperties": false, "type": "object", "properties": { "templateCategory": { "description": "The category of the template", "type": "string", "enum": [ "Old", "New" ] }, "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Invoice", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] } }, "required": [ "name", "templateFileName", "base64EncodedTemplateFileContent" ] }, "Template": { "additionalProperties": false, "type": "object", "properties": { "templateCategory": { "description": "The category of the template", "type": "string", "enum": [ "Old", "New" ] }, "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Invoice", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "updatedOn": { "type": "string" }, "id": { "description": "The unique identifier of the template", "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] } } } } }, "responseType": { "$ref": "#/definitions/Template", "definitions": { "TemplatePostDto": { "additionalProperties": false, "type": "object", "properties": { "templateCategory": { "description": "The category of the template", "type": "string", "enum": [ "Old", "New" ] }, "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Invoice", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] } }, "required": [ "name", "templateFileName", "base64EncodedTemplateFileContent" ] }, "Template": { "additionalProperties": false, "type": "object", "properties": { "templateCategory": { "description": "The category of the template", "type": "string", "enum": [ "Old", "New" ] }, "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Invoice", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "updatedOn": { "type": "string" }, "id": { "description": "The unique identifier of the template", "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] } } } } } } ] }, { "key": "QuoteTemplate", "description": "Setting for Quote Template", "context": "Tenant", "pathPattern": "/quote-templates/{id}", "httpOperations": [ { "method": "GET", "url": "/settings/quote-templates/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Quote Template" } ], "responseType": { "$ref": "#/definitions/Template", "definitions": { "Template": { "additionalProperties": false, "type": "object", "properties": { "templateCategory": { "description": "The category of the template", "type": "string", "enum": [ "Old", "New" ] }, "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "suppressZeroValueLine": { "description": "Should zero valued lines be suppressed and not shown in the eventual Invoice", "type": "boolean" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "updatedOn": { "type": "string" }, "id": { "description": "The unique identifier of the template", "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] } } } } } }, { "method": "DELETE", "url": "/settings/quote-templates/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Quote Template" } ] } ] }, { "key": "AllReasonCodes", "description": "Read All Reason Codes", "context": "Entity", "pathPattern": "/reason-codes", "httpOperations": [ { "method": "GET", "url": "/settings/reason-codes", "parameters": [], "responseType": { "$ref": "#/definitions/ReasonCodes", "definitions": { "PostReasonCode": { "additionalProperties": false, "type": "object", "properties": { "reasonCodeName": { "minLength": 1, "description": "Unique name for the Reason code", "type": "string", "maxLength": 25 }, "reasonCodeTransactionType": { "description": "Type of Transaction (RefundPayment, InvoiceAdjustment etc)", "type": "string", "enum": [ "RefundPayment", "RefundCreditBalance", "InvoiceItemAdjustment", "InvoiceAdjustment", "CreditBalanceAdjustment", "CreditMemo", "DebitMemo", "RefundCreditMemo", "ReturnOrder" ] }, "isActive": { "description": "Flag to indicate if Reason Code is active", "type": "boolean" } } }, "ReasonCode": { "type": "object", "properties": { "reasonCodeName": { "minLength": 1, "description": "Unique name for the Reason code", "type": "string", "maxLength": 25 }, "isDefault": { "description": "Flag to indicate if it is default Reason Code", "type": "boolean" }, "reasonCodeTransactionType": { "description": "Type of Transaction (RefundPayment, InvoiceAdjustment etc)", "type": "string", "enum": [ "RefundPayment", "RefundCreditBalance", "InvoiceItemAdjustment", "InvoiceAdjustment", "CreditBalanceAdjustment", "CreditMemo", "DebitMemo", "RefundCreditMemo", "ReturnOrder" ] }, "id": { "description": "Unique Id of the ReasonCode", "type": "string" }, "isActive": { "description": "Flag to indicate if Reason Code is active", "type": "boolean" } } }, "ReasonCodes": { "type": "array", "items": { "$ref": "#/definitions/ReasonCode" } } } } }, { "method": "POST", "url": "/settings/reason-codes", "parameters": [], "requestType": { "$ref": "#/definitions/PostReasonCode", "definitions": { "PostReasonCode": { "additionalProperties": false, "type": "object", "properties": { "reasonCodeName": { "minLength": 1, "description": "Unique name for the Reason code", "type": "string", "maxLength": 25 }, "reasonCodeTransactionType": { "description": "Type of Transaction (RefundPayment, InvoiceAdjustment etc)", "type": "string", "enum": [ "RefundPayment", "RefundCreditBalance", "InvoiceItemAdjustment", "InvoiceAdjustment", "CreditBalanceAdjustment", "CreditMemo", "DebitMemo", "RefundCreditMemo", "ReturnOrder" ] }, "isActive": { "description": "Flag to indicate if Reason Code is active", "type": "boolean" } } }, "ReasonCode": { "type": "object", "properties": { "reasonCodeName": { "minLength": 1, "description": "Unique name for the Reason code", "type": "string", "maxLength": 25 }, "isDefault": { "description": "Flag to indicate if it is default Reason Code", "type": "boolean" }, "reasonCodeTransactionType": { "description": "Type of Transaction (RefundPayment, InvoiceAdjustment etc)", "type": "string", "enum": [ "RefundPayment", "RefundCreditBalance", "InvoiceItemAdjustment", "InvoiceAdjustment", "CreditBalanceAdjustment", "CreditMemo", "DebitMemo", "RefundCreditMemo", "ReturnOrder" ] }, "id": { "description": "Unique Id of the ReasonCode", "type": "string" }, "isActive": { "description": "Flag to indicate if Reason Code is active", "type": "boolean" } } }, "ReasonCodes": { "type": "array", "items": { "$ref": "#/definitions/ReasonCode" } } } }, "responseType": { "$ref": "#/definitions/ReasonCode", "definitions": { "PostReasonCode": { "additionalProperties": false, "type": "object", "properties": { "reasonCodeName": { "minLength": 1, "description": "Unique name for the Reason code", "type": "string", "maxLength": 25 }, "reasonCodeTransactionType": { "description": "Type of Transaction (RefundPayment, InvoiceAdjustment etc)", "type": "string", "enum": [ "RefundPayment", "RefundCreditBalance", "InvoiceItemAdjustment", "InvoiceAdjustment", "CreditBalanceAdjustment", "CreditMemo", "DebitMemo", "RefundCreditMemo", "ReturnOrder" ] }, "isActive": { "description": "Flag to indicate if Reason Code is active", "type": "boolean" } } }, "ReasonCode": { "type": "object", "properties": { "reasonCodeName": { "minLength": 1, "description": "Unique name for the Reason code", "type": "string", "maxLength": 25 }, "isDefault": { "description": "Flag to indicate if it is default Reason Code", "type": "boolean" }, "reasonCodeTransactionType": { "description": "Type of Transaction (RefundPayment, InvoiceAdjustment etc)", "type": "string", "enum": [ "RefundPayment", "RefundCreditBalance", "InvoiceItemAdjustment", "InvoiceAdjustment", "CreditBalanceAdjustment", "CreditMemo", "DebitMemo", "RefundCreditMemo", "ReturnOrder" ] }, "id": { "description": "Unique Id of the ReasonCode", "type": "string" }, "isActive": { "description": "Flag to indicate if Reason Code is active", "type": "boolean" } } }, "ReasonCodes": { "type": "array", "items": { "$ref": "#/definitions/ReasonCode" } } } } } ] }, { "key": "ReasonCode", "description": "Manage Reason Code", "context": "Entity", "pathPattern": "/reason-codes/{id}", "httpOperations": [ { "method": "GET", "url": "/settings/reason-codes/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Reason code" } ], "responseType": { "$ref": "#/definitions/GetReasonCode", "definitions": { "PutReasonCode": { "additionalProperties": false, "type": "object", "properties": { "reasonCodeName": { "minLength": 1, "description": "Unique name for the Reason code", "type": "string", "maxLength": 25 }, "isDefault": { "description": "Flag to indicate if it is default Reason Code", "type": "boolean" }, "isActive": { "description": "Flag to indicate if Reason Code is active", "type": "boolean" } } }, "GetReasonCode": { "type": "object", "properties": { "reasonCodeName": { "minLength": 1, "description": "Unique name for the Reason code", "type": "string", "maxLength": 25 }, "isDefault": { "description": "Flag to indicate if it is default Reason Code", "type": "boolean" }, "reasonCodeTransactionType": { "description": "Type of Transaction (RefundPayment, InvoiceAdjustment etc)", "type": "string", "enum": [ "RefundPayment", "RefundCreditBalance", "InvoiceItemAdjustment", "InvoiceAdjustment", "CreditBalanceAdjustment", "CreditMemo", "DebitMemo", "RefundCreditMemo", "ReturnOrder" ] }, "id": { "description": "Unique Id of the Reason Code", "type": "string" }, "isActive": { "description": "Flag to indicate if Reason Code is active", "type": "boolean" } } } } } }, { "method": "PUT", "url": "/settings/reason-codes/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Reason code" } ], "requestType": { "$ref": "#/definitions/PutReasonCode", "definitions": { "PutReasonCode": { "additionalProperties": false, "type": "object", "properties": { "reasonCodeName": { "minLength": 1, "description": "Unique name for the Reason code", "type": "string", "maxLength": 25 }, "isDefault": { "description": "Flag to indicate if it is default Reason Code", "type": "boolean" }, "isActive": { "description": "Flag to indicate if Reason Code is active", "type": "boolean" } } }, "GetReasonCode": { "type": "object", "properties": { "reasonCodeName": { "minLength": 1, "description": "Unique name for the Reason code", "type": "string", "maxLength": 25 }, "isDefault": { "description": "Flag to indicate if it is default Reason Code", "type": "boolean" }, "reasonCodeTransactionType": { "description": "Type of Transaction (RefundPayment, InvoiceAdjustment etc)", "type": "string", "enum": [ "RefundPayment", "RefundCreditBalance", "InvoiceItemAdjustment", "InvoiceAdjustment", "CreditBalanceAdjustment", "CreditMemo", "DebitMemo", "RefundCreditMemo", "ReturnOrder" ] }, "id": { "description": "Unique Id of the Reason Code", "type": "string" }, "isActive": { "description": "Flag to indicate if Reason Code is active", "type": "boolean" } } } } }, "responseType": { "$ref": "#/definitions/GetReasonCode", "definitions": { "PutReasonCode": { "additionalProperties": false, "type": "object", "properties": { "reasonCodeName": { "minLength": 1, "description": "Unique name for the Reason code", "type": "string", "maxLength": 25 }, "isDefault": { "description": "Flag to indicate if it is default Reason Code", "type": "boolean" }, "isActive": { "description": "Flag to indicate if Reason Code is active", "type": "boolean" } } }, "GetReasonCode": { "type": "object", "properties": { "reasonCodeName": { "minLength": 1, "description": "Unique name for the Reason code", "type": "string", "maxLength": 25 }, "isDefault": { "description": "Flag to indicate if it is default Reason Code", "type": "boolean" }, "reasonCodeTransactionType": { "description": "Type of Transaction (RefundPayment, InvoiceAdjustment etc)", "type": "string", "enum": [ "RefundPayment", "RefundCreditBalance", "InvoiceItemAdjustment", "InvoiceAdjustment", "CreditBalanceAdjustment", "CreditMemo", "DebitMemo", "RefundCreditMemo", "ReturnOrder" ] }, "id": { "description": "Unique Id of the Reason Code", "type": "string" }, "isActive": { "description": "Flag to indicate if Reason Code is active", "type": "boolean" } } } } } } ] }, { "key": "AllReusableBlocks", "description": "List of all Reusable Blocks", "context": "Entity", "pathPattern": "/reusable-blocks", "httpOperations": [ { "method": "GET", "url": "/settings/reusable-blocks", "parameters": [], "responseType": { "$ref": "#/definitions/ReusableBlockList", "definitions": { "ReusableBlock": { "additionalProperties": false, "type": "object", "properties": { "number": { "type": [ "string", "null" ] }, "updatedBy": { "type": [ "string", "null" ] }, "createdBy": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "active": { "type": "boolean" }, "unlayerJson": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "updatedOn": { "type": [ "string", "null" ] }, "category": { "type": [ "string", "null" ] }, "createdOn": { "type": [ "string", "null" ] }, "content": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } } }, "ReusableBlockPostPayload": { "additionalProperties": false, "type": "object", "properties": { "number": { "type": [ "string", "null" ], "maxLength": 50 }, "name": { "type": "string", "maxLength": 255 }, "active": { "default": true, "type": "boolean" }, "id": { "type": [ "string", "null" ] }, "category": { "type": [ "string", "null" ] }, "content": { "type": "string" }, "tags": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } }, "PostPayload": { "type": "object", "properties": { "reusableBlocks": { "type": "array", "items": { "$ref": "#/definitions/ReusableBlockPostPayload" } }, "allowPartialSuccess": { "type": "boolean" } } }, "PostResponsePayload": { "type": "object", "properties": { "reasons": { "type": "array", "items": { "$ref": "#/definitions/Reason" } } } }, "ReusableBlockList": { "additionalProperties": false, "type": "object", "properties": { "next": { "type": [ "string", "null" ] }, "data": { "type": "array", "items": { "$ref": "#/definitions/ReusableBlock" } } } }, "Reason": { "type": "object", "properties": { "code": { "type": [ "string", "null" ] }, "message": { "type": [ "string", "null" ] } } } } } }, { "method": "POST", "url": "/settings/reusable-blocks", "parameters": [], "requestType": { "$ref": "#/definitions/PostPayload", "definitions": { "ReusableBlock": { "additionalProperties": false, "type": "object", "properties": { "number": { "type": [ "string", "null" ] }, "updatedBy": { "type": [ "string", "null" ] }, "createdBy": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "active": { "type": "boolean" }, "unlayerJson": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "updatedOn": { "type": [ "string", "null" ] }, "category": { "type": [ "string", "null" ] }, "createdOn": { "type": [ "string", "null" ] }, "content": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } } }, "ReusableBlockPostPayload": { "additionalProperties": false, "type": "object", "properties": { "number": { "type": [ "string", "null" ], "maxLength": 50 }, "name": { "type": "string", "maxLength": 255 }, "active": { "default": true, "type": "boolean" }, "id": { "type": [ "string", "null" ] }, "category": { "type": [ "string", "null" ] }, "content": { "type": "string" }, "tags": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } }, "PostPayload": { "type": "object", "properties": { "reusableBlocks": { "type": "array", "items": { "$ref": "#/definitions/ReusableBlockPostPayload" } }, "allowPartialSuccess": { "type": "boolean" } } }, "PostResponsePayload": { "type": "object", "properties": { "reasons": { "type": "array", "items": { "$ref": "#/definitions/Reason" } } } }, "ReusableBlockList": { "additionalProperties": false, "type": "object", "properties": { "next": { "type": [ "string", "null" ] }, "data": { "type": "array", "items": { "$ref": "#/definitions/ReusableBlock" } } } }, "Reason": { "type": "object", "properties": { "code": { "type": [ "string", "null" ] }, "message": { "type": [ "string", "null" ] } } } } }, "responseType": { "$ref": "#/definitions/PostResponsePayload", "definitions": { "ReusableBlock": { "additionalProperties": false, "type": "object", "properties": { "number": { "type": [ "string", "null" ] }, "updatedBy": { "type": [ "string", "null" ] }, "createdBy": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "active": { "type": "boolean" }, "unlayerJson": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "updatedOn": { "type": [ "string", "null" ] }, "category": { "type": [ "string", "null" ] }, "createdOn": { "type": [ "string", "null" ] }, "content": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } } }, "ReusableBlockPostPayload": { "additionalProperties": false, "type": "object", "properties": { "number": { "type": [ "string", "null" ], "maxLength": 50 }, "name": { "type": "string", "maxLength": 255 }, "active": { "default": true, "type": "boolean" }, "id": { "type": [ "string", "null" ] }, "category": { "type": [ "string", "null" ] }, "content": { "type": "string" }, "tags": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } }, "PostPayload": { "type": "object", "properties": { "reusableBlocks": { "type": "array", "items": { "$ref": "#/definitions/ReusableBlockPostPayload" } }, "allowPartialSuccess": { "type": "boolean" } } }, "PostResponsePayload": { "type": "object", "properties": { "reasons": { "type": "array", "items": { "$ref": "#/definitions/Reason" } } } }, "ReusableBlockList": { "additionalProperties": false, "type": "object", "properties": { "next": { "type": [ "string", "null" ] }, "data": { "type": "array", "items": { "$ref": "#/definitions/ReusableBlock" } } } }, "Reason": { "type": "object", "properties": { "code": { "type": [ "string", "null" ] }, "message": { "type": [ "string", "null" ] } } } } } } ] }, { "key": "ReusableBlock", "description": "Retrieve a specific Reusable Block by its key", "context": "Entity", "pathPattern": "/reusable-blocks/{key}", "httpOperations": [ { "method": "GET", "url": "/settings/reusable-blocks/{key}", "parameters": [ { "name": "key", "description": "Unique identifier of the Reusable Block" } ], "responseType": { "$ref": "#/definitions/ReusableBlock", "definitions": { "ReusableBlock": { "additionalProperties": false, "type": "object", "properties": { "number": { "type": [ "string", "null" ] }, "updatedBy": { "type": [ "string", "null" ] }, "createdBy": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "active": { "type": "boolean" }, "unlayerJson": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "updatedOn": { "type": [ "string", "null" ] }, "category": { "type": [ "string", "null" ] }, "createdOn": { "type": [ "string", "null" ] }, "content": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } } }, "ReusableBlockUpdatePayload": { "additionalProperties": false, "type": "object", "properties": { "number": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "active": { "type": "boolean" }, "category": { "type": [ "string", "null" ] }, "content": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } } } } } }, { "method": "PUT", "url": "/settings/reusable-blocks/{key}", "parameters": [ { "name": "key", "description": "Unique identifier of the Reusable Block" } ], "requestType": { "$ref": "#/definitions/ReusableBlockUpdatePayload", "definitions": { "ReusableBlock": { "additionalProperties": false, "type": "object", "properties": { "number": { "type": [ "string", "null" ] }, "updatedBy": { "type": [ "string", "null" ] }, "createdBy": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "active": { "type": "boolean" }, "unlayerJson": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "updatedOn": { "type": [ "string", "null" ] }, "category": { "type": [ "string", "null" ] }, "createdOn": { "type": [ "string", "null" ] }, "content": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } } }, "ReusableBlockUpdatePayload": { "additionalProperties": false, "type": "object", "properties": { "number": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "active": { "type": "boolean" }, "category": { "type": [ "string", "null" ] }, "content": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } } } } }, "responseType": { "$ref": "#/definitions/ReusableBlock", "definitions": { "ReusableBlock": { "additionalProperties": false, "type": "object", "properties": { "number": { "type": [ "string", "null" ] }, "updatedBy": { "type": [ "string", "null" ] }, "createdBy": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "active": { "type": "boolean" }, "unlayerJson": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "updatedOn": { "type": [ "string", "null" ] }, "category": { "type": [ "string", "null" ] }, "createdOn": { "type": [ "string", "null" ] }, "content": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } } }, "ReusableBlockUpdatePayload": { "additionalProperties": false, "type": "object", "properties": { "number": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "active": { "type": "boolean" }, "category": { "type": [ "string", "null" ] }, "content": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } } } } } }, { "method": "DELETE", "url": "/settings/reusable-blocks/{key}", "parameters": [ { "name": "key", "description": "Unique identifier of the Reusable Block" } ] } ] }, { "key": "AllRevenueEventTypes", "description": "List and create Revenue Event Type", "context": "Entity", "pathPattern": "/revenue-event-types", "httpOperations": [ { "method": "GET", "url": "/settings/revenue-event-types", "parameters": [], "responseType": { "$ref": "#/definitions/RevenueEventTypes", "definitions": { "RevenueEventType": { "additionalProperties": false, "type": "object", "properties": { "systemId": { "default": "", "type": "string", "maxLength": 60 }, "active": { "default": false, "type": "boolean" }, "id": { "description": "Unique Id of Revenue Event Type", "type": "string" }, "label": { "minLength": 1, "type": "string", "maxLength": 50 } } }, "RevenueEventTypes": { "type": "array", "items": { "$ref": "#/definitions/RevenueEventType" } } } } }, { "method": "POST", "url": "/settings/revenue-event-types", "parameters": [], "requestType": { "$ref": "#/definitions/RevenueEventType", "definitions": { "RevenueEventType": { "additionalProperties": false, "type": "object", "properties": { "systemId": { "default": "", "type": "string", "maxLength": 60 }, "active": { "default": false, "type": "boolean" }, "id": { "description": "Unique Id of Revenue Event Type", "type": "string" }, "label": { "minLength": 1, "type": "string", "maxLength": 50 } } }, "RevenueEventTypes": { "type": "array", "items": { "$ref": "#/definitions/RevenueEventType" } } } }, "responseType": { "$ref": "#/definitions/RevenueEventType", "definitions": { "RevenueEventType": { "additionalProperties": false, "type": "object", "properties": { "systemId": { "default": "", "type": "string", "maxLength": 60 }, "active": { "default": false, "type": "boolean" }, "id": { "description": "Unique Id of Revenue Event Type", "type": "string" }, "label": { "minLength": 1, "type": "string", "maxLength": 50 } } }, "RevenueEventTypes": { "type": "array", "items": { "$ref": "#/definitions/RevenueEventType" } } } } } ] }, { "key": "RevenueEventType", "description": "Revenue Event Type", "context": "Entity", "pathPattern": "/revenue-event-types/{id}", "httpOperations": [ { "method": "GET", "url": "/settings/revenue-event-types/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Revenue Event Type" } ], "responseType": { "$ref": "#/definitions/RevenueEventType", "definitions": { "RevenueEventType": { "additionalProperties": false, "type": "object", "properties": { "systemId": { "default": "", "type": "string", "maxLength": 60 }, "active": { "default": false, "type": "boolean" }, "id": { "description": "Unique Id of Revenue Event Type", "type": "string" }, "label": { "minLength": 1, "type": "string", "maxLength": 50 } } } } } }, { "method": "PUT", "url": "/settings/revenue-event-types/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Revenue Event Type" } ], "requestType": { "$ref": "#/definitions/RevenueEventType", "definitions": { "RevenueEventType": { "additionalProperties": false, "type": "object", "properties": { "systemId": { "default": "", "type": "string", "maxLength": 60 }, "active": { "default": false, "type": "boolean" }, "id": { "description": "Unique Id of Revenue Event Type", "type": "string" }, "label": { "minLength": 1, "type": "string", "maxLength": 50 } } } } }, "responseType": { "$ref": "#/definitions/RevenueEventType", "definitions": { "RevenueEventType": { "additionalProperties": false, "type": "object", "properties": { "systemId": { "default": "", "type": "string", "maxLength": 60 }, "active": { "default": false, "type": "boolean" }, "id": { "description": "Unique Id of Revenue Event Type", "type": "string" }, "label": { "minLength": 1, "type": "string", "maxLength": 50 } } } } } } ] }, { "key": "RevenueRecognitionCodeStatus", "description": "Revenue Recognition Code Status", "context": "Entity", "pathPattern": "/revenue-recognition-code-status", "httpOperations": [ { "method": "GET", "url": "/settings/revenue-recognition-code-status", "parameters": [], "responseType": { "$ref": "#/definitions/RevenueRecognitionStatus", "definitions": { "RevenueRecognitionStatus": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ] } } } }, { "method": "PUT", "url": "/settings/revenue-recognition-code-status", "parameters": [], "requestType": { "$ref": "#/definitions/RevenueRecognitionStatus", "definitions": { "RevenueRecognitionStatus": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ] } } }, "responseType": { "$ref": "#/definitions/RevenueRecognitionStatus", "definitions": { "RevenueRecognitionStatus": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ] } } } } ] }, { "key": "AllRevenueRecognitionCodes", "description": "Revenue Recognition", "context": "Entity", "pathPattern": "/revenue-recognition-codes", "httpOperations": [ { "method": "GET", "url": "/settings/revenue-recognition-codes", "parameters": [], "responseType": { "$ref": "#/definitions/AllRevenueRecognition", "definitions": { "RevenueRecognition": { "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "maxLength": 70 }, "active": { "type": "boolean" }, "id": { "type": "string", "maxLength": 32 } } }, "Codes": { "type": "array", "items": { "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "maxLength": 70 }, "active": { "type": "boolean" }, "id": { "type": "string", "maxLength": 32 } } } }, "AllRevenueRecognition": { "type": "object", "properties": { "codes": { "$ref": "#/definitions/Codes" }, "enabled": { "type": "boolean" } } } } } }, { "method": "POST", "url": "/settings/revenue-recognition-codes", "parameters": [], "requestType": { "$ref": "#/definitions/RevenueRecognition", "definitions": { "RevenueRecognition": { "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "maxLength": 70 }, "active": { "type": "boolean" }, "id": { "type": "string", "maxLength": 32 } } }, "Codes": { "type": "array", "items": { "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "maxLength": 70 }, "active": { "type": "boolean" }, "id": { "type": "string", "maxLength": 32 } } } }, "AllRevenueRecognition": { "type": "object", "properties": { "codes": { "$ref": "#/definitions/Codes" }, "enabled": { "type": "boolean" } } } } }, "responseType": { "$ref": "#/definitions/RevenueRecognition", "definitions": { "RevenueRecognition": { "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "maxLength": 70 }, "active": { "type": "boolean" }, "id": { "type": "string", "maxLength": 32 } } }, "Codes": { "type": "array", "items": { "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "maxLength": 70 }, "active": { "type": "boolean" }, "id": { "type": "string", "maxLength": 32 } } } }, "AllRevenueRecognition": { "type": "object", "properties": { "codes": { "$ref": "#/definitions/Codes" }, "enabled": { "type": "boolean" } } } } } } ] }, { "key": "RevenueRecognitionCode", "description": "Revenue Recognition", "context": "Entity", "pathPattern": "/revenue-recognition-codes/{id}", "httpOperations": [ { "method": "GET", "url": "/settings/revenue-recognition-codes/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Revenue Event Type" } ], "responseType": { "$ref": "#/definitions/RevenueRecognition", "definitions": { "RevenueRecognition": { "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "maxLength": 70 }, "active": { "type": "boolean" }, "id": { "type": "string", "maxLength": 32 } } } } } }, { "method": "PUT", "url": "/settings/revenue-recognition-codes/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Revenue Event Type" } ], "requestType": { "$ref": "#/definitions/RevenueRecognition", "definitions": { "RevenueRecognition": { "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "maxLength": 70 }, "active": { "type": "boolean" }, "id": { "type": "string", "maxLength": 32 } } } } }, "responseType": { "$ref": "#/definitions/RevenueRecognition", "definitions": { "RevenueRecognition": { "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "maxLength": 70 }, "active": { "type": "boolean" }, "id": { "type": "string", "maxLength": 32 } } } } } }, { "method": "DELETE", "url": "/settings/revenue-recognition-codes/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Revenue Event Type" } ] } ] }, { "key": "AllRevenueRecognitionModels", "description": "Revenue Recognition Models settings", "context": "Entity", "pathPattern": "/revenue-recognition-models", "httpOperations": [ { "method": "GET", "url": "/settings/revenue-recognition-models", "parameters": [], "responseType": { "$ref": "#/definitions/RevenueRecognitionModels", "definitions": { "RevenueRecognitionModels": { "additionalProperties": false, "type": "object", "properties": { "monthlyRecognitionOverTime": { "type": "boolean" }, "fullRecognitionUponInvoicing": { "type": "boolean" }, "dailyRecognitionOverTime": { "type": "boolean" }, "unlimitedRecognition": { "type": "boolean" }, "manualRecognition": { "type": "boolean" }, "fullRecognitionOnASpecificDate": { "type": "boolean" } } } } } }, { "method": "PUT", "url": "/settings/revenue-recognition-models", "parameters": [], "requestType": { "$ref": "#/definitions/RevenueRecognitionModels", "definitions": { "RevenueRecognitionModels": { "additionalProperties": false, "type": "object", "properties": { "monthlyRecognitionOverTime": { "type": "boolean" }, "fullRecognitionUponInvoicing": { "type": "boolean" }, "dailyRecognitionOverTime": { "type": "boolean" }, "unlimitedRecognition": { "type": "boolean" }, "manualRecognition": { "type": "boolean" }, "fullRecognitionOnASpecificDate": { "type": "boolean" } } } } }, "responseType": { "$ref": "#/definitions/RevenueRecognitionModels", "definitions": { "RevenueRecognitionModels": { "additionalProperties": false, "type": "object", "properties": { "monthlyRecognitionOverTime": { "type": "boolean" }, "fullRecognitionUponInvoicing": { "type": "boolean" }, "dailyRecognitionOverTime": { "type": "boolean" }, "unlimitedRecognition": { "type": "boolean" }, "manualRecognition": { "type": "boolean" }, "fullRecognitionOnASpecificDate": { "type": "boolean" } } } } } } ] }, { "key": "AllRevenueRecognitionRules", "description": "Manage Revenue Recognition Rules", "context": "Entity", "pathPattern": "/revenue-recognition-rules", "httpOperations": [ { "method": "GET", "url": "/settings/revenue-recognition-rules", "parameters": [], "responseType": { "$ref": "#/definitions/RevenueRecognitionRuleObject", "definitions": { "RevenueRecognitionRuleObject": { "type": "object", "properties": { "revenueRecognitionRuleDtos": { "type": "array", "items": { "$ref": "#/definitions/RevenueRecognitionRule" } } } }, "RevenueRecognitionRule": { "type": "object", "properties": { "invoiceItemAdjustmentTransactionRule": { "type": "object", "items": { "$ref": "#/definitions/RevenueTransactionRule" } }, "description": { "type": "string", "maxLength": 500 }, "active": { "default": false, "type": "boolean" }, "apClosedDistributionRule": { "type": "string", "enum": [ "MergeToNextOpen" ] }, "creditMemoTransactionRules": { "type": "array", "items": { "$ref": "#/definitions/CreditMemoTransactionRule" } }, "debitMemoTransactionRules": { "type": "array", "items": { "$ref": "#/definitions/CreditMemoTransactionRule" } }, "transactionDateRule": { "type": "string", "enum": [ "RecognizeWithoutImpact", "AccumulateToTransactionDate" ] }, "name": { "type": "string", "maxLength": 50 }, "roundingRule": { "type": "string", "enum": [ "RoundLast", "RoundTrailing" ] }, "id": { "description": "Unique Id of the revenue recognition rule ", "type": "string" }, "invoiceItemTransactionRule": { "type": "object", "items": { "$ref": "#/definitions/RevenueTransactionRule" } }, "additionalProperties": true, "recognitionModel": { "type": "string", "enum": [ "UponInvoicing", "Daily", "Monthly", "SpecificDate", "Manually", "Unlimited" ] } } }, "RevenueTransactionRule": { "type": "object", "properties": { "termStartField": { "type": "string", "enum": [ "SubscriptionStartDate", "SubscriptionEndDate", "ChargeStartDate", "ChargeEndDate", "ChargeTriggerDate", "InvoiceDate", "InvoiceDueDate", "InvoiceItemServicePeriodStart", "InvoiceItemServicePeriodEnd", "InvoiceItemAdjustmentDate", "IIAServicePeriodStart", "IIAServicePeriodEnd", "RecognitionTermStartDate", "MaximumDate", "CMIServicePeriodStart", "DMIServicePeriodStart", "CMIServicePeriodEnd", "DMIServicePeriodEnd", "CreditMemoDate", "DebitMemoDate", "DebitMemoDueDate" ] }, "termEndUnitOfFixedPeriod": { "type": "string", "enum": [ "Years", "Months", "Days" ] }, "termEndField": { "type": "string", "enum": [ "SubscriptionStartDate", "SubscriptionEndDate", "ChargeStartDate", "ChargeEndDate", "ChargeTriggerDate", "InvoiceDate", "InvoiceDueDate", "InvoiceItemServicePeriodStart", "InvoiceItemServicePeriodEnd", "InvoiceItemAdjustmentDate", "IIAServicePeriodStart", "IIAServicePeriodEnd", "RecognitionTermStartDate", "MaximumDate", "CMIServicePeriodStart", "DMIServicePeriodStart", "CMIServicePeriodEnd", "DMIServicePeriodEnd", "CreditMemoDate", "DebitMemoDate", "DebitMemoDueDate" ] }, "termStartNumberOfFixedPeriod": { "type": "integer" }, "termStartUnitOfFixedPeriod": { "type": "string", "enum": [ "Years", "Months", "Days" ] }, "id": { "type": "string" }, "usedTheSameTransactionRuleAsInvoiceItem": { "type": "boolean" }, "termEndNumberOfFixedPeriod": { "type": "integer" }, "allocationPolicy": { "type": "string", "enum": [ "EvenByDay", "Manually", "FrontLoad", "BackLoad", "Proration" ] } } }, "CreditMemoTransactionRule": { "type": "object", "properties": { "termStartField": { "type": "string", "enum": [ "SubscriptionStartDate", "SubscriptionEndDate", "ChargeStartDate", "ChargeEndDate", "ChargeTriggerDate", "InvoiceDate", "InvoiceDueDate", "InvoiceItemServicePeriodStart", "InvoiceItemServicePeriodEnd", "InvoiceItemAdjustmentDate", "IIAServicePeriodStart", "IIAServicePeriodEnd", "RecognitionTermStartDate", "MaximumDate", "CMIServicePeriodStart", "DMIServicePeriodStart", "CMIServicePeriodEnd", "DMIServicePeriodEnd", "CreditMemoDate", "DebitMemoDate", "DebitMemoDueDate" ] }, "termEndUnitOfFixedPeriod": { "type": "string", "enum": [ "Years", "Months", "Days" ] }, "termEndField": { "type": "string", "enum": [ "SubscriptionStartDate", "SubscriptionEndDate", "ChargeStartDate", "ChargeEndDate", "ChargeTriggerDate", "InvoiceDate", "InvoiceDueDate", "InvoiceItemServicePeriodStart", "InvoiceItemServicePeriodEnd", "InvoiceItemAdjustmentDate", "IIAServicePeriodStart", "IIAServicePeriodEnd", "RecognitionTermStartDate", "MaximumDate", "CMIServicePeriodStart", "DMIServicePeriodStart", "CMIServicePeriodEnd", "DMIServicePeriodEnd", "CreditMemoDate", "DebitMemoDate", "DebitMemoDueDate" ] }, "termStartNumberOfFixedPeriod": { "type": "integer" }, "termStartUnitOfFixedPeriod": { "type": "string", "enum": [ "Years", "Months", "Days" ] }, "transactionCreateFrom": { "type": "string" }, "id": { "type": "string" }, "usedTheSameTransactionRuleAsInvoiceItem": { "type": "boolean" }, "termEndNumberOfFixedPeriod": { "type": "integer" }, "allocationPolicy": { "type": "string", "enum": [ "EvenByDay", "Manually", "FrontLoad", "BackLoad", "Proration" ] }, "usedTheSameTransactionRuleAsDebitMemoItem": { "type": "boolean" } } } } } }, { "method": "POST", "url": "/settings/revenue-recognition-rules", "parameters": [], "requestType": { "$ref": "#/definitions/RevenueRecognitionRule", "definitions": { "RevenueRecognitionRuleObject": { "type": "object", "properties": { "revenueRecognitionRuleDtos": { "type": "array", "items": { "$ref": "#/definitions/RevenueRecognitionRule" } } } }, "RevenueRecognitionRule": { "type": "object", "properties": { "invoiceItemAdjustmentTransactionRule": { "type": "object", "items": { "$ref": "#/definitions/RevenueTransactionRule" } }, "description": { "type": "string", "maxLength": 500 }, "active": { "default": false, "type": "boolean" }, "apClosedDistributionRule": { "type": "string", "enum": [ "MergeToNextOpen" ] }, "creditMemoTransactionRules": { "type": "array", "items": { "$ref": "#/definitions/CreditMemoTransactionRule" } }, "debitMemoTransactionRules": { "type": "array", "items": { "$ref": "#/definitions/CreditMemoTransactionRule" } }, "transactionDateRule": { "type": "string", "enum": [ "RecognizeWithoutImpact", "AccumulateToTransactionDate" ] }, "name": { "type": "string", "maxLength": 50 }, "roundingRule": { "type": "string", "enum": [ "RoundLast", "RoundTrailing" ] }, "id": { "description": "Unique Id of the revenue recognition rule ", "type": "string" }, "invoiceItemTransactionRule": { "type": "object", "items": { "$ref": "#/definitions/RevenueTransactionRule" } }, "additionalProperties": true, "recognitionModel": { "type": "string", "enum": [ "UponInvoicing", "Daily", "Monthly", "SpecificDate", "Manually", "Unlimited" ] } } }, "RevenueTransactionRule": { "type": "object", "properties": { "termStartField": { "type": "string", "enum": [ "SubscriptionStartDate", "SubscriptionEndDate", "ChargeStartDate", "ChargeEndDate", "ChargeTriggerDate", "InvoiceDate", "InvoiceDueDate", "InvoiceItemServicePeriodStart", "InvoiceItemServicePeriodEnd", "InvoiceItemAdjustmentDate", "IIAServicePeriodStart", "IIAServicePeriodEnd", "RecognitionTermStartDate", "MaximumDate", "CMIServicePeriodStart", "DMIServicePeriodStart", "CMIServicePeriodEnd", "DMIServicePeriodEnd", "CreditMemoDate", "DebitMemoDate", "DebitMemoDueDate" ] }, "termEndUnitOfFixedPeriod": { "type": "string", "enum": [ "Years", "Months", "Days" ] }, "termEndField": { "type": "string", "enum": [ "SubscriptionStartDate", "SubscriptionEndDate", "ChargeStartDate", "ChargeEndDate", "ChargeTriggerDate", "InvoiceDate", "InvoiceDueDate", "InvoiceItemServicePeriodStart", "InvoiceItemServicePeriodEnd", "InvoiceItemAdjustmentDate", "IIAServicePeriodStart", "IIAServicePeriodEnd", "RecognitionTermStartDate", "MaximumDate", "CMIServicePeriodStart", "DMIServicePeriodStart", "CMIServicePeriodEnd", "DMIServicePeriodEnd", "CreditMemoDate", "DebitMemoDate", "DebitMemoDueDate" ] }, "termStartNumberOfFixedPeriod": { "type": "integer" }, "termStartUnitOfFixedPeriod": { "type": "string", "enum": [ "Years", "Months", "Days" ] }, "id": { "type": "string" }, "usedTheSameTransactionRuleAsInvoiceItem": { "type": "boolean" }, "termEndNumberOfFixedPeriod": { "type": "integer" }, "allocationPolicy": { "type": "string", "enum": [ "EvenByDay", "Manually", "FrontLoad", "BackLoad", "Proration" ] } } }, "CreditMemoTransactionRule": { "type": "object", "properties": { "termStartField": { "type": "string", "enum": [ "SubscriptionStartDate", "SubscriptionEndDate", "ChargeStartDate", "ChargeEndDate", "ChargeTriggerDate", "InvoiceDate", "InvoiceDueDate", "InvoiceItemServicePeriodStart", "InvoiceItemServicePeriodEnd", "InvoiceItemAdjustmentDate", "IIAServicePeriodStart", "IIAServicePeriodEnd", "RecognitionTermStartDate", "MaximumDate", "CMIServicePeriodStart", "DMIServicePeriodStart", "CMIServicePeriodEnd", "DMIServicePeriodEnd", "CreditMemoDate", "DebitMemoDate", "DebitMemoDueDate" ] }, "termEndUnitOfFixedPeriod": { "type": "string", "enum": [ "Years", "Months", "Days" ] }, "termEndField": { "type": "string", "enum": [ "SubscriptionStartDate", "SubscriptionEndDate", "ChargeStartDate", "ChargeEndDate", "ChargeTriggerDate", "InvoiceDate", "InvoiceDueDate", "InvoiceItemServicePeriodStart", "InvoiceItemServicePeriodEnd", "InvoiceItemAdjustmentDate", "IIAServicePeriodStart", "IIAServicePeriodEnd", "RecognitionTermStartDate", "MaximumDate", "CMIServicePeriodStart", "DMIServicePeriodStart", "CMIServicePeriodEnd", "DMIServicePeriodEnd", "CreditMemoDate", "DebitMemoDate", "DebitMemoDueDate" ] }, "termStartNumberOfFixedPeriod": { "type": "integer" }, "termStartUnitOfFixedPeriod": { "type": "string", "enum": [ "Years", "Months", "Days" ] }, "transactionCreateFrom": { "type": "string" }, "id": { "type": "string" }, "usedTheSameTransactionRuleAsInvoiceItem": { "type": "boolean" }, "termEndNumberOfFixedPeriod": { "type": "integer" }, "allocationPolicy": { "type": "string", "enum": [ "EvenByDay", "Manually", "FrontLoad", "BackLoad", "Proration" ] }, "usedTheSameTransactionRuleAsDebitMemoItem": { "type": "boolean" } } } } }, "responseType": { "$ref": "#/definitions/RevenueRecognitionRule", "definitions": { "RevenueRecognitionRuleObject": { "type": "object", "properties": { "revenueRecognitionRuleDtos": { "type": "array", "items": { "$ref": "#/definitions/RevenueRecognitionRule" } } } }, "RevenueRecognitionRule": { "type": "object", "properties": { "invoiceItemAdjustmentTransactionRule": { "type": "object", "items": { "$ref": "#/definitions/RevenueTransactionRule" } }, "description": { "type": "string", "maxLength": 500 }, "active": { "default": false, "type": "boolean" }, "apClosedDistributionRule": { "type": "string", "enum": [ "MergeToNextOpen" ] }, "creditMemoTransactionRules": { "type": "array", "items": { "$ref": "#/definitions/CreditMemoTransactionRule" } }, "debitMemoTransactionRules": { "type": "array", "items": { "$ref": "#/definitions/CreditMemoTransactionRule" } }, "transactionDateRule": { "type": "string", "enum": [ "RecognizeWithoutImpact", "AccumulateToTransactionDate" ] }, "name": { "type": "string", "maxLength": 50 }, "roundingRule": { "type": "string", "enum": [ "RoundLast", "RoundTrailing" ] }, "id": { "description": "Unique Id of the revenue recognition rule ", "type": "string" }, "invoiceItemTransactionRule": { "type": "object", "items": { "$ref": "#/definitions/RevenueTransactionRule" } }, "additionalProperties": true, "recognitionModel": { "type": "string", "enum": [ "UponInvoicing", "Daily", "Monthly", "SpecificDate", "Manually", "Unlimited" ] } } }, "RevenueTransactionRule": { "type": "object", "properties": { "termStartField": { "type": "string", "enum": [ "SubscriptionStartDate", "SubscriptionEndDate", "ChargeStartDate", "ChargeEndDate", "ChargeTriggerDate", "InvoiceDate", "InvoiceDueDate", "InvoiceItemServicePeriodStart", "InvoiceItemServicePeriodEnd", "InvoiceItemAdjustmentDate", "IIAServicePeriodStart", "IIAServicePeriodEnd", "RecognitionTermStartDate", "MaximumDate", "CMIServicePeriodStart", "DMIServicePeriodStart", "CMIServicePeriodEnd", "DMIServicePeriodEnd", "CreditMemoDate", "DebitMemoDate", "DebitMemoDueDate" ] }, "termEndUnitOfFixedPeriod": { "type": "string", "enum": [ "Years", "Months", "Days" ] }, "termEndField": { "type": "string", "enum": [ "SubscriptionStartDate", "SubscriptionEndDate", "ChargeStartDate", "ChargeEndDate", "ChargeTriggerDate", "InvoiceDate", "InvoiceDueDate", "InvoiceItemServicePeriodStart", "InvoiceItemServicePeriodEnd", "InvoiceItemAdjustmentDate", "IIAServicePeriodStart", "IIAServicePeriodEnd", "RecognitionTermStartDate", "MaximumDate", "CMIServicePeriodStart", "DMIServicePeriodStart", "CMIServicePeriodEnd", "DMIServicePeriodEnd", "CreditMemoDate", "DebitMemoDate", "DebitMemoDueDate" ] }, "termStartNumberOfFixedPeriod": { "type": "integer" }, "termStartUnitOfFixedPeriod": { "type": "string", "enum": [ "Years", "Months", "Days" ] }, "id": { "type": "string" }, "usedTheSameTransactionRuleAsInvoiceItem": { "type": "boolean" }, "termEndNumberOfFixedPeriod": { "type": "integer" }, "allocationPolicy": { "type": "string", "enum": [ "EvenByDay", "Manually", "FrontLoad", "BackLoad", "Proration" ] } } }, "CreditMemoTransactionRule": { "type": "object", "properties": { "termStartField": { "type": "string", "enum": [ "SubscriptionStartDate", "SubscriptionEndDate", "ChargeStartDate", "ChargeEndDate", "ChargeTriggerDate", "InvoiceDate", "InvoiceDueDate", "InvoiceItemServicePeriodStart", "InvoiceItemServicePeriodEnd", "InvoiceItemAdjustmentDate", "IIAServicePeriodStart", "IIAServicePeriodEnd", "RecognitionTermStartDate", "MaximumDate", "CMIServicePeriodStart", "DMIServicePeriodStart", "CMIServicePeriodEnd", "DMIServicePeriodEnd", "CreditMemoDate", "DebitMemoDate", "DebitMemoDueDate" ] }, "termEndUnitOfFixedPeriod": { "type": "string", "enum": [ "Years", "Months", "Days" ] }, "termEndField": { "type": "string", "enum": [ "SubscriptionStartDate", "SubscriptionEndDate", "ChargeStartDate", "ChargeEndDate", "ChargeTriggerDate", "InvoiceDate", "InvoiceDueDate", "InvoiceItemServicePeriodStart", "InvoiceItemServicePeriodEnd", "InvoiceItemAdjustmentDate", "IIAServicePeriodStart", "IIAServicePeriodEnd", "RecognitionTermStartDate", "MaximumDate", "CMIServicePeriodStart", "DMIServicePeriodStart", "CMIServicePeriodEnd", "DMIServicePeriodEnd", "CreditMemoDate", "DebitMemoDate", "DebitMemoDueDate" ] }, "termStartNumberOfFixedPeriod": { "type": "integer" }, "termStartUnitOfFixedPeriod": { "type": "string", "enum": [ "Years", "Months", "Days" ] }, "transactionCreateFrom": { "type": "string" }, "id": { "type": "string" }, "usedTheSameTransactionRuleAsInvoiceItem": { "type": "boolean" }, "termEndNumberOfFixedPeriod": { "type": "integer" }, "allocationPolicy": { "type": "string", "enum": [ "EvenByDay", "Manually", "FrontLoad", "BackLoad", "Proration" ] }, "usedTheSameTransactionRuleAsDebitMemoItem": { "type": "boolean" } } } } } } ] }, { "key": "RevenueRecognitionRule", "description": "Revenue Recognition Rule", "context": "Entity", "pathPattern": "/revenue-recognition-rules/{id}", "httpOperations": [ { "method": "GET", "url": "/settings/revenue-recognition-rules/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the revenue recognition rule" } ], "responseType": { "$ref": "#/definitions/RevenueRecognitionRule", "definitions": { "RevenueRecognitionRule": { "type": "object", "properties": { "transactionDateRule": { "type": "string", "enum": [ "RecognizeWithoutImpact", "AccumulateToTransactionDate" ] }, "invoiceItemAdjustmentTransactionRule": { "type": "object", "items": { "$ref": "#/definitions/RevenueTransactionRule" } }, "name": { "type": "string", "maxLength": 50 }, "roundingRule": { "type": "string", "enum": [ "RoundLast", "RoundTrailing" ] }, "description": { "type": "string", "maxLength": 500 }, "active": { "default": false, "type": "boolean" }, "apClosedDistributionRule": { "type": "string", "enum": [ "MergeToNextOpen" ] }, "id": { "description": "Unique Id of the revenue recognition rule ", "type": "string" }, "invoiceItemTransactionRule": { "type": "object", "items": { "$ref": "#/definitions/RevenueTransactionRule" } }, "creditMemoTransactionRules": { "type": "array", "items": { "$ref": "#/definitions/CreditMemoTransactionRule" } }, "debitMemoTransactionRules": { "type": "array", "items": { "$ref": "#/definitions/CreditMemoTransactionRule" } }, "recognitionModel": { "type": "string", "enum": [ "UponInvoicing", "Daily", "Monthly", "SpecificDate", "Manually", "Unlimited" ] } } }, "RevenueTransactionRule": { "type": "object", "properties": { "termStartField": { "type": "string", "enum": [ "SubscriptionStartDate", "SubscriptionEndDate", "ChargeStartDate", "ChargeEndDate", "ChargeTriggerDate", "InvoiceDate", "InvoiceDueDate", "InvoiceItemServicePeriodStart", "InvoiceItemServicePeriodEnd", "InvoiceItemAdjustmentDate", "IIAServicePeriodStart", "IIAServicePeriodEnd", "RecognitionTermStartDate", "MaximumDate", "CMIServicePeriodStart", "DMIServicePeriodStart", "CMIServicePeriodEnd", "DMIServicePeriodEnd", "CreditMemoDate", "DebitMemoDate", "DebitMemoDueDate" ] }, "termEndUnitOfFixedPeriod": { "type": "string", "enum": [ "Years", "Months", "Days" ] }, "termEndField": { "type": "string", "enum": [ "SubscriptionStartDate", "SubscriptionEndDate", "ChargeStartDate", "ChargeEndDate", "ChargeTriggerDate", "InvoiceDate", "InvoiceDueDate", "InvoiceItemServicePeriodStart", "InvoiceItemServicePeriodEnd", "InvoiceItemAdjustmentDate", "IIAServicePeriodStart", "IIAServicePeriodEnd", "RecognitionTermStartDate", "MaximumDate", "CMIServicePeriodStart", "DMIServicePeriodStart", "CMIServicePeriodEnd", "DMIServicePeriodEnd", "CreditMemoDate", "DebitMemoDate", "DebitMemoDueDate" ] }, "termStartNumberOfFixedPeriod": { "type": "integer" }, "termStartUnitOfFixedPeriod": { "type": "string", "enum": [ "Years", "Months", "Days" ] }, "id": { "type": "string" }, "usedTheSameTransactionRuleAsInvoiceItem": { "type": "boolean" }, "termEndNumberOfFixedPeriod": { "type": "integer" }, "allocationPolicy": { "type": "string", "enum": [ "EvenByDay", "Manually", "FrontLoad", "BackLoad", "Proration" ] } } } } } }, { "method": "PUT", "url": "/settings/revenue-recognition-rules/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the revenue recognition rule" } ], "requestType": { "$ref": "#/definitions/RevenueRecognitionRule", "definitions": { "RevenueRecognitionRule": { "type": "object", "properties": { "transactionDateRule": { "type": "string", "enum": [ "RecognizeWithoutImpact", "AccumulateToTransactionDate" ] }, "invoiceItemAdjustmentTransactionRule": { "type": "object", "items": { "$ref": "#/definitions/RevenueTransactionRule" } }, "name": { "type": "string", "maxLength": 50 }, "roundingRule": { "type": "string", "enum": [ "RoundLast", "RoundTrailing" ] }, "description": { "type": "string", "maxLength": 500 }, "active": { "default": false, "type": "boolean" }, "apClosedDistributionRule": { "type": "string", "enum": [ "MergeToNextOpen" ] }, "id": { "description": "Unique Id of the revenue recognition rule ", "type": "string" }, "invoiceItemTransactionRule": { "type": "object", "items": { "$ref": "#/definitions/RevenueTransactionRule" } }, "creditMemoTransactionRules": { "type": "array", "items": { "$ref": "#/definitions/CreditMemoTransactionRule" } }, "debitMemoTransactionRules": { "type": "array", "items": { "$ref": "#/definitions/CreditMemoTransactionRule" } }, "recognitionModel": { "type": "string", "enum": [ "UponInvoicing", "Daily", "Monthly", "SpecificDate", "Manually", "Unlimited" ] } } }, "RevenueTransactionRule": { "type": "object", "properties": { "termStartField": { "type": "string", "enum": [ "SubscriptionStartDate", "SubscriptionEndDate", "ChargeStartDate", "ChargeEndDate", "ChargeTriggerDate", "InvoiceDate", "InvoiceDueDate", "InvoiceItemServicePeriodStart", "InvoiceItemServicePeriodEnd", "InvoiceItemAdjustmentDate", "IIAServicePeriodStart", "IIAServicePeriodEnd", "RecognitionTermStartDate", "MaximumDate", "CMIServicePeriodStart", "DMIServicePeriodStart", "CMIServicePeriodEnd", "DMIServicePeriodEnd", "CreditMemoDate", "DebitMemoDate", "DebitMemoDueDate" ] }, "termEndUnitOfFixedPeriod": { "type": "string", "enum": [ "Years", "Months", "Days" ] }, "termEndField": { "type": "string", "enum": [ "SubscriptionStartDate", "SubscriptionEndDate", "ChargeStartDate", "ChargeEndDate", "ChargeTriggerDate", "InvoiceDate", "InvoiceDueDate", "InvoiceItemServicePeriodStart", "InvoiceItemServicePeriodEnd", "InvoiceItemAdjustmentDate", "IIAServicePeriodStart", "IIAServicePeriodEnd", "RecognitionTermStartDate", "MaximumDate", "CMIServicePeriodStart", "DMIServicePeriodStart", "CMIServicePeriodEnd", "DMIServicePeriodEnd", "CreditMemoDate", "DebitMemoDate", "DebitMemoDueDate" ] }, "termStartNumberOfFixedPeriod": { "type": "integer" }, "termStartUnitOfFixedPeriod": { "type": "string", "enum": [ "Years", "Months", "Days" ] }, "id": { "type": "string" }, "usedTheSameTransactionRuleAsInvoiceItem": { "type": "boolean" }, "termEndNumberOfFixedPeriod": { "type": "integer" }, "allocationPolicy": { "type": "string", "enum": [ "EvenByDay", "Manually", "FrontLoad", "BackLoad", "Proration" ] } } } } }, "responseType": { "$ref": "#/definitions/RevenueRecognitionRule", "definitions": { "RevenueRecognitionRule": { "type": "object", "properties": { "transactionDateRule": { "type": "string", "enum": [ "RecognizeWithoutImpact", "AccumulateToTransactionDate" ] }, "invoiceItemAdjustmentTransactionRule": { "type": "object", "items": { "$ref": "#/definitions/RevenueTransactionRule" } }, "name": { "type": "string", "maxLength": 50 }, "roundingRule": { "type": "string", "enum": [ "RoundLast", "RoundTrailing" ] }, "description": { "type": "string", "maxLength": 500 }, "active": { "default": false, "type": "boolean" }, "apClosedDistributionRule": { "type": "string", "enum": [ "MergeToNextOpen" ] }, "id": { "description": "Unique Id of the revenue recognition rule ", "type": "string" }, "invoiceItemTransactionRule": { "type": "object", "items": { "$ref": "#/definitions/RevenueTransactionRule" } }, "creditMemoTransactionRules": { "type": "array", "items": { "$ref": "#/definitions/CreditMemoTransactionRule" } }, "debitMemoTransactionRules": { "type": "array", "items": { "$ref": "#/definitions/CreditMemoTransactionRule" } }, "recognitionModel": { "type": "string", "enum": [ "UponInvoicing", "Daily", "Monthly", "SpecificDate", "Manually", "Unlimited" ] } } }, "RevenueTransactionRule": { "type": "object", "properties": { "termStartField": { "type": "string", "enum": [ "SubscriptionStartDate", "SubscriptionEndDate", "ChargeStartDate", "ChargeEndDate", "ChargeTriggerDate", "InvoiceDate", "InvoiceDueDate", "InvoiceItemServicePeriodStart", "InvoiceItemServicePeriodEnd", "InvoiceItemAdjustmentDate", "IIAServicePeriodStart", "IIAServicePeriodEnd", "RecognitionTermStartDate", "MaximumDate", "CMIServicePeriodStart", "DMIServicePeriodStart", "CMIServicePeriodEnd", "DMIServicePeriodEnd", "CreditMemoDate", "DebitMemoDate", "DebitMemoDueDate" ] }, "termEndUnitOfFixedPeriod": { "type": "string", "enum": [ "Years", "Months", "Days" ] }, "termEndField": { "type": "string", "enum": [ "SubscriptionStartDate", "SubscriptionEndDate", "ChargeStartDate", "ChargeEndDate", "ChargeTriggerDate", "InvoiceDate", "InvoiceDueDate", "InvoiceItemServicePeriodStart", "InvoiceItemServicePeriodEnd", "InvoiceItemAdjustmentDate", "IIAServicePeriodStart", "IIAServicePeriodEnd", "RecognitionTermStartDate", "MaximumDate", "CMIServicePeriodStart", "DMIServicePeriodStart", "CMIServicePeriodEnd", "DMIServicePeriodEnd", "CreditMemoDate", "DebitMemoDate", "DebitMemoDueDate" ] }, "termStartNumberOfFixedPeriod": { "type": "integer" }, "termStartUnitOfFixedPeriod": { "type": "string", "enum": [ "Years", "Months", "Days" ] }, "id": { "type": "string" }, "usedTheSameTransactionRuleAsInvoiceItem": { "type": "boolean" }, "termEndNumberOfFixedPeriod": { "type": "integer" }, "allocationPolicy": { "type": "string", "enum": [ "EvenByDay", "Manually", "FrontLoad", "BackLoad", "Proration" ] } } } } } }, { "method": "DELETE", "url": "/settings/revenue-recognition-rules/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the revenue recognition rule" } ] } ] }, { "key": "RevenueRecognitionRuleActivationStatus", "description": "activate Revenue Recognition Rule", "context": "Entity", "pathPattern": "/revenue-recognition-rules/{id}/activation", "httpOperations": [ { "method": "PUT", "url": "/settings/revenue-recognition-rules/{id}/activation", "parameters": [ { "name": "id", "description": "Unique Id of the revenue recognition rule" } ], "requestType": { "$ref": "#/definitions/RevenueRecognitionRule", "definitions": { "RevenueRecognitionRule": { "type": "object", "properties": { "active": { "default": false, "type": "boolean" } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } } } }, "responseType": { "$ref": "#/definitions/CommonResponse", "definitions": { "RevenueRecognitionRule": { "type": "object", "properties": { "active": { "default": false, "type": "boolean" } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ] }, { "key": "RevenueStartDate", "description": "Setting for Revenue Start Date", "context": "Entity", "pathPattern": "/revenue-start-date", "httpOperations": [ { "method": "GET", "url": "/settings/revenue-start-date", "parameters": [], "responseType": { "$ref": "#/definitions/RevenueStartDate", "definitions": { "SetRevenueStartDate": { "type": "object", "properties": { "accountingPeriodName": { "description": "the accounting period that revenue start", "type": "string" }, "userName": { "description": "the name of user who set the Revenue Start Date", "type": "string" } } }, "RevenueStartDate": { "type": "object", "properties": { "revenueStartDate": { "description": "the date of Revenue Start", "type": [ "string", "null" ] }, "additionalProperties": false } } } } }, { "method": "PUT", "url": "/settings/revenue-start-date", "parameters": [], "requestType": { "$ref": "#/definitions/SetRevenueStartDate", "definitions": { "SetRevenueStartDate": { "type": "object", "properties": { "accountingPeriodName": { "description": "the accounting period that revenue start", "type": "string" }, "userName": { "description": "the name of user who set the Revenue Start Date", "type": "string" } } }, "RevenueStartDate": { "type": "object", "properties": { "revenueStartDate": { "description": "the date of Revenue Start", "type": [ "string", "null" ] }, "additionalProperties": false } } } }, "responseType": { "$ref": "#/definitions/RevenueStartDate", "definitions": { "SetRevenueStartDate": { "type": "object", "properties": { "accountingPeriodName": { "description": "the accounting period that revenue start", "type": "string" }, "userName": { "description": "the name of user who set the Revenue Start Date", "type": "string" } } }, "RevenueStartDate": { "type": "object", "properties": { "revenueStartDate": { "description": "the date of Revenue Start", "type": [ "string", "null" ] }, "additionalProperties": false } } } } } ] }, { "key": "SafeHtmlSetting", "description": "Setting to enable/disable safe HTML setting ", "context": "Entity", "pathPattern": "/safe-html-setting", "httpOperations": [ { "method": "GET", "url": "/settings/safe-html-setting", "parameters": [], "responseType": { "$ref": "#/definitions/SafeHtmlSettingResponse", "definitions": { "SafeHtmlSetting": { "additionalProperties": false, "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "SafeHtmlSettingResponse": { "additionalProperties": false, "type": "object", "properties": { "success": { "type": "boolean" }, "enabled": { "type": "boolean" } } } } } }, { "method": "PUT", "url": "/settings/safe-html-setting", "parameters": [], "requestType": { "$ref": "#/definitions/SafeHtmlSetting", "definitions": { "SafeHtmlSetting": { "additionalProperties": false, "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "SafeHtmlSettingResponse": { "additionalProperties": false, "type": "object", "properties": { "success": { "type": "boolean" }, "enabled": { "type": "boolean" } } } } }, "responseType": { "$ref": "#/definitions/SafeHtmlSettingResponse", "definitions": { "SafeHtmlSetting": { "additionalProperties": false, "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "SafeHtmlSettingResponse": { "additionalProperties": false, "type": "object", "properties": { "success": { "type": "boolean" }, "enabled": { "type": "boolean" } } } } } } ] }, { "key": "SecurityPolicy", "description": "Setting for Security Policy", "context": "Tenant", "pathPattern": "/security-policies", "httpOperations": [ { "method": "GET", "url": "/settings/security-policies", "parameters": [], "responseType": { "$ref": "#/definitions/SecurityPolicy", "definitions": { "SecurityPolicy": { "additionalProperties": false, "type": "object", "properties": { "lockoutEffectivePeriod": { "default": 20, "type": "integer", "enum": [ 20, 30, 60 ] }, "twoFactor": { "default": false, "type": "boolean" }, "twoFactorRememberTime": { "default": 30, "type": "integer" }, "passwordExpiration": { "default": 90, "type": "integer", "enum": [ 0, 30, 60, 90 ] }, "minimumPasswordLength": { "default": 8, "type": "integer", "enum": [ 7, 8, 10, 12 ] }, "passwordComplexityRequirement": { "default": "ContainAll", "type": "string", "enum": [ "None", "Characters", "ContainAll" ] }, "maximumInvalidLoginAttempts": { "default": 6, "maximum": 10, "type": "integer", "minimum": 3 }, "enforcePasswordHistory": { "default": 7, "type": "integer", "enum": [ 0, 4, 7 ] }, "sessionTimeout": { "default": 15, "type": "integer", "enum": [ 15, 30, 60, 120, 240, 480 ] } } } } } }, { "method": "PUT", "url": "/settings/security-policies", "parameters": [], "requestType": { "$ref": "#/definitions/SecurityPolicy", "definitions": { "SecurityPolicy": { "additionalProperties": false, "type": "object", "properties": { "lockoutEffectivePeriod": { "default": 20, "type": "integer", "enum": [ 20, 30, 60 ] }, "twoFactor": { "default": false, "type": "boolean" }, "twoFactorRememberTime": { "default": 30, "type": "integer" }, "passwordExpiration": { "default": 90, "type": "integer", "enum": [ 0, 30, 60, 90 ] }, "minimumPasswordLength": { "default": 8, "type": "integer", "enum": [ 7, 8, 10, 12 ] }, "passwordComplexityRequirement": { "default": "ContainAll", "type": "string", "enum": [ "None", "Characters", "ContainAll" ] }, "maximumInvalidLoginAttempts": { "default": 6, "maximum": 10, "type": "integer", "minimum": 3 }, "enforcePasswordHistory": { "default": 7, "type": "integer", "enum": [ 0, 4, 7 ] }, "sessionTimeout": { "default": 15, "type": "integer", "enum": [ 15, 30, 60, 120, 240, 480 ] } } } } }, "responseType": { "$ref": "#/definitions/SecurityPolicy", "definitions": { "SecurityPolicy": { "additionalProperties": false, "type": "object", "properties": { "lockoutEffectivePeriod": { "default": 20, "type": "integer", "enum": [ 20, 30, 60 ] }, "twoFactor": { "default": false, "type": "boolean" }, "twoFactorRememberTime": { "default": 30, "type": "integer" }, "passwordExpiration": { "default": 90, "type": "integer", "enum": [ 0, 30, 60, 90 ] }, "minimumPasswordLength": { "default": 8, "type": "integer", "enum": [ 7, 8, 10, 12 ] }, "passwordComplexityRequirement": { "default": "ContainAll", "type": "string", "enum": [ "None", "Characters", "ContainAll" ] }, "maximumInvalidLoginAttempts": { "default": 6, "maximum": 10, "type": "integer", "minimum": 3 }, "enforcePasswordHistory": { "default": 7, "type": "integer", "enum": [ 0, 4, 7 ] }, "sessionTimeout": { "default": 15, "type": "integer", "enum": [ 15, 30, 60, 120, 240, 480 ] } } } } } } ] }, { "key": "SharingAttribute", "description": "Setting for Sharing Attribute", "context": "Entity", "pathPattern": "/sharing-attributes", "httpOperations": [ { "method": "GET", "url": "/settings/sharing-attributes", "parameters": [], "responseType": { "$ref": "#/definitions/SharingAttribute", "definitions": { "Attribute": { "type": "object", "properties": { "productLevel": { "enum": [ "AccountingPeriod", "Product", "RatePlan", "RatePlanComponent", "ProductRatePlanChargeTier", "CustomField" ] }, "controlLevel": { "enum": [ "Source", "Target" ] }, "attribute": { "type": "string" } } }, "SharingAttribute": { "additionalProperties": false, "type": "object", "properties": { "attributes": { "type": "array", "items": { "$ref": "#/definitions/Attribute" } }, "enabled": { "type": "boolean" } } } } } }, { "method": "PUT", "url": "/settings/sharing-attributes", "parameters": [], "requestType": { "$ref": "#/definitions/SharingAttribute", "definitions": { "Attribute": { "type": "object", "properties": { "productLevel": { "enum": [ "AccountingPeriod", "Product", "RatePlan", "RatePlanComponent", "ProductRatePlanChargeTier", "CustomField" ] }, "controlLevel": { "enum": [ "Source", "Target" ] }, "attribute": { "type": "string" } } }, "SharingAttribute": { "additionalProperties": false, "type": "object", "properties": { "attributes": { "type": "array", "items": { "$ref": "#/definitions/Attribute" } }, "enabled": { "type": "boolean" } } } } }, "responseType": { "$ref": "#/definitions/SharingAttribute", "definitions": { "Attribute": { "type": "object", "properties": { "productLevel": { "enum": [ "AccountingPeriod", "Product", "RatePlan", "RatePlanComponent", "ProductRatePlanChargeTier", "CustomField" ] }, "controlLevel": { "enum": [ "Source", "Target" ] }, "attribute": { "type": "string" } } }, "SharingAttribute": { "additionalProperties": false, "type": "object", "properties": { "attributes": { "type": "array", "items": { "$ref": "#/definitions/Attribute" } }, "enabled": { "type": "boolean" } } } } } } ] }, { "key": "SubscriptionSettings", "description": "Setting for Subscription", "context": "Entity", "pathPattern": "/subscription-settings", "httpOperations": [ { "method": "GET", "url": "/settings/subscription-settings", "parameters": [], "responseType": { "$ref": "#/definitions/SubscriptionSetting", "definitions": { "SubscriptionSetting": { "additionalProperties": false, "type": "object", "properties": { "orderMetricsTaxationOption": { "description": "This field controls whether to calculate Tax for Order TCB and ELP Metrics or not", "type": "string", "enum": [ "YES", "NO", "ONLY_FOR_TAX_INCLUSIVE_CHARGES" ] }, "autoRenewJobScheduleId": { "type": "string" }, "acceptanceOfOrders": { "type": "boolean" }, "increasePriceRenewSubscription": { "type": "boolean" }, "subscriptionsInvoicedSeparately": { "type": "boolean" }, "termType": { "enum": [ "TERMED", "EVERGREEN" ] }, "priceIncreasePercentage": { "maximum": 100, "type": "number", "minimum": 0 }, "updateChargeTriggerCondition": { "description": "This field controls whether to enable the users to update the trigger condition of rate plan charge or not", "type": "boolean" }, "description": { "type": "string" }, "renewNoChargeSubscription": { "type": "boolean" }, "skipOwnerTransferValidationForDeletionAccount": { "description": "This field controls whether to allow users to force delete billing account without the owner transfer validation", "type": "boolean" }, "updateSubscriptionActivationDate": { "description": "This field controls whether users can update Subscription trigger dates or not.", "type": "boolean" }, "autoRenewJobRunTimeType": { "enum": [ "SystemDefault", "TenantSpecified" ] }, "enableAccountLevelDiscount": { "description": "This field controls whether to allow the users to use the account level discount charge or not", "type": "boolean" }, "renewalTerm": { "maximum": 999, "type": "integer", "minimum": 0 }, "initialTerm": { "maximum": 999, "type": "integer", "minimum": 0 }, "productFeatureOfSubscription": { "type": "boolean" }, "implementationPeriod": { "type": "boolean" }, "priceChangeOption": { "enum": [ "NoChange", "SpecificPercentageValue", "UseLatestProductCatalogPricing" ] }, "contractRenewal": { "type": "boolean" }, "invoicePastEndOfTerm": { "type": "boolean" }, "enableOrderUI": { "description": "This field controls whether to enable Order features from UI for a tenant", "type": "boolean" }, "autoRenewJobRunTime": { "maximum": 23, "type": "integer", "minimum": 0 }, "autoRenewByOrder": { "description": "The field autoRenewByOrder controls which notification to be sent for auto-renew on all subscriptions for OH customers", "type": "boolean" }, "enableOrderCpq": { "description": "The field enableOrderCpq controls whether the CPQ can use order or not. So the CPQ will create subscriptions, amendments and orders based on this", "type": "boolean" }, "skipAmendmentGenerationBySubscribe": { "description": "The field skipAmendmentGenerationBySubscribe where customers can control the order asynchronously generated when creating subscriptions via subscription UI or API for version -1", "type": "boolean" } } } } } }, { "method": "PUT", "url": "/settings/subscription-settings", "parameters": [], "requestType": { "$ref": "#/definitions/SubscriptionSetting", "definitions": { "SubscriptionSetting": { "additionalProperties": false, "type": "object", "properties": { "orderMetricsTaxationOption": { "description": "This field controls whether to calculate Tax for Order TCB and ELP Metrics or not", "type": "string", "enum": [ "YES", "NO", "ONLY_FOR_TAX_INCLUSIVE_CHARGES" ] }, "autoRenewJobScheduleId": { "type": "string" }, "acceptanceOfOrders": { "type": "boolean" }, "increasePriceRenewSubscription": { "type": "boolean" }, "subscriptionsInvoicedSeparately": { "type": "boolean" }, "termType": { "enum": [ "TERMED", "EVERGREEN" ] }, "priceIncreasePercentage": { "maximum": 100, "type": "number", "minimum": 0 }, "updateChargeTriggerCondition": { "description": "This field controls whether to enable the users to update the trigger condition of rate plan charge or not", "type": "boolean" }, "description": { "type": "string" }, "renewNoChargeSubscription": { "type": "boolean" }, "skipOwnerTransferValidationForDeletionAccount": { "description": "This field controls whether to allow users to force delete billing account without the owner transfer validation", "type": "boolean" }, "updateSubscriptionActivationDate": { "description": "This field controls whether users can update Subscription trigger dates or not.", "type": "boolean" }, "autoRenewJobRunTimeType": { "enum": [ "SystemDefault", "TenantSpecified" ] }, "enableAccountLevelDiscount": { "description": "This field controls whether to allow the users to use the account level discount charge or not", "type": "boolean" }, "renewalTerm": { "maximum": 999, "type": "integer", "minimum": 0 }, "initialTerm": { "maximum": 999, "type": "integer", "minimum": 0 }, "productFeatureOfSubscription": { "type": "boolean" }, "implementationPeriod": { "type": "boolean" }, "priceChangeOption": { "enum": [ "NoChange", "SpecificPercentageValue", "UseLatestProductCatalogPricing" ] }, "contractRenewal": { "type": "boolean" }, "invoicePastEndOfTerm": { "type": "boolean" }, "enableOrderUI": { "description": "This field controls whether to enable Order features from UI for a tenant", "type": "boolean" }, "autoRenewJobRunTime": { "maximum": 23, "type": "integer", "minimum": 0 }, "autoRenewByOrder": { "description": "The field autoRenewByOrder controls which notification to be sent for auto-renew on all subscriptions for OH customers", "type": "boolean" }, "enableOrderCpq": { "description": "The field enableOrderCpq controls whether the CPQ can use order or not. So the CPQ will create subscriptions, amendments and orders based on this", "type": "boolean" }, "skipAmendmentGenerationBySubscribe": { "description": "The field skipAmendmentGenerationBySubscribe where customers can control the order asynchronously generated when creating subscriptions via subscription UI or API for version -1", "type": "boolean" } } } } }, "responseType": { "$ref": "#/definitions/SubscriptionSetting", "definitions": { "SubscriptionSetting": { "additionalProperties": false, "type": "object", "properties": { "orderMetricsTaxationOption": { "description": "This field controls whether to calculate Tax for Order TCB and ELP Metrics or not", "type": "string", "enum": [ "YES", "NO", "ONLY_FOR_TAX_INCLUSIVE_CHARGES" ] }, "autoRenewJobScheduleId": { "type": "string" }, "acceptanceOfOrders": { "type": "boolean" }, "increasePriceRenewSubscription": { "type": "boolean" }, "subscriptionsInvoicedSeparately": { "type": "boolean" }, "termType": { "enum": [ "TERMED", "EVERGREEN" ] }, "priceIncreasePercentage": { "maximum": 100, "type": "number", "minimum": 0 }, "updateChargeTriggerCondition": { "description": "This field controls whether to enable the users to update the trigger condition of rate plan charge or not", "type": "boolean" }, "description": { "type": "string" }, "renewNoChargeSubscription": { "type": "boolean" }, "skipOwnerTransferValidationForDeletionAccount": { "description": "This field controls whether to allow users to force delete billing account without the owner transfer validation", "type": "boolean" }, "updateSubscriptionActivationDate": { "description": "This field controls whether users can update Subscription trigger dates or not.", "type": "boolean" }, "autoRenewJobRunTimeType": { "enum": [ "SystemDefault", "TenantSpecified" ] }, "enableAccountLevelDiscount": { "description": "This field controls whether to allow the users to use the account level discount charge or not", "type": "boolean" }, "renewalTerm": { "maximum": 999, "type": "integer", "minimum": 0 }, "initialTerm": { "maximum": 999, "type": "integer", "minimum": 0 }, "productFeatureOfSubscription": { "type": "boolean" }, "implementationPeriod": { "type": "boolean" }, "priceChangeOption": { "enum": [ "NoChange", "SpecificPercentageValue", "UseLatestProductCatalogPricing" ] }, "contractRenewal": { "type": "boolean" }, "invoicePastEndOfTerm": { "type": "boolean" }, "enableOrderUI": { "description": "This field controls whether to enable Order features from UI for a tenant", "type": "boolean" }, "autoRenewJobRunTime": { "maximum": 23, "type": "integer", "minimum": 0 }, "autoRenewByOrder": { "description": "The field autoRenewByOrder controls which notification to be sent for auto-renew on all subscriptions for OH customers", "type": "boolean" }, "enableOrderCpq": { "description": "The field enableOrderCpq controls whether the CPQ can use order or not. So the CPQ will create subscriptions, amendments and orders based on this", "type": "boolean" }, "skipAmendmentGenerationBySubscribe": { "description": "The field skipAmendmentGenerationBySubscribe where customers can control the order asynchronously generated when creating subscriptions via subscription UI or API for version -1", "type": "boolean" } } } } } } ] }, { "key": "AllSummaryStatementTemplates", "description": "Setting for Summary Statement Templates", "context": "Tenant", "pathPattern": "/summary-statement-templates", "httpOperations": [ { "method": "GET", "url": "/settings/summary-statement-templates", "parameters": [], "responseType": { "type": "array", "items": { "$ref": "#/definitions/Template" }, "definitions": { "TemplatePostDto": { "additionalProperties": false, "type": "object", "properties": { "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "name": { "description": "The name of the template", "type": "string" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] } }, "required": [ "name", "templateFileName", "base64EncodedTemplateFileContent" ] }, "Template": { "additionalProperties": false, "type": "object", "properties": { "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "name": { "description": "MySummaryStatementTemplate", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "associatedToBillingAccount": { "type": "boolean" }, "id": { "description": "The unique identifier of the template", "type": "string" }, "updatedOn": { "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] } } } } } }, { "method": "POST", "url": "/settings/summary-statement-templates", "parameters": [], "requestType": { "$ref": "#/definitions/TemplatePostDto", "definitions": { "TemplatePostDto": { "additionalProperties": false, "type": "object", "properties": { "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "name": { "description": "The name of the template", "type": "string" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] } }, "required": [ "name", "templateFileName", "base64EncodedTemplateFileContent" ] }, "Template": { "additionalProperties": false, "type": "object", "properties": { "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "name": { "description": "MySummaryStatementTemplate", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "associatedToBillingAccount": { "type": "boolean" }, "id": { "description": "The unique identifier of the template", "type": "string" }, "updatedOn": { "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] } } } } }, "responseType": { "$ref": "#/definitions/Template", "definitions": { "TemplatePostDto": { "additionalProperties": false, "type": "object", "properties": { "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "name": { "description": "The name of the template", "type": "string" }, "templateFileName": { "description": "The name of the template file.", "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] } }, "required": [ "name", "templateFileName", "base64EncodedTemplateFileContent" ] }, "Template": { "additionalProperties": false, "type": "object", "properties": { "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "name": { "description": "MySummaryStatementTemplate", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "associatedToBillingAccount": { "type": "boolean" }, "id": { "description": "The unique identifier of the template", "type": "string" }, "updatedOn": { "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] } } } } } } ] }, { "key": "SummaryStatementTemplatesReplacements", "description": "Settings for Summary Statement Templates Replacements", "context": "Entity", "pathPattern": "/summary-statement-templates-replacements", "httpOperations": [ { "method": "POST", "url": "/settings/summary-statement-templates-replacements", "parameters": [], "requestType": { "$ref": "#/definitions/SummaryStatementTemplatesReplacements", "definitions": { "SummaryStatementTemplatesReplacements": { "additionalProperties": false, "type": "object", "properties": { "newTemplateId": { "type": "string" }, "currentTemplateId": { "type": "string" } } } } } } ] }, { "key": "SummaryStatementTemplate", "description": "Setting for Summary Statement Template", "context": "Tenant", "pathPattern": "/summary-statement-templates/{templateId}", "httpOperations": [ { "method": "GET", "url": "/settings/summary-statement-templates/{templateId}", "parameters": [ { "name": "templateId", "description": "Unique Id of the Summary Statement Template" } ], "responseType": { "$ref": "#/definitions/Template", "definitions": { "SummaryStatementTemplate": { "additionalProperties": false, "type": "object", "properties": { "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" } } }, "Template": { "additionalProperties": false, "type": "object", "properties": { "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "name": { "description": "MySummaryStatementTemplate", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "associatedToBillingAccount": { "type": "boolean" }, "id": { "description": "The unique identifier of the template", "type": "string" }, "updatedOn": { "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] } } } } } }, { "method": "PUT", "url": "/settings/summary-statement-templates/{templateId}", "parameters": [ { "name": "templateId", "description": "Unique Id of the Summary Statement Template" } ], "requestType": { "$ref": "#/definitions/SummaryStatementTemplate", "definitions": { "SummaryStatementTemplate": { "additionalProperties": false, "type": "object", "properties": { "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" } } }, "Template": { "additionalProperties": false, "type": "object", "properties": { "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "name": { "description": "MySummaryStatementTemplate", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "associatedToBillingAccount": { "type": "boolean" }, "id": { "description": "The unique identifier of the template", "type": "string" }, "updatedOn": { "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] } } } } }, "responseType": { "$ref": "#/definitions/Template", "definitions": { "SummaryStatementTemplate": { "additionalProperties": false, "type": "object", "properties": { "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "name": { "description": "The name of the template", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" } } }, "Template": { "additionalProperties": false, "type": "object", "properties": { "base64EncodedTemplateFileContent": { "description": "The template file contents as a base64 encoded string", "type": "string" }, "templateNumber": { "type": "string" }, "name": { "description": "MySummaryStatementTemplate", "type": "string" }, "defaultTemplate": { "description": "Is this template the default template.", "type": "boolean" }, "associatedToBillingAccount": { "type": "boolean" }, "id": { "description": "The unique identifier of the template", "type": "string" }, "updatedOn": { "type": "string" }, "templateFormat": { "description": "The format of the template file.", "type": "string", "enum": [ "WORD", "HTML" ] } } } } } }, { "method": "DELETE", "url": "/settings/summary-statement-templates/{templateId}", "parameters": [ { "name": "templateId", "description": "Unique Id of the Summary Statement Template" } ] } ] }, { "key": "AllTaxCode", "description": "Read all tax code", "context": "Entity", "pathPattern": "/tax-codes", "httpOperations": [ { "method": "GET", "url": "/settings/tax-codes", "parameters": [], "responseType": { "$ref": "#/definitions/AllTaxCode", "definitions": { "TaxCode": { "properties": { "name": { "type": "string" }, "active": { "type": "boolean" }, "description": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "taxEngineId": { "type": [ "string", "null" ] }, "taxEngineTemplate": { "type": [ "string", "null" ] }, "useMultipleTaxEngines": { "type": "boolean" } } }, "AllTaxCode": { "type": "object", "properties": { "taxCodes": { "type": "array", "items": { "$ref": "#/definitions/TaxCode" } } } } } } } ] }, { "key": "CreateAvalaraTaxCode", "description": "Create tax code under Avalara Tax Engine", "context": "Entity", "pathPattern": "/tax-codes/avalara", "httpOperations": [ { "method": "POST", "url": "/settings/tax-codes/avalara", "parameters": [], "requestType": { "$ref": "#/definitions/AvalaraTaxCodeRequest", "definitions": { "AvalaraTaxCodeRequest": { "type": "object", "properties": { "externalTaxCode": { "type": "string" }, "taxCompanyId": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "description": { "type": "string" }, "taxEngineId": { "type": "string" } } }, "AvalaraTaxCodeResponse": { "type": "object", "properties": { "externalTaxCode": { "type": "string" }, "taxCompanyId": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "description": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "taxEngineId": { "type": "string" } } } } }, "responseType": { "$ref": "#/definitions/AvalaraTaxCodeResponse", "definitions": { "AvalaraTaxCodeRequest": { "type": "object", "properties": { "externalTaxCode": { "type": "string" }, "taxCompanyId": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "description": { "type": "string" }, "taxEngineId": { "type": "string" } } }, "AvalaraTaxCodeResponse": { "type": "object", "properties": { "externalTaxCode": { "type": "string" }, "taxCompanyId": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "description": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "taxEngineId": { "type": "string" } } } } } } ] }, { "key": "AvalaraTaxCode", "description": "Setting for tax code under Avalara Tax Engine", "context": "Entity", "pathPattern": "/tax-codes/avalara/{id}", "httpOperations": [ { "method": "GET", "url": "/settings/tax-codes/avalara/{id}", "parameters": [ { "name": "id", "description": "Unique Id of tax code" } ], "responseType": { "$ref": "#/definitions/AvalaraTaxCode", "definitions": { "AvalaraTaxCode": { "type": "object", "properties": { "externalTaxCode": { "type": [ "string", "null" ] }, "taxCompanyId": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "description": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "taxEngineId": { "type": "string" } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } }, { "method": "PUT", "url": "/settings/tax-codes/avalara/{id}", "parameters": [ { "name": "id", "description": "Unique Id of tax code" } ], "requestType": { "$ref": "#/definitions/AvalaraTaxCode", "definitions": { "AvalaraTaxCode": { "type": "object", "properties": { "externalTaxCode": { "type": [ "string", "null" ] }, "taxCompanyId": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "description": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "taxEngineId": { "type": "string" } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } } } }, "responseType": { "$ref": "#/definitions/AvalaraTaxCode", "definitions": { "AvalaraTaxCode": { "type": "object", "properties": { "externalTaxCode": { "type": [ "string", "null" ] }, "taxCompanyId": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "description": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "taxEngineId": { "type": "string" } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } }, { "method": "DELETE", "url": "/settings/tax-codes/avalara/{id}", "parameters": [ { "name": "id", "description": "Unique Id of tax code" } ], "responseType": { "$ref": "#/definitions/CommonResponse", "definitions": { "AvalaraTaxCode": { "type": "object", "properties": { "externalTaxCode": { "type": [ "string", "null" ] }, "taxCompanyId": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "description": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "taxEngineId": { "type": "string" } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ] }, { "key": "CreateConnectorTaxCode", "description": "Create tax code under Connector Tax Engine", "context": "Entity", "pathPattern": "/tax-codes/connector", "httpOperations": [ { "method": "POST", "url": "/settings/tax-codes/connector", "parameters": [], "requestType": { "$ref": "#/definitions/ConnectorTaxCodeRequest", "definitions": { "ConnectorTaxCodeResponse": { "type": "object", "properties": { "taxCompanyId": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "description": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "taxEngineId": { "type": "string" } } }, "ConnectorTaxCodeRequest": { "type": "object", "properties": { "taxCompanyId": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "description": { "type": "string" }, "taxEngineId": { "type": "string" } } } } }, "responseType": { "$ref": "#/definitions/ConnectorTaxCodeResponse", "definitions": { "ConnectorTaxCodeResponse": { "type": "object", "properties": { "taxCompanyId": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "description": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "taxEngineId": { "type": "string" } } }, "ConnectorTaxCodeRequest": { "type": "object", "properties": { "taxCompanyId": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "description": { "type": "string" }, "taxEngineId": { "type": "string" } } } } } } ] }, { "key": "ConnectorTaxCode", "description": "Setting for tax code under Connector Tax Engine", "context": "Entity", "pathPattern": "/tax-codes/connector/{id}", "httpOperations": [ { "method": "GET", "url": "/settings/tax-codes/connector/{id}", "parameters": [ { "name": "id", "description": "Unique Id of connector tax code" } ], "responseType": { "$ref": "#/definitions/ConnectorTaxCode", "definitions": { "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } }, "ConnectorTaxCode": { "type": "object", "properties": { "taxCompanyId": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "description": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "taxEngineId": { "type": "string" } } } } } }, { "method": "PUT", "url": "/settings/tax-codes/connector/{id}", "parameters": [ { "name": "id", "description": "Unique Id of connector tax code" } ], "requestType": { "$ref": "#/definitions/ConnectorTaxCode", "definitions": { "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } }, "ConnectorTaxCode": { "type": "object", "properties": { "taxCompanyId": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "description": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "taxEngineId": { "type": "string" } } } } }, "responseType": { "$ref": "#/definitions/ConnectorTaxCode", "definitions": { "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } }, "ConnectorTaxCode": { "type": "object", "properties": { "taxCompanyId": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "description": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "taxEngineId": { "type": "string" } } } } } }, { "method": "DELETE", "url": "/settings/tax-codes/connector/{id}", "parameters": [ { "name": "id", "description": "Unique Id of connector tax code" } ], "responseType": { "$ref": "#/definitions/CommonResponse", "definitions": { "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } }, "ConnectorTaxCode": { "type": "object", "properties": { "taxCompanyId": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "description": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "taxEngineId": { "type": "string" } } } } } } ] }, { "key": "CreateGlobalTaxHubTaxCode", "description": "Create tax code under global tax hub Tax Engine", "context": "Entity", "pathPattern": "/tax-codes/global-tax-hub", "httpOperations": [ { "method": "POST", "url": "/settings/tax-codes/global-tax-hub", "parameters": [], "requestType": { "$ref": "#/definitions/GlobalTaxHubTaxCodeRequest", "definitions": { "GlobalTaxHubTaxCodeResponse": { "type": "object", "properties": { "taxCompanyId": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "id": { "type": "string" }, "taxEngineId": { "type": "string" } } }, "GlobalTaxHubTaxCodeRequest": { "type": "object", "properties": { "taxCompanyId": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "taxEngineId": { "type": "string" } } } } }, "responseType": { "$ref": "#/definitions/GlobalTaxHubTaxCodeResponse", "definitions": { "GlobalTaxHubTaxCodeResponse": { "type": "object", "properties": { "taxCompanyId": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "id": { "type": "string" }, "taxEngineId": { "type": "string" } } }, "GlobalTaxHubTaxCodeRequest": { "type": "object", "properties": { "taxCompanyId": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "taxEngineId": { "type": "string" } } } } } } ] }, { "key": "GlobalTaxHubTaxCode", "description": "Setting for tax code under Global tax ub Tax Engine", "context": "Entity", "pathPattern": "/tax-codes/global-tax-hub/{id}", "httpOperations": [ { "method": "GET", "url": "/settings/tax-codes/global-tax-hub/{id}", "parameters": [ { "name": "id", "description": "Unique Id of Global Tax Hub tax code" } ], "responseType": { "$ref": "#/definitions/GlobalTaxHubTaxCode", "definitions": { "GlobalTaxHubTaxCode": { "type": "object", "properties": { "taxCompanyId": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "id": { "type": "string" }, "taxEngineId": { "type": "string" } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } }, { "method": "PUT", "url": "/settings/tax-codes/global-tax-hub/{id}", "parameters": [ { "name": "id", "description": "Unique Id of Global Tax Hub tax code" } ], "requestType": { "$ref": "#/definitions/GlobalTaxHubTaxCode", "definitions": { "GlobalTaxHubTaxCode": { "type": "object", "properties": { "taxCompanyId": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "id": { "type": "string" }, "taxEngineId": { "type": "string" } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } } } }, "responseType": { "$ref": "#/definitions/GlobalTaxHubTaxCode", "definitions": { "GlobalTaxHubTaxCode": { "type": "object", "properties": { "taxCompanyId": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "id": { "type": "string" }, "taxEngineId": { "type": "string" } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } }, { "method": "DELETE", "url": "/settings/tax-codes/global-tax-hub/{id}", "parameters": [ { "name": "id", "description": "Unique Id of Global Tax Hub tax code" } ], "responseType": { "$ref": "#/definitions/CommonResponse", "definitions": { "GlobalTaxHubTaxCode": { "type": "object", "properties": { "taxCompanyId": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "id": { "type": "string" }, "taxEngineId": { "type": "string" } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ] }, { "key": "CreateZuoraTaxCode", "description": "Create tax code under Zuora Tax Engine", "context": "Entity", "pathPattern": "/tax-codes/ztax", "httpOperations": [ { "method": "POST", "url": "/settings/tax-codes/ztax", "parameters": [], "requestType": { "$ref": "#/definitions/ZuoraTaxCodeRequest", "definitions": { "ZuoraTaxCodeRequest": { "type": "object", "properties": { "name": { "type": "string" }, "active": { "type": "boolean" }, "description": { "type": "string" }, "taxEngineId": { "type": "string" } } }, "ZuoraTaxCode": { "type": "object", "properties": { "name": { "type": "string" }, "active": { "type": "boolean" }, "description": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "taxEngineId": { "type": "string" } } } } }, "responseType": { "$ref": "#/definitions/ZuoraTaxCode", "definitions": { "ZuoraTaxCodeRequest": { "type": "object", "properties": { "name": { "type": "string" }, "active": { "type": "boolean" }, "description": { "type": "string" }, "taxEngineId": { "type": "string" } } }, "ZuoraTaxCode": { "type": "object", "properties": { "name": { "type": "string" }, "active": { "type": "boolean" }, "description": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "taxEngineId": { "type": "string" } } } } } } ] }, { "key": "ZuoraTaxCode", "description": "Setting for tax code under Zuora Tax Engine", "context": "Entity", "pathPattern": "/tax-codes/ztax/{id}", "httpOperations": [ { "method": "GET", "url": "/settings/tax-codes/ztax/{id}", "parameters": [ { "name": "id", "description": "Unique Id of tax code" } ], "responseType": { "$ref": "#/definitions/ZuoraTaxCode", "definitions": { "ZuoraTaxCode": { "type": "object", "properties": { "name": { "type": "string" }, "active": { "type": "boolean" }, "description": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "taxEngineId": { "type": "string" } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } }, { "method": "PUT", "url": "/settings/tax-codes/ztax/{id}", "parameters": [ { "name": "id", "description": "Unique Id of tax code" } ], "requestType": { "$ref": "#/definitions/ZuoraTaxCode", "definitions": { "ZuoraTaxCode": { "type": "object", "properties": { "name": { "type": "string" }, "active": { "type": "boolean" }, "description": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "taxEngineId": { "type": "string" } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } } } }, "responseType": { "$ref": "#/definitions/ZuoraTaxCode", "definitions": { "ZuoraTaxCode": { "type": "object", "properties": { "name": { "type": "string" }, "active": { "type": "boolean" }, "description": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "taxEngineId": { "type": "string" } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } }, { "method": "DELETE", "url": "/settings/tax-codes/ztax/{id}", "parameters": [ { "name": "id", "description": "Unique Id of tax code" } ], "responseType": { "$ref": "#/definitions/CommonResponse", "definitions": { "ZuoraTaxCode": { "type": "object", "properties": { "name": { "type": "string" }, "active": { "type": "boolean" }, "description": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "taxEngineId": { "type": "string" } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ] }, { "key": "TaxCompanies", "description": "get tax companies under one tax engine", "context": "Entity", "pathPattern": "/tax-companies", "httpOperations": [ { "method": "GET", "url": "/settings/tax-companies", "parameters": [], "responseType": { "$ref": "#/definitions/GetTaxCompanies", "definitions": { "GetTaxCompanies": { "type": "object", "properties": { "taxCompanies": { "type": "array", "items": { "$ref": "#/definitions/TaxCompany" } } } }, "TaxCompany": { "type": "object", "properties": { "companyCode": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "companyId": { "type": [ "string", "null" ] }, "taxRegion": { "type": [ "string", "null" ] }, "address2": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "address1": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "state": { "type": [ "string", "null" ] }, "taxEngineId": { "type": "string" } } } } } }, { "method": "POST", "url": "/settings/tax-companies", "parameters": [], "requestType": { "$ref": "#/definitions/TaxCompany", "definitions": { "GetTaxCompanies": { "type": "object", "properties": { "taxCompanies": { "type": "array", "items": { "$ref": "#/definitions/TaxCompany" } } } }, "TaxCompany": { "type": "object", "properties": { "companyCode": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "companyId": { "type": [ "string", "null" ] }, "taxRegion": { "type": [ "string", "null" ] }, "address2": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "address1": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "state": { "type": [ "string", "null" ] }, "taxEngineId": { "type": "string" } } } } }, "responseType": { "$ref": "#/definitions/TaxCompany", "definitions": { "GetTaxCompanies": { "type": "object", "properties": { "taxCompanies": { "type": "array", "items": { "$ref": "#/definitions/TaxCompany" } } } }, "TaxCompany": { "type": "object", "properties": { "companyCode": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "companyId": { "type": [ "string", "null" ] }, "taxRegion": { "type": [ "string", "null" ] }, "address2": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "address1": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "state": { "type": [ "string", "null" ] }, "taxEngineId": { "type": "string" } } } } } } ] }, { "key": "TaxCompany", "description": "Setting for tax company", "context": "Entity", "pathPattern": "/tax-companies/{id}", "httpOperations": [ { "method": "GET", "url": "/settings/tax-companies/{id}", "parameters": [ { "name": "id", "description": "Unique Id of Tax Company" } ], "responseType": { "$ref": "#/definitions/TaxCompany", "definitions": { "TaxCompany": { "type": "object", "properties": { "companyCode": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "companyId": { "type": [ "string", "null" ] }, "taxRegion": { "type": [ "string", "null" ] }, "address2": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "address1": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "state": { "type": [ "string", "null" ] }, "taxEngineId": { "type": "string" } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } }, { "method": "PUT", "url": "/settings/tax-companies/{id}", "parameters": [ { "name": "id", "description": "Unique Id of Tax Company" } ], "requestType": { "$ref": "#/definitions/TaxCompany", "definitions": { "TaxCompany": { "type": "object", "properties": { "companyCode": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "companyId": { "type": [ "string", "null" ] }, "taxRegion": { "type": [ "string", "null" ] }, "address2": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "address1": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "state": { "type": [ "string", "null" ] }, "taxEngineId": { "type": "string" } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } } } }, "responseType": { "$ref": "#/definitions/TaxCompany", "definitions": { "TaxCompany": { "type": "object", "properties": { "companyCode": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "companyId": { "type": [ "string", "null" ] }, "taxRegion": { "type": [ "string", "null" ] }, "address2": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "address1": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "state": { "type": [ "string", "null" ] }, "taxEngineId": { "type": "string" } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } }, { "method": "DELETE", "url": "/settings/tax-companies/{id}", "parameters": [ { "name": "id", "description": "Unique Id of Tax Company" } ], "responseType": { "$ref": "#/definitions/CommonResponse", "definitions": { "TaxCompany": { "type": "object", "properties": { "companyCode": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "companyId": { "type": [ "string", "null" ] }, "taxRegion": { "type": [ "string", "null" ] }, "address2": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "address1": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "state": { "type": [ "string", "null" ] }, "taxEngineId": { "type": "string" } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ] }, { "key": "AllTaxDateOptions", "description": "List of all Tax Date Option", "context": "Entity", "pathPattern": "/tax-date-options", "httpOperations": [ { "method": "GET", "url": "/settings/tax-date-options", "parameters": [], "responseType": { "$ref": "#/definitions/AllTaxDateOptions", "definitions": { "TaxDateOptions": { "additionalProperties": false, "type": "array", "items": { "type": "object", "properties": { "taxDateOption": { "default": "InvoiceDate", "type": "string", "enum": [ "DocumentDate", "ServicePeriodStartDate", "ServicePeriodEndDate" ] }, "countryCode": { "type": "string" } } } }, "AllTaxDateOptions": { "additionalProperties": false, "type": "object", "properties": { "taxDateSettings": { "type": "array", "items": { "type": "object", "properties": { "taxDateOption": { "default": "InvoiceDate", "type": "string", "enum": [ "DocumentDate", "ServicePeriodStartDate", "ServicePeriodEndDate" ] }, "countryCode": { "type": "string" }, "id": { "type": "string" } } } }, "success": { "type": "boolean" } } } } } }, { "method": "POST", "url": "/settings/tax-date-options", "parameters": [], "requestType": { "$ref": "#/definitions/TaxDateOptions", "definitions": { "TaxDateOptions": { "additionalProperties": false, "type": "array", "items": { "type": "object", "properties": { "taxDateOption": { "default": "InvoiceDate", "type": "string", "enum": [ "DocumentDate", "ServicePeriodStartDate", "ServicePeriodEndDate" ] }, "countryCode": { "type": "string" } } } }, "AllTaxDateOptions": { "additionalProperties": false, "type": "object", "properties": { "taxDateSettings": { "type": "array", "items": { "type": "object", "properties": { "taxDateOption": { "default": "InvoiceDate", "type": "string", "enum": [ "DocumentDate", "ServicePeriodStartDate", "ServicePeriodEndDate" ] }, "countryCode": { "type": "string" }, "id": { "type": "string" } } } }, "success": { "type": "boolean" } } } } }, "responseType": { "$ref": "#/definitions/AllTaxDateOptions", "definitions": { "TaxDateOptions": { "additionalProperties": false, "type": "array", "items": { "type": "object", "properties": { "taxDateOption": { "default": "InvoiceDate", "type": "string", "enum": [ "DocumentDate", "ServicePeriodStartDate", "ServicePeriodEndDate" ] }, "countryCode": { "type": "string" } } } }, "AllTaxDateOptions": { "additionalProperties": false, "type": "object", "properties": { "taxDateSettings": { "type": "array", "items": { "type": "object", "properties": { "taxDateOption": { "default": "InvoiceDate", "type": "string", "enum": [ "DocumentDate", "ServicePeriodStartDate", "ServicePeriodEndDate" ] }, "countryCode": { "type": "string" }, "id": { "type": "string" } } } }, "success": { "type": "boolean" } } } } } } ] }, { "key": "TaxDateOption", "description": "Tax Date Option", "context": "Entity", "pathPattern": "/tax-date-options/{id}", "httpOperations": [ { "method": "PUT", "url": "/settings/tax-date-options/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Tax Date Options" } ], "requestType": { "$ref": "#/definitions/TaxDateOption", "definitions": { "TaxDateOption": { "additionalProperties": false, "type": "object", "properties": { "taxDateOption": { "default": "InvoiceDate", "type": "string", "enum": [ "DocumentDate", "ServicePeriodStartDate", "ServicePeriodEndDate" ] }, "countryCode": { "type": "string" } } }, "AllTaxDateOption": { "additionalProperties": false, "type": "object", "properties": { "taxDateOption": { "default": "InvoiceDate", "type": "string", "enum": [ "DocumentDate", "ServicePeriodStartDate", "ServicePeriodEndDate" ] }, "countryCode": { "type": "string" }, "success": { "type": "boolean" }, "id": { "type": "string" } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } } } }, "responseType": { "$ref": "#/definitions/AllTaxDateOption", "definitions": { "TaxDateOption": { "additionalProperties": false, "type": "object", "properties": { "taxDateOption": { "default": "InvoiceDate", "type": "string", "enum": [ "DocumentDate", "ServicePeriodStartDate", "ServicePeriodEndDate" ] }, "countryCode": { "type": "string" } } }, "AllTaxDateOption": { "additionalProperties": false, "type": "object", "properties": { "taxDateOption": { "default": "InvoiceDate", "type": "string", "enum": [ "DocumentDate", "ServicePeriodStartDate", "ServicePeriodEndDate" ] }, "countryCode": { "type": "string" }, "success": { "type": "boolean" }, "id": { "type": "string" } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } }, { "method": "DELETE", "url": "/settings/tax-date-options/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Tax Date Options" } ], "responseType": { "$ref": "#/definitions/CommonResponse", "definitions": { "TaxDateOption": { "additionalProperties": false, "type": "object", "properties": { "taxDateOption": { "default": "InvoiceDate", "type": "string", "enum": [ "DocumentDate", "ServicePeriodStartDate", "ServicePeriodEndDate" ] }, "countryCode": { "type": "string" } } }, "AllTaxDateOption": { "additionalProperties": false, "type": "object", "properties": { "taxDateOption": { "default": "InvoiceDate", "type": "string", "enum": [ "DocumentDate", "ServicePeriodStartDate", "ServicePeriodEndDate" ] }, "countryCode": { "type": "string" }, "success": { "type": "boolean" }, "id": { "type": "string" } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ] }, { "key": "TaxEngines", "description": "setting to get/update all tax engines", "context": "Entity", "pathPattern": "/tax-engines/{id}", "httpOperations": [ { "method": "GET", "url": "/settings/tax-engines/{id}", "parameters": [ { "name": "id", "description": "Unique Id of tax engine" } ], "responseType": { "$ref": "#/definitions/GetUnifiedTaxEngine", "definitions": { "GetUnifiedTaxEngine": { "type": "object", "properties": { "isTestEnvironment": { "type": "boolean" }, "jsonFields": { "type": [ "object", "null" ] }, "customFieldMetas": { "type": "array", "items": { "$ref": "#/definitions/CustomFieldMeta" } }, "useAdvanceSettings": { "default": "false", "type": "boolean" }, "clientId": { "type": [ "string", "null" ] }, "voidUrl": { "type": [ "string", "null" ] }, "requestTemplate": { "type": [ "string", "null" ] }, "networkReadTimeoutInSeconds": { "type": [ "number", "null" ] }, "url": { "type": [ "string", "null" ] }, "securityToken": { "type": [ "string", "null" ] }, "password": { "type": [ "string", "null" ] }, "responseMappings": { "type": [ "object", "null" ] }, "requestHeaders": { "type": [ "object", "null" ] }, "voidTemplate": { "type": [ "string", "null" ] }, "success": { "type": "boolean" }, "vendor": { "type": "string", "enum": [ "Z-Tax", "ONESOURCE", "VertexAdvancedTax", "AvalaraForBrazil", "AvaTaxForCommunication", "VertexOSeries", "ONESOURCESOAP", "VertexAdvancedTaxSOAP", "CCHSureTax", "Sovos", "Avalara" ] }, "accessTokenUrl": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "clientSecret": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "authenticationType": { "type": "string", "enum": [ "BasicAuth", "OAuth2", "PrivateToken" ] }, "username": { "type": [ "string", "null" ] }, "networkOpenTimeoutInSeconds": { "type": [ "number", "null" ] } } }, "UnifiedTaxEngine": { "type": "object", "properties": { "isTestEnvironment": { "type": "boolean" }, "jsonFields": { "type": [ "object", "null" ] }, "customFieldMetas": { "type": [ "array", "null" ], "items": { "$ref": "#/definitions/CustomFieldMeta" } }, "useAdvanceSettings": { "default": "false", "type": "boolean" }, "clientId": { "type": [ "string", "null" ] }, "voidUrl": { "type": [ "string", "null" ] }, "requestTemplate": { "type": [ "string", "null" ] }, "networkReadTimeoutInSeconds": { "type": [ "number", "null" ] }, "url": { "type": [ "string", "null" ] }, "securityToken": { "type": [ "string", "null" ] }, "password": { "type": [ "string", "null" ] }, "responseMappings": { "type": [ "object", "null" ] }, "requestHeaders": { "type": [ "object", "null" ] }, "voidTemplate": { "type": [ "string", "null" ] }, "vendor": { "type": "string", "enum": [ "Z-Tax", "ONESOURCE", "VertexAdvancedTax", "AvalaraForBrazil", "AvaTaxForCommunication", "VertexOSeries", "ONESOURCESOAP", "VertexAdvancedTaxSOAP", "CCHSureTax", "Sovos", "Avalara" ] }, "accessTokenUrl": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "clientSecret": { "type": [ "string", "null" ] }, "authenticationType": { "type": "string", "enum": [ "BasicAuth", "OAuth2", "PrivateToken" ] }, "username": { "type": [ "string", "null" ] }, "networkOpenTimeoutInSeconds": { "type": [ "number", "null" ] } } }, "CustomFieldMeta": { "additionalProperties": false, "type": "object", "properties": { "useLatestValue": { "type": "boolean" }, "customFieldName": { "type": "string" }, "customFieldObjectType": { "type": "string" } }, "required": [ "customFieldName", "customFieldObjectType" ] }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } }, { "method": "PUT", "url": "/settings/tax-engines/{id}", "parameters": [ { "name": "id", "description": "Unique Id of tax engine" } ], "requestType": { "$ref": "#/definitions/UnifiedTaxEngine", "definitions": { "GetUnifiedTaxEngine": { "type": "object", "properties": { "isTestEnvironment": { "type": "boolean" }, "jsonFields": { "type": [ "object", "null" ] }, "customFieldMetas": { "type": "array", "items": { "$ref": "#/definitions/CustomFieldMeta" } }, "useAdvanceSettings": { "default": "false", "type": "boolean" }, "clientId": { "type": [ "string", "null" ] }, "voidUrl": { "type": [ "string", "null" ] }, "requestTemplate": { "type": [ "string", "null" ] }, "networkReadTimeoutInSeconds": { "type": [ "number", "null" ] }, "url": { "type": [ "string", "null" ] }, "securityToken": { "type": [ "string", "null" ] }, "password": { "type": [ "string", "null" ] }, "responseMappings": { "type": [ "object", "null" ] }, "requestHeaders": { "type": [ "object", "null" ] }, "voidTemplate": { "type": [ "string", "null" ] }, "success": { "type": "boolean" }, "vendor": { "type": "string", "enum": [ "Z-Tax", "ONESOURCE", "VertexAdvancedTax", "AvalaraForBrazil", "AvaTaxForCommunication", "VertexOSeries", "ONESOURCESOAP", "VertexAdvancedTaxSOAP", "CCHSureTax", "Sovos", "Avalara" ] }, "accessTokenUrl": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "clientSecret": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "authenticationType": { "type": "string", "enum": [ "BasicAuth", "OAuth2", "PrivateToken" ] }, "username": { "type": [ "string", "null" ] }, "networkOpenTimeoutInSeconds": { "type": [ "number", "null" ] } } }, "UnifiedTaxEngine": { "type": "object", "properties": { "isTestEnvironment": { "type": "boolean" }, "jsonFields": { "type": [ "object", "null" ] }, "customFieldMetas": { "type": [ "array", "null" ], "items": { "$ref": "#/definitions/CustomFieldMeta" } }, "useAdvanceSettings": { "default": "false", "type": "boolean" }, "clientId": { "type": [ "string", "null" ] }, "voidUrl": { "type": [ "string", "null" ] }, "requestTemplate": { "type": [ "string", "null" ] }, "networkReadTimeoutInSeconds": { "type": [ "number", "null" ] }, "url": { "type": [ "string", "null" ] }, "securityToken": { "type": [ "string", "null" ] }, "password": { "type": [ "string", "null" ] }, "responseMappings": { "type": [ "object", "null" ] }, "requestHeaders": { "type": [ "object", "null" ] }, "voidTemplate": { "type": [ "string", "null" ] }, "vendor": { "type": "string", "enum": [ "Z-Tax", "ONESOURCE", "VertexAdvancedTax", "AvalaraForBrazil", "AvaTaxForCommunication", "VertexOSeries", "ONESOURCESOAP", "VertexAdvancedTaxSOAP", "CCHSureTax", "Sovos", "Avalara" ] }, "accessTokenUrl": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "clientSecret": { "type": [ "string", "null" ] }, "authenticationType": { "type": "string", "enum": [ "BasicAuth", "OAuth2", "PrivateToken" ] }, "username": { "type": [ "string", "null" ] }, "networkOpenTimeoutInSeconds": { "type": [ "number", "null" ] } } }, "CustomFieldMeta": { "additionalProperties": false, "type": "object", "properties": { "useLatestValue": { "type": "boolean" }, "customFieldName": { "type": "string" }, "customFieldObjectType": { "type": "string" } }, "required": [ "customFieldName", "customFieldObjectType" ] }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } } } }, "responseType": { "$ref": "#/definitions/GetUnifiedTaxEngine", "definitions": { "GetUnifiedTaxEngine": { "type": "object", "properties": { "isTestEnvironment": { "type": "boolean" }, "jsonFields": { "type": [ "object", "null" ] }, "customFieldMetas": { "type": "array", "items": { "$ref": "#/definitions/CustomFieldMeta" } }, "useAdvanceSettings": { "default": "false", "type": "boolean" }, "clientId": { "type": [ "string", "null" ] }, "voidUrl": { "type": [ "string", "null" ] }, "requestTemplate": { "type": [ "string", "null" ] }, "networkReadTimeoutInSeconds": { "type": [ "number", "null" ] }, "url": { "type": [ "string", "null" ] }, "securityToken": { "type": [ "string", "null" ] }, "password": { "type": [ "string", "null" ] }, "responseMappings": { "type": [ "object", "null" ] }, "requestHeaders": { "type": [ "object", "null" ] }, "voidTemplate": { "type": [ "string", "null" ] }, "success": { "type": "boolean" }, "vendor": { "type": "string", "enum": [ "Z-Tax", "ONESOURCE", "VertexAdvancedTax", "AvalaraForBrazil", "AvaTaxForCommunication", "VertexOSeries", "ONESOURCESOAP", "VertexAdvancedTaxSOAP", "CCHSureTax", "Sovos", "Avalara" ] }, "accessTokenUrl": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "clientSecret": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "authenticationType": { "type": "string", "enum": [ "BasicAuth", "OAuth2", "PrivateToken" ] }, "username": { "type": [ "string", "null" ] }, "networkOpenTimeoutInSeconds": { "type": [ "number", "null" ] } } }, "UnifiedTaxEngine": { "type": "object", "properties": { "isTestEnvironment": { "type": "boolean" }, "jsonFields": { "type": [ "object", "null" ] }, "customFieldMetas": { "type": [ "array", "null" ], "items": { "$ref": "#/definitions/CustomFieldMeta" } }, "useAdvanceSettings": { "default": "false", "type": "boolean" }, "clientId": { "type": [ "string", "null" ] }, "voidUrl": { "type": [ "string", "null" ] }, "requestTemplate": { "type": [ "string", "null" ] }, "networkReadTimeoutInSeconds": { "type": [ "number", "null" ] }, "url": { "type": [ "string", "null" ] }, "securityToken": { "type": [ "string", "null" ] }, "password": { "type": [ "string", "null" ] }, "responseMappings": { "type": [ "object", "null" ] }, "requestHeaders": { "type": [ "object", "null" ] }, "voidTemplate": { "type": [ "string", "null" ] }, "vendor": { "type": "string", "enum": [ "Z-Tax", "ONESOURCE", "VertexAdvancedTax", "AvalaraForBrazil", "AvaTaxForCommunication", "VertexOSeries", "ONESOURCESOAP", "VertexAdvancedTaxSOAP", "CCHSureTax", "Sovos", "Avalara" ] }, "accessTokenUrl": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "clientSecret": { "type": [ "string", "null" ] }, "authenticationType": { "type": "string", "enum": [ "BasicAuth", "OAuth2", "PrivateToken" ] }, "username": { "type": [ "string", "null" ] }, "networkOpenTimeoutInSeconds": { "type": [ "number", "null" ] } } }, "CustomFieldMeta": { "additionalProperties": false, "type": "object", "properties": { "useLatestValue": { "type": "boolean" }, "customFieldName": { "type": "string" }, "customFieldObjectType": { "type": "string" } }, "required": [ "customFieldName", "customFieldObjectType" ] }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } }, { "method": "DELETE", "url": "/settings/tax-engines/{id}", "parameters": [ { "name": "id", "description": "Unique Id of tax engine" } ], "responseType": { "$ref": "#/definitions/CommonResponse", "definitions": { "GetUnifiedTaxEngine": { "type": "object", "properties": { "isTestEnvironment": { "type": "boolean" }, "jsonFields": { "type": [ "object", "null" ] }, "customFieldMetas": { "type": "array", "items": { "$ref": "#/definitions/CustomFieldMeta" } }, "useAdvanceSettings": { "default": "false", "type": "boolean" }, "clientId": { "type": [ "string", "null" ] }, "voidUrl": { "type": [ "string", "null" ] }, "requestTemplate": { "type": [ "string", "null" ] }, "networkReadTimeoutInSeconds": { "type": [ "number", "null" ] }, "url": { "type": [ "string", "null" ] }, "securityToken": { "type": [ "string", "null" ] }, "password": { "type": [ "string", "null" ] }, "responseMappings": { "type": [ "object", "null" ] }, "requestHeaders": { "type": [ "object", "null" ] }, "voidTemplate": { "type": [ "string", "null" ] }, "success": { "type": "boolean" }, "vendor": { "type": "string", "enum": [ "Z-Tax", "ONESOURCE", "VertexAdvancedTax", "AvalaraForBrazil", "AvaTaxForCommunication", "VertexOSeries", "ONESOURCESOAP", "VertexAdvancedTaxSOAP", "CCHSureTax", "Sovos", "Avalara" ] }, "accessTokenUrl": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "clientSecret": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "authenticationType": { "type": "string", "enum": [ "BasicAuth", "OAuth2", "PrivateToken" ] }, "username": { "type": [ "string", "null" ] }, "networkOpenTimeoutInSeconds": { "type": [ "number", "null" ] } } }, "UnifiedTaxEngine": { "type": "object", "properties": { "isTestEnvironment": { "type": "boolean" }, "jsonFields": { "type": [ "object", "null" ] }, "customFieldMetas": { "type": [ "array", "null" ], "items": { "$ref": "#/definitions/CustomFieldMeta" } }, "useAdvanceSettings": { "default": "false", "type": "boolean" }, "clientId": { "type": [ "string", "null" ] }, "voidUrl": { "type": [ "string", "null" ] }, "requestTemplate": { "type": [ "string", "null" ] }, "networkReadTimeoutInSeconds": { "type": [ "number", "null" ] }, "url": { "type": [ "string", "null" ] }, "securityToken": { "type": [ "string", "null" ] }, "password": { "type": [ "string", "null" ] }, "responseMappings": { "type": [ "object", "null" ] }, "requestHeaders": { "type": [ "object", "null" ] }, "voidTemplate": { "type": [ "string", "null" ] }, "vendor": { "type": "string", "enum": [ "Z-Tax", "ONESOURCE", "VertexAdvancedTax", "AvalaraForBrazil", "AvaTaxForCommunication", "VertexOSeries", "ONESOURCESOAP", "VertexAdvancedTaxSOAP", "CCHSureTax", "Sovos", "Avalara" ] }, "accessTokenUrl": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "clientSecret": { "type": [ "string", "null" ] }, "authenticationType": { "type": "string", "enum": [ "BasicAuth", "OAuth2", "PrivateToken" ] }, "username": { "type": [ "string", "null" ] }, "networkOpenTimeoutInSeconds": { "type": [ "number", "null" ] } } }, "CustomFieldMeta": { "additionalProperties": false, "type": "object", "properties": { "useLatestValue": { "type": "boolean" }, "customFieldName": { "type": "string" }, "customFieldObjectType": { "type": "string" } }, "required": [ "customFieldName", "customFieldObjectType" ] }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ] }, { "key": "AllTaxEngines", "description": "setting to read all tax engines", "context": "Entity", "pathPattern": "/tax-engines", "httpOperations": [ { "method": "GET", "url": "/settings/tax-engines", "parameters": [], "responseType": { "type": "object", "properties": { "taxEngines": { "type": "array", "items": { "$ref": "#/definitions/TaxEngine" } } }, "definitions": { "GetUnifiedTaxEngine": { "type": "object", "properties": { "isTestEnvironment": { "type": "boolean" }, "customFieldMetas": { "type": "array", "items": { "$ref": "#/definitions/CustomFieldMeta" } }, "useAdvanceSettings": { "default": "false", "type": "boolean" }, "clientId": { "type": [ "string", "null" ] }, "voidUrl": { "type": [ "string", "null" ] }, "requestTemplate": { "type": [ "string", "null" ] }, "networkReadTimeoutInSeconds": { "type": [ "number", "null" ] }, "url": { "type": [ "string", "null" ] }, "securityToken": { "type": [ "string", "null" ] }, "password": { "type": [ "string", "null" ] }, "responseMappings": { "type": [ "object", "null" ] }, "requestHeaders": { "type": [ "object", "null" ] }, "voidTemplate": { "type": [ "string", "null" ] }, "success": { "type": "boolean" }, "vendor": { "type": "string", "enum": [ "Z-Tax", "ONESOURCE", "VertexAdvancedTax", "AvalaraForBrazil", "AvaTaxForCommunication", "VertexOSeries", "ONESOURCESOAP", "VertexAdvancedTaxSOAP", "CCHSureTax", "Sovos", "Avalara" ] }, "accessTokenUrl": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "clientSecret": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "authenticationType": { "type": "string", "enum": [ "BasicAuth", "OAuth2", "PrivateToken" ] }, "username": { "type": [ "string", "null" ] }, "networkOpenTimeoutInSeconds": { "type": [ "number", "null" ] } } }, "TaxEngine": { "additionalProperties": false, "type": "object", "properties": { "customFieldMetas": { "type": "array", "items": { "$ref": "#/definitions/CustomFieldMeta" } }, "voidUrl": { "type": [ "string", "null" ] }, "oauthScope": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "updatedDate": { "type": "string" }, "password": { "type": [ "string", "null" ] }, "voidTemplate": { "type": [ "string", "null" ] }, "vendor": { "type": "string", "enum": [ "AvalaraTelco", "AvalaraBrazil", "AvaTax", "Vertex_SOAP", "OneSource_SOAP", "Vertex_REST", "Anrok", "Taxamo", "SureTax_REST", "SureTax_SOAP", "SovosTaxware", "OneSource_REST" ] }, "accessTokenUrl": { "type": [ "string", "null" ] }, "clientSecret": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "networkOpenTimeoutInSeconds": { "type": [ "number", "null" ] }, "jsonFields": { "type": [ "object", "null" ] }, "clientId": { "type": [ "string", "null" ] }, "updatedBy": { "type": [ "string", "null" ] }, "requestTemplate": { "type": [ "string", "null" ] }, "networkReadTimeoutInSeconds": { "type": [ "number", "null" ] }, "accountNumber": { "type": "string" }, "sellerInfo": { "type": "object" }, "taxEngineType": { "type": "string", "enum": [ "Z_Tax", "Avalara", "ConnectTaxEngine", "GlobalTaxHub" ] }, "url": { "type": [ "string", "null" ] }, "securityToken": { "type": [ "string", "null" ] }, "responseMappings": { "type": [ "object", "null" ] }, "requestHeaders": { "type": [ "object", "null" ] }, "createdDate": { "type": "string" }, "isTest": { "type": "boolean" }, "createdBy": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "authenticationType": { "type": "string", "enum": [ "BasicAuth", "OAuth2", "PrivateToken" ] }, "username": { "type": [ "string", "null" ] } } }, "UnifiedTaxEngine": { "type": "object", "properties": { "isTestEnvironment": { "type": "boolean" }, "jsonFields": { "type": [ "object", "null" ] }, "customFieldMetas": { "type": [ "array", "null" ], "items": { "$ref": "#/definitions/CustomFieldMeta" } }, "useAdvanceSettings": { "default": "false", "type": "boolean" }, "clientId": { "type": [ "string", "null" ] }, "voidUrl": { "type": [ "string", "null" ] }, "requestTemplate": { "type": [ "string", "null" ] }, "networkReadTimeoutInSeconds": { "type": [ "number", "null" ] }, "url": { "type": [ "string", "null" ] }, "securityToken": { "type": [ "string", "null" ] }, "password": { "type": [ "string", "null" ] }, "responseMappings": { "type": [ "object", "null" ] }, "requestHeaders": { "type": [ "object", "null" ] }, "voidTemplate": { "type": [ "string", "null" ] }, "vendor": { "type": "string", "enum": [ "Z-Tax", "ONESOURCE", "VertexAdvancedTax", "AvalaraForBrazil", "AvaTaxForCommunication", "VertexOSeries", "ONESOURCESOAP", "VertexAdvancedTaxSOAP", "CCHSureTax", "Sovos", "Avalara" ] }, "accessTokenUrl": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "clientSecret": { "type": [ "string", "null" ] }, "authenticationType": { "type": "string", "enum": [ "BasicAuth", "OAuth2", "PrivateToken" ] }, "username": { "type": [ "string", "null" ] }, "networkOpenTimeoutInSeconds": { "type": [ "number", "null" ] } } }, "CustomFieldMeta": { "additionalProperties": false, "type": "object", "properties": { "useLatestValue": { "type": "boolean" }, "customFieldName": { "type": "string" }, "customFieldObjectType": { "type": "string" } }, "required": [ "customFieldName", "customFieldObjectType" ] } } } }, { "method": "POST", "url": "/settings/tax-engines", "parameters": [], "requestType": { "$ref": "#/definitions/UnifiedTaxEngine", "definitions": { "GetUnifiedTaxEngine": { "type": "object", "properties": { "isTestEnvironment": { "type": "boolean" }, "customFieldMetas": { "type": "array", "items": { "$ref": "#/definitions/CustomFieldMeta" } }, "useAdvanceSettings": { "default": "false", "type": "boolean" }, "clientId": { "type": [ "string", "null" ] }, "voidUrl": { "type": [ "string", "null" ] }, "requestTemplate": { "type": [ "string", "null" ] }, "networkReadTimeoutInSeconds": { "type": [ "number", "null" ] }, "url": { "type": [ "string", "null" ] }, "securityToken": { "type": [ "string", "null" ] }, "password": { "type": [ "string", "null" ] }, "responseMappings": { "type": [ "object", "null" ] }, "requestHeaders": { "type": [ "object", "null" ] }, "voidTemplate": { "type": [ "string", "null" ] }, "success": { "type": "boolean" }, "vendor": { "type": "string", "enum": [ "Z-Tax", "ONESOURCE", "VertexAdvancedTax", "AvalaraForBrazil", "AvaTaxForCommunication", "VertexOSeries", "ONESOURCESOAP", "VertexAdvancedTaxSOAP", "CCHSureTax", "Sovos", "Avalara" ] }, "accessTokenUrl": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "clientSecret": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "authenticationType": { "type": "string", "enum": [ "BasicAuth", "OAuth2", "PrivateToken" ] }, "username": { "type": [ "string", "null" ] }, "networkOpenTimeoutInSeconds": { "type": [ "number", "null" ] } } }, "TaxEngine": { "additionalProperties": false, "type": "object", "properties": { "customFieldMetas": { "type": "array", "items": { "$ref": "#/definitions/CustomFieldMeta" } }, "voidUrl": { "type": [ "string", "null" ] }, "oauthScope": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "updatedDate": { "type": "string" }, "password": { "type": [ "string", "null" ] }, "voidTemplate": { "type": [ "string", "null" ] }, "vendor": { "type": "string", "enum": [ "AvalaraTelco", "AvalaraBrazil", "AvaTax", "Vertex_SOAP", "OneSource_SOAP", "Vertex_REST", "Anrok", "Taxamo", "SureTax_REST", "SureTax_SOAP", "SovosTaxware", "OneSource_REST" ] }, "accessTokenUrl": { "type": [ "string", "null" ] }, "clientSecret": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "networkOpenTimeoutInSeconds": { "type": [ "number", "null" ] }, "jsonFields": { "type": [ "object", "null" ] }, "clientId": { "type": [ "string", "null" ] }, "updatedBy": { "type": [ "string", "null" ] }, "requestTemplate": { "type": [ "string", "null" ] }, "networkReadTimeoutInSeconds": { "type": [ "number", "null" ] }, "accountNumber": { "type": "string" }, "sellerInfo": { "type": "object" }, "taxEngineType": { "type": "string", "enum": [ "Z_Tax", "Avalara", "ConnectTaxEngine", "GlobalTaxHub" ] }, "url": { "type": [ "string", "null" ] }, "securityToken": { "type": [ "string", "null" ] }, "responseMappings": { "type": [ "object", "null" ] }, "requestHeaders": { "type": [ "object", "null" ] }, "createdDate": { "type": "string" }, "isTest": { "type": "boolean" }, "createdBy": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "authenticationType": { "type": "string", "enum": [ "BasicAuth", "OAuth2", "PrivateToken" ] }, "username": { "type": [ "string", "null" ] } } }, "UnifiedTaxEngine": { "type": "object", "properties": { "isTestEnvironment": { "type": "boolean" }, "jsonFields": { "type": [ "object", "null" ] }, "customFieldMetas": { "type": [ "array", "null" ], "items": { "$ref": "#/definitions/CustomFieldMeta" } }, "useAdvanceSettings": { "default": "false", "type": "boolean" }, "clientId": { "type": [ "string", "null" ] }, "voidUrl": { "type": [ "string", "null" ] }, "requestTemplate": { "type": [ "string", "null" ] }, "networkReadTimeoutInSeconds": { "type": [ "number", "null" ] }, "url": { "type": [ "string", "null" ] }, "securityToken": { "type": [ "string", "null" ] }, "password": { "type": [ "string", "null" ] }, "responseMappings": { "type": [ "object", "null" ] }, "requestHeaders": { "type": [ "object", "null" ] }, "voidTemplate": { "type": [ "string", "null" ] }, "vendor": { "type": "string", "enum": [ "Z-Tax", "ONESOURCE", "VertexAdvancedTax", "AvalaraForBrazil", "AvaTaxForCommunication", "VertexOSeries", "ONESOURCESOAP", "VertexAdvancedTaxSOAP", "CCHSureTax", "Sovos", "Avalara" ] }, "accessTokenUrl": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "clientSecret": { "type": [ "string", "null" ] }, "authenticationType": { "type": "string", "enum": [ "BasicAuth", "OAuth2", "PrivateToken" ] }, "username": { "type": [ "string", "null" ] }, "networkOpenTimeoutInSeconds": { "type": [ "number", "null" ] } } }, "CustomFieldMeta": { "additionalProperties": false, "type": "object", "properties": { "useLatestValue": { "type": "boolean" }, "customFieldName": { "type": "string" }, "customFieldObjectType": { "type": "string" } }, "required": [ "customFieldName", "customFieldObjectType" ] } } }, "responseType": { "$ref": "#/definitions/GetUnifiedTaxEngine", "definitions": { "GetUnifiedTaxEngine": { "type": "object", "properties": { "isTestEnvironment": { "type": "boolean" }, "customFieldMetas": { "type": "array", "items": { "$ref": "#/definitions/CustomFieldMeta" } }, "useAdvanceSettings": { "default": "false", "type": "boolean" }, "clientId": { "type": [ "string", "null" ] }, "voidUrl": { "type": [ "string", "null" ] }, "requestTemplate": { "type": [ "string", "null" ] }, "networkReadTimeoutInSeconds": { "type": [ "number", "null" ] }, "url": { "type": [ "string", "null" ] }, "securityToken": { "type": [ "string", "null" ] }, "password": { "type": [ "string", "null" ] }, "responseMappings": { "type": [ "object", "null" ] }, "requestHeaders": { "type": [ "object", "null" ] }, "voidTemplate": { "type": [ "string", "null" ] }, "success": { "type": "boolean" }, "vendor": { "type": "string", "enum": [ "Z-Tax", "ONESOURCE", "VertexAdvancedTax", "AvalaraForBrazil", "AvaTaxForCommunication", "VertexOSeries", "ONESOURCESOAP", "VertexAdvancedTaxSOAP", "CCHSureTax", "Sovos", "Avalara" ] }, "accessTokenUrl": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "clientSecret": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "authenticationType": { "type": "string", "enum": [ "BasicAuth", "OAuth2", "PrivateToken" ] }, "username": { "type": [ "string", "null" ] }, "networkOpenTimeoutInSeconds": { "type": [ "number", "null" ] } } }, "TaxEngine": { "additionalProperties": false, "type": "object", "properties": { "customFieldMetas": { "type": "array", "items": { "$ref": "#/definitions/CustomFieldMeta" } }, "voidUrl": { "type": [ "string", "null" ] }, "oauthScope": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "updatedDate": { "type": "string" }, "password": { "type": [ "string", "null" ] }, "voidTemplate": { "type": [ "string", "null" ] }, "vendor": { "type": "string", "enum": [ "AvalaraTelco", "AvalaraBrazil", "AvaTax", "Vertex_SOAP", "OneSource_SOAP", "Vertex_REST", "Anrok", "Taxamo", "SureTax_REST", "SureTax_SOAP", "SovosTaxware", "OneSource_REST" ] }, "accessTokenUrl": { "type": [ "string", "null" ] }, "clientSecret": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "networkOpenTimeoutInSeconds": { "type": [ "number", "null" ] }, "jsonFields": { "type": [ "object", "null" ] }, "clientId": { "type": [ "string", "null" ] }, "updatedBy": { "type": [ "string", "null" ] }, "requestTemplate": { "type": [ "string", "null" ] }, "networkReadTimeoutInSeconds": { "type": [ "number", "null" ] }, "accountNumber": { "type": "string" }, "sellerInfo": { "type": "object" }, "taxEngineType": { "type": "string", "enum": [ "Z_Tax", "Avalara", "ConnectTaxEngine", "GlobalTaxHub" ] }, "url": { "type": [ "string", "null" ] }, "securityToken": { "type": [ "string", "null" ] }, "responseMappings": { "type": [ "object", "null" ] }, "requestHeaders": { "type": [ "object", "null" ] }, "createdDate": { "type": "string" }, "isTest": { "type": "boolean" }, "createdBy": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "authenticationType": { "type": "string", "enum": [ "BasicAuth", "OAuth2", "PrivateToken" ] }, "username": { "type": [ "string", "null" ] } } }, "UnifiedTaxEngine": { "type": "object", "properties": { "isTestEnvironment": { "type": "boolean" }, "jsonFields": { "type": [ "object", "null" ] }, "customFieldMetas": { "type": [ "array", "null" ], "items": { "$ref": "#/definitions/CustomFieldMeta" } }, "useAdvanceSettings": { "default": "false", "type": "boolean" }, "clientId": { "type": [ "string", "null" ] }, "voidUrl": { "type": [ "string", "null" ] }, "requestTemplate": { "type": [ "string", "null" ] }, "networkReadTimeoutInSeconds": { "type": [ "number", "null" ] }, "url": { "type": [ "string", "null" ] }, "securityToken": { "type": [ "string", "null" ] }, "password": { "type": [ "string", "null" ] }, "responseMappings": { "type": [ "object", "null" ] }, "requestHeaders": { "type": [ "object", "null" ] }, "voidTemplate": { "type": [ "string", "null" ] }, "vendor": { "type": "string", "enum": [ "Z-Tax", "ONESOURCE", "VertexAdvancedTax", "AvalaraForBrazil", "AvaTaxForCommunication", "VertexOSeries", "ONESOURCESOAP", "VertexAdvancedTaxSOAP", "CCHSureTax", "Sovos", "Avalara" ] }, "accessTokenUrl": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "clientSecret": { "type": [ "string", "null" ] }, "authenticationType": { "type": "string", "enum": [ "BasicAuth", "OAuth2", "PrivateToken" ] }, "username": { "type": [ "string", "null" ] }, "networkOpenTimeoutInSeconds": { "type": [ "number", "null" ] } } }, "CustomFieldMeta": { "additionalProperties": false, "type": "object", "properties": { "useLatestValue": { "type": "boolean" }, "customFieldName": { "type": "string" }, "customFieldObjectType": { "type": "string" } }, "required": [ "customFieldName", "customFieldObjectType" ] } } } } ] }, { "key": "CreateAvalaraTaxEngine", "description": "Setting for Avalara tax engine", "context": "Entity", "pathPattern": "/tax-engines/avalara", "httpOperations": [ { "method": "POST", "url": "/settings/tax-engines/avalara", "parameters": [], "requestType": { "$ref": "#/definitions/AvalaraTaxEngine", "definitions": { "AvalaraTaxEngine": { "type": "object", "properties": { "licenseKey": { "type": "string" }, "password": { "type": "string" }, "isTest": { "type": "boolean" }, "name": { "type": "string" }, "accountNumber": { "type": "string" }, "taxEngineType": { "type": "string", "enum": [ "Avalara" ] }, "username": { "type": "string" } } }, "GetAvalaraTaxEngine": { "type": "object", "properties": { "isTest": { "type": "boolean" }, "name": { "type": "string" }, "id": { "type": "string" }, "accountNumber": { "type": "string" }, "taxEngineType": { "type": "string", "enum": [ "Avalara" ] }, "username": { "type": "string" } } } } }, "responseType": { "$ref": "#/definitions/GetAvalaraTaxEngine", "definitions": { "AvalaraTaxEngine": { "type": "object", "properties": { "licenseKey": { "type": "string" }, "password": { "type": "string" }, "isTest": { "type": "boolean" }, "name": { "type": "string" }, "accountNumber": { "type": "string" }, "taxEngineType": { "type": "string", "enum": [ "Avalara" ] }, "username": { "type": "string" } } }, "GetAvalaraTaxEngine": { "type": "object", "properties": { "isTest": { "type": "boolean" }, "name": { "type": "string" }, "id": { "type": "string" }, "accountNumber": { "type": "string" }, "taxEngineType": { "type": "string", "enum": [ "Avalara" ] }, "username": { "type": "string" } } } } } } ] }, { "key": "AvalaraTaxEngine", "description": "Setting for Avalara tax engine", "context": "Entity", "pathPattern": "/tax-engines/avalara/{id}", "httpOperations": [ { "method": "GET", "url": "/settings/tax-engines/avalara/{id}", "parameters": [ { "name": "id", "description": "Unique Id of avalara tax engine" } ], "responseType": { "$ref": "#/definitions/GetAvalaraTaxEngine", "definitions": { "AvalaraTaxEngine": { "type": "object", "properties": { "licenseKey": { "type": "string" }, "password": { "type": "string" }, "isTest": { "type": "boolean" }, "name": { "type": "string" }, "accountNumber": { "type": "string" }, "taxEngineType": { "type": "string", "enum": [ "Avalara" ] }, "username": { "type": "string" } } }, "GetAvalaraTaxEngine": { "type": "object", "properties": { "isTest": { "type": "boolean" }, "name": { "type": "string" }, "id": { "type": "string" }, "accountNumber": { "type": "string" }, "taxEngineType": { "type": "string", "enum": [ "Avalara" ] }, "username": { "type": "string" } } } } } }, { "method": "PUT", "url": "/settings/tax-engines/avalara/{id}", "parameters": [ { "name": "id", "description": "Unique Id of avalara tax engine" } ], "requestType": { "$ref": "#/definitions/AvalaraTaxEngine", "definitions": { "AvalaraTaxEngine": { "type": "object", "properties": { "licenseKey": { "type": "string" }, "password": { "type": "string" }, "isTest": { "type": "boolean" }, "name": { "type": "string" }, "accountNumber": { "type": "string" }, "taxEngineType": { "type": "string", "enum": [ "Avalara" ] }, "username": { "type": "string" } } }, "GetAvalaraTaxEngine": { "type": "object", "properties": { "isTest": { "type": "boolean" }, "name": { "type": "string" }, "id": { "type": "string" }, "accountNumber": { "type": "string" }, "taxEngineType": { "type": "string", "enum": [ "Avalara" ] }, "username": { "type": "string" } } } } }, "responseType": { "$ref": "#/definitions/GetAvalaraTaxEngine", "definitions": { "AvalaraTaxEngine": { "type": "object", "properties": { "licenseKey": { "type": "string" }, "password": { "type": "string" }, "isTest": { "type": "boolean" }, "name": { "type": "string" }, "accountNumber": { "type": "string" }, "taxEngineType": { "type": "string", "enum": [ "Avalara" ] }, "username": { "type": "string" } } }, "GetAvalaraTaxEngine": { "type": "object", "properties": { "isTest": { "type": "boolean" }, "name": { "type": "string" }, "id": { "type": "string" }, "accountNumber": { "type": "string" }, "taxEngineType": { "type": "string", "enum": [ "Avalara" ] }, "username": { "type": "string" } } } } } } ] }, { "key": "CreateConnectorTaxEngine", "description": "Setting for connector tax engine", "context": "Entity", "pathPattern": "/tax-engines/connector", "httpOperations": [ { "method": "POST", "url": "/settings/tax-engines/connector", "parameters": [], "requestType": { "$ref": "#/definitions/ConnectorTaxEngine", "definitions": { "ConnectorTaxEngine": { "additionalProperties": false, "type": "object", "properties": { "password": { "type": "string" }, "customFieldMetas": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/CustomFieldMeta" } }, "name": { "type": "string" }, "taxEngineType": { "type": "string", "enum": [ "ConnectTaxEngine" ] } }, "required": [ "name", "taxEngineType", "password" ] }, "CustomFieldMeta": { "additionalProperties": false, "type": "object", "properties": { "useLatestValue": { "type": "boolean" }, "customFieldName": { "type": "string" }, "customFieldObjectType": { "type": "string" } }, "required": [ "customFieldName", "customFieldObjectType" ] }, "GetConnectorTaxEngine": { "type": "object", "properties": { "customFieldMetas": { "type": "array", "items": { "$ref": "#/definitions/CustomFieldMeta" } }, "name": { "type": "string" }, "id": { "type": "string" }, "taxEngineType": { "type": "string", "enum": [ "ConnectTaxEngine" ] } } } } }, "responseType": { "$ref": "#/definitions/GetConnectorTaxEngine", "definitions": { "ConnectorTaxEngine": { "additionalProperties": false, "type": "object", "properties": { "password": { "type": "string" }, "customFieldMetas": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/CustomFieldMeta" } }, "name": { "type": "string" }, "taxEngineType": { "type": "string", "enum": [ "ConnectTaxEngine" ] } }, "required": [ "name", "taxEngineType", "password" ] }, "CustomFieldMeta": { "additionalProperties": false, "type": "object", "properties": { "useLatestValue": { "type": "boolean" }, "customFieldName": { "type": "string" }, "customFieldObjectType": { "type": "string" } }, "required": [ "customFieldName", "customFieldObjectType" ] }, "GetConnectorTaxEngine": { "type": "object", "properties": { "customFieldMetas": { "type": "array", "items": { "$ref": "#/definitions/CustomFieldMeta" } }, "name": { "type": "string" }, "id": { "type": "string" }, "taxEngineType": { "type": "string", "enum": [ "ConnectTaxEngine" ] } } } } } } ] }, { "key": "ConnectorTaxEngine", "description": "Setting for connector tax engine", "context": "Entity", "pathPattern": "/tax-engines/connector/{id}", "httpOperations": [ { "method": "GET", "url": "/settings/tax-engines/connector/{id}", "parameters": [ { "name": "id", "description": "Unique Id of connector tax engine" } ], "responseType": { "$ref": "#/definitions/GetConnectorTaxEngine", "definitions": { "ConnectorTaxEngine": { "type": "object", "properties": { "password": { "type": "string" }, "customFieldMetas": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/CustomFieldMeta" } }, "name": { "type": "string" } } }, "CustomFieldMeta": { "type": "object", "properties": { "useLatestValue": { "type": "boolean" }, "customFieldName": { "type": "string" }, "customFieldObjectType": { "type": "string" } }, "required": [ "customFieldName", "customFieldObjectType" ] }, "GetConnectorTaxEngine": { "type": "object", "properties": { "customFieldMetas": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/CustomFieldMeta" } }, "name": { "type": "string" }, "id": { "type": "string" }, "taxEngineType": { "type": "string", "enum": [ "ConnectTaxEngine" ] } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } }, { "method": "PUT", "url": "/settings/tax-engines/connector/{id}", "parameters": [ { "name": "id", "description": "Unique Id of connector tax engine" } ], "requestType": { "$ref": "#/definitions/ConnectorTaxEngine", "definitions": { "ConnectorTaxEngine": { "type": "object", "properties": { "password": { "type": "string" }, "customFieldMetas": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/CustomFieldMeta" } }, "name": { "type": "string" } } }, "CustomFieldMeta": { "type": "object", "properties": { "useLatestValue": { "type": "boolean" }, "customFieldName": { "type": "string" }, "customFieldObjectType": { "type": "string" } }, "required": [ "customFieldName", "customFieldObjectType" ] }, "GetConnectorTaxEngine": { "type": "object", "properties": { "customFieldMetas": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/CustomFieldMeta" } }, "name": { "type": "string" }, "id": { "type": "string" }, "taxEngineType": { "type": "string", "enum": [ "ConnectTaxEngine" ] } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } } } }, "responseType": { "$ref": "#/definitions/GetConnectorTaxEngine", "definitions": { "ConnectorTaxEngine": { "type": "object", "properties": { "password": { "type": "string" }, "customFieldMetas": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/CustomFieldMeta" } }, "name": { "type": "string" } } }, "CustomFieldMeta": { "type": "object", "properties": { "useLatestValue": { "type": "boolean" }, "customFieldName": { "type": "string" }, "customFieldObjectType": { "type": "string" } }, "required": [ "customFieldName", "customFieldObjectType" ] }, "GetConnectorTaxEngine": { "type": "object", "properties": { "customFieldMetas": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/CustomFieldMeta" } }, "name": { "type": "string" }, "id": { "type": "string" }, "taxEngineType": { "type": "string", "enum": [ "ConnectTaxEngine" ] } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } }, { "method": "DELETE", "url": "/settings/tax-engines/connector/{id}", "parameters": [ { "name": "id", "description": "Unique Id of connector tax engine" } ], "responseType": { "$ref": "#/definitions/CommonResponse", "definitions": { "ConnectorTaxEngine": { "type": "object", "properties": { "password": { "type": "string" }, "customFieldMetas": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/CustomFieldMeta" } }, "name": { "type": "string" } } }, "CustomFieldMeta": { "type": "object", "properties": { "useLatestValue": { "type": "boolean" }, "customFieldName": { "type": "string" }, "customFieldObjectType": { "type": "string" } }, "required": [ "customFieldName", "customFieldObjectType" ] }, "GetConnectorTaxEngine": { "type": "object", "properties": { "customFieldMetas": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/CustomFieldMeta" } }, "name": { "type": "string" }, "id": { "type": "string" }, "taxEngineType": { "type": "string", "enum": [ "ConnectTaxEngine" ] } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ] }, { "key": "CreateGlobalTaxHubTaxEngine", "description": "Setting for global tax hub tax engine", "context": "Entity", "pathPattern": "/tax-engines/global-tax-hub", "httpOperations": [ { "method": "POST", "url": "/settings/tax-engines/global-tax-hub", "parameters": [], "requestType": { "$ref": "#/definitions/GlobalTaxHubTaxEngine", "definitions": { "CustomFieldMeta": { "type": "object", "properties": { "useLatestValue": { "type": "boolean" }, "customFieldName": { "type": "string" }, "customFieldObjectType": { "type": "string" } } }, "GetGlobalTaxHubTaxEngine": { "type": "object", "properties": { "jsonFields": { "type": "object" }, "customFieldMetas": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/CustomFieldMeta" } }, "clientId": { "type": "string" }, "voidUrl": { "type": "string" }, "requestTemplate": { "type": "string" }, "oauthScope": { "type": [ "string", "null" ] }, "networkReadTimeoutInSeconds": { "type": "number" }, "sellerInfo": { "type": "object" }, "taxEngineType": { "type": "string", "enum": [ "ConnectTaxEngine", "GlobalTaxHub" ] }, "url": { "type": "string" }, "responseMappings": { "type": "object" }, "requestHeaders": { "type": "object" }, "voidTemplate": { "type": [ "string", "null" ] }, "vendor": { "type": "string", "enum": [ "AvalaraTelco", "AvalaraBrazil", "AvaTax", "Vertex_SOAP", "OneSource_SOAP", "Vertex_REST", "Anrok", "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" } } }, "GlobalTaxHubTaxEngine": { "additionalProperties": false, "type": "object", "properties": { "jsonFields": { "type": "object" }, "customFieldMetas": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/CustomFieldMeta" } }, "clientId": { "type": "string" }, "voidUrl": { "type": "string" }, "requestTemplate": { "type": "string" }, "oauthScope": { "type": [ "string", "null" ] }, "networkReadTimeoutInSeconds": { "type": "number" }, "sellerInfo": { "type": "object" }, "taxEngineType": { "type": "string", "enum": [ "ConnectTaxEngine", "GlobalTaxHub" ] }, "url": { "type": "string" }, "securityToken": { "type": "string" }, "password": { "type": "string" }, "responseMappings": { "type": "object" }, "requestHeaders": { "type": "object" }, "voidTemplate": { "type": [ "string", "null" ] }, "vendor": { "type": "string", "enum": [ "AvalaraTelco", "AvalaraBrazil", "AvaTax", "Vertex_SOAP", "OneSource_SOAP", "Vertex_REST", "Anrok", "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" } }, "required": [ "name", "taxEngineType", "vendor", "authenticationType", "url" ] } } }, "responseType": { "$ref": "#/definitions/GetGlobalTaxHubTaxEngine", "definitions": { "CustomFieldMeta": { "type": "object", "properties": { "useLatestValue": { "type": "boolean" }, "customFieldName": { "type": "string" }, "customFieldObjectType": { "type": "string" } } }, "GetGlobalTaxHubTaxEngine": { "type": "object", "properties": { "jsonFields": { "type": "object" }, "customFieldMetas": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/CustomFieldMeta" } }, "clientId": { "type": "string" }, "voidUrl": { "type": "string" }, "requestTemplate": { "type": "string" }, "oauthScope": { "type": [ "string", "null" ] }, "networkReadTimeoutInSeconds": { "type": "number" }, "sellerInfo": { "type": "object" }, "taxEngineType": { "type": "string", "enum": [ "ConnectTaxEngine", "GlobalTaxHub" ] }, "url": { "type": "string" }, "responseMappings": { "type": "object" }, "requestHeaders": { "type": "object" }, "voidTemplate": { "type": [ "string", "null" ] }, "vendor": { "type": "string", "enum": [ "AvalaraTelco", "AvalaraBrazil", "AvaTax", "Vertex_SOAP", "OneSource_SOAP", "Vertex_REST", "Anrok", "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" } } }, "GlobalTaxHubTaxEngine": { "additionalProperties": false, "type": "object", "properties": { "jsonFields": { "type": "object" }, "customFieldMetas": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/CustomFieldMeta" } }, "clientId": { "type": "string" }, "voidUrl": { "type": "string" }, "requestTemplate": { "type": "string" }, "oauthScope": { "type": [ "string", "null" ] }, "networkReadTimeoutInSeconds": { "type": "number" }, "sellerInfo": { "type": "object" }, "taxEngineType": { "type": "string", "enum": [ "ConnectTaxEngine", "GlobalTaxHub" ] }, "url": { "type": "string" }, "securityToken": { "type": "string" }, "password": { "type": "string" }, "responseMappings": { "type": "object" }, "requestHeaders": { "type": "object" }, "voidTemplate": { "type": [ "string", "null" ] }, "vendor": { "type": "string", "enum": [ "AvalaraTelco", "AvalaraBrazil", "AvaTax", "Vertex_SOAP", "OneSource_SOAP", "Vertex_REST", "Anrok", "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" } }, "required": [ "name", "taxEngineType", "vendor", "authenticationType", "url" ] } } } } ] }, { "key": "GlobalTaxHubTaxEngine", "description": "Setting for global tax hub tax engine", "context": "Entity", "pathPattern": "/tax-engines/global-tax-hub/{id}", "httpOperations": [ { "method": "GET", "url": "/settings/tax-engines/global-tax-hub/{id}", "parameters": [ { "name": "id", "description": "Unique Id of global tax hub tax engine" } ], "responseType": { "$ref": "#/definitions/GetGlobalTaxHubTaxEngine", "definitions": { "CustomFieldMeta": { "type": "object", "properties": { "useLatestValue": { "type": "boolean" }, "customFieldName": { "type": "string" }, "customFieldObjectType": { "type": "string" } } }, "GetGlobalTaxHubTaxEngine": { "type": "object", "properties": { "jsonFields": { "type": "object" }, "customFieldMetas": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/CustomFieldMeta" } }, "clientId": { "type": "string" }, "voidUrl": { "type": "string" }, "requestTemplate": { "type": "string" }, "oauthScope": { "type": [ "string", "null" ] }, "networkReadTimeoutInSeconds": { "type": "number" }, "sellerInfo": { "type": "object" }, "taxEngineType": { "type": "string", "enum": [ "ConnectTaxEngine", "GlobalTaxHub" ] }, "url": { "type": "string" }, "responseMappings": { "type": "object" }, "requestHeaders": { "type": "object" }, "voidTemplate": { "type": [ "string", "null" ] }, "vendor": { "type": "string", "enum": [ "AvalaraTelco", "AvalaraBrazil", "AvaTax", "Vertex_SOAP", "OneSource_SOAP", "Vertex_REST", "Anrok", "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" } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } }, "GlobalTaxHubTaxEngine": { "additionalProperties": false, "type": "object", "properties": { "jsonFields": { "type": "object" }, "customFieldMetas": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/CustomFieldMeta" } }, "clientId": { "type": "string" }, "voidUrl": { "type": "string" }, "requestTemplate": { "type": "string" }, "oauthScope": { "type": [ "string", "null" ] }, "networkReadTimeoutInSeconds": { "type": "number" }, "sellerInfo": { "type": "object" }, "taxEngineType": { "type": "string", "enum": [ "ConnectTaxEngine", "GlobalTaxHub" ] }, "url": { "type": "string" }, "securityToken": { "type": "string" }, "password": { "type": "string" }, "responseMappings": { "type": "object" }, "requestHeaders": { "type": "object" }, "voidTemplate": { "type": [ "string", "null" ] }, "vendor": { "type": "string", "enum": [ "AvalaraTelco", "AvalaraBrazil", "AvaTax", "Vertex_SOAP", "OneSource_SOAP", "Vertex_REST", "Anrok", "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" } }, "required": [ "name", "taxEngineType", "vendor", "authenticationType", "url" ] }, "PutGlobalTaxHubTaxEngine": { "additionalProperties": false, "type": "object", "properties": { "jsonFields": { "type": "object" }, "customFieldMetas": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/CustomFieldMeta" } }, "clientId": { "type": "string" }, "voidUrl": { "type": "string" }, "requestTemplate": { "type": "string" }, "oauthScope": { "type": [ "string", "null" ] }, "networkReadTimeoutInSeconds": { "type": "number" }, "sellerInfo": { "type": "object" }, "url": { "type": "string" }, "securityToken": { "type": "string" }, "password": { "type": "string" }, "responseMappings": { "type": "object" }, "requestHeaders": { "type": "object" }, "voidTemplate": { "type": [ "string", "null" ] }, "vendor": { "type": "string", "enum": [ "AvalaraTelco", "AvalaraBrazil", "AvaTax", "Vertex_SOAP", "OneSource_SOAP", "Vertex_REST", "Anrok", "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" } } } } } }, { "method": "PUT", "url": "/settings/tax-engines/global-tax-hub/{id}", "parameters": [ { "name": "id", "description": "Unique Id of global tax hub tax engine" } ], "requestType": { "$ref": "#/definitions/PutGlobalTaxHubTaxEngine", "definitions": { "CustomFieldMeta": { "type": "object", "properties": { "useLatestValue": { "type": "boolean" }, "customFieldName": { "type": "string" }, "customFieldObjectType": { "type": "string" } } }, "GetGlobalTaxHubTaxEngine": { "type": "object", "properties": { "jsonFields": { "type": "object" }, "customFieldMetas": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/CustomFieldMeta" } }, "clientId": { "type": "string" }, "voidUrl": { "type": "string" }, "requestTemplate": { "type": "string" }, "oauthScope": { "type": [ "string", "null" ] }, "networkReadTimeoutInSeconds": { "type": "number" }, "sellerInfo": { "type": "object" }, "taxEngineType": { "type": "string", "enum": [ "ConnectTaxEngine", "GlobalTaxHub" ] }, "url": { "type": "string" }, "responseMappings": { "type": "object" }, "requestHeaders": { "type": "object" }, "voidTemplate": { "type": [ "string", "null" ] }, "vendor": { "type": "string", "enum": [ "AvalaraTelco", "AvalaraBrazil", "AvaTax", "Vertex_SOAP", "OneSource_SOAP", "Vertex_REST", "Anrok", "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" } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } }, "GlobalTaxHubTaxEngine": { "additionalProperties": false, "type": "object", "properties": { "jsonFields": { "type": "object" }, "customFieldMetas": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/CustomFieldMeta" } }, "clientId": { "type": "string" }, "voidUrl": { "type": "string" }, "requestTemplate": { "type": "string" }, "oauthScope": { "type": [ "string", "null" ] }, "networkReadTimeoutInSeconds": { "type": "number" }, "sellerInfo": { "type": "object" }, "taxEngineType": { "type": "string", "enum": [ "ConnectTaxEngine", "GlobalTaxHub" ] }, "url": { "type": "string" }, "securityToken": { "type": "string" }, "password": { "type": "string" }, "responseMappings": { "type": "object" }, "requestHeaders": { "type": "object" }, "voidTemplate": { "type": [ "string", "null" ] }, "vendor": { "type": "string", "enum": [ "AvalaraTelco", "AvalaraBrazil", "AvaTax", "Vertex_SOAP", "OneSource_SOAP", "Vertex_REST", "Anrok", "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" } }, "required": [ "name", "taxEngineType", "vendor", "authenticationType", "url" ] }, "PutGlobalTaxHubTaxEngine": { "additionalProperties": false, "type": "object", "properties": { "jsonFields": { "type": "object" }, "customFieldMetas": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/CustomFieldMeta" } }, "clientId": { "type": "string" }, "voidUrl": { "type": "string" }, "requestTemplate": { "type": "string" }, "oauthScope": { "type": [ "string", "null" ] }, "networkReadTimeoutInSeconds": { "type": "number" }, "sellerInfo": { "type": "object" }, "url": { "type": "string" }, "securityToken": { "type": "string" }, "password": { "type": "string" }, "responseMappings": { "type": "object" }, "requestHeaders": { "type": "object" }, "voidTemplate": { "type": [ "string", "null" ] }, "vendor": { "type": "string", "enum": [ "AvalaraTelco", "AvalaraBrazil", "AvaTax", "Vertex_SOAP", "OneSource_SOAP", "Vertex_REST", "Anrok", "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" } } } } }, "responseType": { "$ref": "#/definitions/GetGlobalTaxHubTaxEngine", "definitions": { "CustomFieldMeta": { "type": "object", "properties": { "useLatestValue": { "type": "boolean" }, "customFieldName": { "type": "string" }, "customFieldObjectType": { "type": "string" } } }, "GetGlobalTaxHubTaxEngine": { "type": "object", "properties": { "jsonFields": { "type": "object" }, "customFieldMetas": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/CustomFieldMeta" } }, "clientId": { "type": "string" }, "voidUrl": { "type": "string" }, "requestTemplate": { "type": "string" }, "oauthScope": { "type": [ "string", "null" ] }, "networkReadTimeoutInSeconds": { "type": "number" }, "sellerInfo": { "type": "object" }, "taxEngineType": { "type": "string", "enum": [ "ConnectTaxEngine", "GlobalTaxHub" ] }, "url": { "type": "string" }, "responseMappings": { "type": "object" }, "requestHeaders": { "type": "object" }, "voidTemplate": { "type": [ "string", "null" ] }, "vendor": { "type": "string", "enum": [ "AvalaraTelco", "AvalaraBrazil", "AvaTax", "Vertex_SOAP", "OneSource_SOAP", "Vertex_REST", "Anrok", "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" } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } }, "GlobalTaxHubTaxEngine": { "additionalProperties": false, "type": "object", "properties": { "jsonFields": { "type": "object" }, "customFieldMetas": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/CustomFieldMeta" } }, "clientId": { "type": "string" }, "voidUrl": { "type": "string" }, "requestTemplate": { "type": "string" }, "oauthScope": { "type": [ "string", "null" ] }, "networkReadTimeoutInSeconds": { "type": "number" }, "sellerInfo": { "type": "object" }, "taxEngineType": { "type": "string", "enum": [ "ConnectTaxEngine", "GlobalTaxHub" ] }, "url": { "type": "string" }, "securityToken": { "type": "string" }, "password": { "type": "string" }, "responseMappings": { "type": "object" }, "requestHeaders": { "type": "object" }, "voidTemplate": { "type": [ "string", "null" ] }, "vendor": { "type": "string", "enum": [ "AvalaraTelco", "AvalaraBrazil", "AvaTax", "Vertex_SOAP", "OneSource_SOAP", "Vertex_REST", "Anrok", "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" } }, "required": [ "name", "taxEngineType", "vendor", "authenticationType", "url" ] }, "PutGlobalTaxHubTaxEngine": { "additionalProperties": false, "type": "object", "properties": { "jsonFields": { "type": "object" }, "customFieldMetas": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/CustomFieldMeta" } }, "clientId": { "type": "string" }, "voidUrl": { "type": "string" }, "requestTemplate": { "type": "string" }, "oauthScope": { "type": [ "string", "null" ] }, "networkReadTimeoutInSeconds": { "type": "number" }, "sellerInfo": { "type": "object" }, "url": { "type": "string" }, "securityToken": { "type": "string" }, "password": { "type": "string" }, "responseMappings": { "type": "object" }, "requestHeaders": { "type": "object" }, "voidTemplate": { "type": [ "string", "null" ] }, "vendor": { "type": "string", "enum": [ "AvalaraTelco", "AvalaraBrazil", "AvaTax", "Vertex_SOAP", "OneSource_SOAP", "Vertex_REST", "Anrok", "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" } } } } } }, { "method": "DELETE", "url": "/settings/tax-engines/global-tax-hub/{id}", "parameters": [ { "name": "id", "description": "Unique Id of global tax hub tax engine" } ], "responseType": { "$ref": "#/definitions/CommonResponse", "definitions": { "CustomFieldMeta": { "type": "object", "properties": { "useLatestValue": { "type": "boolean" }, "customFieldName": { "type": "string" }, "customFieldObjectType": { "type": "string" } } }, "GetGlobalTaxHubTaxEngine": { "type": "object", "properties": { "jsonFields": { "type": "object" }, "customFieldMetas": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/CustomFieldMeta" } }, "clientId": { "type": "string" }, "voidUrl": { "type": "string" }, "requestTemplate": { "type": "string" }, "oauthScope": { "type": [ "string", "null" ] }, "networkReadTimeoutInSeconds": { "type": "number" }, "sellerInfo": { "type": "object" }, "taxEngineType": { "type": "string", "enum": [ "ConnectTaxEngine", "GlobalTaxHub" ] }, "url": { "type": "string" }, "responseMappings": { "type": "object" }, "requestHeaders": { "type": "object" }, "voidTemplate": { "type": [ "string", "null" ] }, "vendor": { "type": "string", "enum": [ "AvalaraTelco", "AvalaraBrazil", "AvaTax", "Vertex_SOAP", "OneSource_SOAP", "Vertex_REST", "Anrok", "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" } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } }, "GlobalTaxHubTaxEngine": { "additionalProperties": false, "type": "object", "properties": { "jsonFields": { "type": "object" }, "customFieldMetas": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/CustomFieldMeta" } }, "clientId": { "type": "string" }, "voidUrl": { "type": "string" }, "requestTemplate": { "type": "string" }, "oauthScope": { "type": [ "string", "null" ] }, "networkReadTimeoutInSeconds": { "type": "number" }, "sellerInfo": { "type": "object" }, "taxEngineType": { "type": "string", "enum": [ "ConnectTaxEngine", "GlobalTaxHub" ] }, "url": { "type": "string" }, "securityToken": { "type": "string" }, "password": { "type": "string" }, "responseMappings": { "type": "object" }, "requestHeaders": { "type": "object" }, "voidTemplate": { "type": [ "string", "null" ] }, "vendor": { "type": "string", "enum": [ "AvalaraTelco", "AvalaraBrazil", "AvaTax", "Vertex_SOAP", "OneSource_SOAP", "Vertex_REST", "Anrok", "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" } }, "required": [ "name", "taxEngineType", "vendor", "authenticationType", "url" ] }, "PutGlobalTaxHubTaxEngine": { "additionalProperties": false, "type": "object", "properties": { "jsonFields": { "type": "object" }, "customFieldMetas": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/CustomFieldMeta" } }, "clientId": { "type": "string" }, "voidUrl": { "type": "string" }, "requestTemplate": { "type": "string" }, "oauthScope": { "type": [ "string", "null" ] }, "networkReadTimeoutInSeconds": { "type": "number" }, "sellerInfo": { "type": "object" }, "url": { "type": "string" }, "securityToken": { "type": "string" }, "password": { "type": "string" }, "responseMappings": { "type": "object" }, "requestHeaders": { "type": "object" }, "voidTemplate": { "type": [ "string", "null" ] }, "vendor": { "type": "string", "enum": [ "AvalaraTelco", "AvalaraBrazil", "AvaTax", "Vertex_SOAP", "OneSource_SOAP", "Vertex_REST", "Anrok", "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", "description": "Setting for Zuora tax engine", "context": "Entity", "pathPattern": "/tax-engines/ztax/{id}", "httpOperations": [ { "method": "GET", "url": "/settings/tax-engines/ztax/{id}", "parameters": [ { "name": "id", "description": "Unique Id of Zuora tax engine" } ], "responseType": { "$ref": "#/definitions/ZuoraTaxEngine", "definitions": { "ZuoraTaxEngine": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "taxEngineType": { "type": "string", "enum": [ "Z_Tax" ] } } }, "ZuoraTaxEnginePUT": { "additionalProperties": false, "type": "object", "properties": { "name": { "type": "string" } } } } } }, { "method": "PUT", "url": "/settings/tax-engines/ztax/{id}", "parameters": [ { "name": "id", "description": "Unique Id of Zuora tax engine" } ], "requestType": { "$ref": "#/definitions/ZuoraTaxEnginePUT", "definitions": { "ZuoraTaxEngine": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "taxEngineType": { "type": "string", "enum": [ "Z_Tax" ] } } }, "ZuoraTaxEnginePUT": { "additionalProperties": false, "type": "object", "properties": { "name": { "type": "string" } } } } }, "responseType": { "$ref": "#/definitions/ZuoraTaxEngine", "definitions": { "ZuoraTaxEngine": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "taxEngineType": { "type": "string", "enum": [ "Z_Tax" ] } } }, "ZuoraTaxEnginePUT": { "additionalProperties": false, "type": "object", "properties": { "name": { "type": "string" } } } } } } ] }, { "key": "AllTaxRatePeriod", "description": "all tax rate periods", "context": "Entity", "pathPattern": "/tax-rate-periods", "httpOperations": [ { "method": "GET", "url": "/settings/tax-rate-periods", "parameters": [], "responseType": { "type": "object", "properties": { "taxRatePeriods": { "type": "array", "items": { "$ref": "#/definitions/TaxRatePeriod" } } }, "definitions": { "TaxRatePeriod": { "type": "object", "properties": { "endDate": { "format": "date", "type": [ "string", "null" ] }, "id": { "type": "string" }, "taxCodeId": { "type": "string" }, "startDate": { "format": "date", "type": "string" } } } } } }, { "method": "POST", "url": "/settings/tax-rate-periods", "parameters": [], "requestType": { "$ref": "#/definitions/TaxRatePeriod", "definitions": { "TaxRatePeriod": { "type": "object", "properties": { "endDate": { "format": "date", "type": [ "string", "null" ] }, "id": { "type": "string" }, "taxCodeId": { "type": "string" }, "startDate": { "format": "date", "type": "string" } } } } }, "responseType": { "$ref": "#/definitions/TaxRatePeriod", "definitions": { "TaxRatePeriod": { "type": "object", "properties": { "endDate": { "format": "date", "type": [ "string", "null" ] }, "id": { "type": "string" }, "taxCodeId": { "type": "string" }, "startDate": { "format": "date", "type": "string" } } } } } } ] }, { "key": "TaxRatePeriod", "description": "Setting for Zuora tax rate period", "context": "Entity", "pathPattern": "/tax-rate-periods/{id}", "httpOperations": [ { "method": "GET", "url": "/settings/tax-rate-periods/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Tax Rate Period" } ], "responseType": { "$ref": "#/definitions/TaxRatePeriod", "definitions": { "TaxRatePeriod": { "type": "object", "properties": { "endDate": { "format": "date", "type": [ "string", "null" ] }, "id": { "type": "string" }, "taxCodeId": { "type": "string" }, "startDate": { "format": "date", "type": "string" } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } }, { "method": "PUT", "url": "/settings/tax-rate-periods/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Tax Rate Period" } ], "requestType": { "$ref": "#/definitions/TaxRatePeriod", "definitions": { "TaxRatePeriod": { "type": "object", "properties": { "endDate": { "format": "date", "type": [ "string", "null" ] }, "id": { "type": "string" }, "taxCodeId": { "type": "string" }, "startDate": { "format": "date", "type": "string" } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } } } }, "responseType": { "$ref": "#/definitions/TaxRatePeriod", "definitions": { "TaxRatePeriod": { "type": "object", "properties": { "endDate": { "format": "date", "type": [ "string", "null" ] }, "id": { "type": "string" }, "taxCodeId": { "type": "string" }, "startDate": { "format": "date", "type": "string" } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } }, { "method": "DELETE", "url": "/settings/tax-rate-periods/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Tax Rate Period" } ], "responseType": { "$ref": "#/definitions/CommonResponse", "definitions": { "TaxRatePeriod": { "type": "object", "properties": { "endDate": { "format": "date", "type": [ "string", "null" ] }, "id": { "type": "string" }, "taxCodeId": { "type": "string" }, "startDate": { "format": "date", "type": "string" } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ] }, { "key": "TaxRates", "description": "Setting for tax rates", "context": "Entity", "pathPattern": "/tax-rate-periods/{taxRatePeriodId}/tax-rates", "httpOperations": [ { "method": "GET", "url": "/settings/tax-rate-periods/{taxRatePeriodId}/tax-rates?size=&page=", "parameters": [ { "name": "page", "description": "The page number" }, { "name": "size", "description": "The page size" }, { "name": "taxRatePeriodId", "description": "Unique Id of tax rate period" } ], "responseType": { "$ref": "#/definitions/TaxRates", "definitions": { "TaxRate": { "type": "object", "properties": { "country": { "type": "string" }, "city": { "type": [ "string", "null" ] }, "postalCode": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "taxRegion": { "type": [ "string", "null" ] }, "taxRate3": { "type": [ "number", "null" ] }, "taxName1": { "type": "string" }, "taxRateType2": { "oneOf": [ { "type": "string", "enum": [ "Percentage", "FlatFee" ] }, { "type": "null" } ] }, "taxRateType1": { "type": "string", "enum": [ "Percentage", "FlatFee" ] }, "id": { "type": "string" }, "state": { "type": [ "string", "null" ] }, "taxRateType3": { "oneOf": [ { "type": "string", "enum": [ "Percentage", "FlatFee" ] }, { "type": "null" } ] }, "taxRate2": { "type": [ "number", "null" ] }, "taxRate1": { "type": "number" }, "taxName3": { "type": [ "string", "null" ] }, "taxName2": { "type": [ "string", "null" ] }, "taxJursdiction3": { "type": [ "string", "null" ] }, "taxLocationCode3": { "type": [ "string", "null" ] }, "taxRatePeriodId": { "type": "string" }, "taxLocationCode1": { "type": [ "string", "null" ] }, "taxLocationCode2": { "type": [ "string", "null" ] }, "taxRateDescription3": { "type": [ "string", "null" ] }, "taxRateDescription1": { "type": [ "string", "null" ] }, "taxJursdiction2": { "type": [ "string", "null" ] }, "taxJursdiction1": { "type": [ "string", "null" ] }, "taxRateDescription2": { "type": [ "string", "null" ] } } }, "TaxRatesPost": { "type": "object", "properties": { "taxRates": { "type": "array", "items": { "$ref": "#/definitions/TaxRatePost" } } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } }, "TaxRatePost": { "type": "object", "properties": { "country": { "type": "string" }, "taxJursdiction3": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "postalCode": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "taxLocationCode3": { "type": [ "string", "null" ] }, "taxLocationCode1": { "type": [ "string", "null" ] }, "taxLocationCode2": { "type": [ "string", "null" ] }, "taxRateDescription3": { "type": [ "string", "null" ] }, "taxRateDescription1": { "type": [ "string", "null" ] }, "taxJursdiction2": { "type": [ "string", "null" ] }, "taxJursdiction1": { "type": [ "string", "null" ] }, "taxRateDescription2": { "type": [ "string", "null" ] }, "taxRegion": { "type": [ "string", "null" ] }, "taxRate3": { "type": [ "number", "null" ] }, "taxName1": { "type": "string" }, "taxRateType2": { "oneOf": [ { "type": "string", "enum": [ "Percentage", "FlatFee" ] }, { "type": "null" } ] }, "taxRateType1": { "type": "string", "enum": [ "Percentage", "FlatFee" ] }, "state": { "type": [ "string", "null" ] }, "taxRateType3": { "oneOf": [ { "type": "string", "enum": [ "Percentage", "FlatFee" ] }, { "type": "null" } ] }, "taxRate2": { "type": [ "number", "null" ] }, "taxRate1": { "type": "number" }, "taxName3": { "type": [ "string", "null" ] }, "taxName2": { "type": [ "string", "null" ] } } }, "TaxRates": { "type": "object", "properties": { "taxRates": { "type": "array", "items": { "$ref": "#/definitions/TaxRate" } } } } } } }, { "method": "POST", "url": "/settings/tax-rate-periods/{taxRatePeriodId}/tax-rates", "parameters": [ { "name": "taxRatePeriodId", "description": "Unique Id of tax rate period" } ], "requestType": { "$ref": "#/definitions/TaxRatesPost", "definitions": { "TaxRate": { "type": "object", "properties": { "country": { "type": "string" }, "city": { "type": [ "string", "null" ] }, "postalCode": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "taxRegion": { "type": [ "string", "null" ] }, "taxRate3": { "type": [ "number", "null" ] }, "taxName1": { "type": "string" }, "taxRateType2": { "oneOf": [ { "type": "string", "enum": [ "Percentage", "FlatFee" ] }, { "type": "null" } ] }, "taxRateType1": { "type": "string", "enum": [ "Percentage", "FlatFee" ] }, "id": { "type": "string" }, "state": { "type": [ "string", "null" ] }, "taxRateType3": { "oneOf": [ { "type": "string", "enum": [ "Percentage", "FlatFee" ] }, { "type": "null" } ] }, "taxRate2": { "type": [ "number", "null" ] }, "taxRate1": { "type": "number" }, "taxName3": { "type": [ "string", "null" ] }, "taxName2": { "type": [ "string", "null" ] }, "taxJursdiction3": { "type": [ "string", "null" ] }, "taxLocationCode3": { "type": [ "string", "null" ] }, "taxRatePeriodId": { "type": "string" }, "taxLocationCode1": { "type": [ "string", "null" ] }, "taxLocationCode2": { "type": [ "string", "null" ] }, "taxRateDescription3": { "type": [ "string", "null" ] }, "taxRateDescription1": { "type": [ "string", "null" ] }, "taxJursdiction2": { "type": [ "string", "null" ] }, "taxJursdiction1": { "type": [ "string", "null" ] }, "taxRateDescription2": { "type": [ "string", "null" ] } } }, "TaxRatesPost": { "type": "object", "properties": { "taxRates": { "type": "array", "items": { "$ref": "#/definitions/TaxRatePost" } } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } }, "TaxRatePost": { "type": "object", "properties": { "country": { "type": "string" }, "taxJursdiction3": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "postalCode": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "taxLocationCode3": { "type": [ "string", "null" ] }, "taxLocationCode1": { "type": [ "string", "null" ] }, "taxLocationCode2": { "type": [ "string", "null" ] }, "taxRateDescription3": { "type": [ "string", "null" ] }, "taxRateDescription1": { "type": [ "string", "null" ] }, "taxJursdiction2": { "type": [ "string", "null" ] }, "taxJursdiction1": { "type": [ "string", "null" ] }, "taxRateDescription2": { "type": [ "string", "null" ] }, "taxRegion": { "type": [ "string", "null" ] }, "taxRate3": { "type": [ "number", "null" ] }, "taxName1": { "type": "string" }, "taxRateType2": { "oneOf": [ { "type": "string", "enum": [ "Percentage", "FlatFee" ] }, { "type": "null" } ] }, "taxRateType1": { "type": "string", "enum": [ "Percentage", "FlatFee" ] }, "state": { "type": [ "string", "null" ] }, "taxRateType3": { "oneOf": [ { "type": "string", "enum": [ "Percentage", "FlatFee" ] }, { "type": "null" } ] }, "taxRate2": { "type": [ "number", "null" ] }, "taxRate1": { "type": "number" }, "taxName3": { "type": [ "string", "null" ] }, "taxName2": { "type": [ "string", "null" ] } } }, "TaxRates": { "type": "object", "properties": { "taxRates": { "type": "array", "items": { "$ref": "#/definitions/TaxRate" } } } } } }, "responseType": { "$ref": "#/definitions/TaxRates", "definitions": { "TaxRate": { "type": "object", "properties": { "country": { "type": "string" }, "city": { "type": [ "string", "null" ] }, "postalCode": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "taxRegion": { "type": [ "string", "null" ] }, "taxRate3": { "type": [ "number", "null" ] }, "taxName1": { "type": "string" }, "taxRateType2": { "oneOf": [ { "type": "string", "enum": [ "Percentage", "FlatFee" ] }, { "type": "null" } ] }, "taxRateType1": { "type": "string", "enum": [ "Percentage", "FlatFee" ] }, "id": { "type": "string" }, "state": { "type": [ "string", "null" ] }, "taxRateType3": { "oneOf": [ { "type": "string", "enum": [ "Percentage", "FlatFee" ] }, { "type": "null" } ] }, "taxRate2": { "type": [ "number", "null" ] }, "taxRate1": { "type": "number" }, "taxName3": { "type": [ "string", "null" ] }, "taxName2": { "type": [ "string", "null" ] }, "taxJursdiction3": { "type": [ "string", "null" ] }, "taxLocationCode3": { "type": [ "string", "null" ] }, "taxRatePeriodId": { "type": "string" }, "taxLocationCode1": { "type": [ "string", "null" ] }, "taxLocationCode2": { "type": [ "string", "null" ] }, "taxRateDescription3": { "type": [ "string", "null" ] }, "taxRateDescription1": { "type": [ "string", "null" ] }, "taxJursdiction2": { "type": [ "string", "null" ] }, "taxJursdiction1": { "type": [ "string", "null" ] }, "taxRateDescription2": { "type": [ "string", "null" ] } } }, "TaxRatesPost": { "type": "object", "properties": { "taxRates": { "type": "array", "items": { "$ref": "#/definitions/TaxRatePost" } } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } }, "TaxRatePost": { "type": "object", "properties": { "country": { "type": "string" }, "taxJursdiction3": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "postalCode": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "taxLocationCode3": { "type": [ "string", "null" ] }, "taxLocationCode1": { "type": [ "string", "null" ] }, "taxLocationCode2": { "type": [ "string", "null" ] }, "taxRateDescription3": { "type": [ "string", "null" ] }, "taxRateDescription1": { "type": [ "string", "null" ] }, "taxJursdiction2": { "type": [ "string", "null" ] }, "taxJursdiction1": { "type": [ "string", "null" ] }, "taxRateDescription2": { "type": [ "string", "null" ] }, "taxRegion": { "type": [ "string", "null" ] }, "taxRate3": { "type": [ "number", "null" ] }, "taxName1": { "type": "string" }, "taxRateType2": { "oneOf": [ { "type": "string", "enum": [ "Percentage", "FlatFee" ] }, { "type": "null" } ] }, "taxRateType1": { "type": "string", "enum": [ "Percentage", "FlatFee" ] }, "state": { "type": [ "string", "null" ] }, "taxRateType3": { "oneOf": [ { "type": "string", "enum": [ "Percentage", "FlatFee" ] }, { "type": "null" } ] }, "taxRate2": { "type": [ "number", "null" ] }, "taxRate1": { "type": "number" }, "taxName3": { "type": [ "string", "null" ] }, "taxName2": { "type": [ "string", "null" ] } } }, "TaxRates": { "type": "object", "properties": { "taxRates": { "type": "array", "items": { "$ref": "#/definitions/TaxRate" } } } } } } }, { "method": "DELETE", "url": "/settings/tax-rate-periods/{taxRatePeriodId}/tax-rates", "parameters": [ { "name": "taxRatePeriodId", "description": "Unique Id of tax rate period" } ], "responseType": { "$ref": "#/definitions/CommonResponse", "definitions": { "TaxRate": { "type": "object", "properties": { "country": { "type": "string" }, "city": { "type": [ "string", "null" ] }, "postalCode": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "taxRegion": { "type": [ "string", "null" ] }, "taxRate3": { "type": [ "number", "null" ] }, "taxName1": { "type": "string" }, "taxRateType2": { "oneOf": [ { "type": "string", "enum": [ "Percentage", "FlatFee" ] }, { "type": "null" } ] }, "taxRateType1": { "type": "string", "enum": [ "Percentage", "FlatFee" ] }, "id": { "type": "string" }, "state": { "type": [ "string", "null" ] }, "taxRateType3": { "oneOf": [ { "type": "string", "enum": [ "Percentage", "FlatFee" ] }, { "type": "null" } ] }, "taxRate2": { "type": [ "number", "null" ] }, "taxRate1": { "type": "number" }, "taxName3": { "type": [ "string", "null" ] }, "taxName2": { "type": [ "string", "null" ] }, "taxJursdiction3": { "type": [ "string", "null" ] }, "taxLocationCode3": { "type": [ "string", "null" ] }, "taxRatePeriodId": { "type": "string" }, "taxLocationCode1": { "type": [ "string", "null" ] }, "taxLocationCode2": { "type": [ "string", "null" ] }, "taxRateDescription3": { "type": [ "string", "null" ] }, "taxRateDescription1": { "type": [ "string", "null" ] }, "taxJursdiction2": { "type": [ "string", "null" ] }, "taxJursdiction1": { "type": [ "string", "null" ] }, "taxRateDescription2": { "type": [ "string", "null" ] } } }, "TaxRatesPost": { "type": "object", "properties": { "taxRates": { "type": "array", "items": { "$ref": "#/definitions/TaxRatePost" } } } }, "CommonResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } }, "TaxRatePost": { "type": "object", "properties": { "country": { "type": "string" }, "taxJursdiction3": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "postalCode": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "taxLocationCode3": { "type": [ "string", "null" ] }, "taxLocationCode1": { "type": [ "string", "null" ] }, "taxLocationCode2": { "type": [ "string", "null" ] }, "taxRateDescription3": { "type": [ "string", "null" ] }, "taxRateDescription1": { "type": [ "string", "null" ] }, "taxJursdiction2": { "type": [ "string", "null" ] }, "taxJursdiction1": { "type": [ "string", "null" ] }, "taxRateDescription2": { "type": [ "string", "null" ] }, "taxRegion": { "type": [ "string", "null" ] }, "taxRate3": { "type": [ "number", "null" ] }, "taxName1": { "type": "string" }, "taxRateType2": { "oneOf": [ { "type": "string", "enum": [ "Percentage", "FlatFee" ] }, { "type": "null" } ] }, "taxRateType1": { "type": "string", "enum": [ "Percentage", "FlatFee" ] }, "state": { "type": [ "string", "null" ] }, "taxRateType3": { "oneOf": [ { "type": "string", "enum": [ "Percentage", "FlatFee" ] }, { "type": "null" } ] }, "taxRate2": { "type": [ "number", "null" ] }, "taxRate1": { "type": "number" }, "taxName3": { "type": [ "string", "null" ] }, "taxName2": { "type": [ "string", "null" ] } } }, "TaxRates": { "type": "object", "properties": { "taxRates": { "type": "array", "items": { "$ref": "#/definitions/TaxRate" } } } } } } } ] }, { "key": "TranslationProfile", "description": "Setting to enable/disable PDF Translation ", "context": "Entity", "pathPattern": "/translation-profiles/presentment-translation", "httpOperations": [ { "method": "GET", "url": "/settings/translation-profiles/presentment-translation", "parameters": [], "responseType": { "$ref": "#/definitions/TranslationProfileResponse", "definitions": { "TranslationProfileResponse": { "additionalProperties": false, "type": "object", "properties": { "success": { "type": "boolean" }, "enabled": { "type": "boolean" } } }, "TranslationProfile": { "additionalProperties": false, "type": "object", "properties": { "enabled": { "type": "boolean" } } } } } }, { "method": "PUT", "url": "/settings/translation-profiles/presentment-translation", "parameters": [], "requestType": { "$ref": "#/definitions/TranslationProfile", "definitions": { "TranslationProfileResponse": { "additionalProperties": false, "type": "object", "properties": { "success": { "type": "boolean" }, "enabled": { "type": "boolean" } } }, "TranslationProfile": { "additionalProperties": false, "type": "object", "properties": { "enabled": { "type": "boolean" } } } } }, "responseType": { "$ref": "#/definitions/TranslationProfileResponse", "definitions": { "TranslationProfileResponse": { "additionalProperties": false, "type": "object", "properties": { "success": { "type": "boolean" }, "enabled": { "type": "boolean" } } }, "TranslationProfile": { "additionalProperties": false, "type": "object", "properties": { "enabled": { "type": "boolean" } } } } } } ] }, { "key": "AllUnitsOfMeasure", "description": "List of all Units of Measure", "context": "Entity", "pathPattern": "/units-of-measure", "httpOperations": [ { "method": "GET", "url": "/settings/units-of-measure", "parameters": [], "responseType": { "$ref": "#/definitions/UnitsOfMeasureList", "definitions": { "UnitOfMeasure": { "additionalProperties": false, "type": "object", "properties": { "usageLogFileLabel": { "type": "string" }, "roundingMode": { "type": "string" }, "displayAs": { "type": "string" }, "precision": { "type": "number" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "id": { "type": "string" } } }, "UnitsOfMeasureList": { "additionalProperties": false, "type": "object", "properties": { "unitsOfMeasure": { "type": "array", "items": { "$ref": "#/definitions/UnitOfMeasure" } } } }, "UnitOfMeasurePost": { "additionalProperties": false, "type": "object", "properties": { "usageLogFileLabel": { "type": "string" }, "roundingMode": { "type": "string" }, "displayAs": { "type": "string" }, "precision": { "type": "number" }, "name": { "type": "string" }, "active": { "type": "boolean" } } } } } }, { "method": "POST", "url": "/settings/units-of-measure", "parameters": [], "requestType": { "$ref": "#/definitions/UnitOfMeasurePost", "definitions": { "UnitOfMeasure": { "additionalProperties": false, "type": "object", "properties": { "usageLogFileLabel": { "type": "string" }, "roundingMode": { "type": "string" }, "displayAs": { "type": "string" }, "precision": { "type": "number" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "id": { "type": "string" } } }, "UnitsOfMeasureList": { "additionalProperties": false, "type": "object", "properties": { "unitsOfMeasure": { "type": "array", "items": { "$ref": "#/definitions/UnitOfMeasure" } } } }, "UnitOfMeasurePost": { "additionalProperties": false, "type": "object", "properties": { "usageLogFileLabel": { "type": "string" }, "roundingMode": { "type": "string" }, "displayAs": { "type": "string" }, "precision": { "type": "number" }, "name": { "type": "string" }, "active": { "type": "boolean" } } } } }, "responseType": { "$ref": "#/definitions/UnitOfMeasure", "definitions": { "UnitOfMeasure": { "additionalProperties": false, "type": "object", "properties": { "usageLogFileLabel": { "type": "string" }, "roundingMode": { "type": "string" }, "displayAs": { "type": "string" }, "precision": { "type": "number" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "id": { "type": "string" } } }, "UnitsOfMeasureList": { "additionalProperties": false, "type": "object", "properties": { "unitsOfMeasure": { "type": "array", "items": { "$ref": "#/definitions/UnitOfMeasure" } } } }, "UnitOfMeasurePost": { "additionalProperties": false, "type": "object", "properties": { "usageLogFileLabel": { "type": "string" }, "roundingMode": { "type": "string" }, "displayAs": { "type": "string" }, "precision": { "type": "number" }, "name": { "type": "string" }, "active": { "type": "boolean" } } } } } } ] }, { "key": "UnitOfMeasure", "description": "Unit of Measure", "context": "Entity", "pathPattern": "/units-of-measure/{id}", "httpOperations": [ { "method": "GET", "url": "/settings/units-of-measure/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Unit of Measure" } ], "responseType": { "$ref": "#/definitions/UnitOfMeasure", "definitions": { "UnitOfMeasure": { "additionalProperties": false, "type": "object", "properties": { "usageLogFileLabel": { "type": "string", "maxLength": 50 }, "roundingMode": { "type": "string", "enum": [ "Up", "Down" ] }, "displayAs": { "minLength": 1, "type": "string", "maxLength": 50 }, "precision": { "type": "number", "minimum": 0 }, "name": { "minLength": 1, "type": "string", "maxLength": 50 }, "active": { "default": false, "type": "boolean" }, "id": { "type": "string", "maxLength": 36 } } } } } }, { "method": "PUT", "url": "/settings/units-of-measure/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Unit of Measure" } ], "requestType": { "$ref": "#/definitions/UnitOfMeasure", "definitions": { "UnitOfMeasure": { "additionalProperties": false, "type": "object", "properties": { "usageLogFileLabel": { "type": "string", "maxLength": 50 }, "roundingMode": { "type": "string", "enum": [ "Up", "Down" ] }, "displayAs": { "minLength": 1, "type": "string", "maxLength": 50 }, "precision": { "type": "number", "minimum": 0 }, "name": { "minLength": 1, "type": "string", "maxLength": 50 }, "active": { "default": false, "type": "boolean" }, "id": { "type": "string", "maxLength": 36 } } } } }, "responseType": { "$ref": "#/definitions/UnitOfMeasure", "definitions": { "UnitOfMeasure": { "additionalProperties": false, "type": "object", "properties": { "usageLogFileLabel": { "type": "string", "maxLength": 50 }, "roundingMode": { "type": "string", "enum": [ "Up", "Down" ] }, "displayAs": { "minLength": 1, "type": "string", "maxLength": 50 }, "precision": { "type": "number", "minimum": 0 }, "name": { "minLength": 1, "type": "string", "maxLength": 50 }, "active": { "default": false, "type": "boolean" }, "id": { "type": "string", "maxLength": 36 } } } } } }, { "method": "DELETE", "url": "/settings/units-of-measure/{id}", "parameters": [ { "name": "id", "description": "Unique Id of the Unit of Measure" } ] } ] }, { "key": "UserRoles", "description": "User Roles", "context": "Entity", "pathPattern": "/user-roles", "httpOperations": [ { "method": "GET", "url": "/settings/user-roles?size=&page=", "parameters": [ { "name": "page", "description": "The page number" }, { "name": "size", "description": "The page size" } ], "responseType": { "$ref": "#/definitions/RolesPage", "definitions": { "Role": { "type": "object", "properties": { "name": { "type": "string" }, "attributes": { "type": "array", "items": { "$ref": "#/definitions/Attribute" } }, "id": { "type": "string" }, "category": { "type": "string" } } }, "Attribute": { "additionalProperties": false, "type": "object", "properties": { "scope": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "string" } } }, "RolesPage": { "type": "object", "properties": { "size": { "type": "integer" }, "last": { "type": "boolean" }, "contents": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "page": { "type": "integer" } } } } } } ] } ] }