{"items":[{"type":"link","label":"Prana Partner API","link":"/pranaapi/openapiprana","routeSlug":"/pranaapi/openapiprana","content":{"contentType":"overview","meta":{"name":"Prana Partner API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapiprana.json","url":"/_bundle/PranaAPI/openapiprana.json?download"},{"kind":"download","label":"openapiprana.yaml","url":"/_bundle/PranaAPI/openapiprana.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.prana.software"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Prana Partner API (1.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"API definition for Partners to interact with the Prana platform"}],"sectionId":"/pranaapi/openapiprana"}],"sectionId":"/pranaapi/openapiprana"}]}]}},{"type":"group","label":"partner-customer-controller","link":"/pranaapi/openapiprana/partner-customer-controller","routeSlug":"/pranaapi/openapiprana/partner-customer-controller","items":[{"label":"getByIdPartnerCustomer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pranaapi/openapiprana/partner-customer-controller/getbyidpartnercustomer","routeSlug":"/pranaapi/openapiprana/partner-customer-controller/getbyidpartnercustomer","metadata":{"seo":{"title":"getByIdPartnerCustomer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getByIdPartnerCustomer","name":"getByIdPartnerCustomer","isWebhook":false,"pointer":"/paths/~1api~1v1~1partner~1subscription~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"getByIdPartnerCustomer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1partner~1subscription~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/partner/subscription/{id}","servers":[{"url":"https://api.prana.software"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/api/v1/partner/subscription/{id}","href":"partner-customer-controller/getbyidpartnercustomer","openApiOperationId":"getByIdPartnerCustomer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.prana.software"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiPartnerCustomerReadDto"}},"schemaId":"components/schemas/ApiPartnerCustomerReadDto"}],"pointer":"/paths/~1api~1v1~1partner~1subscription~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiPartnerCustomerReadDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiPartnerCustomerReadDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/partner-customer-controller/getbyidpartnercustomer"}],"panels":[]}]},"httpPath":"/api/v1/partner/subscription/{id}"},{"label":"updatePartnerCustomer","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pranaapi/openapiprana/partner-customer-controller/updatepartnercustomer","routeSlug":"/pranaapi/openapiprana/partner-customer-controller/updatepartnercustomer","metadata":{"seo":{"title":"updatePartnerCustomer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePartnerCustomer","name":"updatePartnerCustomer","isWebhook":false,"pointer":"/paths/~1api~1v1~1partner~1subscription~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"updatePartnerCustomer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1partner~1subscription~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiPartnerCustomerWriteDto"}},"schemaId":"components/schemas/ApiPartnerCustomerWriteDto","pointer":"/paths/~1api~1v1~1partner~1subscription~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/partner/subscription/{id}","servers":[{"url":"https://api.prana.software"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiPartnerCustomerWriteDto"}},"responseCodes":["200"],"pointer":"/api/v1/partner/subscription/{id}","href":"partner-customer-controller/updatepartnercustomer","openApiOperationId":"updatePartnerCustomer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.prana.software"}],"schemaId":"components/schemas/ApiPartnerCustomerWriteDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiPartnerCustomerWriteDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiPartnerCustomerReadDto"}},"schemaId":"components/schemas/ApiPartnerCustomerReadDto"}],"pointer":"/paths/~1api~1v1~1partner~1subscription~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiPartnerCustomerReadDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiPartnerCustomerReadDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/partner-customer-controller/updatepartnercustomer"}],"panels":[]}]},"httpPath":"/api/v1/partner/subscription/{id}"},{"label":"deletePartnerCustomer","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pranaapi/openapiprana/partner-customer-controller/deletepartnercustomer","routeSlug":"/pranaapi/openapiprana/partner-customer-controller/deletepartnercustomer","metadata":{"seo":{"title":"deletePartnerCustomer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePartnerCustomer","name":"deletePartnerCustomer","isWebhook":false,"pointer":"/paths/~1api~1v1~1partner~1subscription~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"deletePartnerCustomer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1partner~1subscription~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/partner/subscription/{id}","servers":[{"url":"https://api.prana.software"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/api/v1/partner/subscription/{id}","href":"partner-customer-controller/deletepartnercustomer","openApiOperationId":"deletePartnerCustomer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.prana.software"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1api~1v1~1partner~1subscription~1{id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/partner-customer-controller/deletepartnercustomer"}],"panels":[]}]},"httpPath":"/api/v1/partner/subscription/{id}"},{"label":"patchPartnerCustomer","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pranaapi/openapiprana/partner-customer-controller/patchpartnercustomer","routeSlug":"/pranaapi/openapiprana/partner-customer-controller/patchpartnercustomer","metadata":{"seo":{"title":"patchPartnerCustomer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchPartnerCustomer","name":"patchPartnerCustomer","isWebhook":false,"pointer":"/paths/~1api~1v1~1partner~1subscription~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"patchPartnerCustomer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1partner~1subscription~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1"}},"schemaId":"schema_1","pointer":"/paths/~1api~1v1~1partner~1subscription~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/partner/subscription/{id}","servers":[{"url":"https://api.prana.software"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1"}},"responseCodes":["200"],"pointer":"/api/v1/partner/subscription/{id}","href":"partner-customer-controller/patchpartnercustomer","openApiOperationId":"patchPartnerCustomer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.prana.software"}],"schemaId":"schema_1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiPartnerCustomerReadDto"}},"schemaId":"components/schemas/ApiPartnerCustomerReadDto"}],"pointer":"/paths/~1api~1v1~1partner~1subscription~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiPartnerCustomerReadDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiPartnerCustomerReadDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/partner-customer-controller/patchpartnercustomer"}],"panels":[]}]},"httpPath":"/api/v1/partner/subscription/{id}"},{"label":"activatePartnerCustomer","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pranaapi/openapiprana/partner-customer-controller/activatepartnercustomer","routeSlug":"/pranaapi/openapiprana/partner-customer-controller/activatepartnercustomer","metadata":{"seo":{"title":"activatePartnerCustomer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"activatePartnerCustomer","name":"activatePartnerCustomer","isWebhook":false,"pointer":"/paths/~1api~1v1~1partner~1subscription~1activate/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"activatePartnerCustomer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiManagementActivateRequestDto"}},"schemaId":"components/schemas/ApiManagementActivateRequestDto","pointer":"/paths/~1api~1v1~1partner~1subscription~1activate/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/partner/subscription/activate","servers":[{"url":"https://api.prana.software"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiManagementActivateRequestDto"}},"responseCodes":["200"],"pointer":"/api/v1/partner/subscription/activate","href":"partner-customer-controller/activatepartnercustomer","openApiOperationId":"activatePartnerCustomer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.prana.software"}],"schemaId":"components/schemas/ApiManagementActivateRequestDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiManagementActivateRequestDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1api~1v1~1partner~1subscription~1activate/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/partner-customer-controller/activatepartnercustomer"}],"panels":[]}]},"httpPath":"/api/v1/partner/subscription/activate"},{"label":"getAllPartnerCustomer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pranaapi/openapiprana/partner-customer-controller/getallpartnercustomer","routeSlug":"/pranaapi/openapiprana/partner-customer-controller/getallpartnercustomer","metadata":{"seo":{"title":"getAllPartnerCustomer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllPartnerCustomer","name":"getAllPartnerCustomer","isWebhook":false,"pointer":"/paths/~1api~1v1~1partner~1subscription~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"getAllPartnerCustomer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiSearchCriteriaDto"}},"schemaId":"components/schemas/ApiSearchCriteriaDto","pointer":"/paths/~1api~1v1~1partner~1subscription~1search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/partner/subscription/search","servers":[{"url":"https://api.prana.software"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiSearchCriteriaDto"}},"responseCodes":["200"],"pointer":"/api/v1/partner/subscription/search","href":"partner-customer-controller/getallpartnercustomer","openApiOperationId":"getAllPartnerCustomer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.prana.software"}],"schemaId":"components/schemas/ApiSearchCriteriaDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiSearchCriteriaDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiPageDtoPartnerCustomerListReadDto"}},"schemaId":"components/schemas/ApiPageDtoPartnerCustomerListReadDto"}],"pointer":"/paths/~1api~1v1~1partner~1subscription~1search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiPageDtoPartnerCustomerListReadDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiPageDtoPartnerCustomerListReadDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/partner-customer-controller/getallpartnercustomer"}],"panels":[]}]},"httpPath":"/api/v1/partner/subscription/search"},{"label":"getRenewalPartnerCustomer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pranaapi/openapiprana/partner-customer-controller/getrenewalpartnercustomer","routeSlug":"/pranaapi/openapiprana/partner-customer-controller/getrenewalpartnercustomer","metadata":{"seo":{"title":"getRenewalPartnerCustomer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRenewalPartnerCustomer","name":"getRenewalPartnerCustomer","isWebhook":false,"pointer":"/paths/~1api~1v1~1partner~1subscription~1renewal/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"getRenewalPartnerCustomer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","pointer":"/paths/~1api~1v1~1partner~1subscription~1renewal/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/partner/subscription/renewal","servers":[{"url":"https://api.prana.software"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_2"}},"responseCodes":["200"],"pointer":"/api/v1/partner/subscription/renewal","href":"partner-customer-controller/getrenewalpartnercustomer","openApiOperationId":"getRenewalPartnerCustomer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.prana.software"}],"schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_2"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3"}},"schemaId":"schema_3"}],"pointer":"/paths/~1api~1v1~1partner~1subscription~1renewal/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_3","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/partner-customer-controller/getrenewalpartnercustomer"}],"panels":[]}]},"httpPath":"/api/v1/partner/subscription/renewal"},{"label":"createPartnerCustomer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pranaapi/openapiprana/partner-customer-controller/createpartnercustomer","routeSlug":"/pranaapi/openapiprana/partner-customer-controller/createpartnercustomer","metadata":{"seo":{"title":"createPartnerCustomer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPartnerCustomer","name":"createPartnerCustomer","isWebhook":false,"pointer":"/paths/~1api~1v1~1partner~1subscription/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"createPartnerCustomer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiPartnerCustomerWriteDto"}},"schemaId":"components/schemas/ApiPartnerCustomerWriteDto","pointer":"/paths/~1api~1v1~1partner~1subscription/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/partner/subscription","servers":[{"url":"https://api.prana.software"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiPartnerCustomerWriteDto"}},"responseCodes":["200"],"pointer":"/api/v1/partner/subscription","href":"partner-customer-controller/createpartnercustomer","openApiOperationId":"createPartnerCustomer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.prana.software"}],"schemaId":"components/schemas/ApiPartnerCustomerWriteDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiPartnerCustomerWriteDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiPartnerCustomerReadDto"}},"schemaId":"components/schemas/ApiPartnerCustomerReadDto"}],"pointer":"/paths/~1api~1v1~1partner~1subscription/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiPartnerCustomerReadDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiPartnerCustomerReadDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/partner-customer-controller/createpartnercustomer"}],"panels":[]}]},"httpPath":"/api/v1/partner/subscription"},{"label":"deleteByIdsPartnerCustomer","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pranaapi/openapiprana/partner-customer-controller/deletebyidspartnercustomer","routeSlug":"/pranaapi/openapiprana/partner-customer-controller/deletebyidspartnercustomer","metadata":{"seo":{"title":"deleteByIdsPartnerCustomer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteByIdsPartnerCustomer","name":"deleteByIdsPartnerCustomer","isWebhook":false,"pointer":"/paths/~1api~1v1~1partner~1subscription/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"deleteByIdsPartnerCustomer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiDeleteByIdsRequestDto"}},"schemaId":"components/schemas/ApiDeleteByIdsRequestDto","pointer":"/paths/~1api~1v1~1partner~1subscription/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/partner/subscription","servers":[{"url":"https://api.prana.software"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiDeleteByIdsRequestDto"}},"responseCodes":["200"],"pointer":"/api/v1/partner/subscription","href":"partner-customer-controller/deletebyidspartnercustomer","openApiOperationId":"deleteByIdsPartnerCustomer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.prana.software"}],"schemaId":"components/schemas/ApiDeleteByIdsRequestDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiDeleteByIdsRequestDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_4"}},"schemaId":"schema_4"}],"pointer":"/paths/~1api~1v1~1partner~1subscription/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_4","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_4"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/partner-customer-controller/deletebyidspartnercustomer"}],"panels":[]}]},"httpPath":"/api/v1/partner/subscription"}],"content":{"contentType":"group","meta":{"name":"partner-customer-controller"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"partner-customer-controller","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/partner/subscription/{id}","summary":"getByIdPartnerCustomer","prefix":{"name":"get","color":"get"},"badges":[],"link":"/partner-customer-controller/getbyidpartnercustomer","deprecated":false},{"title":"/api/v1/partner/subscription/{id}","summary":"updatePartnerCustomer","prefix":{"name":"put","color":"put"},"badges":[],"link":"/partner-customer-controller/updatepartnercustomer","deprecated":false},{"title":"/api/v1/partner/subscription/{id}","summary":"deletePartnerCustomer","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/partner-customer-controller/deletepartnercustomer","deprecated":false},{"title":"/api/v1/partner/subscription/{id}","summary":"patchPartnerCustomer","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/partner-customer-controller/patchpartnercustomer","deprecated":false},{"title":"/api/v1/partner/subscription/activate","summary":"activatePartnerCustomer","prefix":{"name":"put","color":"put"},"badges":[],"link":"/partner-customer-controller/activatepartnercustomer","deprecated":false},{"title":"/api/v1/partner/subscription/search","summary":"getAllPartnerCustomer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/partner-customer-controller/getallpartnercustomer","deprecated":false},{"title":"/api/v1/partner/subscription/renewal","summary":"getRenewalPartnerCustomer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/partner-customer-controller/getrenewalpartnercustomer","deprecated":false},{"title":"/api/v1/partner/subscription","summary":"createPartnerCustomer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/partner-customer-controller/createpartnercustomer","deprecated":false},{"title":"/api/v1/partner/subscription","summary":"deleteByIdsPartnerCustomer","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/partner-customer-controller/deletebyidspartnercustomer","deprecated":false}]}]}]}]}},{"type":"group","label":"admin-company-controller","link":"/pranaapi/openapiprana/admin-company-controller","routeSlug":"/pranaapi/openapiprana/admin-company-controller","items":[{"label":"terminateSubscriptionAdminCompany","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pranaapi/openapiprana/admin-company-controller/terminatesubscriptionadmincompany","routeSlug":"/pranaapi/openapiprana/admin-company-controller/terminatesubscriptionadmincompany","metadata":{"seo":{"title":"terminateSubscriptionAdminCompany"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"terminateSubscriptionAdminCompany","name":"terminateSubscriptionAdminCompany","isWebhook":false,"pointer":"/paths/~1api~1v1~1partner~1admin~1company~1{companyId}~1terminate/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"terminateSubscriptionAdminCompany","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1partner~1admin~1company~1{companyId}~1terminate/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiCancelSubscriptionWriteDto"}},"schemaId":"components/schemas/ApiCancelSubscriptionWriteDto","pointer":"/paths/~1api~1v1~1partner~1admin~1company~1{companyId}~1terminate/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/partner/admin/company/{companyId}/terminate","servers":[{"url":"https://api.prana.software"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiCancelSubscriptionWriteDto"}},"responseCodes":["200"],"pointer":"/api/v1/partner/admin/company/{companyId}/terminate","href":"admin-company-controller/terminatesubscriptionadmincompany","openApiOperationId":"terminateSubscriptionAdminCompany"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.prana.software"}],"schemaId":"components/schemas/ApiCancelSubscriptionWriteDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiCancelSubscriptionWriteDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5"}],"pointer":"/paths/~1api~1v1~1partner~1admin~1company~1{companyId}~1terminate/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admin-company-controller/terminatesubscriptionadmincompany"}],"panels":[]}]},"httpPath":"/api/v1/partner/admin/company/{companyId}/terminate"},{"label":"cancelSubscriptionAdminCompany","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pranaapi/openapiprana/admin-company-controller/cancelsubscriptionadmincompany","routeSlug":"/pranaapi/openapiprana/admin-company-controller/cancelsubscriptionadmincompany","metadata":{"seo":{"title":"cancelSubscriptionAdminCompany"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelSubscriptionAdminCompany","name":"cancelSubscriptionAdminCompany","isWebhook":false,"pointer":"/paths/~1api~1v1~1partner~1admin~1company~1{companyId}~1cancel/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"cancelSubscriptionAdminCompany","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1partner~1admin~1company~1{companyId}~1cancel/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiCancelSubscriptionWriteDto"}},"schemaId":"components/schemas/ApiCancelSubscriptionWriteDto","pointer":"/paths/~1api~1v1~1partner~1admin~1company~1{companyId}~1cancel/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/partner/admin/company/{companyId}/cancel","servers":[{"url":"https://api.prana.software"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiCancelSubscriptionWriteDto"}},"responseCodes":["200"],"pointer":"/api/v1/partner/admin/company/{companyId}/cancel","href":"admin-company-controller/cancelsubscriptionadmincompany","openApiOperationId":"cancelSubscriptionAdminCompany"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.prana.software"}],"schemaId":"components/schemas/ApiCancelSubscriptionWriteDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiCancelSubscriptionWriteDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5"}],"pointer":"/paths/~1api~1v1~1partner~1admin~1company~1{companyId}~1cancel/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admin-company-controller/cancelsubscriptionadmincompany"}],"panels":[]}]},"httpPath":"/api/v1/partner/admin/company/{companyId}/cancel"}],"content":{"contentType":"group","meta":{"name":"admin-company-controller"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"admin-company-controller","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/partner/admin/company/{companyId}/terminate","summary":"terminateSubscriptionAdminCompany","prefix":{"name":"put","color":"put"},"badges":[],"link":"/admin-company-controller/terminatesubscriptionadmincompany","deprecated":false},{"title":"/api/v1/partner/admin/company/{companyId}/cancel","summary":"cancelSubscriptionAdminCompany","prefix":{"name":"put","color":"put"},"badges":[],"link":"/admin-company-controller/cancelsubscriptionadmincompany","deprecated":false}]}]}]}]}},{"type":"group","label":"management-state-controller","link":"/pranaapi/openapiprana/management-state-controller","routeSlug":"/pranaapi/openapiprana/management-state-controller","items":[{"label":"getAllManagementState","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pranaapi/openapiprana/management-state-controller/getallmanagementstate","routeSlug":"/pranaapi/openapiprana/management-state-controller/getallmanagementstate","metadata":{"seo":{"title":"getAllManagementState"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllManagementState","name":"getAllManagementState","isWebhook":false,"pointer":"/paths/~1api~1v1~1partner~1state~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"getAllManagementState","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiSearchCriteriaDto"}},"schemaId":"components/schemas/ApiSearchCriteriaDto","pointer":"/paths/~1api~1v1~1partner~1state~1search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/partner/state/search","servers":[{"url":"https://api.prana.software"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiSearchCriteriaDto"}},"responseCodes":["200"],"pointer":"/api/v1/partner/state/search","href":"management-state-controller/getallmanagementstate","openApiOperationId":"getAllManagementState"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.prana.software"}],"schemaId":"components/schemas/ApiSearchCriteriaDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiSearchCriteriaDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiPageDtoManagementStateListReadDto"}},"schemaId":"components/schemas/ApiPageDtoManagementStateListReadDto"}],"pointer":"/paths/~1api~1v1~1partner~1state~1search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiPageDtoManagementStateListReadDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiPageDtoManagementStateListReadDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/management-state-controller/getallmanagementstate"}],"panels":[]}]},"httpPath":"/api/v1/partner/state/search"}],"content":{"contentType":"group","meta":{"name":"management-state-controller"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"management-state-controller","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/partner/state/search","summary":"getAllManagementState","prefix":{"name":"post","color":"post"},"badges":[],"link":"/management-state-controller/getallmanagementstate","deprecated":false}]}]}]}]}},{"type":"group","label":"plan-controller","link":"/pranaapi/openapiprana/plan-controller","routeSlug":"/pranaapi/openapiprana/plan-controller","items":[{"label":"getAllPlan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pranaapi/openapiprana/plan-controller/getallplan","routeSlug":"/pranaapi/openapiprana/plan-controller/getallplan","metadata":{"seo":{"title":"getAllPlan"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllPlan","name":"getAllPlan","isWebhook":false,"pointer":"/paths/~1api~1v1~1partner~1plan~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"getAllPlan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiSearchCriteriaDto"}},"schemaId":"components/schemas/ApiSearchCriteriaDto","pointer":"/paths/~1api~1v1~1partner~1plan~1search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/partner/plan/search","servers":[{"url":"https://api.prana.software"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiSearchCriteriaDto"}},"responseCodes":["200"],"pointer":"/api/v1/partner/plan/search","href":"plan-controller/getallplan","openApiOperationId":"getAllPlan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.prana.software"}],"schemaId":"components/schemas/ApiSearchCriteriaDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiSearchCriteriaDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiPageDtoPlanListReadDto"}},"schemaId":"components/schemas/ApiPageDtoPlanListReadDto"}],"pointer":"/paths/~1api~1v1~1partner~1plan~1search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiPageDtoPlanListReadDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiPageDtoPlanListReadDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/plan-controller/getallplan"}],"panels":[]}]},"httpPath":"/api/v1/partner/plan/search"}],"content":{"contentType":"group","meta":{"name":"plan-controller"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"plan-controller","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/partner/plan/search","summary":"getAllPlan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/plan-controller/getallplan","deprecated":false}]}]}]}]}},{"type":"group","label":"management-period-controller","link":"/pranaapi/openapiprana/management-period-controller","routeSlug":"/pranaapi/openapiprana/management-period-controller","items":[{"label":"getAllManagementPeriod","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pranaapi/openapiprana/management-period-controller/getallmanagementperiod","routeSlug":"/pranaapi/openapiprana/management-period-controller/getallmanagementperiod","metadata":{"seo":{"title":"getAllManagementPeriod"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllManagementPeriod","name":"getAllManagementPeriod","isWebhook":false,"pointer":"/paths/~1api~1v1~1partner~1period~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"getAllManagementPeriod","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiSearchCriteriaDto"}},"schemaId":"components/schemas/ApiSearchCriteriaDto","pointer":"/paths/~1api~1v1~1partner~1period~1search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/partner/period/search","servers":[{"url":"https://api.prana.software"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiSearchCriteriaDto"}},"responseCodes":["200"],"pointer":"/api/v1/partner/period/search","href":"management-period-controller/getallmanagementperiod","openApiOperationId":"getAllManagementPeriod"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.prana.software"}],"schemaId":"components/schemas/ApiSearchCriteriaDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiSearchCriteriaDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiPageDtoManagementPeriodListReadDto"}},"schemaId":"components/schemas/ApiPageDtoManagementPeriodListReadDto"}],"pointer":"/paths/~1api~1v1~1partner~1period~1search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiPageDtoManagementPeriodListReadDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiPageDtoManagementPeriodListReadDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/management-period-controller/getallmanagementperiod"}],"panels":[]}]},"httpPath":"/api/v1/partner/period/search"}],"content":{"contentType":"group","meta":{"name":"management-period-controller"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"management-period-controller","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/partner/period/search","summary":"getAllManagementPeriod","prefix":{"name":"post","color":"post"},"badges":[],"link":"/management-period-controller/getallmanagementperiod","deprecated":false}]}]}]}]}},{"type":"group","label":"management-country-controller","link":"/pranaapi/openapiprana/management-country-controller","routeSlug":"/pranaapi/openapiprana/management-country-controller","items":[{"label":"getAllManagementCountry","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pranaapi/openapiprana/management-country-controller/getallmanagementcountry","routeSlug":"/pranaapi/openapiprana/management-country-controller/getallmanagementcountry","metadata":{"seo":{"title":"getAllManagementCountry"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllManagementCountry","name":"getAllManagementCountry","isWebhook":false,"pointer":"/paths/~1api~1v1~1partner~1country~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"getAllManagementCountry","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiSearchCriteriaDto"}},"schemaId":"components/schemas/ApiSearchCriteriaDto","pointer":"/paths/~1api~1v1~1partner~1country~1search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/partner/country/search","servers":[{"url":"https://api.prana.software"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiSearchCriteriaDto"}},"responseCodes":["200"],"pointer":"/api/v1/partner/country/search","href":"management-country-controller/getallmanagementcountry","openApiOperationId":"getAllManagementCountry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.prana.software"}],"schemaId":"components/schemas/ApiSearchCriteriaDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiSearchCriteriaDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiPageDtoManagementCountryListReadDto"}},"schemaId":"components/schemas/ApiPageDtoManagementCountryListReadDto"}],"pointer":"/paths/~1api~1v1~1partner~1country~1search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiPageDtoManagementCountryListReadDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiPageDtoManagementCountryListReadDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/management-country-controller/getallmanagementcountry"}],"panels":[]}]},"httpPath":"/api/v1/partner/country/search"}],"content":{"contentType":"group","meta":{"name":"management-country-controller"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"management-country-controller","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/partner/country/search","summary":"getAllManagementCountry","prefix":{"name":"post","color":"post"},"badges":[],"link":"/management-country-controller/getallmanagementcountry","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ApiPartnerWriteDto":{"id":"components/schemas/ApiPartnerWriteDto","kind":"json-schema","title":"ApiPartnerWriteDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Partner creation/update request","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Identifier of the object to modify or delete"},"commercialName":{"type":"string","default":"","description":"Commercial name.","maxLength":200,"minLength":0},"cif":{"type":"string","default":"","description":"Partner CIF.","example":"A12345678","maxLength":20,"minLength":0},"name":{"type":"string","default":"","description":"Partner name.","maxLength":200,"minLength":0},"marginOne":{"type":"number","default":"","description":"First margin percentage.","example":5.5},"marginTwo":{"type":"number","default":"","description":"Second margin percentage.","example":10},"web":{"type":"string","default":"","description":"Partner website URL."},"logo":{"type":"string","default":"","description":"Partner logo URL."},"contactPerson":{"type":"string","default":"","description":"Contact person name."},"firstPhoneNumber":{"type":"string","default":"","description":"First phone number.","example":"+34912345678","maxLength":20,"minLength":0},"secondPhoneNumber":{"type":"string","default":"","description":"Second phone number.","example":"+34912345679","maxLength":20,"minLength":0},"email":{"type":"string","default":"","description":"Contact email.","example":"partner@example.com","maxLength":250,"minLength":0},"country":{"type":"integer","format":"int32","default":"","description":"Country identifier.","example":1},"state":{"type":"integer","format":"int32","default":"","description":"State identifier.","example":1},"address":{"type":"string","default":"","description":"Street address.","maxLength":100,"minLength":0},"postalCode":{"type":"string","default":"","description":"Postal code.","example":"28001","maxLength":10,"minLength":0},"city":{"type":"string","default":"","description":"City name.","maxLength":100,"minLength":0},"supportService":{"type":"boolean","default":false,"description":"Support service available flag.","example":true},"withPaymentGateway":{"type":"boolean","default":false,"description":"Payment gateway enabled flag.","example":true},"subscriptionLimit":{"type":"integer","format":"int32","default":"","description":"Subscription limit.","example":100},"conditionsUrl":{"type":"string","default":"","description":"Conditions URL.","maxLength":200,"minLength":0},"darkLogo":{"type":"string","default":"","description":"Dark theme logo URL."},"externalCode":{"type":"string","default":"","description":"External partner code.","maxLength":20,"minLength":0},"htmlConditions":{"type":"string","default":"","description":"HTML conditions content."},"directDebitAllowed":{"type":"boolean","default":false,"description":"Direct debit payment method allowed","example":false}},"required":["marginOne","marginTwo","name","subscriptionLimit"]}},"components/schemas/ApiCompanyStatusEnum":{"id":"components/schemas/ApiCompanyStatusEnum","kind":"json-schema","title":"ApiCompanyStatusEnum","data":{"type":"string","additionalProperties":false,"enum":["ACTIVE","INACTIVE","LOCKED","DELETED"]}},"components/schemas/ApiCompanyUsersRangeEnum":{"id":"components/schemas/ApiCompanyUsersRangeEnum","kind":"json-schema","title":"ApiCompanyUsersRangeEnum","data":{"type":"string","additionalProperties":false,"enum":["ONE","FIVE","TEN","TWENTY_FIVE","FIFTY","BIGGER"]}},"components/schemas/ApiManagementCompanyListReadDto":{"id":"components/schemas/ApiManagementCompanyListReadDto","kind":"json-schema","title":"ApiManagementCompanyListReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Management company list entry","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Unique identifier of the object"},"companyName":{"type":"string","default":"","description":"Company name."},"companyType":{"$ref":"#/components/schemas/ApiManagementCompanyTypeEnum","default":"","description":"Company type."},"companyStatus":{"$ref":"#/components/schemas/ApiCompanyStatusEnum","default":"","description":"Company status."},"employees":{"$ref":"#/components/schemas/ApiCompanyUsersRangeEnum","default":"","description":"Employee range."},"fullName":{"type":"string","default":"","description":"Full name of company representative."},"active":{"type":"boolean","default":false,"description":"Active status.","example":true},"country":{"$ref":"#/components/schemas/ApiManagementCountryReadDto","default":"","description":"Company country."},"phone":{"type":"string","default":"","description":"Contact phone number."}},"required":["id"]}},"components/schemas/ApiManagementCompanyTypeEnum":{"id":"components/schemas/ApiManagementCompanyTypeEnum","kind":"json-schema","title":"ApiManagementCompanyTypeEnum","data":{"type":"string","additionalProperties":false,"enum":["SELF_EMPLOYED","COMPANY","CONSULTANT_COMPANY"]}},"components/schemas/ApiManagementCountryListReadDto":{"id":"components/schemas/ApiManagementCountryListReadDto","kind":"json-schema","title":"ApiManagementCountryListReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Management country list entry","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Unique identifier of the object"},"code":{"type":"string","default":"","description":"Country code."},"description":{"type":"string","default":"","description":"Country description."},"isoCode":{"type":"string","default":"","description":"Country ISO code.","example":"ES"}},"required":["id"]}},"components/schemas/ApiManagementCountryReadDto":{"id":"components/schemas/ApiManagementCountryReadDto","kind":"json-schema","title":"ApiManagementCountryReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Management country details","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Unique identifier of the object"},"code":{"type":"string","default":"","description":"Country code."},"description":{"type":"string","default":"","description":"Country description."},"isoCode":{"type":"string","default":"","description":"Country ISO code.","example":"ES"}},"required":["id"]}},"components/schemas/ApiManagementStateListReadDto":{"id":"components/schemas/ApiManagementStateListReadDto","kind":"json-schema","title":"ApiManagementStateListReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"State list entry","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Unique identifier of the object"},"code":{"type":"string","default":"","description":"State code.","example":"CA","minLength":1},"description":{"type":"string","default":"","description":"State description."},"isoCode":{"type":"string","default":"","description":"ISO code.","example":"US-CA"},"country":{"$ref":"#/components/schemas/ApiManagementCountryListReadDto","default":"","description":"State country."}},"required":["code","id"]}},"components/schemas/ApiPartnerListReadDto":{"id":"components/schemas/ApiPartnerListReadDto","kind":"json-schema","title":"ApiPartnerListReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Partner list entry","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Unique identifier of the object"},"commercialName":{"type":"string","default":"","description":"Commercial name."},"cif":{"type":"string","default":"","description":"Partner CIF.","example":"A12345678"},"name":{"type":"string","default":"","description":"Partner name."},"email":{"type":"string","default":"","description":"Contact email.","example":"partner@example.com"},"marginOne":{"type":"number","default":"","description":"First margin percentage.","example":5.5},"marginTwo":{"type":"number","default":"","description":"Second margin percentage.","example":10},"logo":{"type":"string","default":"","description":"Partner logo URL."},"status":{"$ref":"#/components/schemas/ApiPartnerStatusEnum","default":"","description":"Partner status."},"companyName":{"type":"string","default":"","description":"Associated company name."},"companyOwnerEmail":{"type":"string","default":"","description":"Company owner email.","example":"owner@example.com"},"externalCode":{"type":"string","default":"","description":"External partner code."},"subscriptionLimit":{"type":"integer","format":"int32","default":"","description":"Subscription limit.","example":100}},"required":["id"]}},"components/schemas/ApiPartnerReadDto":{"id":"components/schemas/ApiPartnerReadDto","kind":"json-schema","title":"ApiPartnerReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Partner details with company, contact and location information","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Unique identifier of the object"},"createdOn":{"type":"string","format":"date-time","default":"","description":"Creation date and time."},"modifiedOn":{"type":"string","format":"date-time","default":"","description":"Last modification date and time."},"parent":{"$ref":"#/components/schemas/ApiPartnerListReadDto","default":"","description":"Parent partner information."},"company":{"$ref":"#/components/schemas/ApiManagementCompanyListReadDto","default":"","description":"Associated company."},"partnerType":{"$ref":"#/components/schemas/ApiPartnerTypeEnum","default":"","description":"Partner type."},"commercialName":{"type":"string","default":"","description":"Commercial name."},"cif":{"type":"string","default":"","description":"Partner CIF.","example":"A12345678"},"name":{"type":"string","default":"","description":"Partner name."},"marginOne":{"type":"number","default":"","description":"First margin percentage.","example":5.5},"marginTwo":{"type":"number","default":"","description":"Second margin percentage.","example":10},"web":{"type":"string","default":"","description":"Partner website URL."},"theme":{"$ref":"#/components/schemas/ApiThemeEnum","default":"","description":"Theme enumeration."},"logo":{"type":"string","default":"","description":"Partner logo URL."},"logoToken":{"type":"string","default":"","description":"Logo file token."},"contactPerson":{"type":"string","default":"","description":"Contact person name."},"firstPhoneNumber":{"type":"string","default":"","description":"First phone number.","example":"+34912345678"},"secondPhoneNumber":{"type":"string","default":"","description":"Second phone number.","example":"+34912345679"},"email":{"type":"string","default":"","description":"Contact email.","example":"partner@example.com"},"country":{"$ref":"#/components/schemas/ApiManagementCountryListReadDto","default":"","description":"Partner country."},"state":{"$ref":"#/components/schemas/ApiManagementStateListReadDto","default":"","description":"Partner state."},"address":{"type":"string","default":"","description":"Street address."},"postalCode":{"type":"string","default":"","description":"Postal code.","example":"28001"},"city":{"type":"string","default":"","description":"City name."},"active":{"type":"boolean","default":false,"description":"Active flag.","example":true},"supportService":{"type":"boolean","default":false,"description":"Support service available flag.","example":true},"invitationCode":{"type":"string","default":"","description":"Invitation code."},"invitationSentOn":{"type":"string","format":"date-time","default":"","description":"Invitation sent date and time."},"invitationAcceptedOn":{"type":"string","format":"date-time","default":"","description":"Invitation accepted date and time."},"withPaymentGateway":{"type":"boolean","default":false,"description":"Payment gateway enabled flag.","example":true},"status":{"$ref":"#/components/schemas/ApiPartnerStatusEnum","default":"","description":"Partner status."},"companyName":{"type":"string","default":"","description":"Associated company name."},"companyOwnerEmail":{"type":"string","default":"","description":"Company owner email.","example":"owner@example.com"},"subscriptionLimit":{"type":"integer","format":"int32","default":"","description":"Subscription limit.","example":100},"conditionsUrl":{"type":"string","default":"","description":"Conditions URL."},"darkLogo":{"type":"string","default":"","description":"Dark theme logo URL."},"darkLogoToken":{"type":"string","default":"","description":"Dark theme logo token."},"externalCode":{"type":"string","default":"","description":"External partner code."},"htmlConditions":{"type":"string","default":"","description":"HTML conditions content."},"customizedTheme":{"type":"boolean","default":false,"description":"Customized theme flag.","example":false},"invitationReference":{"type":"string","default":"","description":"Invitation reference code."},"noViewPrices":{"type":"boolean","default":false,"description":"Hide prices flag.","example":false},"directDebitAllowed":{"type":"boolean","default":false,"description":"Direct debit allowed.","example":false}},"required":["id"]}},"components/schemas/ApiPartnerStatusEnum":{"id":"components/schemas/ApiPartnerStatusEnum","kind":"json-schema","title":"ApiPartnerStatusEnum","data":{"type":"string","additionalProperties":false,"enum":["ACTIVE","INACTIVE","PENDING"]}},"components/schemas/ApiPartnerTypeEnum":{"id":"components/schemas/ApiPartnerTypeEnum","kind":"json-schema","title":"ApiPartnerTypeEnum","data":{"type":"string","additionalProperties":false,"enum":["ENTERPRISE_PARTNER","PARTNER","CUSTOMER"]}},"components/schemas/ApiThemeEnum":{"id":"components/schemas/ApiThemeEnum","kind":"json-schema","title":"ApiThemeEnum","data":{"type":"string","additionalProperties":false,"enum":["THEME_A","THEME_B","THEME_C","THEME_D","THEME_E","THEME_F","THEME_G","THEME_H","THEME_I","THEME_J","THEME_K","THEME_L","THEME_M","THEME_N","THEME_O","THEME_P","THEME_Q","THEME_R","THEME_S","THEME_T","THEME_U","THEME_V","THEME_W","THEME_X","THEME_Y","THEME_Z"]}},"components/schemas/ApiPartnerSupportWriteDto":{"id":"components/schemas/ApiPartnerSupportWriteDto","kind":"json-schema","title":"ApiPartnerSupportWriteDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Partner support contact request","properties":{"name":{"type":"string","default":"","description":"Support contact name.","maxLength":200,"minLength":0},"email":{"type":"string","default":"","description":"Support contact email.","example":"support@example.com","maxLength":200,"minLength":0}},"required":["email","name"]}},"components/schemas/ApiPartnerCustomerWriteDto":{"id":"components/schemas/ApiPartnerCustomerWriteDto","kind":"json-schema","title":"ApiPartnerCustomerWriteDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Partner customer creation/update request","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Identifier of the object to modify or delete"},"commercialName":{"type":"string","default":"","description":"Commercial name.","maxLength":200,"minLength":0},"cif":{"type":"string","default":"","description":"Customer CIF.","example":"A12345678","maxLength":20,"minLength":0},"name":{"type":"string","default":"","description":"Customer name.","maxLength":200,"minLength":0},"discount":{"type":"number","default":"","description":"Discount percentage.","example":5},"web":{"type":"string","default":"","description":"Customer website URL."},"logo":{"type":"string","default":"","description":"Customer logo URL."},"contactPerson":{"type":"string","default":"","description":"Contact person name."},"firstPhoneNumber":{"type":"string","default":"","description":"First phone number.","example":"+34912345678","maxLength":20,"minLength":0},"secondPhoneNumber":{"type":"string","default":"","description":"Second phone number.","example":"+34912345679","maxLength":20,"minLength":0},"email":{"type":"string","default":"","description":"Contact email.","example":"customer@example.com","maxLength":250,"minLength":0},"country":{"type":"integer","format":"int32","default":"","description":"Country identifier.","example":1},"state":{"type":"integer","format":"int32","default":"","description":"State identifier.","example":1},"address":{"type":"string","default":"","description":"Street address.","maxLength":100,"minLength":0},"postalCode":{"type":"string","default":"","description":"Postal code.","example":"28001","maxLength":10,"minLength":0},"city":{"type":"string","default":"","description":"City name.","maxLength":100,"minLength":0},"externalCode":{"type":"string","default":"","description":"External customer code.","maxLength":20,"minLength":0},"newsletter":{"type":"boolean","default":false,"description":"Newsletter subscription flag.","example":true},"plan":{"type":"integer","format":"int32","default":"","description":"Plan identifier.","example":1},"period":{"type":"integer","format":"int32","default":"","description":"Period identifier.","example":1},"companyType":{"$ref":"#/components/schemas/ApiManagementCompanyTypeEnum","default":"","description":"Company type."},"employees":{"$ref":"#/components/schemas/ApiCompanyUsersRangeEnum","default":"","description":"Number of employees range."},"igic":{"type":"boolean","default":false,"description":"IGIC tax flag for Canary Islands.","example":false},"directDebitAllowed":{"type":"boolean","default":false,"description":"Direct debit payment method allowed","example":false}},"required":["discount","name"]}},"components/schemas/ApiManagementModuleTypeEnum":{"id":"components/schemas/ApiManagementModuleTypeEnum","kind":"json-schema","title":"ApiManagementModuleTypeEnum","data":{"type":"string","additionalProperties":false,"enum":["STANDARD","LICENSE","CURRENCY","STORE","SALE_ORDER","PURCHASE_ORDER","SALE_DELIVERY_NOTE","PURCHASE_DELIVERY_NOTE","SALE_INVOICE","PURCHASE_INVOICE","SALE_QUOTATION","SCAN_DOCUMENT","TEMPLATE_SALE_INVOICE","BANK_SYNCHRONIZABLE","TPV","SHOP","SHOPIFY_SHOP"]}},"components/schemas/ApiManagementPeriodListReadDto":{"id":"components/schemas/ApiManagementPeriodListReadDto","kind":"json-schema","title":"ApiManagementPeriodListReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Period list entry","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Unique identifier of the object"},"description":{"type":"string","default":"","description":"Period description.","example":"Annual"},"months":{"type":"integer","format":"int32","default":"","description":"Number of months.","example":12}},"required":["id"]}},"components/schemas/ApiModuleListReadDto":{"id":"components/schemas/ApiModuleListReadDto","kind":"json-schema","title":"ApiModuleListReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Module list entry","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Unique identifier of the object"},"name":{"type":"string","default":"","description":"Module name.","example":"Accounting"},"description":{"type":"string","default":"","description":"Module description."},"visibleMarketplace":{"type":"boolean","default":false,"description":"Visible in marketplace flag.","example":true},"highlighted":{"type":"boolean","default":false,"description":"Highlighted flag.","example":false},"logo":{"type":"string","default":"","description":"Module logo URL."},"trialPeriod":{"type":"integer","format":"int32","default":"","description":"Trial period in days.","example":30},"noRenew":{"type":"boolean","default":false,"description":"No renewal flag.","example":false},"moduleType":{"$ref":"#/components/schemas/ApiManagementModuleTypeEnum","default":"","description":"Module type."},"quantity":{"type":"integer","format":"int32","default":"","description":"Module quantity.","example":1}},"required":["id"]}},"components/schemas/ApiPartnerCustomerReadDto":{"id":"components/schemas/ApiPartnerCustomerReadDto","kind":"json-schema","title":"ApiPartnerCustomerReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Partner customer details with company, contact and subscription information","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Unique identifier of the object"},"createdOn":{"type":"string","format":"date-time","default":"","description":"Creation date and time."},"modifiedOn":{"type":"string","format":"date-time","default":"","description":"Last modification date and time."},"partner":{"$ref":"#/components/schemas/ApiPartnerListReadDto","default":"","description":"Partner information."},"company":{"$ref":"#/components/schemas/ApiManagementCompanyListReadDto","default":"","description":"Associated company."},"commercialName":{"type":"string","default":"","description":"Commercial name."},"cif":{"type":"string","default":"","description":"Customer CIF.","example":"A12345678"},"name":{"type":"string","default":"","description":"Customer name."},"discount":{"type":"number","default":"","description":"Discount percentage.","example":5},"web":{"type":"string","default":"","description":"Customer website URL."},"logo":{"type":"string","default":"","description":"Customer logo URL."},"contactPerson":{"type":"string","default":"","description":"Contact person name."},"firstPhoneNumber":{"type":"string","default":"","description":"First phone number.","example":"+34912345678"},"secondPhoneNumber":{"type":"string","default":"","description":"Second phone number.","example":"+34912345679"},"email":{"type":"string","default":"","description":"Contact email.","example":"customer@example.com"},"country":{"$ref":"#/components/schemas/ApiManagementCountryListReadDto","default":"","description":"Customer country."},"state":{"$ref":"#/components/schemas/ApiManagementStateListReadDto","default":"","description":"Customer state."},"address":{"type":"string","default":"","description":"Street address."},"postalCode":{"type":"string","default":"","description":"Postal code.","example":"28001"},"city":{"type":"string","default":"","description":"City name."},"active":{"type":"boolean","default":false,"description":"Active flag.","example":true},"invitationCode":{"type":"string","default":"","description":"Invitation code."},"invitationSentOn":{"type":"string","format":"date-time","default":"","description":"Invitation sent date and time."},"invitationAcceptedOn":{"type":"string","format":"date-time","default":"","description":"Invitation accepted date and time."},"plan":{"$ref":"#/components/schemas/ApiPlanListReadDto","default":"","description":"Subscription plan."},"period":{"$ref":"#/components/schemas/ApiManagementPeriodListReadDto","default":"","description":"Billing period."},"moduleOnBoarding":{"$ref":"#/components/schemas/ApiModuleListReadDto","default":"","description":"Module onboarding."},"status":{"$ref":"#/components/schemas/ApiPartnerStatusEnum","default":"","description":"Partner customer status."},"companyName":{"type":"string","default":"","description":"Associated company name."},"companyOwnerEmail":{"type":"string","default":"","description":"Company owner email.","example":"owner@example.com"},"externalCode":{"type":"string","default":"","description":"External customer code."},"newsletter":{"type":"boolean","default":false,"description":"Newsletter subscription flag.","example":true},"lastAccess":{"type":"string","format":"date-time","default":"","description":"Last access date and time."},"cancellationDate":{"type":"string","format":"date-time","default":"","description":"Cancellation date and time."},"cancellationReason":{"type":"string","default":"","description":"Cancellation reason."},"terminateDate":{"type":"string","format":"date-time","default":"","description":"Termination date and time."},"terminateReason":{"type":"string","default":"","description":"Termination reason."},"companyType":{"$ref":"#/components/schemas/ApiManagementCompanyTypeEnum","default":"","description":"Company type."},"employees":{"$ref":"#/components/schemas/ApiCompanyUsersRangeEnum","default":"","description":"Number of employees range."},"igic":{"type":"boolean","default":false,"description":"IGIC tax flag for Canary Islands.","example":false},"directDebitAllowed":{"type":"boolean","default":false,"description":"Direct debit payment method allowed","example":false}},"required":["id"]}},"components/schemas/ApiPlanListReadDto":{"id":"components/schemas/ApiPlanListReadDto","kind":"json-schema","title":"ApiPlanListReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Plan list entry","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Unique identifier of the object"},"description":{"type":"string","default":"","description":"Plan description.","example":"Premium Plan"},"suggested":{"type":"boolean","default":false,"description":"Suggested plan flag.","example":true},"planPrecedence":{"type":"integer","format":"int32","default":"","description":"Plan precedence order.","example":1},"productId":{"type":"integer","format":"int32","default":"","description":"Associated product ID.","example":42}},"required":["id"]}},"components/schemas/ApiPartnerCustomerPlanModuleWriteDto":{"id":"components/schemas/ApiPartnerCustomerPlanModuleWriteDto","kind":"json-schema","title":"ApiPartnerCustomerPlanModuleWriteDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Partner customer plan and module assignment","properties":{"plan":{"type":"integer","format":"int32","default":"","description":"Plan identifier.","example":1},"period":{"type":"integer","format":"int32","default":"","description":"Period identifier.","example":1},"moduleOnBoarding":{"type":"integer","format":"int32","default":"","description":"Module onboarding identifier.","example":1}}}},"components/schemas/ApiManagementActivateRequestDto":{"id":"components/schemas/ApiManagementActivateRequestDto","kind":"json-schema","title":"ApiManagementActivateRequestDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Management activation request","properties":{"ids":{"type":"array","default":"","description":"List of entity identifiers to activate or deactivate.","example":[1,2,3],"items":{"type":"integer","format":"int32"},"minItems":1},"activate":{"type":"boolean","default":false,"description":"Activation flag.","example":true}},"required":["activate","ids"]}},"components/schemas/ApiPartnerFileWriteDto":{"id":"components/schemas/ApiPartnerFileWriteDto","kind":"json-schema","title":"ApiPartnerFileWriteDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Partner file creation/update request","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Identifier of the object to modify or delete"},"partner":{"type":"integer","format":"int32","default":"","description":"Partner identifier.","example":1},"token":{"type":"string","default":"","description":"File token.","maxLength":36,"minLength":0},"fileName":{"type":"string","default":"","description":"File name.","example":"document.pdf","maxLength":255,"minLength":0},"fileExtension":{"type":"string","default":"","description":"File extension.","example":"pdf","maxLength":10,"minLength":0},"fileSize":{"type":"integer","format":"int64","default":"","description":"File size in bytes.","example":1024},"title":{"type":"string","default":"","description":"File title.","maxLength":200,"minLength":0},"description":{"type":"string","default":"","description":"File description.","maxLength":400,"minLength":0}},"required":["fileExtension","fileName","fileSize","title","token"]}},"components/schemas/ApiPartnerFileReadDto":{"id":"components/schemas/ApiPartnerFileReadDto","kind":"json-schema","title":"ApiPartnerFileReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Partner file details","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Unique identifier of the object"},"token":{"type":"string","default":"","description":"File token."},"url":{"type":"string","default":"","description":"File URL."},"fileName":{"type":"string","default":"","description":"File name.","example":"document.pdf"},"fileExtension":{"type":"string","default":"","description":"File extension.","example":"pdf"},"fileSize":{"type":"integer","format":"int64","default":"","description":"File size in bytes.","example":1024},"modifiedOn":{"type":"string","format":"date-time","default":"","description":"Last modification date and time."},"title":{"type":"string","default":"","description":"File title."},"description":{"type":"string","default":"","description":"File description."}},"required":["id"]}},"components/schemas/ApiCancelSubscriptionWriteDto":{"id":"components/schemas/ApiCancelSubscriptionWriteDto","kind":"json-schema","title":"ApiCancelSubscriptionWriteDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Subscription cancellation request","properties":{"reason":{"type":"string","default":"","description":"Reason for cancellation.","maxLength":255,"minLength":0}}}},"components/schemas/ApiManagementCompanyInfoWriteDto":{"id":"components/schemas/ApiManagementCompanyInfoWriteDto","kind":"json-schema","title":"ApiManagementCompanyInfoWriteDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Management company information with location identifiers","properties":{"commercialName":{"type":"string","default":"","description":"Commercial name.","example":"Acme Corp","maxLength":200,"minLength":0},"address":{"type":"string","default":"","description":"Physical address.","maxLength":100,"minLength":0},"postalCode":{"type":"string","default":"","description":"Postal code.","maxLength":10,"minLength":0},"city":{"type":"string","default":"","description":"City name.","maxLength":100,"minLength":0},"phone1":{"type":"string","default":"","description":"Primary phone number.","maxLength":20,"minLength":0},"phone2":{"type":"string","default":"","description":"Secondary phone number.","maxLength":20,"minLength":0},"email":{"type":"string","default":"","description":"Email address.","example":"contact@example.com","maxLength":250,"minLength":0},"website":{"type":"string","default":"","description":"Company website URL.","maxLength":100,"minLength":0},"commercialRegistry":{"type":"string","default":"","description":"Commercial registry reference."},"observations":{"type":"string","default":"","description":"Additional observations."},"logo":{"type":"string","default":"","description":"Company logo identifier.","maxLength":36,"minLength":0},"country":{"type":"integer","format":"int32","default":"","description":"Country identifier.","example":1},"state":{"type":"integer","format":"int32","default":"","description":"State/Province identifier.","example":1}},"required":["commercialName","country"]}},"components/schemas/ApiManagementCompanyWriteDto":{"id":"components/schemas/ApiManagementCompanyWriteDto","kind":"json-schema","title":"ApiManagementCompanyWriteDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Management company creation/update request","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Identifier of the object to modify or delete"},"name":{"type":"string","default":"","description":"Company name.","example":"Acme Corp","maxLength":200,"minLength":0},"cif":{"type":"string","default":"","description":"Company tax identification number.","maxLength":20,"minLength":0},"additionalInfo":{"$ref":"#/components/schemas/ApiManagementCompanyInfoWriteDto","default":"","description":"Additional company information with location."}},"required":["additionalInfo","name"]}},"components/schemas/ApiManagementCompanyReadDto":{"id":"components/schemas/ApiManagementCompanyReadDto","kind":"json-schema","title":"ApiManagementCompanyReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Management company details","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Unique identifier of the object"},"plan":{"$ref":"#/components/schemas/ApiPlanListReadDto","default":"","description":"Assigned plan."},"customer":{"$ref":"#/components/schemas/ApiManagementCustomerListReadDto","default":"","description":"Associated customer."},"period":{"$ref":"#/components/schemas/ApiManagementPeriodListReadDto","default":"","description":"Billing period."},"companyType":{"$ref":"#/components/schemas/ApiManagementCompanyTypeEnum","default":"","description":"Company type."},"companyStatus":{"$ref":"#/components/schemas/ApiCompanyStatusEnum","default":"","description":"Company status."},"companyName":{"type":"string","default":"","description":"Company name."},"employees":{"$ref":"#/components/schemas/ApiCompanyUsersRangeEnum","default":"","description":"Employee range."},"fullName":{"type":"string","default":"","description":"Full name of company representative."},"cif":{"type":"string","default":"","description":"Tax identification number."},"active":{"type":"boolean","default":false,"description":"Active status.","example":true},"address":{"type":"string","default":"","description":"Physical address."},"country":{"$ref":"#/components/schemas/ApiManagementCountryListReadDto","default":"","description":"Company country."},"state":{"$ref":"#/components/schemas/ApiManagementStateListReadDto","default":"","description":"Company state/province."},"postalCode":{"type":"string","default":"","description":"Postal code."},"city":{"type":"string","default":"","description":"City name."},"phone":{"type":"string","default":"","description":"Primary phone number."},"phone2":{"type":"string","default":"","description":"Secondary phone number."},"email":{"type":"string","default":"","description":"Email address.","example":"info@example.com"},"website":{"type":"string","default":"","description":"Company website URL."},"commercialRegistry":{"type":"string","default":"","description":"Commercial registry reference."},"logo":{"type":"string","default":"","description":"Company logo identifier."},"logoToken":{"type":"string","default":"","description":"Logo token for access."},"observations":{"type":"string","default":"","description":"Additional observations."},"billingServiceId":{"type":"string","default":"","description":"External billing service identifier."}},"required":["id"]}},"components/schemas/ApiManagementCustomerListReadDto":{"id":"components/schemas/ApiManagementCustomerListReadDto","kind":"json-schema","title":"ApiManagementCustomerListReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Management customer list entry","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Unique identifier of the object"},"name":{"type":"string","default":"","description":"Customer name."},"invoiceData":{"type":"string","default":"","description":"Invoice data."}},"required":["id"]}},"components/schemas/ApiModuleCategoryListReadDto":{"id":"components/schemas/ApiModuleCategoryListReadDto","kind":"json-schema","title":"ApiModuleCategoryListReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Module category list entry","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Unique identifier of the object"},"description":{"type":"string","default":"","description":"Category description."},"logo":{"type":"string","default":"","description":"Category logo URL."}},"required":["id"]}},"components/schemas/ApiModuleMarketReadDto":{"id":"components/schemas/ApiModuleMarketReadDto","kind":"json-schema","title":"ApiModuleMarketReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Module marketplace details with pricing and available plans","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Unique identifier of the object"},"name":{"type":"string","default":"","description":"Module name.","example":"Accounting"},"description":{"type":"string","default":"","description":"Module description."},"moduleTrialPeriod":{"type":"integer","format":"int32","default":"","description":"Module trial period in days.","example":30},"logo":{"type":"string","default":"","description":"Module logo URL."},"price":{"type":"number","default":"","description":"Module price.","example":99.99},"endTrialDate":{"type":"string","format":"date","default":"","description":"Trial end date.","example":"2024-02-15"},"endPeriodDate":{"type":"string","format":"date","default":"","description":"Period end date.","example":"2024-12-31"},"periodName":{"type":"string","default":"","description":"Period name."},"comingSoon":{"type":"boolean","default":false,"description":"Coming soon flag.","example":false},"noRenew":{"type":"boolean","default":false,"description":"No renewal flag.","example":false},"canceled":{"type":"boolean","default":false,"description":"Canceled flag.","example":false},"category":{"$ref":"#/components/schemas/ApiModuleCategoryListReadDto","default":"","description":"Module category."},"moduleCode":{"type":"string","default":"","description":"Module code."},"multiplePurchase":{"type":"boolean","default":false,"description":"Multiple purchase allowed flag.","example":false},"byQuantity":{"type":"boolean","default":false,"description":"Billed by quantity flag.","example":false},"quantity":{"type":"integer","format":"int32","default":"","description":"Module quantity.","example":1},"quantityPurchased":{"type":"integer","format":"int32","default":"","description":"Quantity purchased.","example":2},"amount":{"type":"number","default":"","description":"Total amount.","example":199.98},"allowedPlans":{"type":"array","default":"","description":"Allowed plans.","items":{"$ref":"#/components/schemas/ApiPlanListReadDto"}}},"required":["id"]}},"components/schemas/ApiManagementCompanyBillingInfoWriteDto":{"id":"components/schemas/ApiManagementCompanyBillingInfoWriteDto","kind":"json-schema","title":"ApiManagementCompanyBillingInfoWriteDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Management company billing information update request","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Identifier of the object to modify or delete"},"invoiceName":{"type":"string","default":"","description":"Invoice recipient name.","example":"Acme Corp","maxLength":200,"minLength":0},"invoiceCif":{"type":"string","default":"","description":"Invoice tax identification number.","maxLength":20,"minLength":0},"invoiceCountry":{"type":"integer","format":"int32","default":"","description":"Invoice country identifier.","example":1},"invoiceState":{"type":"integer","format":"int32","default":"","description":"Invoice state/province identifier.","example":1},"invoiceAddress":{"type":"string","default":"","description":"Invoice address.","maxLength":100,"minLength":0},"invoicePostalCode":{"type":"string","default":"","description":"Invoice postal code.","maxLength":10,"minLength":0},"invoiceCity":{"type":"string","default":"","description":"Invoice city.","maxLength":100,"minLength":0},"invoiceEmail":{"type":"string","default":"","description":"Invoice email address.","example":"billing@example.com","maxLength":250,"minLength":0},"paymentMethod":{"$ref":"#/components/schemas/ApiPaymentMethodEnum","default":"","description":"Billing payment method","example":"CARD"},"iban":{"type":"string","default":"","description":"IBAN of the bank account.","example":"ES9820385778983000760236","maxLength":34,"minLength":0}},"required":["invoiceCountry","invoiceEmail","invoiceName","invoiceState"]}},"components/schemas/ApiPaymentMethodEnum":{"id":"components/schemas/ApiPaymentMethodEnum","kind":"json-schema","title":"ApiPaymentMethodEnum","data":{"type":"string","additionalProperties":false,"enum":["CARD","DIRECT_DEBIT"]}},"components/schemas/ApiCompanyBillingInfoReadDto":{"id":"components/schemas/ApiCompanyBillingInfoReadDto","kind":"json-schema","title":"ApiCompanyBillingInfoReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Company billing information","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Unique identifier of the object"},"invoiceName":{"type":"string","default":"","description":"Invoice recipient name."},"invoiceCif":{"type":"string","default":"","description":"Invoice tax identification number."},"invoiceCountry":{"$ref":"#/components/schemas/ApiManagementCountryListReadDto","default":"","description":"Invoice country."},"invoiceState":{"$ref":"#/components/schemas/ApiManagementStateListReadDto","default":"","description":"Invoice state/province."},"invoiceAddress":{"type":"string","default":"","description":"Invoice address."},"invoicePostalCode":{"type":"string","default":"","description":"Invoice postal code."},"invoiceCity":{"type":"string","default":"","description":"Invoice city."},"invoiceEmail":{"type":"string","default":"","description":"Invoice email address.","example":"billing@example.com"},"paymentMethod":{"$ref":"#/components/schemas/ApiPaymentMethodEnum","default":"","description":"Billing payment method","example":"CARD"},"iban":{"type":"string","default":"","description":"IBAN of the bank account.","example":"ES9820385778983000760236"}},"required":["id"]}},"components/schemas/ApiManagementStateWriteDto":{"id":"components/schemas/ApiManagementStateWriteDto","kind":"json-schema","title":"ApiManagementStateWriteDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"State creation/update request","properties":{"country":{"type":"integer","format":"int32","default":"","description":"Country identifier.","example":1},"code":{"type":"string","default":"","description":"State code.","example":"CA","maxLength":20,"minLength":0},"description":{"type":"string","default":"","description":"State description.","maxLength":100,"minLength":0},"isoCode":{"type":"string","default":"","description":"ISO code.","example":"US-CA","maxLength":5,"minLength":0}},"required":["code","country"]}},"components/schemas/ApiManagementStateReadDto":{"id":"components/schemas/ApiManagementStateReadDto","kind":"json-schema","title":"ApiManagementStateReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"State details with country information","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Unique identifier of the object"},"country":{"$ref":"#/components/schemas/ApiManagementCountryListReadDto","default":"","description":"State country."},"code":{"type":"string","default":"","description":"State code.","example":"CA","minLength":1},"description":{"type":"string","default":"","description":"State description."},"isoCode":{"type":"string","default":"","description":"ISO code.","example":"US-CA","maxLength":5,"minLength":0}},"required":["code","country","id"]}},"components/schemas/ApiPlanPropertyWriteDto":{"id":"components/schemas/ApiPlanPropertyWriteDto","kind":"json-schema","title":"ApiPlanPropertyWriteDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Plan property creation/update request","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Identifier of the object to modify or delete"},"plan":{"type":"integer","format":"int32","default":"","description":"Plan identifier.","example":1},"description":{"type":"string","default":"","description":"Property description.","maxLength":255,"minLength":0},"propertyOrder":{"type":"integer","format":"int32","default":"","description":"Property display order.","example":1}}}},"components/schemas/ApiPlanWriteDto":{"id":"components/schemas/ApiPlanWriteDto","kind":"json-schema","title":"ApiPlanWriteDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Plan creation/update request","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Identifier of the object to modify or delete"},"description":{"type":"string","default":"","description":"Plan description.","example":"Premium Plan","maxLength":100,"minLength":0},"visibleMarketplace":{"type":"boolean","default":false,"description":"Visible in marketplace flag.","example":true},"suggested":{"type":"boolean","default":false,"description":"Suggested plan flag.","example":true},"observations":{"type":"string","default":"","description":"Plan observations.","maxLength":255,"minLength":0},"planOrder":{"type":"integer","format":"int32","default":"","description":"Plan display order.","example":1},"planPrecedence":{"type":"integer","format":"int32","default":"","description":"Plan precedence order.","example":1},"partnerPlan":{"type":"boolean","default":false,"description":"Partner plan flag.","example":false},"code":{"type":"string","default":"","description":"Plan code.","example":"PREMIUM","maxLength":50,"minLength":0},"product":{"type":"integer","format":"int32","default":"","description":"Product identifier.","example":1},"modules":{"type":"array","default":"","description":"Module identifiers included in this plan.","items":{"type":"integer","format":"int32"}},"allowedModules":{"type":"array","default":"","description":"Module identifiers allowed in this plan.","items":{"type":"integer","format":"int32"}},"properties":{"type":"array","default":"","description":"Plan properties.","items":{"$ref":"#/components/schemas/ApiPlanPropertyWriteDto"}}},"required":["description","observations","partnerPlan","planOrder","planPrecedence","product","suggested","visibleMarketplace"]}},"components/schemas/ApiPlanPropertyReadDto":{"id":"components/schemas/ApiPlanPropertyReadDto","kind":"json-schema","title":"ApiPlanPropertyReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Plan property details","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Unique identifier of the object"},"description":{"type":"string","default":"","description":"Property description."},"propertyOrder":{"type":"integer","format":"int32","default":"","description":"Property display order.","example":1}},"required":["id"]}},"components/schemas/ApiPlanReadDto":{"id":"components/schemas/ApiPlanReadDto","kind":"json-schema","title":"ApiPlanReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Plan details with modules and properties","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Unique identifier of the object"},"description":{"type":"string","default":"","description":"Plan description.","example":"Premium Plan"},"visibleMarketplace":{"type":"boolean","default":false,"description":"Visible in marketplace flag.","example":true},"suggested":{"type":"boolean","default":false,"description":"Suggested plan flag.","example":true},"observations":{"type":"string","default":"","description":"Plan observations."},"planOrder":{"type":"integer","format":"int32","default":"","description":"Plan display order.","example":1},"planPrecedence":{"type":"integer","format":"int32","default":"","description":"Plan precedence order.","example":1},"partnerPlan":{"type":"boolean","default":false,"description":"Partner plan flag.","example":false},"code":{"type":"string","default":"","description":"Plan code.","example":"PREMIUM"},"product":{"$ref":"#/components/schemas/ApiProductListReadDto","default":"","description":"Associated product."},"modules":{"type":"array","default":"","description":"Modules included in this plan.","items":{"$ref":"#/components/schemas/ApiModuleListReadDto"}},"allowedModules":{"type":"array","default":"","description":"Modules allowed in this plan.","items":{"$ref":"#/components/schemas/ApiModuleListReadDto"}},"properties":{"type":"array","default":"","description":"Plan properties.","items":{"$ref":"#/components/schemas/ApiPlanPropertyReadDto"}}},"required":["id"]}},"components/schemas/ApiProductListReadDto":{"id":"components/schemas/ApiProductListReadDto","kind":"json-schema","title":"ApiProductListReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Product list entry","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Unique identifier of the object"},"code":{"type":"string","default":"","description":"Product code.","example":"PROD001"},"description":{"type":"string","default":"","description":"Product description."},"billingProduct":{"type":"string","default":"","description":"Billing product name."}},"required":["id"]}},"components/schemas/ApiManagementPeriodWriteDto":{"id":"components/schemas/ApiManagementPeriodWriteDto","kind":"json-schema","title":"ApiManagementPeriodWriteDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Period creation/update request","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Identifier of the object to modify or delete"},"description":{"type":"string","default":"","description":"Period description.","example":"Annual","maxLength":100,"minLength":0},"months":{"type":"integer","format":"int32","default":"","description":"Number of months.","example":12},"visibleMarketplace":{"type":"boolean","default":false,"description":"Visible in marketplace flag.","example":true},"trial":{"type":"boolean","default":false,"description":"Trial period flag.","example":false},"partnerPeriod":{"type":"boolean","default":false,"description":"Partner period flag.","example":false}},"required":["description","months","partnerPeriod","trial","visibleMarketplace"]}},"components/schemas/ApiManagementPeriodReadDto":{"id":"components/schemas/ApiManagementPeriodReadDto","kind":"json-schema","title":"ApiManagementPeriodReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Period details","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Unique identifier of the object"},"description":{"type":"string","default":"","description":"Period description.","example":"Annual"},"months":{"type":"integer","format":"int32","default":"","description":"Number of months.","example":12},"visibleMarketplace":{"type":"boolean","default":false,"description":"Visible in marketplace flag.","example":true},"trial":{"type":"boolean","default":false,"description":"Trial period flag.","example":false},"partnerPeriod":{"type":"boolean","default":false,"description":"Partner period flag.","example":false}},"required":["id"]}},"components/schemas/ApiManagementCountryWriteDto":{"id":"components/schemas/ApiManagementCountryWriteDto","kind":"json-schema","title":"ApiManagementCountryWriteDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Country creation/update request","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Identifier of the object to modify or delete"},"code":{"type":"string","default":"","description":"Country code.","example":"ES","maxLength":5,"minLength":0},"description":{"type":"string","default":"","description":"Country description.","example":"Spain","maxLength":100,"minLength":0},"isoCode":{"type":"string","default":"","description":"Country ISO code.","example":"ES","maxLength":5,"minLength":0}},"required":["code","description","isoCode"]}},"components/schemas/ApiCondition":{"id":"components/schemas/ApiCondition","kind":"json-schema","title":"ApiCondition","data":{"type":"object","additionalProperties":false,"properties":{"field":{"type":"string"},"value":{},"type":{"$ref":"#/components/schemas/ApiRelationalOperatorEnum"},"endValue":{},"innerConditions":{"type":"array","items":{"$ref":"#/components/schemas/ApiCondition"}},"conditionType":{"$ref":"#/components/schemas/ApiConditionTypeEnum"},"empty":{"type":"boolean"},"compareFields":{"type":"boolean"}}}},"components/schemas/ApiConditionTypeEnum":{"id":"components/schemas/ApiConditionTypeEnum","kind":"json-schema","title":"ApiConditionTypeEnum","data":{"type":"string","additionalProperties":false,"default":null,"enum":["AND","OR"]}},"components/schemas/ApiRelationalOperatorEnum":{"id":"components/schemas/ApiRelationalOperatorEnum","kind":"json-schema","title":"ApiRelationalOperatorEnum","data":{"type":"string","additionalProperties":false,"default":null,"enum":["BETWEEN","EQ","LT","LTE","GT","GTE","NE","LIKE","START","FINISH","IN","NIN","NLIKE","LENGTH"]}},"components/schemas/ApiSearchCriteriaDto":{"id":"components/schemas/ApiSearchCriteriaDto","kind":"json-schema","title":"ApiSearchCriteriaDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Search criteria DTO with support for pagination and sorting","properties":{"conditions":{"type":"array","default":"","description":"List of conditions to be applied with AND logic","items":{"$ref":"#/components/schemas/ApiCondition"}},"orConditions":{"type":"array","default":"","description":"List of conditions to be applied with OR logic","items":{"$ref":"#/components/schemas/ApiCondition"}},"sortCriteria":{"type":"array","default":"","description":"List of sorting criteria for search results","items":{"$ref":"#/components/schemas/ApiSortDto"}},"pageNumber":{"type":"integer","format":"int32","default":"","description":"Page number to retrieve (zero-based)"},"pageSize":{"type":"integer","format":"int32","default":"","description":"Page size (number of elements to retrieve, default 20)"}},"required":["pageNumber","pageSize"]}},"components/schemas/ApiSortDirectionEnum":{"id":"components/schemas/ApiSortDirectionEnum","kind":"json-schema","title":"ApiSortDirectionEnum","data":{"type":"string","additionalProperties":false,"default":null,"enum":["ASC","DESC"]}},"components/schemas/ApiSortDto":{"id":"components/schemas/ApiSortDto","kind":"json-schema","title":"ApiSortDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"DTO specifying a sort criterion for a field","properties":{"sortField":{"type":"string","default":"","description":"Field name to sort by"},"sortDirection":{"$ref":"#/components/schemas/ApiSortDirectionEnum","default":"","description":"Sort direction (ASC for ascending, DESC for descending)"}}}},"components/schemas/ApiCompanyConsumptionDetailListReadDto":{"id":"components/schemas/ApiCompanyConsumptionDetailListReadDto","kind":"json-schema","title":"ApiCompanyConsumptionDetailListReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Company consumption detail list entry","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Unique identifier of the object"},"productCode":{"type":"string","default":"","description":"Product code."},"productDescription":{"type":"string","default":"","description":"Product description."},"billingProduct":{"type":"string","default":"","description":"Billing product."},"quantity":{"type":"integer","format":"int32","default":"","description":"Consumption quantity.","example":5},"partnerPurchase":{"type":"number","default":"","description":"Partner purchase amount.","example":1000},"partnerSale":{"type":"number","default":"","description":"Partner sale amount.","example":1200},"enterprisePurchase":{"type":"number","default":"","description":"Enterprise purchase amount.","example":500},"enterpriseSale":{"type":"number","default":"","description":"Enterprise sale amount.","example":600},"partnerCommission":{"type":"number","default":"","description":"Partner commission amount.","example":100},"enterpriseCommission":{"type":"number","default":"","description":"Enterprise commission amount.","example":50},"voucherAmount":{"type":"number","default":"","description":"Voucher discount amount.","example":10},"pvp":{"type":"number","default":"","description":"PVP (list price).","example":1500},"pvpPeriod":{"type":"number","default":"","description":"PVP for the period.","example":1500},"periodEndDate":{"type":"string","format":"date","default":"","description":"Period end date.","example":"2024-01-31"}},"required":["id"]}},"components/schemas/ApiCompanyConsumptionPartnerSubscriptionListDto":{"id":"components/schemas/ApiCompanyConsumptionPartnerSubscriptionListDto","kind":"json-schema","title":"ApiCompanyConsumptionPartnerSubscriptionListDto","data":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32","default":"","description":"Unique identifier of the object"},"companyId":{"type":"integer","format":"int32","default":"","description":"Company identifier.","example":1},"companyName":{"type":"string","default":"","description":"Company name."},"partnerName":{"type":"string","default":"","description":"Partner name."},"partnerCustomerName":{"type":"string","default":"","description":"Partner customer name."},"partnerCustomerCommercialName":{"type":"string","default":"","description":"Partner customer commercial name."},"firstDate":{"type":"string","format":"date","default":"","description":"First consumption date.","example":"2024-01-15"},"partnerPurchase":{"type":"number","default":"","description":"Partner purchase amount.","example":1000},"partnerSale":{"type":"number","default":"","description":"Partner sale amount.","example":1200},"enterprisePurchase":{"type":"number","default":"","description":"Enterprise purchase amount.","example":500},"enterpriseSale":{"type":"number","default":"","description":"Enterprise sale amount.","example":600},"partnerCommission":{"type":"number","default":"","description":"Partner commission amount.","example":100},"enterpriseCommission":{"type":"number","default":"","description":"Enterprise commission amount.","example":50},"voucherAmount":{"type":"number","default":"","description":"Voucher discount amount.","example":10},"pvp":{"type":"number","default":"","description":"PVP (list price).","example":1500},"pvpPeriod":{"type":"number","default":"","description":"PVP for the period.","example":1500},"periodEndDate":{"type":"string","format":"date","default":"","description":"Period end date.","example":"2024-01-31"},"partnerLogo":{"type":"string"},"partnerCif":{"type":"string"},"partnerEmail":{"type":"string"},"partnerCustomerLogo":{"type":"string"},"partnerCustomerCif":{"type":"string"},"partnerCustomerEmail":{"type":"string"},"partnerExternalCode":{"type":"string"},"partnerCustomerPeriod":{"type":"string"},"partnerSubscriptionLimit":{"type":"integer","format":"int32"},"partnerCustomerExternalCode":{"type":"string"},"plans":{"type":"array","items":{"type":"string"}},"details":{"type":"array","items":{"$ref":"#/components/schemas/ApiCompanyConsumptionDetailListReadDto"}}},"required":["id"]}},"components/schemas/ApiPageDtoCompanyConsumptionPartnerSubscriptionListDto":{"id":"components/schemas/ApiPageDtoCompanyConsumptionPartnerSubscriptionListDto","kind":"json-schema","title":"ApiPageDtoCompanyConsumptionPartnerSubscriptionListDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Generic DTO to wrap paginated data with pagination information","properties":{"data":{"type":"array","default":"","description":"List of data elements in the current page","items":{"$ref":"#/components/schemas/ApiCompanyConsumptionPartnerSubscriptionListDto"}},"page":{"type":"integer","format":"int32","default":"","description":"Current page number (zero-based)"},"total":{"type":"integer","format":"int32","default":"","description":"Total number of elements across all pages"},"pages":{"type":"integer","format":"int64","default":"","description":"Total number of pages"},"size":{"type":"integer","format":"int32","default":"","description":"Page size (number of elements per page)"}},"required":["data","page","pages","size","total"]}},"components/schemas/ApiPageDtoPartnerCustomerViewReadDto":{"id":"components/schemas/ApiPageDtoPartnerCustomerViewReadDto","kind":"json-schema","title":"ApiPageDtoPartnerCustomerViewReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Generic DTO to wrap paginated data with pagination information","properties":{"data":{"type":"array","default":"","description":"List of data elements in the current page","items":{"$ref":"#/components/schemas/ApiPartnerCustomerViewReadDto"}},"page":{"type":"integer","format":"int32","default":"","description":"Current page number (zero-based)"},"total":{"type":"integer","format":"int32","default":"","description":"Total number of elements across all pages"},"pages":{"type":"integer","format":"int64","default":"","description":"Total number of pages"},"size":{"type":"integer","format":"int32","default":"","description":"Page size (number of elements per page)"}},"required":["data","page","pages","size","total"]}},"components/schemas/ApiPartnerCustomerViewReadDto":{"id":"components/schemas/ApiPartnerCustomerViewReadDto","kind":"json-schema","title":"ApiPartnerCustomerViewReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Partner customer view details with lifecycle information","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Unique identifier of the object"},"commercialName":{"type":"string","default":"","description":"Commercial name."},"cif":{"type":"string","default":"","description":"Customer CIF.","example":"A12345678"},"name":{"type":"string","default":"","description":"Customer name."},"email":{"type":"string","default":"","description":"Contact email.","example":"customer@example.com"},"discount":{"type":"number","default":"","description":"Discount percentage.","example":5},"logo":{"type":"string","default":"","description":"Customer logo URL."},"subscription":{"type":"string","default":"","description":"Subscription name."},"period":{"type":"string","default":"","description":"Period name."},"status":{"$ref":"#/components/schemas/ApiPartnerStatusEnum","default":"","description":"Partner customer status."},"partnerId":{"type":"integer","format":"int32","default":"","description":"Partner identifier.","example":1},"partnerName":{"type":"string","default":"","description":"Partner name."},"companyId":{"type":"integer","format":"int32","default":"","description":"Company identifier.","example":1},"companyName":{"type":"string","default":"","description":"Company name."},"companyOwnerEmail":{"type":"string","default":"","description":"Company owner email.","example":"owner@example.com"},"externalCode":{"type":"string","default":"","description":"External customer code."},"invitationSentOn":{"type":"string","format":"date-time","default":"","description":"Invitation sent date and time."},"invitationAcceptedOn":{"type":"string","format":"date-time","default":"","description":"Invitation accepted date and time."},"createdOn":{"type":"string","format":"date-time","default":"","description":"Creation date and time."},"firstPhoneNumber":{"type":"string","default":"","description":"First phone number.","example":"+34912345678"},"cancellationDate":{"type":"string","format":"date-time","default":"","description":"Cancellation date and time."},"cancellationReason":{"type":"string","default":"","description":"Cancellation reason."},"trialExpirationDays":{"type":"integer","format":"int32","default":"","description":"Trial expiration days remaining.","example":30},"trialExtended":{"type":"boolean","default":false,"description":"Trial extended flag.","example":false},"lastAccess":{"type":"string","format":"date-time","default":"","description":"Last access date and time."},"terminateDate":{"type":"string","format":"date-time","default":"","description":"Termination date and time."},"terminateReason":{"type":"string","default":"","description":"Termination reason."}},"required":["id"]}},"components/schemas/ApiPageDtoPartnerCustomerListReadDto":{"id":"components/schemas/ApiPageDtoPartnerCustomerListReadDto","kind":"json-schema","title":"ApiPageDtoPartnerCustomerListReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Generic DTO to wrap paginated data with pagination information","properties":{"data":{"type":"array","default":"","description":"List of data elements in the current page","items":{"$ref":"#/components/schemas/ApiPartnerCustomerListReadDto"}},"page":{"type":"integer","format":"int32","default":"","description":"Current page number (zero-based)"},"total":{"type":"integer","format":"int32","default":"","description":"Total number of elements across all pages"},"pages":{"type":"integer","format":"int64","default":"","description":"Total number of pages"},"size":{"type":"integer","format":"int32","default":"","description":"Page size (number of elements per page)"}},"required":["data","page","pages","size","total"]}},"components/schemas/ApiPartnerCustomerListReadDto":{"id":"components/schemas/ApiPartnerCustomerListReadDto","kind":"json-schema","title":"ApiPartnerCustomerListReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Partner customer list entry","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Unique identifier of the object"},"commercialName":{"type":"string","default":"","description":"Commercial name."},"cif":{"type":"string","default":"","description":"Customer CIF.","example":"A12345678"},"name":{"type":"string","default":"","description":"Customer name."},"email":{"type":"string","default":"","description":"Contact email.","example":"customer@example.com"},"discount":{"type":"number","default":"","description":"Discount percentage.","example":5},"logo":{"type":"string","default":"","description":"Customer logo URL."},"subscription":{"type":"string","default":"","description":"Subscription name."},"period":{"type":"string","default":"","description":"Period name."},"status":{"$ref":"#/components/schemas/ApiPartnerStatusEnum","default":"","description":"Partner customer status."},"partnerId":{"type":"integer","format":"int32","default":"","description":"Partner identifier.","example":1},"partnerName":{"type":"string","default":"","description":"Partner name."},"companyId":{"type":"integer","format":"int32","default":"","description":"Company identifier.","example":1},"companyName":{"type":"string","default":"","description":"Company name."},"companyOwnerEmail":{"type":"string","default":"","description":"Company owner email.","example":"owner@example.com"},"externalCode":{"type":"string","default":"","description":"External customer code."},"invitationSentOn":{"type":"string","format":"date-time","default":"","description":"Invitation sent date and time."},"invitationAcceptedOn":{"type":"string","format":"date-time","default":"","description":"Invitation accepted date and time."},"createdOn":{"type":"string","format":"date-time","default":"","description":"Creation date and time."},"firstPhoneNumber":{"type":"string","default":"","description":"First phone number.","example":"+34912345678"}},"required":["id"]}},"components/schemas/ApiPartnerCustomerRenewalReadDto":{"id":"components/schemas/ApiPartnerCustomerRenewalReadDto","kind":"json-schema","title":"ApiPartnerCustomerRenewalReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Partner customer renewal details with services","properties":{"subscriptionId":{"type":"integer","format":"int32","default":"","description":"Id of the subscription.","example":12345},"subscriptionName":{"type":"string","default":"","description":"Name of the subscription.","example":"Clavei"},"renewalDate":{"type":"string","format":"date","default":"","description":"Renewal date.","example":"2025-10-01"},"services":{"type":"array","default":"","description":"List of services included in this renewal group.","items":{"$ref":"#/components/schemas/ApiPartnerCustomerServiceRenewReadDto"}}}}},"components/schemas/ApiPartnerCustomerServiceRenewReadDto":{"id":"components/schemas/ApiPartnerCustomerServiceRenewReadDto","kind":"json-schema","title":"ApiPartnerCustomerServiceRenewReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Partner customer service renewal pricing information","properties":{"serviceId":{"type":"integer","format":"int32","default":"","description":"Internal ID of the product.","example":18392},"serviceName":{"type":"string","default":"","description":"Name of the product.","example":"Trial plan"},"price":{"type":"number","default":"","description":"Price.","example":15},"discount":{"type":"number","default":"","description":"Discount percentage.","example":10},"nextPrice":{"type":"number","default":"","description":"Next price.","example":15},"nextDiscount":{"type":"number","default":"","description":"Next discount percentage.","example":10}}}},"components/schemas/ApiPartnerCustomerImportResponseDto":{"id":"components/schemas/ApiPartnerCustomerImportResponseDto","kind":"json-schema","title":"ApiPartnerCustomerImportResponseDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Partner customer import response","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Unique identifier of the object"},"email":{"type":"string","default":"","description":"Customer email address.","example":"customer@example.com"},"name":{"type":"string","default":"","description":"Customer name."},"success":{"type":"boolean","default":false,"description":"Import success flag.","example":true},"error":{"type":"string","default":"","description":"Error message if import failed."}},"required":["id"]}},"components/schemas/ApiExportCriteriaDto":{"id":"components/schemas/ApiExportCriteriaDto","kind":"json-schema","title":"ApiExportCriteriaDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Export criteria DTO that extends SearchCriteriaDto with field translations","properties":{"conditions":{"type":"array","default":"","description":"List of conditions to be applied with AND logic","items":{"$ref":"#/components/schemas/ApiCondition"}},"orConditions":{"type":"array","default":"","description":"List of conditions to be applied with OR logic","items":{"$ref":"#/components/schemas/ApiCondition"}},"sortCriteria":{"type":"array","default":"","description":"List of sorting criteria for search results","items":{"$ref":"#/components/schemas/ApiSortDto"}},"pageNumber":{"type":"integer","format":"int32","default":"","description":"Page number to retrieve (zero-based)"},"pageSize":{"type":"integer","format":"int32","default":"","description":"Page size (number of elements to retrieve, default 20)"},"translates":{"type":"object","additionalProperties":{"type":"string"},"default":"","description":"Map of translations for field names during export"}},"required":["pageNumber","pageSize"]}},"components/schemas/ApiApiExceptionDto":{"id":"components/schemas/ApiApiExceptionDto","kind":"json-schema","title":"ApiApiExceptionDto","data":{"type":"object","additionalProperties":false,"properties":{"code":{"type":"string"},"message":{"type":"string"},"fields":{"type":"array","items":{"type":"string"}},"list":{"type":"boolean"}}}},"components/schemas/ApiBatchWriteResponseDto":{"id":"components/schemas/ApiBatchWriteResponseDto","kind":"json-schema","title":"ApiBatchWriteResponseDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Result of a single item in a batch write operation","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Identifier of the created or updated object. Null if the operation failed."},"success":{"type":"boolean","default":false,"description":"Whether the operation succeeded for this item."},"error":{"$ref":"#/components/schemas/ApiApiExceptionDto","default":"","description":"Error details if the operation failed."}}}},"components/schemas/ApiAmountStatsResponseDto":{"id":"components/schemas/ApiAmountStatsResponseDto","kind":"json-schema","title":"ApiAmountStatsResponseDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Amount statistics response","properties":{"amount":{"type":"number","default":"","description":"Amount value.","example":1500}}}},"components/schemas/ApiPartnerCustomerSalesDto":{"id":"components/schemas/ApiPartnerCustomerSalesDto","kind":"json-schema","title":"ApiPartnerCustomerSalesDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Partner customer sales summary","properties":{"partnerCustomerName":{"type":"string","default":"","description":"Partner customer name."},"partnerCustomerId":{"type":"integer","format":"int32","default":"","description":"Partner customer identifier.","example":1},"partnerName":{"type":"string","default":"","description":"Partner name."},"partnerId":{"type":"integer","format":"int32","default":"","description":"Partner identifier.","example":1},"total":{"type":"number","default":"","description":"Total sales amount.","example":1500}}}},"components/schemas/ApiManagementTotalStatsResponseDto":{"id":"components/schemas/ApiManagementTotalStatsResponseDto","kind":"json-schema","title":"ApiManagementTotalStatsResponseDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Management total statistics response","properties":{"labels":{"type":"array","default":"","description":"Chart labels for statistics data.","items":{"type":"string"}},"datasets":{"type":"array","default":"","description":"Datasets with statistics values.","items":{"$ref":"#/components/schemas/ApiTotalStatsDataResponseDto"}}}}},"components/schemas/ApiTotalStatsDataResponseDto":{"id":"components/schemas/ApiTotalStatsDataResponseDto","kind":"json-schema","title":"ApiTotalStatsDataResponseDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Total statistics data with values","properties":{"data":{"type":"array","default":"","description":"Statistical data values.","items":{"type":"number"}},"type":{"type":"string","default":"","description":"Chart type.","example":"line"},"label":{"type":"string","default":"","description":"Data label.","example":"Total Sales"}}}},"components/schemas/ApiPartnerSalesDto":{"id":"components/schemas/ApiPartnerSalesDto","kind":"json-schema","title":"ApiPartnerSalesDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Partner sales summary","properties":{"partnerName":{"type":"string","default":"","description":"Partner name."},"partnerId":{"type":"integer","format":"int32","default":"","description":"Partner identifier.","example":1},"total":{"type":"number","default":"","description":"Total sales amount.","example":5000}}}},"components/schemas/ApiCountStatsResponseDto":{"id":"components/schemas/ApiCountStatsResponseDto","kind":"json-schema","title":"ApiCountStatsResponseDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Count statistics response","properties":{"count":{"type":"integer","format":"int64","default":"","description":"Total count.","example":100}}}},"components/schemas/ApiPageDtoPartnerListReadDto":{"id":"components/schemas/ApiPageDtoPartnerListReadDto","kind":"json-schema","title":"ApiPageDtoPartnerListReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Generic DTO to wrap paginated data with pagination information","properties":{"data":{"type":"array","default":"","description":"List of data elements in the current page","items":{"$ref":"#/components/schemas/ApiPartnerListReadDto"}},"page":{"type":"integer","format":"int32","default":"","description":"Current page number (zero-based)"},"total":{"type":"integer","format":"int32","default":"","description":"Total number of elements across all pages"},"pages":{"type":"integer","format":"int64","default":"","description":"Total number of pages"},"size":{"type":"integer","format":"int32","default":"","description":"Page size (number of elements per page)"}},"required":["data","page","pages","size","total"]}},"components/schemas/ApiPartnerFileListReadDto":{"id":"components/schemas/ApiPartnerFileListReadDto","kind":"json-schema","title":"ApiPartnerFileListReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Partner file list entry","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Unique identifier of the object"},"token":{"type":"string","default":"","description":"File token."},"url":{"type":"string","default":"","description":"File URL."},"fileName":{"type":"string","default":"","description":"File name.","example":"document.pdf"},"fileExtension":{"type":"string","default":"","description":"File extension.","example":"pdf"},"fileSize":{"type":"integer","format":"int64","default":"","description":"File size in bytes.","example":1024},"modifiedOn":{"type":"string","format":"date-time","default":"","description":"Last modification date and time."},"title":{"type":"string","default":"","description":"File title."},"description":{"type":"string","default":"","description":"File description."}},"required":["id"]}},"components/schemas/ApiAcceptSepaWriteDto":{"id":"components/schemas/ApiAcceptSepaWriteDto","kind":"json-schema","title":"ApiAcceptSepaWriteDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"SEPA direct debit acceptance request","properties":{"iban":{"type":"string","default":"","description":"IBAN of the bank account.","example":"ES9820385778983000760236","maxLength":34,"minLength":0}},"required":["iban"]}},"components/schemas/ApiAdminCompanyWriteDto":{"id":"components/schemas/ApiAdminCompanyWriteDto","kind":"json-schema","title":"ApiAdminCompanyWriteDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Admin company creation/update request","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Identifier of the object to modify or delete"},"companyType":{"$ref":"#/components/schemas/ApiManagementCompanyTypeEnum","default":"","description":"Company type."},"companyName":{"type":"string","default":"","description":"Company legal name.","example":"Acme Corporation","maxLength":200,"minLength":0},"employees":{"$ref":"#/components/schemas/ApiCompanyUsersRangeEnum","default":"","description":"Employee range."},"fullName":{"type":"string","default":"","description":"Full name of company representative.","example":"John Doe","maxLength":200,"minLength":0},"cif":{"type":"string","default":"","description":"Company tax identification number.","maxLength":20,"minLength":0},"creationDate":{"type":"string","format":"date","default":"","description":"Company creation date.","example":"2024-01-15"},"inactiveDate":{"type":"string","format":"date","default":"","description":"Company inactivation date.","example":"2025-01-15"},"active":{"type":"boolean","default":false,"description":"Active status.","example":true},"address":{"type":"string","default":"","description":"Physical address.","maxLength":100,"minLength":0},"country":{"type":"integer","format":"int32","default":"","description":"Country identifier.","example":1},"state":{"type":"integer","format":"int32","default":"","description":"State/Province identifier."},"postalCode":{"type":"string","default":"","description":"Postal code.","maxLength":10,"minLength":0},"city":{"type":"string","default":"","description":"City name.","maxLength":100,"minLength":0},"phone":{"type":"string","default":"","description":"Primary phone number.","maxLength":20,"minLength":0},"phone2":{"type":"string","default":"","description":"Secondary phone number.","maxLength":20,"minLength":0},"email":{"type":"string","default":"","description":"Email address.","example":"info@example.com","maxLength":250,"minLength":0},"website":{"type":"string","default":"","description":"Company website.","maxLength":100,"minLength":0},"commercialRegistry":{"type":"string","default":"","description":"Commercial registry reference."},"observations":{"type":"string","default":"","description":"Additional observations."},"logo":{"type":"string","default":"","description":"Company logo identifier.","maxLength":36,"minLength":0},"creditCardUser":{"type":"integer","format":"int32","default":"","description":"Credit card user identifier."},"igic":{"type":"boolean","default":false,"description":"IGIC tax flag."},"domain":{"type":"integer","format":"int32","default":"","description":"Domain identifier."},"plan":{"type":"integer","format":"int32","default":"","description":"Plan identifier.","example":1},"customer":{"type":"integer","format":"int32","default":"","description":"Customer identifier."},"period":{"type":"integer","format":"int32","default":"","description":"Period identifier."},"companyStatus":{"$ref":"#/components/schemas/ApiCompanyStatusEnum","default":"","description":"Company status."},"partnerId":{"type":"integer","format":"int32","default":"","description":"Partner identifier."}},"required":["active","companyName","companyType","country","employees","fullName","plan"]}},"components/schemas/ApiCompanyProvisionedReadDto":{"id":"components/schemas/ApiCompanyProvisionedReadDto","kind":"json-schema","title":"ApiCompanyProvisionedReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Provisioned company with trial and partner information","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Unique identifier of the object"},"plan":{"$ref":"#/components/schemas/ApiPlanListReadDto","default":"","description":"Assigned plan."},"customer":{"$ref":"#/components/schemas/ApiManagementCustomerListReadDto","default":"","description":"Associated customer."},"period":{"$ref":"#/components/schemas/ApiManagementPeriodListReadDto","default":"","description":"Billing period."},"companyType":{"$ref":"#/components/schemas/ApiManagementCompanyTypeEnum","default":"","description":"Company type."},"companyStatus":{"$ref":"#/components/schemas/ApiCompanyStatusEnum","default":"","description":"Company status."},"companyName":{"type":"string","default":"","description":"Company name."},"employees":{"$ref":"#/components/schemas/ApiCompanyUsersRangeEnum","default":"","description":"Employee range."},"fullName":{"type":"string","default":"","description":"Full name of company representative."},"cif":{"type":"string","default":"","description":"Tax identification number."},"active":{"type":"boolean","default":false,"description":"Active status.","example":true},"address":{"type":"string","default":"","description":"Physical address."},"country":{"$ref":"#/components/schemas/ApiManagementCountryListReadDto","default":"","description":"Company country."},"state":{"$ref":"#/components/schemas/ApiManagementStateListReadDto","default":"","description":"Company state/province."},"postalCode":{"type":"string","default":"","description":"Postal code."},"city":{"type":"string","default":"","description":"City name."},"phone":{"type":"string","default":"","description":"Primary phone number."},"phone2":{"type":"string","default":"","description":"Secondary phone number."},"email":{"type":"string","default":"","description":"Email address.","example":"info@example.com"},"website":{"type":"string","default":"","description":"Company website URL."},"commercialRegistry":{"type":"string","default":"","description":"Commercial registry reference."},"logo":{"type":"string","default":"","description":"Company logo identifier."},"logoToken":{"type":"string","default":"","description":"Logo token for access."},"observations":{"type":"string","default":"","description":"Additional observations."},"billingServiceId":{"type":"string","default":"","description":"External billing service identifier."},"trial":{"type":"boolean","default":false,"description":"Trial status.","example":true},"initialDate":{"type":"string","format":"date","default":"","description":"Trial start date.","example":"2024-01-15"},"finalDate":{"type":"string","format":"date","default":"","description":"Trial end date.","example":"2024-02-15"},"partnerType":{"$ref":"#/components/schemas/ApiPartnerTypeEnum","default":"","description":"Partner type."},"theme":{"$ref":"#/components/schemas/ApiThemeEnum","default":"","description":"Company theme."},"conditionsUrl":{"type":"string","default":"","description":"Terms and conditions URL."},"partnerDemo":{"type":"boolean","default":false,"description":"Partner demo flag.","example":false},"partnerBusiness":{"type":"boolean","default":false,"description":"Partner business flag.","example":true},"igic":{"type":"boolean","default":false,"description":"IGIC tax flag."},"trialExtended":{"type":"boolean","default":false,"description":"Trial extended flag.","example":false},"noRenew":{"type":"boolean","default":false,"description":"No renewal flag.","example":false},"canceled":{"type":"boolean","default":false,"description":"Canceled flag.","example":false},"partnerWithPaymentGateway":{"type":"boolean","default":false,"description":"Partner has payment gateway flag.","example":true},"userInvitationReferenceUrl":{"type":"string","default":"","description":"User invitation reference URL."}},"required":["id"]}},"components/schemas/ApiPageDtoManagementStateListReadDto":{"id":"components/schemas/ApiPageDtoManagementStateListReadDto","kind":"json-schema","title":"ApiPageDtoManagementStateListReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Generic DTO to wrap paginated data with pagination information","properties":{"data":{"type":"array","default":"","description":"List of data elements in the current page","items":{"$ref":"#/components/schemas/ApiManagementStateListReadDto"}},"page":{"type":"integer","format":"int32","default":"","description":"Current page number (zero-based)"},"total":{"type":"integer","format":"int32","default":"","description":"Total number of elements across all pages"},"pages":{"type":"integer","format":"int64","default":"","description":"Total number of pages"},"size":{"type":"integer","format":"int32","default":"","description":"Page size (number of elements per page)"}},"required":["data","page","pages","size","total"]}},"components/schemas/ApiPageDtoPlanListReadDto":{"id":"components/schemas/ApiPageDtoPlanListReadDto","kind":"json-schema","title":"ApiPageDtoPlanListReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Generic DTO to wrap paginated data with pagination information","properties":{"data":{"type":"array","default":"","description":"List of data elements in the current page","items":{"$ref":"#/components/schemas/ApiPlanListReadDto"}},"page":{"type":"integer","format":"int32","default":"","description":"Current page number (zero-based)"},"total":{"type":"integer","format":"int32","default":"","description":"Total number of elements across all pages"},"pages":{"type":"integer","format":"int64","default":"","description":"Total number of pages"},"size":{"type":"integer","format":"int32","default":"","description":"Page size (number of elements per page)"}},"required":["data","page","pages","size","total"]}},"components/schemas/ApiPageDtoManagementPeriodListReadDto":{"id":"components/schemas/ApiPageDtoManagementPeriodListReadDto","kind":"json-schema","title":"ApiPageDtoManagementPeriodListReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Generic DTO to wrap paginated data with pagination information","properties":{"data":{"type":"array","default":"","description":"List of data elements in the current page","items":{"$ref":"#/components/schemas/ApiManagementPeriodListReadDto"}},"page":{"type":"integer","format":"int32","default":"","description":"Current page number (zero-based)"},"total":{"type":"integer","format":"int32","default":"","description":"Total number of elements across all pages"},"pages":{"type":"integer","format":"int64","default":"","description":"Total number of pages"},"size":{"type":"integer","format":"int32","default":"","description":"Page size (number of elements per page)"}},"required":["data","page","pages","size","total"]}},"components/schemas/ApiPageDtoManagementCountryListReadDto":{"id":"components/schemas/ApiPageDtoManagementCountryListReadDto","kind":"json-schema","title":"ApiPageDtoManagementCountryListReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Generic DTO to wrap paginated data with pagination information","properties":{"data":{"type":"array","default":"","description":"List of data elements in the current page","items":{"$ref":"#/components/schemas/ApiManagementCountryListReadDto"}},"page":{"type":"integer","format":"int32","default":"","description":"Current page number (zero-based)"},"total":{"type":"integer","format":"int32","default":"","description":"Total number of elements across all pages"},"pages":{"type":"integer","format":"int64","default":"","description":"Total number of pages"},"size":{"type":"integer","format":"int32","default":"","description":"Page size (number of elements per page)"}},"required":["data","page","pages","size","total"]}},"components/schemas/ApiPeriodStatsRequestEnum":{"id":"components/schemas/ApiPeriodStatsRequestEnum","kind":"json-schema","title":"ApiPeriodStatsRequestEnum","data":{"type":"string","additionalProperties":false,"enum":["CURRENT_YEAR","PREVIOUS_YEAR","LAST_12_MONTHS"]}},"components/schemas/ApiPageDtoPartnerFileListReadDto":{"id":"components/schemas/ApiPageDtoPartnerFileListReadDto","kind":"json-schema","title":"ApiPageDtoPartnerFileListReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Generic DTO to wrap paginated data with pagination information","properties":{"data":{"type":"array","default":"","description":"List of data elements in the current page","items":{"$ref":"#/components/schemas/ApiPartnerFileListReadDto"}},"page":{"type":"integer","format":"int32","default":"","description":"Current page number (zero-based)"},"total":{"type":"integer","format":"int32","default":"","description":"Total number of elements across all pages"},"pages":{"type":"integer","format":"int64","default":"","description":"Total number of pages"},"size":{"type":"integer","format":"int32","default":"","description":"Page size (number of elements per page)"}},"required":["data","page","pages","size","total"]}},"components/schemas/ApiCompanyStatusReadDto":{"id":"components/schemas/ApiCompanyStatusReadDto","kind":"json-schema","title":"ApiCompanyStatusReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Company subscription status with payment information","properties":{"planId":{"type":"integer","format":"int32","default":"","description":"Plan identifier.","example":1},"planName":{"type":"string","default":"","description":"Plan name.","example":"Premium"},"periodId":{"type":"integer","format":"int32","default":"","description":"Period identifier.","example":1},"periodName":{"type":"string","default":"","description":"Period name.","example":"Monthly"},"planPrice":{"type":"number","default":"","description":"Plan price.","example":99.99},"lastPayment":{"type":"string","format":"date","default":"","description":"Last payment date.","example":"2024-01-15"},"lastPaymentAmount":{"type":"number","default":"","description":"Last payment amount.","example":99.99},"nextPayment":{"type":"string","format":"date","default":"","description":"Next payment date.","example":"2024-02-15"},"nextPaymentAmount":{"type":"number","default":"","description":"Next payment amount.","example":99.99},"canceled":{"type":"boolean","default":false,"description":"Subscription canceled flag.","example":false}}}},"components/schemas/ApiManagementFeatureListReadDto":{"id":"components/schemas/ApiManagementFeatureListReadDto","kind":"json-schema","title":"ApiManagementFeatureListReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Management feature list entry","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Unique identifier of the object"},"description":{"type":"string","default":"","description":"Feature description."}},"required":["id"]}},"components/schemas/ApiManagementModuleCompleteReadDto":{"id":"components/schemas/ApiManagementModuleCompleteReadDto","kind":"json-schema","title":"ApiManagementModuleCompleteReadDto","data":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32","default":"","description":"Unique identifier of the object"},"description":{"type":"string"},"visibleMarketplace":{"type":"boolean"},"code":{"type":"string"},"cancelled":{"type":"boolean"},"cancellationDate":{"type":"string","format":"date-time"},"endPeriodDate":{"type":"string","format":"date"},"endTrialDate":{"type":"string","format":"date"},"features":{"type":"array","items":{"$ref":"#/components/schemas/ApiManagementFeatureListReadDto"}}},"required":["id"]}},"components/schemas/ApiDowngradeAvailableReadDto":{"id":"components/schemas/ApiDowngradeAvailableReadDto","kind":"json-schema","title":"ApiDowngradeAvailableReadDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Downgrade availability information","properties":{"available":{"type":"boolean","default":false,"description":"Downgrade available flag.","example":true},"reasons":{"type":"array","default":"","description":"Reasons why downgrade might not be available.","items":{"type":"string"}}}}},"components/schemas/ApiRoleDto":{"id":"components/schemas/ApiRoleDto","kind":"json-schema","title":"ApiRoleDto","data":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"code":{"type":"string"},"description":{"type":"string"},"admin":{"type":"boolean"},"singleUser":{"type":"boolean"},"consultant":{"type":"boolean"},"noAccess":{"type":"boolean"},"systemCore":{"type":"boolean"}}}},"components/schemas/ApiDeleteByIdsRequestDto":{"id":"components/schemas/ApiDeleteByIdsRequestDto","kind":"json-schema","title":"ApiDeleteByIdsRequestDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Request DTO to delete multiple objects by their identifiers","properties":{"ids":{"type":"array","default":"","description":"List of identifiers of objects to delete","items":{"type":"integer","format":"int32"},"minItems":1}},"required":["ids"]}},"components/schemas/ApiDeleteResponseDto":{"id":"components/schemas/ApiDeleteResponseDto","kind":"json-schema","title":"ApiDeleteResponseDto","data":{"type":"object","additionalProperties":false,"default":null,"description":"Response DTO for object deletion operation","properties":{"id":{"type":"integer","format":"int32","default":"","description":"Identifier of the deleted object"},"success":{"type":"boolean","default":false,"description":"Indicator of whether the deletion was successful"},"error":{"$ref":"#/components/schemas/ApiApiExceptionDto","default":"","description":"Error details if the deletion was not successful"}}}},"schema_0":{"kind":"json-schema","data":{"type":"integer","format":"int32"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"object","additionalProperties":{}},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"array","items":{"type":"integer","format":"int32"}},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ApiPartnerCustomerRenewalReadDto"}},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ApiDeleteResponseDto"}},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_5"}},"exampleStore":{},"securitySchemeStore":{},"servers":[{"url":"https://api.prana.software"}]},"options":{"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/PranaAPI/openapiprana.json?download"},{"url":"/_bundle/PranaAPI/openapiprana.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Prana Partner API","description":"API definition for Partners to interact with the Prana platform"}},"baseSlug":"/pranaapi/openapiprana","routesMapping":{}}