Example: E-Invoicing Configuration
Comprehensive configuration form for electronic invoicing.
{
"schema": {
"type": "object",
"properties": {
"companyProfile": {
"type": "object",
"properties": {
"legalName": {
"type": "string",
"title": "Legal Name"
},
"commercialName": {
"type": "string",
"title": "Commercial Name"
},
"taxIdentifier": {
"type": "string",
"title": "Tax ID"
},
"fiscalRegime": {
"type": "string",
"title": "Fiscal Regime"
},
"address": {
"type": "object",
"properties": {
"street": {
"type": "string",
"title": "Street"
},
"number": {
"type": "string",
"title": "Number"
},
"city": {
"type": "string",
"title": "City"
},
"state": {
"type": "string",
"title": "State/Province"
},
"postalCode": {
"type": "string",
"title": "Postal Code"
},
"country": {
"type": "string",
"title": "Country"
}
},
"required": [
"street",
"number",
"city",
"country"
]
},
"contact": {
"type": "object",
"properties": {
"email": {
"type": [
"null",
"string"
],
"format": "email",
"title": "Email"
},
"phone": {
"type": "string",
"title": "Phone"
},
"website": {
"type": [
"null",
"string"
],
"format": "uri",
"title": "Website"
}
},
"required": [
"email"
]
},
"logo": {
"type": [
"null",
"string"
],
"format": "uri",
"title": "Company Logo URL"
}
},
"required": [
"legalName",
"taxIdentifier",
"fiscalRegime"
]
},
"digitalSignature": {
"type": "object",
"properties": {
"certificateType": {
"type": "string",
"enum": [
"production",
"testing"
],
"default": "testing",
"title": "Certificate Type"
},
"certificateFile": {
"type": "string",
"title": "Certificate File (.cer)"
},
"privateKeyFile": {
"type": "string",
"title": "Private Key File (.key)"
},
"privateKeyPassword": {
"type": "string",
"title": "Private Key Password"
},
"certificateExpiration": {
"type": [
"null",
"string"
],
"format": "date",
"title": "Certificate Expiration Date"
},
"enableNotifications": {
"type": "boolean",
"title": "Enable Expiration Notifications",
"default": true
},
"notificationThreshold": {
"type": "number",
"title": "Days Before Expiration to Notify",
"default": 30,
"minimum": 1,
"maximum": 90
}
},
"required": [
"certificateType",
"certificateFile",
"privateKeyFile",
"privateKeyPassword"
]
},
"documentTypes": {
"type": "object",
"properties": {
"enabledDocuments": {
"type": "array",
"items": {
"type": "string",
"enum": [
"invoice",
"creditNote",
"debitNote",
"receipt",
"paymentReceipt"
]
},
"uniqueItems": true,
"default": [
"invoice"
],
"title": "Enabled Document Types"
},
"documentSettings": {
"type": "object",
"properties": {
"invoice": {
"type": "object",
"properties": {
"series": {
"type": "string",
"title": "Series",
"default": "A"
},
"startNumber": {
"type": "number",
"title": "Starting Number",
"default": 1
},
"folioDigits": {
"type": "number",
"title": "Folio Digits",
"default": 8,
"minimum": 1,
"maximum": 10
},
"defaultCurrency": {
"type": "string",
"title": "Default Currency",
"default": "USD"
},
"defaultTaxRate": {
"type": "number",
"title": "Default Tax Rate (%)",
"default": 0
}
}
},
"creditNote": {
"type": "object",
"properties": {
"series": {
"type": "string",
"title": "Series",
"default": "NC"
},
"startNumber": {
"type": "number",
"title": "Starting Number",
"default": 1
},
"folioDigits": {
"type": "number",
"title": "Folio Digits",
"default": 8
},
"requiresReference": {
"type": "boolean",
"title": "Requires Reference to Invoice",
"default": true
}
}
},
"debitNote": {
"type": "object",
"properties": {
"series": {
"type": "string",
"title": "Series",
"default": "ND"
},
"startNumber": {
"type": "number",
"title": "Starting Number",
"default": 1
},
"folioDigits": {
"type": "number",
"title": "Folio Digits",
"default": 8
},
"requiresReference": {
"type": "boolean",
"title": "Requires Reference to Invoice",
"default": true
}
}
}
}
}
}
},
"notifications": {
"type": "object",
"properties": {
"emailNotifications": {
"type": "object",
"properties": {
"sendToCustomer": {
"type": "boolean",
"title": "Send Email to Customer",
"default": true
},
"attachPdf": {
"type": "boolean",
"title": "Attach PDF",
"default": true
},
"attachXml": {
"type": "boolean",
"title": "Attach XML",
"default": true
},
"customMessage": {
"type": "string",
"title": "Custom Message Template"
},
"ccEmails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"title": "Email"
}
},
"required": [
"email"
]
},
"title": "CC Email Addresses"
},
"bccEmails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"title": "Email"
}
},
"required": [
"email"
]
},
"title": "BCC Email Addresses"
}
}
},
"adminNotifications": {
"type": "object",
"properties": {
"errorNotifications": {
"type": "boolean",
"title": "Receive Error Notifications",
"default": true
},
"successSummary": {
"type": "boolean",
"title": "Receive Daily Success Summary",
"default": false
},
"notificationEmails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"title": "Email"
}
},
"required": [
"email"
]
},
"title": "Notification Emails"
}
}
}
}
},
"integration": {
"type": "object",
"properties": {
"webServiceUrl": {
"type": [
"null",
"string"
],
"format": "uri",
"title": "Fiscal Authority Web Service URL"
},
"apiKeys": {
"type": "object",
"properties": {
"production": {
"type": "string",
"title": "Production API Key"
},
"testing": {
"type": "string",
"title": "Testing API Key"
}
}
},
"webhook": {
"type": "object",
"properties": {
"enableWebhook": {
"type": "boolean",
"title": "Enable Status Webhook",
"default": false
},
"webhookUrl": {
"type": [
"null",
"string"
],
"format": "uri",
"title": "Webhook URL"
},
"secret": {
"type": "string",
"title": "Webhook Secret"
}
}
}
}
}
},
"required": [
"companyProfile",
"digitalSignature"
]
},
"uischema": {
"type": "Categorization",
"elements": [
{
"type": "Category",
"label": "Company Profile",
"elements": [
{
"type": "Group",
"label": "Company Information",
"elements": [
{
"type": "HorizontalLayout",
"elements": [
{
"type": "Control",
"scope": "#/properties/companyProfile/properties/legalName"
},
{
"type": "Control",
"scope": "#/properties/companyProfile/properties/commercialName"
}
]
},
{
"type": "HorizontalLayout",
"elements": [
{
"type": "Control",
"scope": "#/properties/companyProfile/properties/taxIdentifier"
},
{
"type": "Control",
"scope": "#/properties/companyProfile/properties/fiscalRegime"
}
]
}
]
},
{
"type": "Group",
"label": "Address",
"elements": [
{
"type": "HorizontalLayout",
"elements": [
{
"type": "Control",
"scope": "#/properties/companyProfile/properties/address/properties/street"
},
{
"type": "Control",
"scope": "#/properties/companyProfile/properties/address/properties/number"
}
]
},
{
"type": "HorizontalLayout",
"elements": [
{
"type": "Control",
"scope": "#/properties/companyProfile/properties/address/properties/city"
},
{
"type": "Control",
"scope": "#/properties/companyProfile/properties/address/properties/state"
}
]
},
{
"type": "HorizontalLayout",
"elements": [
{
"type": "Control",
"scope": "#/properties/companyProfile/properties/address/properties/postalCode"
},
{
"type": "Control",
"scope": "#/properties/companyProfile/properties/address/properties/country"
}
]
}
]
},
{
"type": "Group",
"label": "Contact Information",
"elements": [
{
"type": "HorizontalLayout",
"elements": [
{
"type": "Control",
"scope": "#/properties/companyProfile/properties/contact/properties/email"
},
{
"type": "Control",
"scope": "#/properties/companyProfile/properties/contact/properties/phone"
},
{
"type": "Control",
"scope": "#/properties/companyProfile/properties/contact/properties/website"
}
]
}
]
},
{
"type": "Group",
"label": "Branding",
"elements": [
{
"type": "Control",
"scope": "#/properties/companyProfile/properties/logo",
"options": {
"format": "file"
}
}
]
}
]
},
{
"type": "Category",
"label": "Digital Signature",
"elements": [
{
"type": "Group",
"label": "Certificate Information",
"elements": [
{
"type": "Control",
"scope": "#/properties/digitalSignature/properties/certificateType",
"options": {
"format": "radio"
}
},
{
"type": "HorizontalLayout",
"elements": [
{
"type": "Control",
"scope": "#/properties/digitalSignature/properties/certificateFile",
"options": {
"format": "file"
}
},
{
"type": "Control",
"scope": "#/properties/digitalSignature/properties/privateKeyFile",
"options": {
"format": "file"
}
}
]
},
{
"type": "Control",
"scope": "#/properties/digitalSignature/properties/privateKeyPassword",
"options": {
"format": "password"
}
},
{
"type": "Control",
"scope": "#/properties/digitalSignature/properties/certificateExpiration"
}
]
},
{
"type": "Group",
"label": "Expiration Notifications",
"elements": [
{
"type": "Control",
"scope": "#/properties/digitalSignature/properties/enableNotifications"
},
{
"type": "Control",
"scope": "#/properties/digitalSignature/properties/notificationThreshold",
"rule": {
"effect": "SHOW",
"condition": {
"scope": "#/properties/digitalSignature/properties/enableNotifications",
"schema": {
"const": true
}
}
}
}
]
}
]
},
{
"type": "Category",
"label": "Document Types",
"elements": [
{
"type": "Group",
"label": "Enabled Documents",
"elements": [
{
"type": "Control",
"scope": "#/properties/documentTypes/properties/enabledDocuments",
"options": {
"format": "checkbox"
}
}
]
},
{
"type": "Categorization",
"elements": [
{
"type": "Category",
"label": "Invoice",
"elements": [
{
"type": "Group",
"label": "Invoice Settings",
"elements": [
{
"type": "HorizontalLayout",
"elements": [
{
"type": "Control",
"scope": "#/properties/documentTypes/properties/documentSettings/properties/invoice/properties/series"
},
{
"type": "Control",
"scope": "#/properties/documentTypes/properties/documentSettings/properties/invoice/properties/startNumber"
},
{
"type": "Control",
"scope": "#/properties/documentTypes/properties/documentSettings/properties/invoice/properties/folioDigits"
}
]
},
{
"type": "HorizontalLayout",
"elements": [
{
"type": "Control",
"scope": "#/properties/documentTypes/properties/documentSettings/properties/invoice/properties/defaultCurrency"
},
{
"type": "Control",
"scope": "#/properties/documentTypes/properties/documentSettings/properties/invoice/properties/defaultTaxRate"
}
]
}
]
}
],
"rule": {
"effect": "SHOW",
"condition": {
"scope": "#/properties/documentTypes/properties/enabledDocuments",
"schema": {
"contains": {
"const": "invoice"
}
}
}
}
},
{
"type": "Category",
"label": "Credit Note",
"elements": [
{
"type": "Group",
"label": "Credit Note Settings",
"elements": [
{
"type": "HorizontalLayout",
"elements": [
{
"type": "Control",
"scope": "#/properties/documentTypes/properties/documentSettings/properties/creditNote/properties/series"
},
{
"type": "Control",
"scope": "#/properties/documentTypes/properties/documentSettings/properties/creditNote/properties/startNumber"
},
{
"type": "Control",
"scope": "#/properties/documentTypes/properties/documentSettings/properties/creditNote/properties/folioDigits"
}
]
},
{
"type": "Control",
"scope": "#/properties/documentTypes/properties/documentSettings/properties/creditNote/properties/requiresReference"
}
]
}
],
"rule": {
"effect": "SHOW",
"condition": {
"scope": "#/properties/documentTypes/properties/enabledDocuments",
"schema": {
"contains": {
"const": "creditNote"
}
}
}
}
},
{
"type": "Category",
"label": "Debit Note",
"elements": [
{
"type": "Group",
"label": "Debit Note Settings",
"elements": [
{
"type": "HorizontalLayout",
"elements": [
{
"type": "Control",
"scope": "#/properties/documentTypes/properties/documentSettings/properties/debitNote/properties/series"
},
{
"type": "Control",
"scope": "#/properties/documentTypes/properties/documentSettings/properties/debitNote/properties/startNumber"
},
{
"type": "Control",
"scope": "#/properties/documentTypes/properties/documentSettings/properties/debitNote/properties/folioDigits"
}
]
},
{
"type": "Control",
"scope": "#/properties/documentTypes/properties/documentSettings/properties/debitNote/properties/requiresReference"
}
]
}
],
"rule": {
"effect": "SHOW",
"condition": {
"scope": "#/properties/documentTypes/properties/enabledDocuments",
"schema": {
"contains": {
"const": "debitNote"
}
}
}
}
}
]
}
]
},
{
"type": "Category",
"label": "Notifications",
"elements": [
{
"type": "Group",
"label": "Customer Notifications",
"elements": [
{
"type": "Control",
"scope": "#/properties/notifications/properties/emailNotifications/properties/sendToCustomer"
},
{
"type": "HorizontalLayout",
"elements": [
{
"type": "Control",
"scope": "#/properties/notifications/properties/emailNotifications/properties/attachPdf"
},
{
"type": "Control",
"scope": "#/properties/notifications/properties/emailNotifications/properties/attachXml"
}
],
"rule": {
"effect": "SHOW",
"condition": {
"scope": "#/properties/notifications/properties/emailNotifications/properties/sendToCustomer",
"schema": {
"const": true
}
}
}
},
{
"type": "Control",
"scope": "#/properties/notifications/properties/emailNotifications/properties/customMessage",
"options": {
"multi": true
},
"rule": {
"effect": "SHOW",
"condition": {
"scope": "#/properties/notifications/properties/emailNotifications/properties/sendToCustomer",
"schema": {
"const": true
}
}
}
},
{
"type": "Control",
"scope": "#/properties/notifications/properties/emailNotifications/properties/ccEmails",
"options": {
"detail": {
"type": "VerticalLayout",
"elements": [
{
"type": "Control",
"scope": "#/properties/email"
}
]
}
},
"rule": {
"effect": "SHOW",
"condition": {
"scope": "#/properties/notifications/properties/emailNotifications/properties/sendToCustomer",
"schema": {
"const": true
}
}
}
},
{
"type": "Control",
"scope": "#/properties/notifications/properties/emailNotifications/properties/bccEmails",
"options": {
"detail": {
"type": "VerticalLayout",
"elements": [
{
"type": "Control",
"scope": "#/properties/email"
}
]
}
},
"rule": {
"effect": "SHOW",
"condition": {
"scope": "#/properties/notifications/properties/emailNotifications/properties/sendToCustomer",
"schema": {
"const": true
}
}
}
}
]
},
{
"type": "Group",
"label": "Admin Notifications",
"elements": [
{
"type": "Control",
"scope": "#/properties/notifications/properties/adminNotifications/properties/errorNotifications"
},
{
"type": "Control",
"scope": "#/properties/notifications/properties/adminNotifications/properties/successSummary"
},
{
"type": "Control",
"scope": "#/properties/notifications/properties/adminNotifications/properties/notificationEmails",
"options": {
"detail": {
"type": "VerticalLayout",
"elements": [
{
"type": "Control",
"scope": "#/properties/email"
}
]
}
},
"rule": {
"effect": "SHOW",
"condition": {
"type": "OR",
"conditions": [
{
"scope": "#/properties/notifications/properties/adminNotifications/properties/errorNotifications",
"schema": {
"const": true
}
},
{
"scope": "#/properties/notifications/properties/adminNotifications/properties/successSummary",
"schema": {
"const": true
}
}
]
}
}
}
]
}
]
},
{
"type": "Category",
"label": "Integration",
"elements": [
{
"type": "Group",
"label": "Fiscal Authority Integration",
"elements": [
{
"type": "Control",
"scope": "#/properties/integration/properties/webServiceUrl"
},
{
"type": "HorizontalLayout",
"elements": [
{
"type": "Control",
"scope": "#/properties/integration/properties/apiKeys/properties/production",
"options": {
"format": "password"
}
},
{
"type": "Control",
"scope": "#/properties/integration/properties/apiKeys/properties/testing",
"options": {
"format": "password"
}
}
]
}
]
},
{
"type": "Group",
"label": "Webhook Configuration",
"elements": [
{
"type": "Control",
"scope": "#/properties/integration/properties/webhook/properties/enableWebhook"
},
{
"type": "Control",
"scope": "#/properties/integration/properties/webhook/properties/webhookUrl",
"rule": {
"effect": "SHOW",
"condition": {
"scope": "#/properties/integration/properties/webhook/properties/enableWebhook",
"schema": {
"const": true
}
}
}
},
{
"type": "Control",
"scope": "#/properties/integration/properties/webhook/properties/secret",
"options": {
"format": "password"
},
"rule": {
"effect": "SHOW",
"condition": {
"scope": "#/properties/integration/properties/webhook/properties/enableWebhook",
"schema": {
"const": true
}
}
}
}
]
}
]
}
]
},
"data": {
"companyProfile": {
"legalName": "",
"commercialName": "",
"taxIdentifier": "",
"fiscalRegime": "",
"address": {
"street": "",
"number": "",
"city": "",
"state": "",
"postalCode": "",
"country": ""
},
"contact": {
"email": null,
"phone": "",
"website": null
},
"logo": null
},
"digitalSignature": {
"certificateType": "testing",
"certificateFile": "",
"privateKeyFile": "",
"privateKeyPassword": "",
"certificateExpiration": null,
"enableNotifications": true,
"notificationThreshold": 30
},
"documentTypes": {
"enabledDocuments": [
"invoice"
],
"documentSettings": {
"invoice": {
"series": "A",
"startNumber": 1,
"folioDigits": 8,
"defaultCurrency": "USD",
"defaultTaxRate": 0
},
"creditNote": {
"series": "NC",
"startNumber": 1,
"folioDigits": 8,
"requiresReference": true
},
"debitNote": {
"series": "ND",
"startNumber": 1,
"folioDigits": 8,
"requiresReference": true
}
}
},
"notifications": {
"emailNotifications": {
"sendToCustomer": true,
"attachPdf": true,
"attachXml": true,
"customMessage": "",
"ccEmails": [],
"bccEmails": []
},
"adminNotifications": {
"errorNotifications": true,
"successSummary": false,
"notificationEmails": []
}
},
"integration": {
"webServiceUrl": null,
"apiKeys": {
"production": "",
"testing": ""
},
"webhook": {
"enableWebhook": false,
"webhookUrl": null,
"secret": ""
}
}
}
}
WIP: Work In Progress.
{
"type": "object",
"properties": {
"companyProfile": {
"type": "object",
"properties": {
"legalName": {
"type": "string",
"title": "Legal Name"
},
"commercialName": {
"type": "string",
"title": "Commercial Name"
},
"taxIdentifier": {
"type": "string",
"title": "Tax ID"
},
"fiscalRegime": {
"type": "string",
"title": "Fiscal Regime"
},
"address": {
"type": "object",
"properties": {
"street": {
"type": "string",
"title": "Street"
},
"number": {
"type": "string",
"title": "Number"
},
"city": {
"type": "string",
"title": "City"
},
"state": {
"type": "string",
"title": "State/Province"
},
"postalCode": {
"type": "string",
"title": "Postal Code"
},
"country": {
"type": "string",
"title": "Country"
}
},
"required": [
"street",
"number",
"city",
"country"
]
},
"contact": {
"type": "object",
"properties": {
"email": {
"type": "string",
"title": "Email",
"format": "email"
},
"phone": {
"type": "string",
"title": "Phone"
},
"website": {
"type": "string",
"title": "Website",
"format": "uri"
}
},
"required": [
"email"
]
},
"logo": {
"type": "string",
"title": "Company Logo URL",
"format": "uri"
}
},
"required": [
"legalName",
"taxIdentifier",
"fiscalRegime"
]
},
"digitalSignature": {
"type": "object",
"properties": {
"certificateType": {
"type": "string",
"title": "Certificate Type",
"default": "testing",
"enum": [
"production",
"testing"
]
},
"certificateFile": {
"type": "string",
"title": "Certificate File (.cer)"
},
"privateKeyFile": {
"type": "string",
"title": "Private Key File (.key)"
},
"privateKeyPassword": {
"type": "string",
"title": "Private Key Password"
},
"certificateExpiration": {
"type": "string",
"title": "Certificate Expiration Date",
"format": "date"
},
"enableNotifications": {
"type": "boolean",
"title": "Enable Expiration Notifications",
"default": true
},
"notificationThreshold": {
"type": "number",
"title": "Days Before Expiration to Notify",
"default": 30,
"maximum": 90,
"minimum": 1
}
},
"required": [
"certificateType",
"certificateFile",
"privateKeyFile",
"privateKeyPassword"
]
},
"documentTypes": {
"type": "object",
"properties": {
"enabledDocuments": {
"type": "array",
"title": "Enabled Document Types",
"default": [
"invoice"
],
"items": {
"type": "string",
"enum": [
"invoice",
"creditNote",
"debitNote",
"receipt",
"paymentReceipt"
]
},
"uniqueItems": true
},
"documentSettings": {
"type": "object",
"properties": {
"invoice": {
"type": "object",
"properties": {
"series": {
"type": "string",
"title": "Series",
"default": "A"
},
"startNumber": {
"type": "number",
"title": "Starting Number",
"default": 1
},
"folioDigits": {
"type": "number",
"title": "Folio Digits",
"default": 8,
"maximum": 10,
"minimum": 1
},
"defaultCurrency": {
"type": "string",
"title": "Default Currency",
"default": "USD"
},
"defaultTaxRate": {
"type": "number",
"title": "Default Tax Rate (%)",
"default": 0
}
}
},
"creditNote": {
"type": "object",
"properties": {
"series": {
"type": "string",
"title": "Series",
"default": "NC"
},
"startNumber": {
"type": "number",
"title": "Starting Number",
"default": 1
},
"folioDigits": {
"type": "number",
"title": "Folio Digits",
"default": 8
},
"requiresReference": {
"type": "boolean",
"title": "Requires Reference to Invoice",
"default": true
}
}
},
"debitNote": {
"type": "object",
"properties": {
"series": {
"type": "string",
"title": "Series",
"default": "ND"
},
"startNumber": {
"type": "number",
"title": "Starting Number",
"default": 1
},
"folioDigits": {
"type": "number",
"title": "Folio Digits",
"default": 8
},
"requiresReference": {
"type": "boolean",
"title": "Requires Reference to Invoice",
"default": true
}
}
}
}
}
}
},
"notifications": {
"type": "object",
"properties": {
"emailNotifications": {
"type": "object",
"properties": {
"sendToCustomer": {
"type": "boolean",
"title": "Send Email to Customer",
"default": true
},
"attachPdf": {
"type": "boolean",
"title": "Attach PDF",
"default": true
},
"attachXml": {
"type": "boolean",
"title": "Attach XML",
"default": true
},
"customMessage": {
"type": "string",
"title": "Custom Message Template"
},
"ccEmails": {
"type": "array",
"title": "CC Email Addresses",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"title": "Email"
}
},
"required": [
"email"
]
}
},
"bccEmails": {
"type": "array",
"title": "BCC Email Addresses",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"title": "Email"
}
},
"required": [
"email"
]
}
}
}
},
"adminNotifications": {
"type": "object",
"properties": {
"errorNotifications": {
"type": "boolean",
"title": "Receive Error Notifications",
"default": true
},
"successSummary": {
"type": "boolean",
"title": "Receive Daily Success Summary",
"default": false
},
"notificationEmails": {
"type": "array",
"title": "Notification Emails",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"title": "Email"
}
},
"required": [
"email"
]
}
}
}
}
}
},
"integration": {
"type": "object",
"properties": {
"webServiceUrl": {
"type": "string",
"title": "Fiscal Authority Web Service URL",
"format": "uri"
},
"apiKeys": {
"type": "object",
"properties": {
"production": {
"type": "string",
"title": "Production API Key"
},
"testing": {
"type": "string",
"title": "Testing API Key"
}
}
},
"webhook": {
"type": "object",
"properties": {
"enableWebhook": {
"type": "boolean",
"title": "Enable Status Webhook",
"default": false
},
"webhookUrl": {
"type": "string",
"title": "Webhook URL",
"format": "uri"
},
"secret": {
"type": "string",
"title": "Webhook Secret"
}
}
}
}
}
},
"required": [
"companyProfile",
"digitalSignature"
]
}{
"type": "Categorization",
"elements": [
{
"type": "Category",
"label": "Company Profile",
"elements": [
{
"type": "Group",
"label": "Company Information",
"elements": [
{
"type": "HorizontalLayout",
"elements": [
{
"type": "Control",
"scope": "#/properties/companyProfile/properties/legalName"
},
{
"type": "Control",
"scope": "#/properties/companyProfile/properties/commercialName"
}
]
},
{
"type": "HorizontalLayout",
"elements": [
{
"type": "Control",
"scope": "#/properties/companyProfile/properties/taxIdentifier"
},
{
"type": "Control",
"scope": "#/properties/companyProfile/properties/fiscalRegime"
}
]
}
]
},
{
"type": "Group",
"label": "Address",
"elements": [
{
"type": "HorizontalLayout",
"elements": [
{
"type": "Control",
"scope": "#/properties/companyProfile/properties/address/properties/street"
},
{
"type": "Control",
"scope": "#/properties/companyProfile/properties/address/properties/number"
}
]
},
{
"type": "HorizontalLayout",
"elements": [
{
"type": "Control",
"scope": "#/properties/companyProfile/properties/address/properties/city"
},
{
"type": "Control",
"scope": "#/properties/companyProfile/properties/address/properties/state"
}
]
},
{
"type": "HorizontalLayout",
"elements": [
{
"type": "Control",
"scope": "#/properties/companyProfile/properties/address/properties/postalCode"
},
{
"type": "Control",
"scope": "#/properties/companyProfile/properties/address/properties/country"
}
]
}
]
},
{
"type": "Group",
"label": "Contact Information",
"elements": [
{
"type": "HorizontalLayout",
"elements": [
{
"type": "Control",
"scope": "#/properties/companyProfile/properties/contact/properties/email"
},
{
"type": "Control",
"scope": "#/properties/companyProfile/properties/contact/properties/phone"
},
{
"type": "Control",
"scope": "#/properties/companyProfile/properties/contact/properties/website"
}
]
}
]
},
{
"type": "Group",
"label": "Branding",
"elements": [
{
"type": "Control",
"scope": "#/properties/companyProfile/properties/logo",
"options": {
"format": "file"
}
}
]
}
]
},
{
"type": "Category",
"label": "Digital Signature",
"elements": [
{
"type": "Group",
"label": "Certificate Information",
"elements": [
{
"type": "Control",
"scope": "#/properties/digitalSignature/properties/certificateType",
"options": {
"format": "radio"
}
},
{
"type": "HorizontalLayout",
"elements": [
{
"type": "Control",
"scope": "#/properties/digitalSignature/properties/certificateFile",
"options": {
"format": "file"
}
},
{
"type": "Control",
"scope": "#/properties/digitalSignature/properties/privateKeyFile",
"options": {
"format": "file"
}
}
]
},
{
"type": "Control",
"scope": "#/properties/digitalSignature/properties/privateKeyPassword",
"options": {
"format": "password"
}
},
{
"type": "Control",
"scope": "#/properties/digitalSignature/properties/certificateExpiration"
}
]
},
{
"type": "Group",
"label": "Expiration Notifications",
"elements": [
{
"type": "Control",
"scope": "#/properties/digitalSignature/properties/enableNotifications"
},
{
"type": "Control",
"scope": "#/properties/digitalSignature/properties/notificationThreshold",
"rule": {
"effect": "SHOW",
"condition": {
"scope": "#/properties/digitalSignature/properties/enableNotifications",
"schema": {
"const": true
}
}
}
}
]
}
]
},
{
"type": "Category",
"label": "Document Types",
"elements": [
{
"type": "Group",
"label": "Enabled Documents",
"elements": [
{
"type": "Control",
"scope": "#/properties/documentTypes/properties/enabledDocuments",
"options": {
"format": "checkbox"
}
}
]
},
{
"type": "Categorization",
"elements": [
{
"type": "Category",
"label": "Invoice",
"elements": [
{
"type": "Group",
"label": "Invoice Settings",
"elements": [
{
"type": "HorizontalLayout",
"elements": [
{
"type": "Control",
"scope": "#/properties/documentTypes/properties/documentSettings/properties/invoice/properties/series"
},
{
"type": "Control",
"scope": "#/properties/documentTypes/properties/documentSettings/properties/invoice/properties/startNumber"
},
{
"type": "Control",
"scope": "#/properties/documentTypes/properties/documentSettings/properties/invoice/properties/folioDigits"
}
]
},
{
"type": "HorizontalLayout",
"elements": [
{
"type": "Control",
"scope": "#/properties/documentTypes/properties/documentSettings/properties/invoice/properties/defaultCurrency"
},
{
"type": "Control",
"scope": "#/properties/documentTypes/properties/documentSettings/properties/invoice/properties/defaultTaxRate"
}
]
}
]
}
],
"rule": {
"effect": "SHOW",
"condition": {
"scope": "#/properties/documentTypes/properties/enabledDocuments",
"schema": {
"contains": {
"const": "invoice"
}
}
}
}
},
{
"type": "Category",
"label": "Credit Note",
"elements": [
{
"type": "Group",
"label": "Credit Note Settings",
"elements": [
{
"type": "HorizontalLayout",
"elements": [
{
"type": "Control",
"scope": "#/properties/documentTypes/properties/documentSettings/properties/creditNote/properties/series"
},
{
"type": "Control",
"scope": "#/properties/documentTypes/properties/documentSettings/properties/creditNote/properties/startNumber"
},
{
"type": "Control",
"scope": "#/properties/documentTypes/properties/documentSettings/properties/creditNote/properties/folioDigits"
}
]
},
{
"type": "Control",
"scope": "#/properties/documentTypes/properties/documentSettings/properties/creditNote/properties/requiresReference"
}
]
}
],
"rule": {
"effect": "SHOW",
"condition": {
"scope": "#/properties/documentTypes/properties/enabledDocuments",
"schema": {
"contains": {
"const": "creditNote"
}
}
}
}
},
{
"type": "Category",
"label": "Debit Note",
"elements": [
{
"type": "Group",
"label": "Debit Note Settings",
"elements": [
{
"type": "HorizontalLayout",
"elements": [
{
"type": "Control",
"scope": "#/properties/documentTypes/properties/documentSettings/properties/debitNote/properties/series"
},
{
"type": "Control",
"scope": "#/properties/documentTypes/properties/documentSettings/properties/debitNote/properties/startNumber"
},
{
"type": "Control",
"scope": "#/properties/documentTypes/properties/documentSettings/properties/debitNote/properties/folioDigits"
}
]
},
{
"type": "Control",
"scope": "#/properties/documentTypes/properties/documentSettings/properties/debitNote/properties/requiresReference"
}
]
}
],
"rule": {
"effect": "SHOW",
"condition": {
"scope": "#/properties/documentTypes/properties/enabledDocuments",
"schema": {
"contains": {
"const": "debitNote"
}
}
}
}
}
],
"options": []
}
]
},
{
"type": "Category",
"label": "Notifications",
"elements": [
{
"type": "Group",
"label": "Customer Notifications",
"elements": [
{
"type": "Control",
"scope": "#/properties/notifications/properties/emailNotifications/properties/sendToCustomer"
},
{
"type": "HorizontalLayout",
"elements": [
{
"type": "Control",
"scope": "#/properties/notifications/properties/emailNotifications/properties/attachPdf"
},
{
"type": "Control",
"scope": "#/properties/notifications/properties/emailNotifications/properties/attachXml"
}
]
},
{
"type": "Control",
"scope": "#/properties/notifications/properties/emailNotifications/properties/customMessage",
"options": {
"multi": true
},
"rule": {
"effect": "SHOW",
"condition": {
"scope": "#/properties/notifications/properties/emailNotifications/properties/sendToCustomer",
"schema": {
"const": true
}
}
}
},
{
"type": "Control",
"scope": "#/properties/notifications/properties/emailNotifications/properties/ccEmails",
"options": {
"detail": {
"type": "VerticalLayout",
"elements": [
{
"type": "Control",
"scope": "#/properties/email"
}
]
}
},
"rule": {
"effect": "SHOW",
"condition": {
"scope": "#/properties/notifications/properties/emailNotifications/properties/sendToCustomer",
"schema": {
"const": true
}
}
}
},
{
"type": "Control",
"scope": "#/properties/notifications/properties/emailNotifications/properties/bccEmails",
"options": {
"detail": {
"type": "VerticalLayout",
"elements": [
{
"type": "Control",
"scope": "#/properties/email"
}
]
}
},
"rule": {
"effect": "SHOW",
"condition": {
"scope": "#/properties/notifications/properties/emailNotifications/properties/sendToCustomer",
"schema": {
"const": true
}
}
}
}
]
},
{
"type": "Group",
"label": "Admin Notifications",
"elements": [
{
"type": "Control",
"scope": "#/properties/notifications/properties/adminNotifications/properties/errorNotifications"
},
{
"type": "Control",
"scope": "#/properties/notifications/properties/adminNotifications/properties/successSummary"
},
{
"type": "Control",
"scope": "#/properties/notifications/properties/adminNotifications/properties/notificationEmails",
"options": {
"detail": {
"type": "VerticalLayout",
"elements": [
{
"type": "Control",
"scope": "#/properties/email"
}
]
}
},
"rule": {
"effect": "SHOW",
"condition": {
"type": "OR",
"conditions": [
{
"scope": "#/properties/notifications/properties/adminNotifications/properties/errorNotifications",
"schema": {
"const": true
}
},
{
"scope": "#/properties/notifications/properties/adminNotifications/properties/successSummary",
"schema": {
"const": true
}
}
]
}
}
}
]
}
]
},
{
"type": "Category",
"label": "Integration",
"elements": [
{
"type": "Group",
"label": "Fiscal Authority Integration",
"elements": [
{
"type": "Control",
"scope": "#/properties/integration/properties/webServiceUrl"
},
{
"type": "HorizontalLayout",
"elements": [
{
"type": "Control",
"scope": "#/properties/integration/properties/apiKeys/properties/production",
"options": {
"format": "password"
}
},
{
"type": "Control",
"scope": "#/properties/integration/properties/apiKeys/properties/testing",
"options": {
"format": "password"
}
}
]
}
]
},
{
"type": "Group",
"label": "Webhook Configuration",
"elements": [
{
"type": "Control",
"scope": "#/properties/integration/properties/webhook/properties/enableWebhook"
},
{
"type": "Control",
"scope": "#/properties/integration/properties/webhook/properties/webhookUrl",
"rule": {
"effect": "SHOW",
"condition": {
"scope": "#/properties/integration/properties/webhook/properties/enableWebhook",
"schema": {
"const": true
}
}
}
},
{
"type": "Control",
"scope": "#/properties/integration/properties/webhook/properties/secret",
"options": {
"format": "password"
},
"rule": {
"effect": "SHOW",
"condition": {
"scope": "#/properties/integration/properties/webhook/properties/enableWebhook",
"schema": {
"const": true
}
}
}
}
]
}
]
}
],
"options": []
}{
"companyProfile": {
"legalName": "",
"commercialName": "",
"taxIdentifier": "",
"fiscalRegime": "",
"address": {
"street": "",
"number": "",
"city": "",
"state": "",
"postalCode": "",
"country": ""
},
"contact": {
"email": null,
"phone": "",
"website": null
},
"logo": null
},
"digitalSignature": {
"certificateType": "testing",
"certificateFile": "",
"privateKeyFile": "",
"privateKeyPassword": "",
"certificateExpiration": null,
"enableNotifications": true,
"notificationThreshold": 30
},
"documentTypes": {
"enabledDocuments": [
"invoice"
],
"documentSettings": {
"invoice": {
"series": "A",
"startNumber": 1,
"folioDigits": 8,
"defaultCurrency": "USD",
"defaultTaxRate": 0
},
"creditNote": {
"series": "NC",
"startNumber": 1,
"folioDigits": 8,
"requiresReference": true
},
"debitNote": {
"series": "ND",
"startNumber": 1,
"folioDigits": 8,
"requiresReference": true
}
}
},
"notifications": {
"emailNotifications": {
"sendToCustomer": true,
"attachPdf": true,
"attachXml": true,
"customMessage": "",
"ccEmails": [],
"bccEmails": []
},
"adminNotifications": {
"errorNotifications": true,
"successSummary": false,
"notificationEmails": []
}
},
"integration": {
"webServiceUrl": null,
"apiKeys": {
"production": "",
"testing": ""
},
"webhook": {
"enableWebhook": false,
"webhookUrl": null,
"secret": ""
}
}
}
Tags: #categories #groups #conditionalCategories #conditionalFields #nullableFields
010_config
