{"items":[{"type":"link","label":"Monitoring - One Platform Organizations Integration API","link":"/products/oneplatform/apis/oas/organizations","routeSlug":"/products/oneplatform/apis/oas/organizations","content":{"contentType":"overview","meta":{"name":"Monitoring - One Platform Organizations Integration API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"organizations.json","url":"/_bundle/products/oneplatform/apis/oas/organizations.json?download"},{"kind":"download","label":"organizations.yaml","url":"/_bundle/products/oneplatform/apis/oas/organizations.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"}]}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Monitoring - One Platform Organizations Integration API (v1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Monitoring - Public endpoints to integrate Organization with One Platform"}],"sectionId":"/"}],"sectionId":"/"}]}]}},{"type":"group","label":"Consumptions","link":"/products/oneplatform/apis/oas/organizations/consumptions","routeSlug":"/products/oneplatform/apis/oas/organizations/consumptions","items":[{"label":"Get product consumptions as aggregated for a consumer based on related consumer associated to given organization.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/consumptions/get_v1_organizations_id_consumptions-aggregated_consumers_consumerid","routeSlug":"/products/oneplatform/apis/oas/organizations/consumptions/get_v1_organizations_id_consumptions-aggregated_consumers_consumerid","metadata":{"seo":{"title":"Get product consumptions as aggregated for a consumer based on related consumer associated to given organization.","description":"Security policies: OrganizationsConsumptionsView"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_v1_organizations_id_consumptions-aggregated_consumers_consumerId","name":"Get product consumptions as aggregated for a consumer based on related consumer associated to given organization.","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1consumptions-aggregated~1consumers~1{consumerId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get product consumptions as aggregated for a consumer based on related consumer associated to given organization.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationsConsumptionsView"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"The identifier of the organization which associated consumer should be used as parent consumer filter for given\r\nchild consumer\r\naggregated consumptions.","required":true},{"name":"consumerId","in":"path","schemaId":"schema_0","description":"The consumer identifier for which aggregated consumptions are desired.","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumptions-aggregated~1consumers~1{consumerId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"productId","in":"query","schemaId":"schema_0","description":"The product identifier for which consumer's aggregated consumptions should be filtered.","required":true},{"name":"metricId","in":"query","schemaId":"schema_0","description":"The list of metric identifiers for which consumer's aggregated consumptions should be filtered.\r\nIs JSON array format.","required":true},{"name":"legalEntityId","in":"query","schemaId":"schema_0","description":"The legal entity identifier for which consumer's aggregated consumptions should be\r\nfiltered."},{"name":"rootPath","in":"query","schemaId":"schema_0","description":"The root path for which consumer's aggregated consumptions should be filtered (activated with\r\nstrict at true)."},{"name":"year","in":"query","schemaId":"schema_1","description":"The year for which consumer's aggregated consumptions should be filtered.","required":true},{"name":"month","in":"query","schemaId":"schema_1","description":"The month for which consumer's aggregated consumptions should be filtered.\r\nIf Empty then we will get aggregated consumptions for all months of the given year."},{"name":"attributeId","in":"query","schemaId":"schema_0","description":"The attribute identifier for which consumer's aggregated consumptions should be filtered."},{"name":"aggregateType","in":"query","schemaId":"schema_0","description":"Aggregate type (Daily, Monthly, Yearly) of the aggregated consumptions value."},{"name":"strict","in":"query","schemaId":"schema_2","description":"Boolean which defines whether or not to strictly activate given filter params. (Default: false)"},{"name":"integratorId","in":"query","schemaId":"schema_0","description":"The integrator identifier for which aggregated consumptions are desired (activated with\r\nstrict at true)."},{"name":"owner","in":"query","schemaId":"schema_2","description":"Boolean which defines whether only consumptions directly owned by provided consumerId should be\r\nreturned (activated with strict at true). (Default: false)"},{"name":"legalEntityMode","in":"query","schemaId":"schema_2"}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumptions-aggregated~1consumers~1{consumerId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/{id}/consumptions-aggregated/consumers/{consumerId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"},{"name":"consumerId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"productId","in":"query","required":true,"schemaId":"schema_0"},{"name":"metricId","in":"query","required":true,"schemaId":"schema_0"},{"name":"legalEntityId","in":"query","schemaId":"schema_0"},{"name":"rootPath","in":"query","schemaId":"schema_0"},{"name":"year","in":"query","required":true,"schemaId":"schema_1"},{"name":"month","in":"query","schemaId":"schema_1"},{"name":"attributeId","in":"query","schemaId":"schema_0"},{"name":"aggregateType","in":"query","schemaId":"schema_0"},{"name":"strict","in":"query","schemaId":"schema_2"},{"name":"integratorId","in":"query","schemaId":"schema_0"},{"name":"owner","in":"query","schemaId":"schema_2"},{"name":"legalEntityMode","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","500"],"pointer":"/v1/organizations/{id}/consumptions-aggregated/consumers/{consumerId}","href":"consumptions/get_v1_organizations_id_consumptions-aggregated_consumers_consumerid","openApiOperationId":"GET_v1_organizations_id_consumptions-aggregated_consumers_consumerId","summary":"Get product consumptions as aggregated for a consumer based on related consumer associated to given organization."},"isWebhook":false,"hideReplay":false,"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/ConsumptionsAggregatedConsumerDto"}},"schemaId":"components/schemas/ConsumptionsAggregatedConsumerDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumptions-aggregated~1consumers~1{consumerId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConsumptionsAggregatedConsumerDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsumptionsAggregatedConsumerDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consumptions/get_v1_organizations_id_consumptions-aggregated_consumers_consumerid"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/consumptions-aggregated/consumers/{consumerId}"},{"label":"Get product consumptions as aggregated for business relation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/consumptions/get_v1_organizations_id_consumptions-aggregated_business-relations_businessrelationid","routeSlug":"/products/oneplatform/apis/oas/organizations/consumptions/get_v1_organizations_id_consumptions-aggregated_business-relations_businessrelationid","metadata":{"seo":{"title":"Get product consumptions as aggregated for business relation","description":"Security policies: OrganizationsConsumptionsView"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_v1_organizations_id_consumptions-aggregated_business-relations_businessRelationId","name":"Get product consumptions as aggregated for business relation","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1consumptions-aggregated~1business-relations~1{businessRelationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get product consumptions as aggregated for business relation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationsConsumptionsView"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"The identifier of the organization which associated consumer should be used as business relation owner","required":true},{"name":"businessRelationId","in":"path","schemaId":"schema_0","description":"The business relation identifier for which aggregated consumptions are desired.","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumptions-aggregated~1business-relations~1{businessRelationId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"metricId","in":"query","schemaId":"schema_0","description":"The list of metric identifiers for which aggregated consumptions should be filtered.\r\nIs JSON array format.","required":true},{"name":"year","in":"query","schemaId":"schema_1","description":"The year for which aggregated consumptions should be filtered.","required":true},{"name":"month","in":"query","schemaId":"schema_1","description":"The month for which aggregated consumptions should be filtered.\r\nIf Empty then we will get aggregated consumptions for all months of the given year."},{"name":"attributeId","in":"query","schemaId":"schema_0","description":"The attribute identifier for which aggregated consumptions should be filtered."},{"name":"aggregateType","in":"query","schemaId":"schema_0","description":"Aggregate type (Daily, Monthly, Yearly) of the aggregated consumptions value."},{"name":"legalEntityMode","in":"query","schemaId":"schema_2","description":"Boolean which defines if try to use the legal entity associated to the \r\norganization consumer. (Default: false)"}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumptions-aggregated~1business-relations~1{businessRelationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/{id}/consumptions-aggregated/business-relations/{businessRelationId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"},{"name":"businessRelationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"metricId","in":"query","required":true,"schemaId":"schema_0"},{"name":"year","in":"query","required":true,"schemaId":"schema_1"},{"name":"month","in":"query","schemaId":"schema_1"},{"name":"attributeId","in":"query","schemaId":"schema_0"},{"name":"aggregateType","in":"query","schemaId":"schema_0"},{"name":"legalEntityMode","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","500"],"pointer":"/v1/organizations/{id}/consumptions-aggregated/business-relations/{businessRelationId}","href":"consumptions/get_v1_organizations_id_consumptions-aggregated_business-relations_businessrelationid","openApiOperationId":"GET_v1_organizations_id_consumptions-aggregated_business-relations_businessRelationId","summary":"Get product consumptions as aggregated for business relation"},"isWebhook":false,"hideReplay":false,"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/ConsumptionsAggregatedDto"}},"schemaId":"components/schemas/ConsumptionsAggregatedDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumptions-aggregated~1business-relations~1{businessRelationId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConsumptionsAggregatedDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsumptionsAggregatedDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"405","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consumptions/get_v1_organizations_id_consumptions-aggregated_business-relations_businessrelationid"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/consumptions-aggregated/business-relations/{businessRelationId}"},{"label":"Get latest consumptions for a business relation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/consumptions/get_v1_organizations_id_consumptions_latest","routeSlug":"/products/oneplatform/apis/oas/organizations/consumptions/get_v1_organizations_id_consumptions_latest","metadata":{"seo":{"title":"Get latest consumptions for a business relation","description":"It will return the latest consumptions for a business relation using query filtersSecurity policies: OrganizationsConsumptionsView"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_v1_organizations_id_consumptions_latest","name":"Get latest consumptions for a business relation","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1consumptions~1latest/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get latest consumptions for a business relation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It will return the latest consumptions for a business relation using query filters"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationsConsumptionsView"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"The organization identifier","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumptions~1latest/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"businessRelationId","in":"query","schemaId":"schema_0","description":"Business relation identifier.","required":true},{"name":"metricId","in":"query","schemaId":"schema_0","description":"Metric identifier. (Default: All metrics)"},{"name":"legalEntityMode","in":"query","schemaId":"schema_2","description":"Boolean which defines if try to use the legal entity associated to the \r\norganization consumer. (Default: false)"}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumptions~1latest/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/{id}/consumptions/latest","servers":[{"url":"/"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"businessRelationId","in":"query","required":true,"schemaId":"schema_0"},{"name":"metricId","in":"query","schemaId":"schema_0"},{"name":"legalEntityMode","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","500"],"pointer":"/v1/organizations/{id}/consumptions/latest","href":"consumptions/get_v1_organizations_id_consumptions_latest","openApiOperationId":"GET_v1_organizations_id_consumptions_latest","summary":"Get latest consumptions for a business relation"},"isWebhook":false,"hideReplay":false,"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/LatestConsumptionsDto"}},"schemaId":"components/schemas/LatestConsumptionsDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumptions~1latest/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LatestConsumptionsDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LatestConsumptionsDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"405","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consumptions/get_v1_organizations_id_consumptions_latest"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/consumptions/latest"}],"content":{"contentType":"group","meta":{"name":"Consumptions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Consumptions","showPageActions":true},{"nodeType":"markdoc","content":"Show consumptions of your product in One Platform"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/organizations/{id}/consumptions-aggregated/consumers/{consumerId}","summary":"Get product consumptions as aggregated for a consumer based on related consumer associated to given organization.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/consumptions/get_v1_organizations_id_consumptions-aggregated_consumers_consumerid","deprecated":false},{"title":"/v1/organizations/{id}/consumptions-aggregated/business-relations/{businessRelationId}","summary":"Get product consumptions as aggregated for business relation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/consumptions/get_v1_organizations_id_consumptions-aggregated_business-relations_businessrelationid","deprecated":false},{"title":"/v1/organizations/{id}/consumptions/latest","summary":"Get latest consumptions for a business relation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/consumptions/get_v1_organizations_id_consumptions_latest","deprecated":false}]}]}]}]}},{"type":"group","label":"Business Relations","link":"/products/oneplatform/apis/oas/organizations/business-relations","routeSlug":"/products/oneplatform/apis/oas/organizations/business-relations","items":[{"label":"Returns the list of the business relations.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/business-relations/get_v1_organizations_id_business-relations","routeSlug":"/products/oneplatform/apis/oas/organizations/business-relations/get_v1_organizations_id_business-relations","metadata":{"seo":{"title":"Returns the list of the business relations.","description":"Security policies: OrganizationOrGlobalBusinessRelationView"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_v1_organizations_id_business-relations","name":"Returns the list of the business relations.","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1business-relations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns the list of the business relations.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationOrGlobalBusinessRelationView"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"The organization identifier","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1business-relations/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"productId","in":"query","schemaId":"schema_0","description":"The product identifier of the business relation to filter. (Default: Not applied)"},{"name":"legalEntityId","in":"query","schemaId":"schema_0","description":"The legal entity identifier of the business relation to filter. (Default: Not applied)"},{"name":"legalEntityName","in":"query","schemaId":"schema_0","description":"The legal entity name of the business relation to filter.\r\nIgnored if a search filter is defined.\r\n(Default: Not applied)"},{"name":"consumerIdsPath","in":"query","schemaId":"schema_0","description":"The consumer identifiers path of the business relation to filter. (Default: Not applied)"},{"name":"originId","in":"query","schemaId":"schema_0","description":"The origin identifier of the business relation to filter. (Default: Not applied)"},{"name":"originIdIsNull","in":"query","schemaId":"schema_2","description":"Boolean, which defines whether to filter business relations with OriginId null or not null.\r\nIgnored if originId is defined. (Default: Not applied)"},{"name":"integratorId","in":"query","schemaId":"schema_0","description":"The integrator identifier to filter. (Default: Not applied)"},{"name":"integratorLabel","in":"query","schemaId":"schema_0","description":"The integrator label to filter. (Default: Not applied)"},{"name":"resourceType","in":"query","schemaId":"schema_0"},{"name":"createdAtFrom","in":"query","schemaId":"schema_0","description":"Date and time from when business relation was created. ISO 8601 format.\r\nExample: 2023-11-28T08:14:32.585Z\r\n(Default: Not applied)"},{"name":"createdAtTo","in":"query","schemaId":"schema_0","description":"Date and time to when business relation was created. ISO 8601 format.\r\nExample: 2023-11-28T08:14:32.585Z\r\n(Default: Not applied)"},{"name":"updatedAtFrom","in":"query","schemaId":"schema_0","description":"Date and time from when this business relation was updated. ISO 8601 format.\r\nExample: 2023-11-28T08:14:32.585Z\r\n(Default: Not applied)"},{"name":"updatedAtTo","in":"query","schemaId":"schema_0","description":"Date and time to when this business relation was updated. ISO 8601 format.\r\nExample: 2023-11-28T08:14:32.585Z\r\n(Default: Not applied)"},{"name":"search","in":"query","schemaId":"schema_0","description":"The identifier, legal entity name or integrator identifier to filter.\r\n(Default: Not applied)"},{"name":"exact","in":"query","schemaId":"schema_2","description":"Boolean, which defines whether the params legalEntityName and search must match\r\nexactly. (Default: false)"},{"name":"pageNumber","in":"query","schemaId":"schema_1","description":"The page number of pagination. (Default: 1)"},{"name":"pageSize","in":"query","schemaId":"schema_1","description":"The page size of pagination. (Default: 50, Max: 500)"},{"name":"shouldCount","in":"query","schemaId":"schema_2"},{"name":"legalEntityMode","in":"query","schemaId":"schema_2","description":"Boolean, which defines if try to use the legal entity associated with the\r\norganization consumer. (Default: false)"}],"pointer":"/paths/~1v1~1organizations~1{id}~1business-relations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/{id}/business-relations","servers":[{"url":"/"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"productId","in":"query","schemaId":"schema_0"},{"name":"legalEntityId","in":"query","schemaId":"schema_0"},{"name":"legalEntityName","in":"query","schemaId":"schema_0"},{"name":"consumerIdsPath","in":"query","schemaId":"schema_0"},{"name":"originId","in":"query","schemaId":"schema_0"},{"name":"originIdIsNull","in":"query","schemaId":"schema_2"},{"name":"integratorId","in":"query","schemaId":"schema_0"},{"name":"integratorLabel","in":"query","schemaId":"schema_0"},{"name":"resourceType","in":"query","schemaId":"schema_0"},{"name":"createdAtFrom","in":"query","schemaId":"schema_0"},{"name":"createdAtTo","in":"query","schemaId":"schema_0"},{"name":"updatedAtFrom","in":"query","schemaId":"schema_0"},{"name":"updatedAtTo","in":"query","schemaId":"schema_0"},{"name":"search","in":"query","schemaId":"schema_0"},{"name":"exact","in":"query","schemaId":"schema_2"},{"name":"pageNumber","in":"query","schemaId":"schema_1"},{"name":"pageSize","in":"query","schemaId":"schema_1"},{"name":"shouldCount","in":"query","schemaId":"schema_2"},{"name":"legalEntityMode","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","500"],"pointer":"/v1/organizations/{id}/business-relations","href":"business-relations/get_v1_organizations_id_business-relations","openApiOperationId":"GET_v1_organizations_id_business-relations","summary":"Returns the list of the business relations."},"isWebhook":false,"hideReplay":false,"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/PaginationDtoOfBusinessRelationDto"}},"schemaId":"components/schemas/PaginationDtoOfBusinessRelationDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1business-relations/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaginationDtoOfBusinessRelationDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationDtoOfBusinessRelationDto"}}},{"code":"401"},{"code":"403"},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-relations/get_v1_organizations_id_business-relations"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/business-relations"},{"label":"Returns the list of consumer root paths based on related consumer associated with the given organization.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/business-relations/get_v1_organizations_id_business-relations_consumer-paths_consumerid","routeSlug":"/products/oneplatform/apis/oas/organizations/business-relations/get_v1_organizations_id_business-relations_consumer-paths_consumerid","metadata":{"seo":{"title":"Returns the list of consumer root paths based on related consumer associated with the given organization.","description":"Security policies: OrganizationsBusinessRelationsConsumerPathsView"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_v1_organizations_id_business-relations_consumer-paths_consumerId","name":"Returns the list of consumer root paths based on related consumer associated with the given organization.","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1business-relations~1consumer-paths~1{consumerId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns the list of consumer root paths based on related consumer associated with the given organization.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationsBusinessRelationsConsumerPathsView"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"The organization identifier which associated consumer should be used as the parent consumer filter for\r\ngiven child consumer paths.","required":true},{"name":"consumerId","in":"path","schemaId":"schema_0","description":"The consumer identifier of the business relation path to filter.","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1business-relations~1consumer-paths~1{consumerId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"productId","in":"query","schemaId":"schema_0","description":"The product identifier of the business relation to filter.","required":true},{"name":"legalEntityMode","in":"query","schemaId":"schema_2"}],"pointer":"/paths/~1v1~1organizations~1{id}~1business-relations~1consumer-paths~1{consumerId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/{id}/business-relations/consumer-paths/{consumerId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"},{"name":"consumerId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"productId","in":"query","required":true,"schemaId":"schema_0"},{"name":"legalEntityMode","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","500"],"pointer":"/v1/organizations/{id}/business-relations/consumer-paths/{consumerId}","href":"business-relations/get_v1_organizations_id_business-relations_consumer-paths_consumerid","openApiOperationId":"GET_v1_organizations_id_business-relations_consumer-paths_consumerId","summary":"Returns the list of consumer root paths based on related consumer associated with the given organization."},"isWebhook":false,"hideReplay":false,"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/ListDtoOfConsumerPathWithNameDto"}},"schemaId":"components/schemas/ListDtoOfConsumerPathWithNameDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1business-relations~1consumer-paths~1{consumerId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListDtoOfConsumerPathWithNameDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListDtoOfConsumerPathWithNameDto"}}},{"code":"401"},{"code":"403"},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-relations/get_v1_organizations_id_business-relations_consumer-paths_consumerid"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/business-relations/consumer-paths/{consumerId}"},{"label":"Returns the list of consumer path items based on related consumer associated with the given organization.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/business-relations/get_v1_organizations_id_business-relations_consumer-path-items","routeSlug":"/products/oneplatform/apis/oas/organizations/business-relations/get_v1_organizations_id_business-relations_consumer-path-items","metadata":{"seo":{"title":"Returns the list of consumer path items based on related consumer associated with the given organization.","description":"Security policies: OrganizationsBusinessRelationsConsumerPathsView"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_v1_organizations_id_business-relations_consumer-path-items","name":"Returns the list of consumer path items based on related consumer associated with the given organization.","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1business-relations~1consumer-path-items/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns the list of consumer path items based on related consumer associated with the given organization.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationsBusinessRelationsConsumerPathsView"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"The organization identifier which associated consumer should be used as the filter.","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1business-relations~1consumer-path-items/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"productId","in":"query","schemaId":"schema_0","description":"The product identifier of the business relation to filter.","required":true},{"name":"legalEntityId","in":"query","schemaId":"schema_0","description":"The legal entity identifier of the business relation to filter."},{"name":"rootPath","in":"query","schemaId":"schema_0","description":"The consumer root path of the business relation to filter."},{"name":"search","in":"query","schemaId":"schema_0","description":"The consumer name to filter. (Default: Not applied)"},{"name":"exact","in":"query","schemaId":"schema_2","description":"Boolean, which defines whether the params name and search must match exactly.\r\n(Default: false)"},{"name":"pageNumber","in":"query","schemaId":"schema_1","description":"The page number of pagination. (Default: 1)"},{"name":"pageSize","in":"query","schemaId":"schema_1","description":"The page size of pagination. (Default: 50, Max: 500)"},{"name":"legalEntityMode","in":"query","schemaId":"schema_2","description":"Boolean, which defines if try to use the legal entity associated with the\r\norganization consumer. (Default: false)"},{"name":"shouldCount","in":"query","schemaId":"schema_2"}],"pointer":"/paths/~1v1~1organizations~1{id}~1business-relations~1consumer-path-items/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/{id}/business-relations/consumer-path-items","servers":[{"url":"/"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"productId","in":"query","required":true,"schemaId":"schema_0"},{"name":"legalEntityId","in":"query","schemaId":"schema_0"},{"name":"rootPath","in":"query","schemaId":"schema_0"},{"name":"search","in":"query","schemaId":"schema_0"},{"name":"exact","in":"query","schemaId":"schema_2"},{"name":"pageNumber","in":"query","schemaId":"schema_1"},{"name":"pageSize","in":"query","schemaId":"schema_1"},{"name":"legalEntityMode","in":"query","schemaId":"schema_2"},{"name":"shouldCount","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","500"],"pointer":"/v1/organizations/{id}/business-relations/consumer-path-items","href":"business-relations/get_v1_organizations_id_business-relations_consumer-path-items","openApiOperationId":"GET_v1_organizations_id_business-relations_consumer-path-items","summary":"Returns the list of consumer path items based on related consumer associated with the given organization."},"isWebhook":false,"hideReplay":false,"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/PaginationDtoOfConsumerPathItemDto"}},"schemaId":"components/schemas/PaginationDtoOfConsumerPathItemDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1business-relations~1consumer-path-items/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaginationDtoOfConsumerPathItemDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationDtoOfConsumerPathItemDto"}}},{"code":"401"},{"code":"403"},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-relations/get_v1_organizations_id_business-relations_consumer-path-items"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/business-relations/consumer-path-items"},{"label":"Returns the first 50 consumers based on the search parameter related to the consumer associated with the given organization.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/business-relations/get_v1_organizations_id_business-relations_contracts-consumers","routeSlug":"/products/oneplatform/apis/oas/organizations/business-relations/get_v1_organizations_id_business-relations_contracts-consumers","metadata":{"seo":{"title":"Returns the first 50 consumers based on the search parameter related to the consumer associated with the given organization.","description":"Security policies: OrganizationOrGlobalContractView"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_v1_organizations_id_business-relations_contracts-consumers","name":"Returns the first 50 consumers based on the search parameter related to the consumer associated with the given organization.","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1business-relations~1contracts-consumers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns the first 50 consumers based on the search parameter related to the consumer associated with the given organization.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationOrGlobalContractView"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"The organization identifier which associated consumer should be used as the filter.","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1business-relations~1contracts-consumers/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"consumerParty","in":"query","schemaId":"schema_3","description":"The consumer party of the contract to return. (Default: BillingConsumer)"},{"name":"targetParty","in":"query","schemaId":"schema_3","description":"The party of the given organization. (Default: LegalEntity)"},{"name":"search","in":"query","schemaId":"schema_0","description":"The consumer name to filter. (Default: Not applied)"},{"name":"shouldCount","in":"query","schemaId":"schema_2"}],"pointer":"/paths/~1v1~1organizations~1{id}~1business-relations~1contracts-consumers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/{id}/business-relations/contracts-consumers","servers":[{"url":"/"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"consumerParty","in":"query","schemaId":"schema_3"},{"name":"targetParty","in":"query","schemaId":"schema_3"},{"name":"search","in":"query","schemaId":"schema_0"},{"name":"shouldCount","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","500"],"pointer":"/v1/organizations/{id}/business-relations/contracts-consumers","href":"business-relations/get_v1_organizations_id_business-relations_contracts-consumers","openApiOperationId":"GET_v1_organizations_id_business-relations_contracts-consumers","summary":"Returns the first 50 consumers based on the search parameter related to the consumer associated with the given organization."},"isWebhook":false,"hideReplay":false,"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/PaginationDtoOfConsumerDto"}},"schemaId":"components/schemas/PaginationDtoOfConsumerDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1business-relations~1contracts-consumers/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaginationDtoOfConsumerDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationDtoOfConsumerDto"}}},{"code":"401"},{"code":"403"},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-relations/get_v1_organizations_id_business-relations_contracts-consumers"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/business-relations/contracts-consumers"}],"content":{"contentType":"group","meta":{"name":"Business Relations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Business Relations","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/organizations/{id}/business-relations","summary":"Returns the list of the business relations.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/business-relations/get_v1_organizations_id_business-relations","deprecated":false},{"title":"/v1/organizations/{id}/business-relations/consumer-paths/{consumerId}","summary":"Returns the list of consumer root paths based on related consumer associated with the given organization.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/business-relations/get_v1_organizations_id_business-relations_consumer-paths_consumerid","deprecated":false},{"title":"/v1/organizations/{id}/business-relations/consumer-path-items","summary":"Returns the list of consumer path items based on related consumer associated with the given organization.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/business-relations/get_v1_organizations_id_business-relations_consumer-path-items","deprecated":false},{"title":"/v1/organizations/{id}/business-relations/contracts-consumers","summary":"Returns the first 50 consumers based on the search parameter related to the consumer associated with the given organization.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/business-relations/get_v1_organizations_id_business-relations_contracts-consumers","deprecated":false}]}]}]}]}},{"type":"group","label":"Consumers","link":"/products/oneplatform/apis/oas/organizations/consumers","routeSlug":"/products/oneplatform/apis/oas/organizations/consumers","items":[{"label":"Returns the list of directly connected consumers to consumer associated to provided organizationId.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/consumers/get_v2_organizations_id_consumers","routeSlug":"/products/oneplatform/apis/oas/organizations/consumers/get_v2_organizations_id_consumers","metadata":{"seo":{"title":"Returns the list of directly connected consumers to consumer associated to provided organizationId.","description":"⚠️ UNSTABLE ENDPOINT — This v2 endpoint is under active development.The contract (fields, request/response structure, behavior) may change without notice.All integrations consuming this endpoint must be updated accordingly.This notice will be removed once the endpoint is stable.Security policies: OrganizationsConsumersView"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_v2_organizations_id_consumers","name":"Returns the list of directly connected consumers to consumer associated to provided organizationId.","isWebhook":false,"pointer":"/paths/~1v2~1organizations~1{id}~1consumers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns the list of directly connected consumers to consumer associated to provided organizationId.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ UNSTABLE ENDPOINT — This v2 endpoint is under active development."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contract (fields, request/response structure, behavior) may change without notice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All integrations consuming this endpoint must be updated accordingly."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This notice will be removed once the endpoint is stable."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationsConsumersView"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"The organization identifier","required":true}],"pointer":"/paths/~1v2~1organizations~1{id}~1consumers/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"allLevels","in":"query","schemaId":"schema_2","description":"Boolean which defines whether to include all levels of consumers. (Default: false)"},{"name":"totalElements","in":"query","schemaId":"schema_1","description":"The total number of elements in the pagination. (Default: Not applied)"},{"name":"legalEntityMode","in":"query","schemaId":"schema_2","description":"Boolean which defines if trying to use the legal entity associated with the organization consumer. (Default: false)"},{"name":"name","in":"query","schemaId":"schema_0","description":"The name of the consumer to filter. Ignored if search filter defined. (Default: Not applied)"},{"name":"type","in":"query","schemaId":"schema_0","description":"The types of consumer to filter. (Default: Not applied)"},{"name":"metadata","in":"query","schemaId":"schema_0","description":"Metadata values of the consumer to filter. Is JSON object format. (Default: Not applied)"},{"name":"taxCode1","in":"query","schemaId":"schema_0","description":"The tax code 1 of the consumer to filter. Ignored if search filter defined. (Default: Not applied)"},{"name":"taxCode2","in":"query","schemaId":"schema_0","description":"The tax code 2 of the consumer to filter. Ignored if search filter defined. (Default: Not applied)"},{"name":"taxCode3","in":"query","schemaId":"schema_0","description":"The tax code 3 of the consumer to filter. Ignored if search filter defined. (Default: Not applied)"},{"name":"country","in":"query","schemaId":"schema_0","description":"The country of the consumer to filter. Ignored if search filter defined. (Default: Not applied)"},{"name":"customerType","in":"query","schemaId":"schema_0","description":"The types of customer to filter. (Default: Not applied)"},{"name":"search","in":"query","schemaId":"schema_0","description":"The search term for filtering items. (Default: Not applied)"},{"name":"exact","in":"query","schemaId":"schema_2","description":"Boolean which defines whether the params name and search must match exactly. (Default: false)"},{"name":"pageNumber","in":"query","schemaId":"schema_1","description":"The page number of pagination. (Default: 1)"},{"name":"pageSize","in":"query","schemaId":"schema_1","description":"The page size of pagination. (Default: 50, Max: 500)"},{"name":"shouldCount","in":"query","schemaId":"schema_2","description":"Indicates whether the query should also return the total count of items (Default: true)"}],"pointer":"/paths/~1v2~1organizations~1{id}~1consumers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/organizations/{id}/consumers","servers":[{"url":"/"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"allLevels","in":"query","schemaId":"schema_2"},{"name":"totalElements","in":"query","schemaId":"schema_1"},{"name":"legalEntityMode","in":"query","schemaId":"schema_2"},{"name":"name","in":"query","schemaId":"schema_0"},{"name":"type","in":"query","schemaId":"schema_0"},{"name":"metadata","in":"query","schemaId":"schema_0"},{"name":"taxCode1","in":"query","schemaId":"schema_0"},{"name":"taxCode2","in":"query","schemaId":"schema_0"},{"name":"taxCode3","in":"query","schemaId":"schema_0"},{"name":"country","in":"query","schemaId":"schema_0"},{"name":"customerType","in":"query","schemaId":"schema_0"},{"name":"search","in":"query","schemaId":"schema_0"},{"name":"exact","in":"query","schemaId":"schema_2"},{"name":"pageNumber","in":"query","schemaId":"schema_1"},{"name":"pageSize","in":"query","schemaId":"schema_1"},{"name":"shouldCount","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/v2/organizations/{id}/consumers","href":"consumers/get_v2_organizations_id_consumers","openApiOperationId":"GET_v2_organizations_id_consumers","summary":"Returns the list of directly connected consumers to consumer associated to provided organizationId."},"isWebhook":false,"hideReplay":false,"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/PaginationDtoOfConsumerDto"}},"schemaId":"components/schemas/PaginationDtoOfConsumerDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v2~1organizations~1{id}~1consumers/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaginationDtoOfConsumerDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationDtoOfConsumerDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consumers/get_v2_organizations_id_consumers"}],"panels":[]}]},"httpPath":"/v2/organizations/{id}/consumers"},{"label":"Create organization consumer (V2 — TaxCode1/TaxCode2/TaxCode3) and returns the identifier of created consumer.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/consumers/post_v2_organizations_id_consumers","routeSlug":"/products/oneplatform/apis/oas/organizations/consumers/post_v2_organizations_id_consumers","metadata":{"seo":{"title":"Create organization consumer (V2 — TaxCode1/TaxCode2/TaxCode3) and returns the identifier of created consumer.","description":"⚠️ UNSTABLE ENDPOINT — This v2 endpoint is under active development.The contract (fields, request/response structure, behavior) may change without notice.All integrations consuming this endpoint must be updated accordingly.This notice will be removed once the endpoint is stable."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_v2_organizations_id_consumers","name":"Create organization consumer (V2 — TaxCode1/TaxCode2/TaxCode3) and returns the identifier of created consumer.","isWebhook":false,"pointer":"/paths/~1v2~1organizations~1{id}~1consumers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create organization consumer (V2 — TaxCode1/TaxCode2/TaxCode3) and returns the identifier of created consumer.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ UNSTABLE ENDPOINT — This v2 endpoint is under active development."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contract (fields, request/response structure, behavior) may change without notice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All integrations consuming this endpoint must be updated accordingly."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This notice will be removed once the endpoint is stable."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ NOTE ON TAX CODE VALIDATION — This endpoint applies strict validation for supported countries"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(currently IT and FR). If support for additional countries with strict tax code validation is introduced"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the future, this endpoint will automatically enforce those rules — callers must ensure tax codes are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"valid for the consumer's country."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationsConsumersCreate"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"The organization identifier","required":true}],"pointer":"/paths/~1v2~1organizations~1{id}~1consumers/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_2"}],"pointer":"/paths/~1v2~1organizations~1{id}~1consumers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConsumerBaseWithoutCrmDto"}},"schemaId":"components/schemas/ConsumerBaseWithoutCrmDto","pointer":"/paths/~1v2~1organizations~1{id}~1consumers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/organizations/{id}/consumers","servers":[{"url":"/"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"dryRun","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConsumerBaseWithoutCrmDto"}},"responseCodes":["200","400","401","403","409","500"],"pointer":"/v2/organizations/{id}/consumers","href":"consumers/post_v2_organizations_id_consumers","openApiOperationId":"POST_v2_organizations_id_consumers","summary":"Create organization consumer (V2 — TaxCode1/TaxCode2/TaxCode3) and returns the identifier of created consumer."},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/ConsumerBaseWithoutCrmDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConsumerBaseWithoutCrmDto"}},"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/IdDto"}},"schemaId":"components/schemas/IdDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v2~1organizations~1{id}~1consumers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/IdDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"409","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consumers/post_v2_organizations_id_consumers"}],"panels":[]}]},"httpPath":"/v2/organizations/{id}/consumers"},{"label":"Returns the detail of a consumer based on related consumer associated to given organization.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/consumers/get_v2_organizations_id_consumers_consumerid","routeSlug":"/products/oneplatform/apis/oas/organizations/consumers/get_v2_organizations_id_consumers_consumerid","metadata":{"seo":{"title":"Returns the detail of a consumer based on related consumer associated to given organization.","description":"⚠️ UNSTABLE ENDPOINT — This v2 endpoint is under active development.The contract (fields, request/response structure, behavior) may change without notice.All integrations consuming this endpoint must be updated accordingly.This notice will be removed once the endpoint is stable.Security policies: OrganizationsConsumerDetailsView"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_v2_organizations_id_consumers_consumerId","name":"Returns the detail of a consumer based on related consumer associated to given organization.","isWebhook":false,"pointer":"/paths/~1v2~1organizations~1{id}~1consumers~1{consumerId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns the detail of a consumer based on related consumer associated to given organization.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ UNSTABLE ENDPOINT — This v2 endpoint is under active development."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contract (fields, request/response structure, behavior) may change without notice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All integrations consuming this endpoint must be updated accordingly."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This notice will be removed once the endpoint is stable."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationsConsumerDetailsView"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"The identifier of the organization which associated consumer should be used as parent consumer filter for given\r\nconsumer.","required":true},{"name":"consumerId","in":"path","schemaId":"schema_0","description":"The identifier of the consumer to retrieve.","required":true}],"pointer":"/paths/~1v2~1organizations~1{id}~1consumers~1{consumerId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"includeHasContracts","in":"query","schemaId":"schema_2"}],"pointer":"/paths/~1v2~1organizations~1{id}~1consumers~1{consumerId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/organizations/{id}/consumers/{consumerId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"},{"name":"consumerId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"includeHasContracts","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/v2/organizations/{id}/consumers/{consumerId}","href":"consumers/get_v2_organizations_id_consumers_consumerid","openApiOperationId":"GET_v2_organizations_id_consumers_consumerId","summary":"Returns the detail of a consumer based on related consumer associated to given organization."},"isWebhook":false,"hideReplay":false,"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/ConsumerWithExtraInfoDto"}},"schemaId":"components/schemas/ConsumerWithExtraInfoDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v2~1organizations~1{id}~1consumers~1{consumerId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConsumerWithExtraInfoDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsumerWithExtraInfoDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consumers/get_v2_organizations_id_consumers_consumerid"}],"panels":[]}]},"httpPath":"/v2/organizations/{id}/consumers/{consumerId}"},{"label":"Update organization consumer general infos and returns the identifier of updated consumer.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/consumers/put_v2_organizations_id_consumers_consumerid_general-infos","routeSlug":"/products/oneplatform/apis/oas/organizations/consumers/put_v2_organizations_id_consumers_consumerid_general-infos","metadata":{"seo":{"title":"Update organization consumer general infos and returns the identifier of updated consumer.","description":"⚠️ UNSTABLE ENDPOINT — This v2 endpoint is under active development.The contract (fields, request/response structure, behavior) may change without notice.All integrations consuming this endpoint must be updated accordingly.This notice will be removed once the endpoint is stable.Security policies: OrganizationsConsumersGeneralInfosEdit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_v2_organizations_id_consumers_consumerId_general-infos","name":"Update organization consumer general infos and returns the identifier of updated consumer.","isWebhook":false,"pointer":"/paths/~1v2~1organizations~1{id}~1consumers~1{consumerId}~1general-infos/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update organization consumer general infos and returns the identifier of updated consumer.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ UNSTABLE ENDPOINT — This v2 endpoint is under active development."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contract (fields, request/response structure, behavior) may change without notice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All integrations consuming this endpoint must be updated accordingly."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This notice will be removed once the endpoint is stable."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationsConsumersGeneralInfosEdit"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"The organization identifier","required":true},{"name":"consumerId","in":"path","schemaId":"schema_0","description":"The identifier of the consumer to retrieve.","required":true}],"pointer":"/paths/~1v2~1organizations~1{id}~1consumers~1{consumerId}~1general-infos/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"force","in":"query","schemaId":"schema_2","description":"Flag to force update if consumer have contracts."}],"pointer":"/paths/~1v2~1organizations~1{id}~1consumers~1{consumerId}~1general-infos/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConsumerGeneralInfosDto"}},"schemaId":"components/schemas/ConsumerGeneralInfosDto","pointer":"/paths/~1v2~1organizations~1{id}~1consumers~1{consumerId}~1general-infos/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/organizations/{id}/consumers/{consumerId}/general-infos","servers":[{"url":"/"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"},{"name":"consumerId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"force","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConsumerGeneralInfosDto"}},"responseCodes":["200","400","401","403","404","500","503"],"pointer":"/v2/organizations/{id}/consumers/{consumerId}/general-infos","href":"consumers/put_v2_organizations_id_consumers_consumerid_general-infos","openApiOperationId":"PUT_v2_organizations_id_consumers_consumerId_general-infos","summary":"Update organization consumer general infos and returns the identifier of updated consumer."},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/ConsumerGeneralInfosDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConsumerGeneralInfosDto"}},"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/IdDto"}},"schemaId":"components/schemas/IdDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v2~1organizations~1{id}~1consumers~1{consumerId}~1general-infos/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/IdDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"503","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consumers/put_v2_organizations_id_consumers_consumerid_general-infos"}],"panels":[]}]},"httpPath":"/v2/organizations/{id}/consumers/{consumerId}/general-infos"},{"label":"Update organization customer birth info and returns the identifier of updated customer..","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/consumers/put_v1_organizations_id_consumers_consumerid_birth-infos","routeSlug":"/products/oneplatform/apis/oas/organizations/consumers/put_v1_organizations_id_consumers_consumerid_birth-infos","metadata":{"seo":{"title":"Update organization customer birth info and returns the identifier of updated customer..","description":"Security policies: OrganizationsConsumersBirthInfoEdit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_v1_organizations_id_consumers_consumerId_birth-infos","name":"Update organization customer birth info and returns the identifier of updated customer..","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1birth-infos/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update organization customer birth info and returns the identifier of updated customer..","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationsConsumersBirthInfoEdit"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"The organization identifier","required":true},{"name":"consumerId","in":"path","schemaId":"schema_0","description":"The identifier of the consumer to retrieve.","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1birth-infos/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConsumerBirthInfoDto"}},"schemaId":"components/schemas/ConsumerBirthInfoDto","pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1birth-infos/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/organizations/{id}/consumers/{consumerId}/birth-infos","servers":[{"url":"/"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"},{"name":"consumerId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConsumerBirthInfoDto"}},"responseCodes":["200","400","401","403","404","405","500","503"],"pointer":"/v1/organizations/{id}/consumers/{consumerId}/birth-infos","href":"consumers/put_v1_organizations_id_consumers_consumerid_birth-infos","openApiOperationId":"PUT_v1_organizations_id_consumers_consumerId_birth-infos","summary":"Update organization customer birth info and returns the identifier of updated customer.."},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/ConsumerBirthInfoDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConsumerBirthInfoDto"}},"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/IdDto"}},"schemaId":"components/schemas/IdDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1birth-infos/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/IdDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"405","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"503","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consumers/put_v1_organizations_id_consumers_consumerid_birth-infos"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/consumers/{consumerId}/birth-infos"},{"label":"Update organization consumer residence info (V2 — PersonalCode) and returns the identifier of updated consumer.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/consumers/put_v2_organizations_id_consumers_consumerid_residence-infos","routeSlug":"/products/oneplatform/apis/oas/organizations/consumers/put_v2_organizations_id_consumers_consumerid_residence-infos","metadata":{"seo":{"title":"Update organization consumer residence info (V2 — PersonalCode) and returns the identifier of updated consumer.","description":"⚠️ UNSTABLE ENDPOINT — This v2 endpoint is under active development.The contract (fields, request/response structure, behavior) may change without notice.All integrations consuming this endpoint must be updated accordingly.This notice will be removed once the endpoint is stable."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_v2_organizations_id_consumers_consumerId_residence-infos","name":"Update organization consumer residence info (V2 — PersonalCode) and returns the identifier of updated consumer.","isWebhook":false,"pointer":"/paths/~1v2~1organizations~1{id}~1consumers~1{consumerId}~1residence-infos/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update organization consumer residence info (V2 — PersonalCode) and returns the identifier of updated consumer.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ UNSTABLE ENDPOINT — This v2 endpoint is under active development."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contract (fields, request/response structure, behavior) may change without notice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All integrations consuming this endpoint must be updated accordingly."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This notice will be removed once the endpoint is stable."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ NOTE ON TAX CODE VALIDATION — This endpoint applies strict validation for supported countries"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(currently IT and FR). If support for additional countries with strict tax code validation is introduced"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the future, this endpoint will automatically enforce those rules — callers must ensure tax codes are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"valid for the consumer's country. Additionally, if the consumer's tax codes are already strictly"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"validated ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IsValidatedTaxCodes = true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), validation cannot regress — submitting codes that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"would fail strict validation will return a 400 error."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationsConsumersResidenceInfoEdit, OrganizationsConsumersTaxDetailsEdit"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"The organization identifier","required":true},{"name":"consumerId","in":"path","schemaId":"schema_0","description":"The identifier of the consumer to retrieve.","required":true}],"pointer":"/paths/~1v2~1organizations~1{id}~1consumers~1{consumerId}~1residence-infos/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConsumerResidenceInfoDto"}},"schemaId":"components/schemas/ConsumerResidenceInfoDto","pointer":"/paths/~1v2~1organizations~1{id}~1consumers~1{consumerId}~1residence-infos/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/organizations/{id}/consumers/{consumerId}/residence-infos","servers":[{"url":"/"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"},{"name":"consumerId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConsumerResidenceInfoDto"}},"responseCodes":["200","400","401","403","404","405","500","503"],"pointer":"/v2/organizations/{id}/consumers/{consumerId}/residence-infos","href":"consumers/put_v2_organizations_id_consumers_consumerid_residence-infos","openApiOperationId":"PUT_v2_organizations_id_consumers_consumerId_residence-infos","summary":"Update organization consumer residence info (V2 — PersonalCode) and returns the identifier of updated consumer."},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/ConsumerResidenceInfoDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConsumerResidenceInfoDto"}},"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/IdDto"}},"schemaId":"components/schemas/IdDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v2~1organizations~1{id}~1consumers~1{consumerId}~1residence-infos/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/IdDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"405","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"503","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consumers/put_v2_organizations_id_consumers_consumerid_residence-infos"}],"panels":[]}]},"httpPath":"/v2/organizations/{id}/consumers/{consumerId}/residence-infos"},{"label":"Update consumer billing infos and returns the identifier of updated consumer.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/consumers/put_v1_organizations_id_consumers_consumerid_billing-details","routeSlug":"/products/oneplatform/apis/oas/organizations/consumers/put_v1_organizations_id_consumers_consumerid_billing-details","metadata":{"seo":{"title":"Update consumer billing infos and returns the identifier of updated consumer.","description":"Security policies: OrganizationsConsumersBillingDetailsEdit, OrganizationsConsumersContactInfosEdit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_v1_organizations_id_consumers_consumerId_billing-details","name":"Update consumer billing infos and returns the identifier of updated consumer.","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1billing-details/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update consumer billing infos and returns the identifier of updated consumer.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationsConsumersBillingDetailsEdit, OrganizationsConsumersContactInfosEdit"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"The organization identifier","required":true},{"name":"consumerId","in":"path","schemaId":"schema_0","description":"The identifier of the consumer to retrieve.","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1billing-details/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"force","in":"query","schemaId":"schema_2","description":"Flag to force update if consumer have contracts."}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1billing-details/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConsumerBillingInfosDto"}},"schemaId":"components/schemas/ConsumerBillingInfosDto","pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1billing-details/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/organizations/{id}/consumers/{consumerId}/billing-details","servers":[{"url":"/"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"},{"name":"consumerId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"force","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConsumerBillingInfosDto"}},"responseCodes":["200","400","401","403","500"],"pointer":"/v1/organizations/{id}/consumers/{consumerId}/billing-details","href":"consumers/put_v1_organizations_id_consumers_consumerid_billing-details","openApiOperationId":"PUT_v1_organizations_id_consumers_consumerId_billing-details","summary":"Update consumer billing infos and returns the identifier of updated consumer."},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/ConsumerBillingInfosDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConsumerBillingInfosDto"}},"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/IdDto"}},"schemaId":"components/schemas/IdDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1billing-details/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/IdDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consumers/put_v1_organizations_id_consumers_consumerid_billing-details"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/consumers/{consumerId}/billing-details"},{"label":"Update consumer contact infos and returns the identifier of updated consumer.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/consumers/put_v1_organizations_id_consumers_consumerid_contact-infos","routeSlug":"/products/oneplatform/apis/oas/organizations/consumers/put_v1_organizations_id_consumers_consumerid_contact-infos","metadata":{"seo":{"title":"Update consumer contact infos and returns the identifier of updated consumer.","description":"Security policies: OrganizationsConsumersContactInfosEdit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_v1_organizations_id_consumers_consumerId_contact-infos","name":"Update consumer contact infos and returns the identifier of updated consumer.","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1contact-infos/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update consumer contact infos and returns the identifier of updated consumer.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationsConsumersContactInfosEdit"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"The organization identifier","required":true},{"name":"consumerId","in":"path","schemaId":"schema_0","description":"The identifier of the consumer to retrieve.","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1contact-infos/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConsumerContactInfosDto"}},"schemaId":"components/schemas/ConsumerContactInfosDto","pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1contact-infos/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/organizations/{id}/consumers/{consumerId}/contact-infos","servers":[{"url":"/"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"},{"name":"consumerId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConsumerContactInfosDto"}},"responseCodes":["200","400","401","403","500"],"pointer":"/v1/organizations/{id}/consumers/{consumerId}/contact-infos","href":"consumers/put_v1_organizations_id_consumers_consumerid_contact-infos","openApiOperationId":"PUT_v1_organizations_id_consumers_consumerId_contact-infos","summary":"Update consumer contact infos and returns the identifier of updated consumer."},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/ConsumerContactInfosDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConsumerContactInfosDto"}},"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/IdDto"}},"schemaId":"components/schemas/IdDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1contact-infos/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/IdDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consumers/put_v1_organizations_id_consumers_consumerid_contact-infos"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/consumers/{consumerId}/contact-infos"},{"label":"Update organization consumer tax infos (V2 — TaxCode1/TaxCode2/TaxCode3) and returns the identifier of updated consumer.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/consumers/put_v2_organizations_id_consumers_consumerid_tax-details","routeSlug":"/products/oneplatform/apis/oas/organizations/consumers/put_v2_organizations_id_consumers_consumerid_tax-details","metadata":{"seo":{"title":"Update organization consumer tax infos (V2 — TaxCode1/TaxCode2/TaxCode3) and returns the identifier of updated consumer.","description":"⚠️ UNSTABLE ENDPOINT — This v2 endpoint is under active development.The contract (fields, request/response structure, behavior) may change without notice.All integrations consuming this endpoint must be updated accordingly.This notice will be removed once the endpoint is stable."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_v2_organizations_id_consumers_consumerId_tax-details","name":"Update organization consumer tax infos (V2 — TaxCode1/TaxCode2/TaxCode3) and returns the identifier of updated consumer.","isWebhook":false,"pointer":"/paths/~1v2~1organizations~1{id}~1consumers~1{consumerId}~1tax-details/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update organization consumer tax infos (V2 — TaxCode1/TaxCode2/TaxCode3) and returns the identifier of updated consumer.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ UNSTABLE ENDPOINT — This v2 endpoint is under active development."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contract (fields, request/response structure, behavior) may change without notice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All integrations consuming this endpoint must be updated accordingly."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This notice will be removed once the endpoint is stable."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ NOTE ON TAX CODE VALIDATION — This endpoint applies strict validation for supported countries"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(currently IT and FR). If support for additional countries with strict tax code validation is introduced"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the future, this endpoint will automatically enforce those rules — callers must ensure tax codes are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"valid for the consumer's country. Additionally, if the consumer's tax codes are already strictly"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"validated ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IsValidatedTaxCodes = true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), validation cannot regress — submitting codes that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"would fail strict validation will return a 400 error."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationsConsumersTaxDetailsEdit"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"The organization identifier","required":true},{"name":"consumerId","in":"path","schemaId":"schema_0","description":"The identifier of the consumer to retrieve.","required":true}],"pointer":"/paths/~1v2~1organizations~1{id}~1consumers~1{consumerId}~1tax-details/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"force","in":"query","schemaId":"schema_2","description":"Flag to force update if consumer have contracts."}],"pointer":"/paths/~1v2~1organizations~1{id}~1consumers~1{consumerId}~1tax-details/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConsumerTaxInfosDto"}},"schemaId":"components/schemas/ConsumerTaxInfosDto","pointer":"/paths/~1v2~1organizations~1{id}~1consumers~1{consumerId}~1tax-details/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/organizations/{id}/consumers/{consumerId}/tax-details","servers":[{"url":"/"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"},{"name":"consumerId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"force","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConsumerTaxInfosDto"}},"responseCodes":["200","400","401","403","500","503"],"pointer":"/v2/organizations/{id}/consumers/{consumerId}/tax-details","href":"consumers/put_v2_organizations_id_consumers_consumerid_tax-details","openApiOperationId":"PUT_v2_organizations_id_consumers_consumerId_tax-details","summary":"Update organization consumer tax infos (V2 — TaxCode1/TaxCode2/TaxCode3) and returns the identifier of updated consumer."},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/ConsumerTaxInfosDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConsumerTaxInfosDto"}},"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/IdDto"}},"schemaId":"components/schemas/IdDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v2~1organizations~1{id}~1consumers~1{consumerId}~1tax-details/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/IdDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"503","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consumers/put_v2_organizations_id_consumers_consumerid_tax-details"}],"panels":[]}]},"httpPath":"/v2/organizations/{id}/consumers/{consumerId}/tax-details"},{"label":"Update consumer additional infos and returns the identifier of updated consumer.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/consumers/put_v1_organizations_id_consumers_consumerid_additional-infos","routeSlug":"/products/oneplatform/apis/oas/organizations/consumers/put_v1_organizations_id_consumers_consumerid_additional-infos","metadata":{"seo":{"title":"Update consumer additional infos and returns the identifier of updated consumer.","description":"Security policies: OrganizationsConsumersAdditionalInfosEdit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_v1_organizations_id_consumers_consumerId_additional-infos","name":"Update consumer additional infos and returns the identifier of updated consumer.","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1additional-infos/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update consumer additional infos and returns the identifier of updated consumer.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationsConsumersAdditionalInfosEdit"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"The organization identifier","required":true},{"name":"consumerId","in":"path","schemaId":"schema_0","description":"The identifier of the consumer to retrieve.","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1additional-infos/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConsumerAdditionalInfosDto"}},"schemaId":"components/schemas/ConsumerAdditionalInfosDto","pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1additional-infos/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/organizations/{id}/consumers/{consumerId}/additional-infos","servers":[{"url":"/"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"},{"name":"consumerId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConsumerAdditionalInfosDto"}},"responseCodes":["200","400","401","403","500","503"],"pointer":"/v1/organizations/{id}/consumers/{consumerId}/additional-infos","href":"consumers/put_v1_organizations_id_consumers_consumerid_additional-infos","openApiOperationId":"PUT_v1_organizations_id_consumers_consumerId_additional-infos","summary":"Update consumer additional infos and returns the identifier of updated consumer."},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/ConsumerAdditionalInfosDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConsumerAdditionalInfosDto"}},"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/IdDto"}},"schemaId":"components/schemas/IdDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1additional-infos/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/IdDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"503","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consumers/put_v1_organizations_id_consumers_consumerid_additional-infos"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/consumers/{consumerId}/additional-infos"},{"label":"Returns the list of associated users.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/consumers/get_v1_organizations_id_consumers_consumerid_users","routeSlug":"/products/oneplatform/apis/oas/organizations/consumers/get_v1_organizations_id_consumers_consumerid_users","metadata":{"seo":{"title":"Returns the list of associated users.","description":"Security policies: OrganizationsConsumerDetailsView"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_v1_organizations_id_consumers_consumerId_users","name":"Returns the list of associated users.","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns the list of associated users.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationsConsumerDetailsView"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true},{"name":"consumerId","in":"path","schemaId":"schema_0","description":"The identifier of the consumer to filter.","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/{id}/consumers/{consumerId}/users","servers":[{"url":"/"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"},{"name":"consumerId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/v1/organizations/{id}/consumers/{consumerId}/users","href":"consumers/get_v1_organizations_id_consumers_consumerid_users","openApiOperationId":"GET_v1_organizations_id_consumers_consumerId_users","summary":"Returns the list of associated users."},"isWebhook":false,"hideReplay":false,"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/ListDtoOfUserBaseDto"}},"schemaId":"components/schemas/ListDtoOfUserBaseDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1users/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListDtoOfUserBaseDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListDtoOfUserBaseDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consumers/get_v1_organizations_id_consumers_consumerid_users"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/consumers/{consumerId}/users"},{"label":"Returns the list of the contract consumers.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/consumers/get_v2_organizations_id_contracts_contractid_consumers","routeSlug":"/products/oneplatform/apis/oas/organizations/consumers/get_v2_organizations_id_contracts_contractid_consumers","metadata":{"seo":{"title":"Returns the list of the contract consumers.","description":"⚠️ UNSTABLE ENDPOINT — This v2 endpoint is under active development.The contract (fields, request/response structure, behavior) may change without notice.All integrations consuming this endpoint must be updated accordingly.This notice will be removed once the endpoint is stable.Security policies: OrganizationOrGlobalContractDetailsView"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_v2_organizations_id_contracts_contractId_consumers","name":"Returns the list of the contract consumers.","isWebhook":false,"pointer":"/paths/~1v2~1organizations~1{id}~1contracts~1{contractId}~1consumers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns the list of the contract consumers.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ UNSTABLE ENDPOINT — This v2 endpoint is under active development."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contract (fields, request/response structure, behavior) may change without notice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All integrations consuming this endpoint must be updated accordingly."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This notice will be removed once the endpoint is stable."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationOrGlobalContractDetailsView"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contractId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1v2~1organizations~1{id}~1contracts~1{contractId}~1consumers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/organizations/{id}/contracts/{contractId}/consumers","servers":[{"url":"/"}],"parameters":{"path":[{"name":"contractId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/v2/organizations/{id}/contracts/{contractId}/consumers","href":"consumers/get_v2_organizations_id_contracts_contractid_consumers","openApiOperationId":"GET_v2_organizations_id_contracts_contractId_consumers","summary":"Returns the list of the contract consumers."},"isWebhook":false,"hideReplay":false,"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/ListDtoOfConsumerDto"}},"schemaId":"components/schemas/ListDtoOfConsumerDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v2~1organizations~1{id}~1contracts~1{contractId}~1consumers/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListDtoOfConsumerDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListDtoOfConsumerDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consumers/get_v2_organizations_id_contracts_contractid_consumers"}],"panels":[]}]},"httpPath":"/v2/organizations/{id}/contracts/{contractId}/consumers"},{"label":"Returns the list of directly connected consumers to consumer associated to provided organizationId (V1).","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/consumers/get_v1_organizations_id_consumers","routeSlug":"/products/oneplatform/apis/oas/organizations/consumers/get_v1_organizations_id_consumers","metadata":{"seo":{"title":"Returns the list of directly connected consumers to consumer associated to provided organizationId (V1).","description":"⚠️ DEPRECATED ⚠️: This API is DEPRECATED and will be removed on 2027-06-01, use API GET '/v2/organizations/{id}/consumers' instead.Security policies: OrganizationsConsumersView"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_v1_organizations_id_consumers","name":"Returns the list of directly connected consumers to consumer associated to provided organizationId (V1).","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1consumers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns the list of directly connected consumers to consumer associated to provided organizationId (V1).","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ DEPRECATED ⚠️"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This API is DEPRECATED and will be removed on 2027-06-01, use API GET '/v2/organizations/{id}/consumers' instead."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationsConsumersView"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"isEmptyVat","in":"query","schemaId":"schema_2","description":"Filter consumers with empty vat number. (Default: Not applied)"},{"name":"vat","in":"query","schemaId":"schema_0","description":"The vat of the consumer to filter. Ignored if search filter defined or is empty vat is true. (Default: Not applied)"},{"name":"taxNumber","in":"query","schemaId":"schema_0","description":"The tax number of the consumer to filter. Ignored if search filter defined. (Default: Not applied)"},{"name":"paNumber","in":"query","schemaId":"schema_0","description":"The PA number of the consumer to filter. Ignored if search filter defined. (Default: Not applied)"},{"name":"country","in":"query","schemaId":"schema_0","description":"The country of the consumer to filter. Ignored if search filter defined. (Default: Not applied)"},{"name":"customerType","in":"query","schemaId":"schema_0","description":"The types of customer to filter. (Default: Not applied)"},{"name":"name","in":"query","schemaId":"schema_0","description":"The name of the consumer to filter. Ignored if search filter defined. (Default: Not applied)"},{"name":"type","in":"query","schemaId":"schema_0","description":"The types of consumer to filter. (Default: Not applied)"},{"name":"metadata","in":"query","schemaId":"schema_0","description":"Metadata values of the consumer to filter. Is JSON object format. (Default: Not applied)"},{"name":"allLevels","in":"query","schemaId":"schema_2","description":"Boolean which defines whether to include all levels of consumers. (Default: false)"},{"name":"totalElements","in":"query","schemaId":"schema_1","description":"The total number of elements in the pagination. (Default: Not applied)"},{"name":"legalEntityMode","in":"query","schemaId":"schema_2","description":"Boolean which defines if trying to use the legal entity associated with the organization consumer. (Default: false)"},{"name":"search","in":"query","schemaId":"schema_0","description":"The search term for filtering items. (Default: Not applied)"},{"name":"exact","in":"query","schemaId":"schema_2","description":"Boolean which defines whether the params name and search must match exactly. (Default: false)"},{"name":"pageNumber","in":"query","schemaId":"schema_1","description":"The page number of pagination. (Default: 1)"},{"name":"pageSize","in":"query","schemaId":"schema_1","description":"The page size of pagination. (Default: 50, Max: 500)"},{"name":"shouldCount","in":"query","schemaId":"schema_2","description":"Indicates whether the query should also return the total count of items (Default: true)"}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/{id}/consumers","servers":[{"url":"/"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"isEmptyVat","in":"query","schemaId":"schema_2"},{"name":"vat","in":"query","schemaId":"schema_0"},{"name":"taxNumber","in":"query","schemaId":"schema_0"},{"name":"paNumber","in":"query","schemaId":"schema_0"},{"name":"country","in":"query","schemaId":"schema_0"},{"name":"customerType","in":"query","schemaId":"schema_0"},{"name":"name","in":"query","schemaId":"schema_0"},{"name":"type","in":"query","schemaId":"schema_0"},{"name":"metadata","in":"query","schemaId":"schema_0"},{"name":"allLevels","in":"query","schemaId":"schema_2"},{"name":"totalElements","in":"query","schemaId":"schema_1"},{"name":"legalEntityMode","in":"query","schemaId":"schema_2"},{"name":"search","in":"query","schemaId":"schema_0"},{"name":"exact","in":"query","schemaId":"schema_2"},{"name":"pageNumber","in":"query","schemaId":"schema_1"},{"name":"pageSize","in":"query","schemaId":"schema_1"},{"name":"shouldCount","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/v1/organizations/{id}/consumers","href":"consumers/get_v1_organizations_id_consumers","openApiOperationId":"GET_v1_organizations_id_consumers","summary":"Returns the list of directly connected consumers to consumer associated to provided organizationId (V1)."},"isWebhook":false,"hideReplay":false,"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/PaginationDtoOfConsumerDtoV1"}},"schemaId":"components/schemas/PaginationDtoOfConsumerDtoV1"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaginationDtoOfConsumerDtoV1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationDtoOfConsumerDtoV1"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consumers/get_v1_organizations_id_consumers"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/consumers"},{"label":"Create organization consumer and returns the identifier of a consumer created.","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/consumers/post_v1_organizations_id_consumers","routeSlug":"/products/oneplatform/apis/oas/organizations/consumers/post_v1_organizations_id_consumers","metadata":{"seo":{"title":"Create organization consumer and returns the identifier of a consumer created.","description":"⚠️ DEPRECATED ⚠️: This API is DEPRECATED and will be removed on 2027-06-01, use API POST '/v2/organizations/{id}/consumers' instead.Security policies: OrganizationsConsumersCreate"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_v1_organizations_id_consumers","name":"Create organization consumer and returns the identifier of a consumer created.","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1consumers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create organization consumer and returns the identifier of a consumer created.","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ DEPRECATED ⚠️"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This API is DEPRECATED and will be removed on 2027-06-01, use API POST '/v2/organizations/{id}/consumers' instead."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationsConsumersCreate"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"The organization identifier","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_2","description":"Performs all creation logic without creating to DB the consumer."}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConsumerBaseWithoutCrmDtoV1"}},"schemaId":"components/schemas/ConsumerBaseWithoutCrmDtoV1","pointer":"/paths/~1v1~1organizations~1{id}~1consumers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/organizations/{id}/consumers","servers":[{"url":"/"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"dryRun","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConsumerBaseWithoutCrmDtoV1"}},"responseCodes":["200","400","401","403","409","500"],"pointer":"/v1/organizations/{id}/consumers","href":"consumers/post_v1_organizations_id_consumers","openApiOperationId":"POST_v1_organizations_id_consumers","summary":"Create organization consumer and returns the identifier of a consumer created."},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/ConsumerBaseWithoutCrmDtoV1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConsumerBaseWithoutCrmDtoV1"}},"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/IdDto"}},"schemaId":"components/schemas/IdDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/IdDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"409","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consumers/post_v1_organizations_id_consumers"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/consumers"},{"label":"Returns the detail of a consumer based on related consumer associated to given organization (V1).","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/consumers/get_v1_organizations_id_consumers_consumerid","routeSlug":"/products/oneplatform/apis/oas/organizations/consumers/get_v1_organizations_id_consumers_consumerid","metadata":{"seo":{"title":"Returns the detail of a consumer based on related consumer associated to given organization (V1).","description":"⚠️ DEPRECATED ⚠️: This API is DEPRECATED and will be removed on 2027-06-01, use API GET '/v2/organizations/{id}/consumers/{consumerId}' instead.Security policies: OrganizationsConsumerDetailsView"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_v1_organizations_id_consumers_consumerId","name":"Returns the detail of a consumer based on related consumer associated to given organization (V1).","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns the detail of a consumer based on related consumer associated to given organization (V1).","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ DEPRECATED ⚠️"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This API is DEPRECATED and will be removed on 2027-06-01, use API GET '/v2/organizations/{id}/consumers/{consumerId}' instead."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationsConsumerDetailsView"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true},{"name":"consumerId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/{id}/consumers/{consumerId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"},{"name":"consumerId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/v1/organizations/{id}/consumers/{consumerId}","href":"consumers/get_v1_organizations_id_consumers_consumerid","openApiOperationId":"GET_v1_organizations_id_consumers_consumerId","summary":"Returns the detail of a consumer based on related consumer associated to given organization (V1)."},"isWebhook":false,"hideReplay":false,"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/ConsumerDtoV1"}},"schemaId":"components/schemas/ConsumerDtoV1"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConsumerDtoV1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsumerDtoV1"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consumers/get_v1_organizations_id_consumers_consumerid"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/consumers/{consumerId}"},{"label":"Update organization consumer general infos and returns the identifier of updated consumer.","deprecated":true,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/consumers/put_v1_organizations_id_consumers_consumerid_general-infos","routeSlug":"/products/oneplatform/apis/oas/organizations/consumers/put_v1_organizations_id_consumers_consumerid_general-infos","metadata":{"seo":{"title":"Update organization consumer general infos and returns the identifier of updated consumer.","description":"⚠️ DEPRECATED ⚠️: This API is DEPRECATED and will be removed on 2027-07-01, use API PUT '/v2/organizations/{id}/consumers/{consumerId}/general-infos' instead.Security policies: OrganizationsConsumersGeneralInfosEdit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_v1_organizations_id_consumers_consumerId_general-infos","name":"Update organization consumer general infos and returns the identifier of updated consumer.","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1general-infos/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update organization consumer general infos and returns the identifier of updated consumer.","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ DEPRECATED ⚠️"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This API is DEPRECATED and will be removed on 2027-07-01, use API PUT '/v2/organizations/{id}/consumers/{consumerId}/general-infos' instead."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationsConsumersGeneralInfosEdit"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"The organization identifier","required":true},{"name":"consumerId","in":"path","schemaId":"schema_0","description":"The identifier of the consumer to retrieve.","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1general-infos/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"force","in":"query","schemaId":"schema_2","description":"Flag to force update if consumer have contracts."}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1general-infos/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConsumerGeneralInfosDtoV1"}},"schemaId":"components/schemas/ConsumerGeneralInfosDtoV1","pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1general-infos/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/organizations/{id}/consumers/{consumerId}/general-infos","servers":[{"url":"/"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"},{"name":"consumerId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"force","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConsumerGeneralInfosDtoV1"}},"responseCodes":["200","400","401","403","404","500","503"],"pointer":"/v1/organizations/{id}/consumers/{consumerId}/general-infos","href":"consumers/put_v1_organizations_id_consumers_consumerid_general-infos","openApiOperationId":"PUT_v1_organizations_id_consumers_consumerId_general-infos","summary":"Update organization consumer general infos and returns the identifier of updated consumer."},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/ConsumerGeneralInfosDtoV1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConsumerGeneralInfosDtoV1"}},"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/IdDto"}},"schemaId":"components/schemas/IdDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1general-infos/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/IdDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"503","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consumers/put_v1_organizations_id_consumers_consumerid_general-infos"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/consumers/{consumerId}/general-infos"},{"label":"Update organization customer residence info and returns the identifier of updated customer.","deprecated":true,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/consumers/put_v1_organizations_id_consumers_consumerid_residence-infos","routeSlug":"/products/oneplatform/apis/oas/organizations/consumers/put_v1_organizations_id_consumers_consumerid_residence-infos","metadata":{"seo":{"title":"Update organization customer residence info and returns the identifier of updated customer.","description":"⚠️ DEPRECATED ⚠️: This API is DEPRECATED and will be removed on 2027-06-01, use API PUT '/v2/organizations/{id}/consumers/{consumerId}/residence-infos' instead.Security policies: OrganizationsConsumersResidenceInfoEdit, OrganizationsConsumersTaxDetailsEdit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_v1_organizations_id_consumers_consumerId_residence-infos","name":"Update organization customer residence info and returns the identifier of updated customer.","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1residence-infos/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update organization customer residence info and returns the identifier of updated customer.","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ DEPRECATED ⚠️"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This API is DEPRECATED and will be removed on 2027-06-01, use API PUT '/v2/organizations/{id}/consumers/{consumerId}/residence-infos' instead."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationsConsumersResidenceInfoEdit, OrganizationsConsumersTaxDetailsEdit"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"The organization identifier","required":true},{"name":"consumerId","in":"path","schemaId":"schema_0","description":"The identifier of the consumer to retrieve.","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1residence-infos/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConsumerResidenceInfoAndTaxNumberDtoV1"}},"schemaId":"components/schemas/ConsumerResidenceInfoAndTaxNumberDtoV1","pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1residence-infos/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/organizations/{id}/consumers/{consumerId}/residence-infos","servers":[{"url":"/"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"},{"name":"consumerId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConsumerResidenceInfoAndTaxNumberDtoV1"}},"responseCodes":["200","400","401","403","404","405","500","503"],"pointer":"/v1/organizations/{id}/consumers/{consumerId}/residence-infos","href":"consumers/put_v1_organizations_id_consumers_consumerid_residence-infos","openApiOperationId":"PUT_v1_organizations_id_consumers_consumerId_residence-infos","summary":"Update organization customer residence info and returns the identifier of updated customer."},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/ConsumerResidenceInfoAndTaxNumberDtoV1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConsumerResidenceInfoAndTaxNumberDtoV1"}},"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/IdDto"}},"schemaId":"components/schemas/IdDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1residence-infos/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/IdDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"405","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"503","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consumers/put_v1_organizations_id_consumers_consumerid_residence-infos"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/consumers/{consumerId}/residence-infos"},{"label":"Update consumer tax infos and returns the identifier of updated consumer.","deprecated":true,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/consumers/put_v1_organizations_id_consumers_consumerid_tax-details","routeSlug":"/products/oneplatform/apis/oas/organizations/consumers/put_v1_organizations_id_consumers_consumerid_tax-details","metadata":{"seo":{"title":"Update consumer tax infos and returns the identifier of updated consumer.","description":"⚠️ DEPRECATED ⚠️: This API is DEPRECATED and will be removed on 2027-06-01, use API PUT '/v2/organizations/{id}/consumers/{consumerId}/tax-details' instead.Security policies: OrganizationsConsumersTaxDetailsEdit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_v1_organizations_id_consumers_consumerId_tax-details","name":"Update consumer tax infos and returns the identifier of updated consumer.","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1tax-details/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update consumer tax infos and returns the identifier of updated consumer.","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ DEPRECATED ⚠️"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This API is DEPRECATED and will be removed on 2027-06-01, use API PUT '/v2/organizations/{id}/consumers/{consumerId}/tax-details' instead."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationsConsumersTaxDetailsEdit"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"The organization identifier","required":true},{"name":"consumerId","in":"path","schemaId":"schema_0","description":"The identifier of the consumer to retrieve.","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1tax-details/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"force","in":"query","schemaId":"schema_2"}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1tax-details/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConsumerTaxInfosDtoV1"}},"schemaId":"components/schemas/ConsumerTaxInfosDtoV1","pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1tax-details/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/organizations/{id}/consumers/{consumerId}/tax-details","servers":[{"url":"/"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"},{"name":"consumerId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"force","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConsumerTaxInfosDtoV1"}},"responseCodes":["200","400","401","403","500","503"],"pointer":"/v1/organizations/{id}/consumers/{consumerId}/tax-details","href":"consumers/put_v1_organizations_id_consumers_consumerid_tax-details","openApiOperationId":"PUT_v1_organizations_id_consumers_consumerId_tax-details","summary":"Update consumer tax infos and returns the identifier of updated consumer."},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/ConsumerTaxInfosDtoV1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConsumerTaxInfosDtoV1"}},"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/IdDto"}},"schemaId":"components/schemas/IdDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1tax-details/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/IdDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"503","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consumers/put_v1_organizations_id_consumers_consumerid_tax-details"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/consumers/{consumerId}/tax-details"},{"label":"Returns the list of the contract consumers (V1).","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/consumers/get_v1_organizations_id_contracts_contractid_consumers","routeSlug":"/products/oneplatform/apis/oas/organizations/consumers/get_v1_organizations_id_contracts_contractid_consumers","metadata":{"seo":{"title":"Returns the list of the contract consumers (V1).","description":"⚠️ DEPRECATED ⚠️: This API is DEPRECATED and will be removed on 2027-06-01, use API GET '/v2/contracts/{contractId}/consumers' instead.⚠️ DEPRECATED ⚠️: This API is DEPRECATED and will be removed on 2027-06-01, use API GET '/v2/organizations/{id}/contracts/{contractId}/consumers' instead.Security policies: OrganizationOrGlobalContractDetailsView"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_v1_organizations_id_contracts_contractId_consumers","name":"Returns the list of the contract consumers (V1).","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}~1consumers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns the list of the contract consumers (V1).","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ DEPRECATED ⚠️"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This API is DEPRECATED and will be removed on 2027-06-01, use API GET '/v2/contracts/{contractId}/consumers' instead."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ DEPRECATED ⚠️"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This API is DEPRECATED and will be removed on 2027-06-01, use API GET '/v2/organizations/{id}/contracts/{contractId}/consumers' instead."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationOrGlobalContractDetailsView"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contractId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}~1consumers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/{id}/contracts/{contractId}/consumers","servers":[{"url":"/"}],"parameters":{"path":[{"name":"contractId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/v1/organizations/{id}/contracts/{contractId}/consumers","href":"consumers/get_v1_organizations_id_contracts_contractid_consumers","openApiOperationId":"GET_v1_organizations_id_contracts_contractId_consumers","summary":"Returns the list of the contract consumers (V1)."},"isWebhook":false,"hideReplay":false,"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"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}~1consumers/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_4","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_4"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consumers/get_v1_organizations_id_contracts_contractid_consumers"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/contracts/{contractId}/consumers"}],"content":{"contentType":"group","meta":{"name":"Consumers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Consumers","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/organizations/{id}/consumers","summary":"Returns the list of directly connected consumers to consumer associated to provided organizationId.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/consumers/get_v2_organizations_id_consumers","deprecated":false},{"title":"/v2/organizations/{id}/consumers","summary":"Create organization consumer (V2 — TaxCode1/TaxCode2/TaxCode3) and returns the identifier of created consumer.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/consumers/post_v2_organizations_id_consumers","deprecated":false},{"title":"/v2/organizations/{id}/consumers/{consumerId}","summary":"Returns the detail of a consumer based on related consumer associated to given organization.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/consumers/get_v2_organizations_id_consumers_consumerid","deprecated":false},{"title":"/v2/organizations/{id}/consumers/{consumerId}/general-infos","summary":"Update organization consumer general infos and returns the identifier of updated consumer.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/consumers/put_v2_organizations_id_consumers_consumerid_general-infos","deprecated":false},{"title":"/v1/organizations/{id}/consumers/{consumerId}/birth-infos","summary":"Update organization customer birth info and returns the identifier of updated customer..","prefix":{"name":"put","color":"put"},"badges":[],"link":"/consumers/put_v1_organizations_id_consumers_consumerid_birth-infos","deprecated":false},{"title":"/v2/organizations/{id}/consumers/{consumerId}/residence-infos","summary":"Update organization consumer residence info (V2 — PersonalCode) and returns the identifier of updated consumer.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/consumers/put_v2_organizations_id_consumers_consumerid_residence-infos","deprecated":false},{"title":"/v1/organizations/{id}/consumers/{consumerId}/billing-details","summary":"Update consumer billing infos and returns the identifier of updated consumer.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/consumers/put_v1_organizations_id_consumers_consumerid_billing-details","deprecated":false},{"title":"/v1/organizations/{id}/consumers/{consumerId}/contact-infos","summary":"Update consumer contact infos and returns the identifier of updated consumer.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/consumers/put_v1_organizations_id_consumers_consumerid_contact-infos","deprecated":false},{"title":"/v2/organizations/{id}/consumers/{consumerId}/tax-details","summary":"Update organization consumer tax infos (V2 — TaxCode1/TaxCode2/TaxCode3) and returns the identifier of updated consumer.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/consumers/put_v2_organizations_id_consumers_consumerid_tax-details","deprecated":false},{"title":"/v1/organizations/{id}/consumers/{consumerId}/additional-infos","summary":"Update consumer additional infos and returns the identifier of updated consumer.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/consumers/put_v1_organizations_id_consumers_consumerid_additional-infos","deprecated":false},{"title":"/v1/organizations/{id}/consumers/{consumerId}/users","summary":"Returns the list of associated users.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/consumers/get_v1_organizations_id_consumers_consumerid_users","deprecated":false},{"title":"/v2/organizations/{id}/contracts/{contractId}/consumers","summary":"Returns the list of the contract consumers.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/consumers/get_v2_organizations_id_contracts_contractid_consumers","deprecated":false},{"title":"/v1/organizations/{id}/consumers","summary":"Returns the list of directly connected consumers to consumer associated to provided organizationId (V1).","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/consumers/get_v1_organizations_id_consumers","deprecated":true},{"title":"/v1/organizations/{id}/consumers","summary":"Create organization consumer and returns the identifier of a consumer created.","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/consumers/post_v1_organizations_id_consumers","deprecated":true},{"title":"/v1/organizations/{id}/consumers/{consumerId}","summary":"Returns the detail of a consumer based on related consumer associated to given organization (V1).","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/consumers/get_v1_organizations_id_consumers_consumerid","deprecated":true},{"title":"/v1/organizations/{id}/consumers/{consumerId}/general-infos","summary":"Update organization consumer general infos and returns the identifier of updated consumer.","prefix":{"name":"put","color":"http-deprecated"},"badges":[],"link":"/consumers/put_v1_organizations_id_consumers_consumerid_general-infos","deprecated":true},{"title":"/v1/organizations/{id}/consumers/{consumerId}/residence-infos","summary":"Update organization customer residence info and returns the identifier of updated customer.","prefix":{"name":"put","color":"http-deprecated"},"badges":[],"link":"/consumers/put_v1_organizations_id_consumers_consumerid_residence-infos","deprecated":true},{"title":"/v1/organizations/{id}/consumers/{consumerId}/tax-details","summary":"Update consumer tax infos and returns the identifier of updated consumer.","prefix":{"name":"put","color":"http-deprecated"},"badges":[],"link":"/consumers/put_v1_organizations_id_consumers_consumerid_tax-details","deprecated":true},{"title":"/v1/organizations/{id}/contracts/{contractId}/consumers","summary":"Returns the list of the contract consumers (V1).","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/consumers/get_v1_organizations_id_contracts_contractid_consumers","deprecated":true}]}]}]}]}},{"type":"group","label":"Contract Items","link":"/products/oneplatform/apis/oas/organizations/contract-items","routeSlug":"/products/oneplatform/apis/oas/organizations/contract-items","items":[{"label":"GET_v1_organizations_id_contract-item-rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/contract-items/get_v1_organizations_id_contract-item-rules","routeSlug":"/products/oneplatform/apis/oas/organizations/contract-items/get_v1_organizations_id_contract-item-rules","metadata":{"seo":{"title":"GET_v1_organizations_id_contract-item-rules","description":"Security policies: OrganizationOrGlobalContractView"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_v1_organizations_id_contract-item-rules","name":"GET_v1_organizations_id_contract-item-rules","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1contract-item-rules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"GET_v1_organizations_id_contract-item-rules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationOrGlobalContractView"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"contractType","in":"query","schemaId":"schema_0","description":"The contract type to filter rules by."},{"name":"skuId","in":"query","schemaId":"schema_0","description":"The sku identifier to filter rules by."}],"pointer":"/paths/~1v1~1organizations~1{id}~1contract-item-rules/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/{id}/contract-item-rules","servers":[{"url":"/"}],"parameters":{"path":[],"query":[{"name":"contractType","in":"query","schemaId":"schema_0"},{"name":"skuId","in":"query","schemaId":"schema_0"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/v1/organizations/{id}/contract-item-rules","href":"contract-items/get_v1_organizations_id_contract-item-rules","openApiOperationId":"GET_v1_organizations_id_contract-item-rules"},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1v1~1organizations~1{id}~1contract-item-rules/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contract-items/get_v1_organizations_id_contract-item-rules"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/contract-item-rules"},{"label":"GET_v1_organizations_id_contracts_contractId_contract-item-rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/contract-items/get_v1_organizations_id_contracts_contractid_contract-item-rules","routeSlug":"/products/oneplatform/apis/oas/organizations/contract-items/get_v1_organizations_id_contracts_contractid_contract-item-rules","metadata":{"seo":{"title":"GET_v1_organizations_id_contracts_contractId_contract-item-rules","description":"Security policies: OrganizationOrGlobalContractView"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_v1_organizations_id_contracts_contractId_contract-item-rules","name":"GET_v1_organizations_id_contracts_contractId_contract-item-rules","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}~1contract-item-rules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"GET_v1_organizations_id_contracts_contractId_contract-item-rules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationOrGlobalContractView"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contractId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}~1contract-item-rules/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/{id}/contracts/{contractId}/contract-item-rules","servers":[{"url":"/"}],"parameters":{"path":[{"name":"contractId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v1/organizations/{id}/contracts/{contractId}/contract-item-rules","href":"contract-items/get_v1_organizations_id_contracts_contractid_contract-item-rules","openApiOperationId":"GET_v1_organizations_id_contracts_contractId_contract-item-rules"},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}~1contract-item-rules/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contract-items/get_v1_organizations_id_contracts_contractid_contract-item-rules"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/contracts/{contractId}/contract-item-rules"},{"label":"Create a contract item on given contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/contract-items/post_v1_organizations_id_contracts_contractid_contract-items","routeSlug":"/products/oneplatform/apis/oas/organizations/contract-items/post_v1_organizations_id_contracts_contractid_contract-items","metadata":{"seo":{"title":"Create a contract item on given contract","description":"Security policies: OrganizationOrGlobalContractCreate"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_v1_organizations_id_contracts_contractId_contract-items","name":"Create a contract item on given contract","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}~1contract-items/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a contract item on given contract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationOrGlobalContractCreate"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contractId","in":"path","schemaId":"schema_0","description":"The identifier of the contract.","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}~1contract-items/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContractItemCreateDto"}},"schemaId":"components/schemas/ContractItemCreateDto","pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}~1contract-items/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/organizations/{id}/contracts/{contractId}/contract-items","servers":[{"url":"/"}],"parameters":{"path":[{"name":"contractId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContractItemCreateDto"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/v1/organizations/{id}/contracts/{contractId}/contract-items","href":"contract-items/post_v1_organizations_id_contracts_contractid_contract-items","openApiOperationId":"POST_v1_organizations_id_contracts_contractId_contract-items","summary":"Create a contract item on given contract"},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/ContractItemCreateDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContractItemCreateDto"}},"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/IdDto"}},"schemaId":"components/schemas/IdDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}~1contract-items/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/IdDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contract-items/post_v1_organizations_id_contracts_contractid_contract-items"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/contracts/{contractId}/contract-items"},{"label":"Returns paginated contract items for a given contract related to the organization with optional filters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/contract-items/get_v1_organizations_id_contracts_contractid_contract-items","routeSlug":"/products/oneplatform/apis/oas/organizations/contract-items/get_v1_organizations_id_contracts_contractid_contract-items","metadata":{"seo":{"title":"Returns paginated contract items for a given contract related to the organization with optional filters","description":"Security policies: OrganizationContractOrGlobalContractDetailsView"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_v1_organizations_id_contracts_contractId_contract-items","name":"Returns paginated contract items for a given contract related to the organization with optional filters","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}~1contract-items/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns paginated contract items for a given contract related to the organization with optional filters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationContractOrGlobalContractDetailsView"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contractId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}~1contract-items/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"ownerId","in":"query","schemaId":"schema_0","description":"The owner identifier to filter contract items by. (Default: Not applied)"},{"name":"productCategoryId","in":"query","schemaId":"schema_0","description":"The product category identifier to filter contract items by. (Default: Not applied)"},{"name":"issuerId","in":"query","schemaId":"schema_0","description":"The issuer identifier to filter contract items by. (Default: Not applied)"},{"name":"billingConsumerId","in":"query","schemaId":"schema_0","description":"The billing consumer identifier to filter contract items by. (Default: Not applied)"},{"name":"legalRepresentativeId","in":"query","schemaId":"schema_0","description":"The legal representative identifier to filter contract items by. (Default: Not applied)"},{"name":"skuId","in":"query","schemaId":"schema_0","description":"The SKU identifier to filter contract items by. (Default: Not applied)"},{"name":"subscriptionId","in":"query","schemaId":"schema_0","description":"The subscription identifier to filter contract items by. (Default: Not applied)"},{"name":"resellContractItemId","in":"query","schemaId":"schema_0","description":"The resell contract item identifier to filter contract items by. (Default: Not applied)"},{"name":"billingModelId","in":"query","schemaId":"schema_0","description":"The billing model identifier to filter contract items by. (Default: Not applied)"},{"name":"status","in":"query","schemaId":"schema_0","description":"The contract status to filter contract items by. (Default: Not applied)"},{"name":"startDateFrom","in":"query","schemaId":"schema_0","description":"Filter contract items by start date from. (Default: Not applied)"},{"name":"startDateTo","in":"query","schemaId":"schema_0","description":"Filter contract items by start date to. (Default: Not applied)"},{"name":"endDateFrom","in":"query","schemaId":"schema_0","description":"Filter contract items by end date from. (Default: Not applied)"},{"name":"endDateTo","in":"query","schemaId":"schema_0","description":"Filter contract items by end date to. (Default: Not applied)"},{"name":"skuParameters","in":"query","schemaId":"schema_0","description":"The SKU parameters to filter contract items by. Pass as string serialized dictionary. (Default: Not applied)"},{"name":"filter","in":"query","schemaId":"schema_0","description":"The filter ODATA expression contract items by. If set exclude all other filters. (Default: Not applied)"},{"name":"orderBy","in":"query","schemaId":"schema_0","description":"The order ODATA expression contract items by. If set exclude other sorts. (Default: Not applied)"},{"name":"userId","in":"query","schemaId":"schema_0","description":"The user identifier to filter contract items by. (Default: Not applied)"},{"name":"productId","in":"query","schemaId":"schema_0","description":"The product identifier to filter contract items by. (Default: Not applied)"},{"name":"search","in":"query","schemaId":"schema_0","description":"The search term for filtering items. (Default: Not applied)"},{"name":"exact","in":"query","schemaId":"schema_2","description":"Boolean which defines whether the params name and search must match exactly. (Default: false)"},{"name":"pageNumber","in":"query","schemaId":"schema_1","description":"The page number of pagination. (Default: 1)"},{"name":"pageSize","in":"query","schemaId":"schema_1","description":"The page size of pagination. (Default: 50, Max: 500)"},{"name":"shouldCount","in":"query","schemaId":"schema_2","description":"Indicates whether the query should also return the total count of items (Default: true)"}],"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}~1contract-items/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/{id}/contracts/{contractId}/contract-items","servers":[{"url":"/"}],"parameters":{"path":[{"name":"contractId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"ownerId","in":"query","schemaId":"schema_0"},{"name":"productCategoryId","in":"query","schemaId":"schema_0"},{"name":"issuerId","in":"query","schemaId":"schema_0"},{"name":"billingConsumerId","in":"query","schemaId":"schema_0"},{"name":"legalRepresentativeId","in":"query","schemaId":"schema_0"},{"name":"skuId","in":"query","schemaId":"schema_0"},{"name":"subscriptionId","in":"query","schemaId":"schema_0"},{"name":"resellContractItemId","in":"query","schemaId":"schema_0"},{"name":"billingModelId","in":"query","schemaId":"schema_0"},{"name":"status","in":"query","schemaId":"schema_0"},{"name":"startDateFrom","in":"query","schemaId":"schema_0"},{"name":"startDateTo","in":"query","schemaId":"schema_0"},{"name":"endDateFrom","in":"query","schemaId":"schema_0"},{"name":"endDateTo","in":"query","schemaId":"schema_0"},{"name":"skuParameters","in":"query","schemaId":"schema_0"},{"name":"filter","in":"query","schemaId":"schema_0"},{"name":"orderBy","in":"query","schemaId":"schema_0"},{"name":"userId","in":"query","schemaId":"schema_0"},{"name":"productId","in":"query","schemaId":"schema_0"},{"name":"search","in":"query","schemaId":"schema_0"},{"name":"exact","in":"query","schemaId":"schema_2"},{"name":"pageNumber","in":"query","schemaId":"schema_1"},{"name":"pageSize","in":"query","schemaId":"schema_1"},{"name":"shouldCount","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/v1/organizations/{id}/contracts/{contractId}/contract-items","href":"contract-items/get_v1_organizations_id_contracts_contractid_contract-items","openApiOperationId":"GET_v1_organizations_id_contracts_contractId_contract-items","summary":"Returns paginated contract items for a given contract related to the organization with optional filters"},"isWebhook":false,"hideReplay":false,"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/PaginationDtoOfContractItemDto"}},"schemaId":"components/schemas/PaginationDtoOfContractItemDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}~1contract-items/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaginationDtoOfContractItemDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationDtoOfContractItemDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contract-items/get_v1_organizations_id_contracts_contractid_contract-items"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/contracts/{contractId}/contract-items"},{"label":"Returns a contract item related to the organization","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/contract-items/get_v1_organizations_id_contract-items_contractitemid","routeSlug":"/products/oneplatform/apis/oas/organizations/contract-items/get_v1_organizations_id_contract-items_contractitemid","metadata":{"seo":{"title":"Returns a contract item related to the organization","description":"Security policies: OrganizationContractOrGlobalContractDetailsView"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_v1_organizations_id_contract-items_contractItemId","name":"Returns a contract item related to the organization","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a contract item related to the organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationContractOrGlobalContractDetailsView"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contractItemId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/{id}/contract-items/{contractItemId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"contractItemId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/v1/organizations/{id}/contract-items/{contractItemId}","href":"contract-items/get_v1_organizations_id_contract-items_contractitemid","openApiOperationId":"GET_v1_organizations_id_contract-items_contractItemId","summary":"Returns a contract item related to the organization"},"isWebhook":false,"hideReplay":false,"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/ContractItemDto"}},"schemaId":"components/schemas/ContractItemDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContractItemDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractItemDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contract-items/get_v1_organizations_id_contract-items_contractitemid"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/contract-items/{contractItemId}"},{"label":"Update a contract item","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/contract-items/put_v1_organizations_id_contract-items_contractitemid","routeSlug":"/products/oneplatform/apis/oas/organizations/contract-items/put_v1_organizations_id_contract-items_contractitemid","metadata":{"seo":{"title":"Update a contract item","description":"Security policies: OrganizationOrGlobalContractEdit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_v1_organizations_id_contract-items_contractItemId","name":"Update a contract item","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a contract item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationOrGlobalContractEdit"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contractItemId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContractItemCreateDto"}},"schemaId":"components/schemas/ContractItemCreateDto","pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/organizations/{id}/contract-items/{contractItemId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"contractItemId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContractItemCreateDto"}},"responseCodes":["200","401","403","404","405","500"],"pointer":"/v1/organizations/{id}/contract-items/{contractItemId}","href":"contract-items/put_v1_organizations_id_contract-items_contractitemid","openApiOperationId":"PUT_v1_organizations_id_contract-items_contractItemId","summary":"Update a contract item"},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/ContractItemCreateDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContractItemCreateDto"}},"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/GuidDto"}},"schemaId":"components/schemas/GuidDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GuidDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuidDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"405","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contract-items/put_v1_organizations_id_contract-items_contractitemid"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/contract-items/{contractItemId}"},{"label":"Delete a contract item related to the organization","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/contract-items/delete_v1_organizations_id_contract-items_contractitemid","routeSlug":"/products/oneplatform/apis/oas/organizations/contract-items/delete_v1_organizations_id_contract-items_contractitemid","metadata":{"seo":{"title":"Delete a contract item related to the organization","description":"Contract items cannot be deleted once the contract they belong to has been signedSecurity policies: OrganizationOrGlobalContractEdit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_v1_organizations_id_contract-items_contractItemId","name":"Delete a contract item related to the organization","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a contract item related to the organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contract items cannot be deleted once the contract they belong to has been signed"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationOrGlobalContractEdit"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contractItemId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/organizations/{id}/contract-items/{contractItemId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"contractItemId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","404","405","500"],"pointer":"/v1/organizations/{id}/contract-items/{contractItemId}","href":"contract-items/delete_v1_organizations_id_contract-items_contractitemid","openApiOperationId":"DELETE_v1_organizations_id_contract-items_contractItemId","summary":"Delete a contract item related to the organization"},"isWebhook":false,"hideReplay":false,"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/GuidDto"}},"schemaId":"components/schemas/GuidDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GuidDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuidDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"405","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contract-items/delete_v1_organizations_id_contract-items_contractitemid"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/contract-items/{contractItemId}"},{"label":"Returns onboarding info associated with the sku of a contract item related to the organization","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/contract-items/get_v1_organizations_id_contract-items_contractitemid_onboarding-info","routeSlug":"/products/oneplatform/apis/oas/organizations/contract-items/get_v1_organizations_id_contract-items_contractitemid_onboarding-info","metadata":{"seo":{"title":"Returns onboarding info associated with the sku of a contract item related to the organization","description":"Security policies: OrganizationContractOrGlobalContractDetailsView"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_v1_organizations_id_contract-items_contractItemId_onboarding-info","name":"Returns onboarding info associated with the sku of a contract item related to the organization","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}~1onboarding-info/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns onboarding info associated with the sku of a contract item related to the organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationContractOrGlobalContractDetailsView"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contractItemId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}~1onboarding-info/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/{id}/contract-items/{contractItemId}/onboarding-info","servers":[{"url":"/"}],"parameters":{"path":[{"name":"contractItemId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500","503"],"pointer":"/v1/organizations/{id}/contract-items/{contractItemId}/onboarding-info","href":"contract-items/get_v1_organizations_id_contract-items_contractitemid_onboarding-info","openApiOperationId":"GET_v1_organizations_id_contract-items_contractItemId_onboarding-info","summary":"Returns onboarding info associated with the sku of a contract item related to the organization"},"isWebhook":false,"hideReplay":false,"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/OnboardingInfoDto"}},"schemaId":"components/schemas/OnboardingInfoDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}~1onboarding-info/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OnboardingInfoDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OnboardingInfoDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"503","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contract-items/get_v1_organizations_id_contract-items_contractitemid_onboarding-info"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/contract-items/{contractItemId}/onboarding-info"},{"label":"Update billing model params of contract item","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/contract-items/put_v1_organizations_id_contract-items_contractitemid_billing-model-parameters","routeSlug":"/products/oneplatform/apis/oas/organizations/contract-items/put_v1_organizations_id_contract-items_contractitemid_billing-model-parameters","metadata":{"seo":{"title":"Update billing model params of contract item","description":"Security policies: OrganizationOrGlobalContractEdit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_v1_organizations_id_contract-items_contractItemId_billing-model-parameters","name":"Update billing model params of contract item","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}~1billing-model-parameters/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update billing model params of contract item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationOrGlobalContractEdit"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contractItemId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}~1billing-model-parameters/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContractItemBillingModelParametersDto"}},"schemaId":"components/schemas/ContractItemBillingModelParametersDto","pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}~1billing-model-parameters/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/organizations/{id}/contract-items/{contractItemId}/billing-model-parameters","servers":[{"url":"/"}],"parameters":{"path":[{"name":"contractItemId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContractItemBillingModelParametersDto"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/v1/organizations/{id}/contract-items/{contractItemId}/billing-model-parameters","href":"contract-items/put_v1_organizations_id_contract-items_contractitemid_billing-model-parameters","openApiOperationId":"PUT_v1_organizations_id_contract-items_contractItemId_billing-model-parameters","summary":"Update billing model params of contract item"},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/ContractItemBillingModelParametersDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContractItemBillingModelParametersDto"}},"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/GuidDto"}},"schemaId":"components/schemas/GuidDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}~1billing-model-parameters/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GuidDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuidDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contract-items/put_v1_organizations_id_contract-items_contractitemid_billing-model-parameters"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/contract-items/{contractItemId}/billing-model-parameters"},{"label":"Update sku parameters of contract item","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/contract-items/put_v1_organizations_id_contract-items_contractitemid_sku-parameters","routeSlug":"/products/oneplatform/apis/oas/organizations/contract-items/put_v1_organizations_id_contract-items_contractitemid_sku-parameters","metadata":{"seo":{"title":"Update sku parameters of contract item","description":"Security policies: OrganizationOrGlobalContractEdit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_v1_organizations_id_contract-items_contractItemId_sku-parameters","name":"Update sku parameters of contract item","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}~1sku-parameters/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update sku parameters of contract item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationOrGlobalContractEdit"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contractItemId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}~1sku-parameters/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContractItemSkuParametersDto"}},"schemaId":"components/schemas/ContractItemSkuParametersDto","pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}~1sku-parameters/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/organizations/{id}/contract-items/{contractItemId}/sku-parameters","servers":[{"url":"/"}],"parameters":{"path":[{"name":"contractItemId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContractItemSkuParametersDto"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/v1/organizations/{id}/contract-items/{contractItemId}/sku-parameters","href":"contract-items/put_v1_organizations_id_contract-items_contractitemid_sku-parameters","openApiOperationId":"PUT_v1_organizations_id_contract-items_contractItemId_sku-parameters","summary":"Update sku parameters of contract item"},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/ContractItemSkuParametersDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContractItemSkuParametersDto"}},"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/GuidDto"}},"schemaId":"components/schemas/GuidDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}~1sku-parameters/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GuidDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuidDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contract-items/put_v1_organizations_id_contract-items_contractitemid_sku-parameters"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/contract-items/{contractItemId}/sku-parameters"},{"label":"Update end date of contract item related to the organization","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/contract-items/put_v1_organizations_id_contract-items_contractitemid_end-date","routeSlug":"/products/oneplatform/apis/oas/organizations/contract-items/put_v1_organizations_id_contract-items_contractitemid_end-date","metadata":{"seo":{"title":"Update end date of contract item related to the organization","description":"Security policies: OrganizationOrGlobalContractEdit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_v1_organizations_id_contract-items_contractItemId_end-date","name":"Update end date of contract item related to the organization","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}~1end-date/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update end date of contract item related to the organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationOrGlobalContractEdit"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contractItemId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}~1end-date/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContractItemEndDateDto"}},"schemaId":"components/schemas/ContractItemEndDateDto","pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}~1end-date/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/organizations/{id}/contract-items/{contractItemId}/end-date","servers":[{"url":"/"}],"parameters":{"path":[{"name":"contractItemId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContractItemEndDateDto"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/v1/organizations/{id}/contract-items/{contractItemId}/end-date","href":"contract-items/put_v1_organizations_id_contract-items_contractitemid_end-date","openApiOperationId":"PUT_v1_organizations_id_contract-items_contractItemId_end-date","summary":"Update end date of contract item related to the organization"},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/ContractItemEndDateDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContractItemEndDateDto"}},"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/GuidDto"}},"schemaId":"components/schemas/GuidDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}~1end-date/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GuidDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuidDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contract-items/put_v1_organizations_id_contract-items_contractitemid_end-date"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/contract-items/{contractItemId}/end-date"},{"label":"Update user id of contract item related to the organization","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/contract-items/put_v1_organizations_id_contract-items_contractitemid_user-id","routeSlug":"/products/oneplatform/apis/oas/organizations/contract-items/put_v1_organizations_id_contract-items_contractitemid_user-id","metadata":{"seo":{"title":"Update user id of contract item related to the organization","description":"Security policies: OrganizationOrGlobalContractEdit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_v1_organizations_id_contract-items_contractItemId_user-id","name":"Update user id of contract item related to the organization","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}~1user-id/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update user id of contract item related to the organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationOrGlobalContractEdit"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contractItemId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}~1user-id/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserIdDto"}},"schemaId":"components/schemas/UserIdDto","pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}~1user-id/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/organizations/{id}/contract-items/{contractItemId}/user-id","servers":[{"url":"/"}],"parameters":{"path":[{"name":"contractItemId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UserIdDto"}},"responseCodes":["200","400","401","403","404","405","500"],"pointer":"/v1/organizations/{id}/contract-items/{contractItemId}/user-id","href":"contract-items/put_v1_organizations_id_contract-items_contractitemid_user-id","openApiOperationId":"PUT_v1_organizations_id_contract-items_contractItemId_user-id","summary":"Update user id of contract item related to the organization"},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/UserIdDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserIdDto"}},"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/GuidDto"}},"schemaId":"components/schemas/GuidDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}~1user-id/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GuidDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuidDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"405","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contract-items/put_v1_organizations_id_contract-items_contractitemid_user-id"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/contract-items/{contractItemId}/user-id"},{"label":"Update subscription id of contract item related to the organization","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/contract-items/put_v1_organizations_id_contract-items_contractitemid_subscription-id","routeSlug":"/products/oneplatform/apis/oas/organizations/contract-items/put_v1_organizations_id_contract-items_contractitemid_subscription-id","metadata":{"seo":{"title":"Update subscription id of contract item related to the organization","description":"Security policies: OrganizationOrGlobalContractEdit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_v1_organizations_id_contract-items_contractItemId_subscription-id","name":"Update subscription id of contract item related to the organization","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}~1subscription-id/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update subscription id of contract item related to the organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationOrGlobalContractEdit"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contractItemId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}~1subscription-id/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriptionIdDto"}},"schemaId":"components/schemas/SubscriptionIdDto","pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}~1subscription-id/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/organizations/{id}/contract-items/{contractItemId}/subscription-id","servers":[{"url":"/"}],"parameters":{"path":[{"name":"contractItemId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SubscriptionIdDto"}},"responseCodes":["200","400","401","403","404","405","500"],"pointer":"/v1/organizations/{id}/contract-items/{contractItemId}/subscription-id","href":"contract-items/put_v1_organizations_id_contract-items_contractitemid_subscription-id","openApiOperationId":"PUT_v1_organizations_id_contract-items_contractItemId_subscription-id","summary":"Update subscription id of contract item related to the organization"},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/SubscriptionIdDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriptionIdDto"}},"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/GuidDto"}},"schemaId":"components/schemas/GuidDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}~1subscription-id/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GuidDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuidDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"405","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contract-items/put_v1_organizations_id_contract-items_contractitemid_subscription-id"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/contract-items/{contractItemId}/subscription-id"},{"label":"Update status of contract item related to the organization to active","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/contract-items/put_v1_organizations_id_contract-items_contractitemid_status_active","routeSlug":"/products/oneplatform/apis/oas/organizations/contract-items/put_v1_organizations_id_contract-items_contractitemid_status_active","metadata":{"seo":{"title":"Update status of contract item related to the organization to active","description":"Security policies: OrganizationOrGlobalContractEdit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_v1_organizations_id_contract-items_contractItemId_status_active","name":"Update status of contract item related to the organization to active","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}~1status~1active/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update status of contract item related to the organization to active","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationOrGlobalContractEdit"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contractItemId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}~1status~1active/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/organizations/{id}/contract-items/{contractItemId}/status/active","servers":[{"url":"/"}],"parameters":{"path":[{"name":"contractItemId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","500"],"pointer":"/v1/organizations/{id}/contract-items/{contractItemId}/status/active","href":"contract-items/put_v1_organizations_id_contract-items_contractitemid_status_active","openApiOperationId":"PUT_v1_organizations_id_contract-items_contractItemId_status_active","summary":"Update status of contract item related to the organization to active"},"isWebhook":false,"hideReplay":false,"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/GuidDto"}},"schemaId":"components/schemas/GuidDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}~1status~1active/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GuidDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuidDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"405","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contract-items/put_v1_organizations_id_contract-items_contractitemid_status_active"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/contract-items/{contractItemId}/status/active"},{"label":"Perform dry-run validation for a contract item","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/contract-items/put_v1_organizations_id_contract-items_contractitemid_provisioning-dry-run","routeSlug":"/products/oneplatform/apis/oas/organizations/contract-items/put_v1_organizations_id_contract-items_contractitemid_provisioning-dry-run","metadata":{"seo":{"title":"Perform dry-run validation for a contract item","description":"Security policies: OrganizationContractOrGlobalContractDetailsView"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_v1_organizations_id_contract-items_contractItemId_provisioning-dry-run","name":"Perform dry-run validation for a contract item","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}~1provisioning-dry-run/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Perform dry-run validation for a contract item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationContractOrGlobalContractDetailsView"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contractItemId","in":"path","schemaId":"schema_0","description":"The identifier of the contract item","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}~1provisioning-dry-run/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContractItemDryRunDto"}},"schemaId":"components/schemas/ContractItemDryRunDto","pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}~1provisioning-dry-run/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/organizations/{id}/contract-items/{contractItemId}/provisioning-dry-run","servers":[{"url":"/"}],"parameters":{"path":[{"name":"contractItemId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContractItemDryRunDto"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/v1/organizations/{id}/contract-items/{contractItemId}/provisioning-dry-run","href":"contract-items/put_v1_organizations_id_contract-items_contractitemid_provisioning-dry-run","openApiOperationId":"PUT_v1_organizations_id_contract-items_contractItemId_provisioning-dry-run","summary":"Perform dry-run validation for a contract item"},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/ContractItemDryRunDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContractItemDryRunDto"}},"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/MultiOperationResponseDtoOfProvisioningValidationResultDto"}},"schemaId":"components/schemas/MultiOperationResponseDtoOfProvisioningValidationResultDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}~1provisioning-dry-run/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MultiOperationResponseDtoOfProvisioningValidationResultDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MultiOperationResponseDtoOfProvisioningValidationResultDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contract-items/put_v1_organizations_id_contract-items_contractitemid_provisioning-dry-run"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/contract-items/{contractItemId}/provisioning-dry-run"},{"label":"Update status of contract item related to the organization to expired","deprecated":true,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/contract-items/put_v1_organizations_id_contract-items_contractitemid_status_expired","routeSlug":"/products/oneplatform/apis/oas/organizations/contract-items/put_v1_organizations_id_contract-items_contractitemid_status_expired","metadata":{"seo":{"title":"Update status of contract item related to the organization to expired","description":"⚠️ DEPRECATED ⚠️: This API is DEPRECATED and will be removed on 2026-12-01.Security policies: OrganizationOrGlobalContractEdit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_v1_organizations_id_contract-items_contractItemId_status_expired","name":"Update status of contract item related to the organization to expired","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}~1status~1expired/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update status of contract item related to the organization to expired","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ DEPRECATED ⚠️"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This API is DEPRECATED and will be removed on 2026-12-01."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationOrGlobalContractEdit"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contractItemId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}~1status~1expired/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/organizations/{id}/contract-items/{contractItemId}/status/expired","servers":[{"url":"/"}],"parameters":{"path":[{"name":"contractItemId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","500"],"pointer":"/v1/organizations/{id}/contract-items/{contractItemId}/status/expired","href":"contract-items/put_v1_organizations_id_contract-items_contractitemid_status_expired","openApiOperationId":"PUT_v1_organizations_id_contract-items_contractItemId_status_expired","summary":"Update status of contract item related to the organization to expired"},"isWebhook":false,"hideReplay":false,"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/GuidDto"}},"schemaId":"components/schemas/GuidDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1contract-items~1{contractItemId}~1status~1expired/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GuidDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuidDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"405","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contract-items/put_v1_organizations_id_contract-items_contractitemid_status_expired"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/contract-items/{contractItemId}/status/expired"},{"label":"GET_v1_organizations_id_consumers_consumerId_contracts_contractId_contract-items","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/contract-items/get_v1_organizations_id_consumers_consumerid_contracts_contractid_contract-items","routeSlug":"/products/oneplatform/apis/oas/organizations/contract-items/get_v1_organizations_id_consumers_consumerid_contracts_contractid_contract-items","metadata":{"seo":{"title":"GET_v1_organizations_id_consumers_consumerId_contracts_contractId_contract-items","description":"🗑️ DEPRECATED (Will no longer be available in the next release) 🗑️: This API is DEPRECATED and will be removed on 2026-04-01, use API GET '/v1/organizations/{id}/contracts/{contractId}/contract-items' instead.Security policies: OrganizationsConsumerContractsView"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_v1_organizations_id_consumers_consumerId_contracts_contractId_contract-items","name":"GET_v1_organizations_id_consumers_consumerId_contracts_contractId_contract-items","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1contracts~1{contractId}~1contract-items/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"GET_v1_organizations_id_consumers_consumerId_contracts_contractId_contract-items","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🗑️ DEPRECATED (Will no longer be available in the next release) 🗑️"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This API is DEPRECATED and will be removed on 2026-04-01, use API GET '/v1/organizations/{id}/contracts/{contractId}/contract-items' instead."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationsConsumerContractsView"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true},{"name":"consumerId","in":"path","schemaId":"schema_0","required":true},{"name":"contractId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1contracts~1{contractId}~1contract-items/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_1"},{"name":"pageSize","in":"query","schemaId":"schema_1"}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1contracts~1{contractId}~1contract-items/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/{id}/consumers/{consumerId}/contracts/{contractId}/contract-items","servers":[{"url":"/"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"},{"name":"consumerId","in":"path","required":true,"schemaId":"schema_0"},{"name":"contractId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"pageNumber","in":"query","schemaId":"schema_1"},{"name":"pageSize","in":"query","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/v1/organizations/{id}/consumers/{consumerId}/contracts/{contractId}/contract-items","href":"contract-items/get_v1_organizations_id_consumers_consumerid_contracts_contractid_contract-items","openApiOperationId":"GET_v1_organizations_id_consumers_consumerId_contracts_contractId_contract-items"},"isWebhook":false,"hideReplay":false,"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/PaginationDtoOfContractItemDto"}},"schemaId":"components/schemas/PaginationDtoOfContractItemDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1contracts~1{contractId}~1contract-items/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaginationDtoOfContractItemDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationDtoOfContractItemDto"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contract-items/get_v1_organizations_id_consumers_consumerid_contracts_contractid_contract-items"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/consumers/{consumerId}/contracts/{contractId}/contract-items"},{"label":"GET_v1_organizations_id_consumers_consumerId_contract-items_contractItemId_signed-doc","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/contract-items/get_v1_organizations_id_consumers_consumerid_contract-items_contractitemid_signed-doc","routeSlug":"/products/oneplatform/apis/oas/organizations/contract-items/get_v1_organizations_id_consumers_consumerid_contract-items_contractitemid_signed-doc","metadata":{"seo":{"title":"GET_v1_organizations_id_consumers_consumerId_contract-items_contractItemId_signed-doc","description":"🗑️ DEPRECATED (Will no longer be available in the next release) 🗑️: This API is DEPRECATED and will be removed on 2026-04-01, use API GET '/v1/organizations/{id}/contract-items/{contractItemId}/signed-doc' instead.Security policies: OrganizationsConsumerContractsView"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_v1_organizations_id_consumers_consumerId_contract-items_contractItemId_signed-doc","name":"GET_v1_organizations_id_consumers_consumerId_contract-items_contractItemId_signed-doc","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1contract-items~1{contractItemId}~1signed-doc/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"GET_v1_organizations_id_consumers_consumerId_contract-items_contractItemId_signed-doc","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🗑️ DEPRECATED (Will no longer be available in the next release) 🗑️"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This API is DEPRECATED and will be removed on 2026-04-01, use API GET '/v1/organizations/{id}/contract-items/{contractItemId}/signed-doc' instead."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationsConsumerContractsView"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true},{"name":"consumerId","in":"path","schemaId":"schema_0","required":true},{"name":"contractItemId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1contract-items~1{contractItemId}~1signed-doc/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_1"},{"name":"pageSize","in":"query","schemaId":"schema_1"}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1contract-items~1{contractItemId}~1signed-doc/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/{id}/consumers/{consumerId}/contract-items/{contractItemId}/signed-doc","servers":[{"url":"/"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"},{"name":"consumerId","in":"path","required":true,"schemaId":"schema_0"},{"name":"contractItemId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"pageNumber","in":"query","schemaId":"schema_1"},{"name":"pageSize","in":"query","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/v1/organizations/{id}/consumers/{consumerId}/contract-items/{contractItemId}/signed-doc","href":"contract-items/get_v1_organizations_id_consumers_consumerid_contract-items_contractitemid_signed-doc","openApiOperationId":"GET_v1_organizations_id_consumers_consumerId_contract-items_contractItemId_signed-doc"},"isWebhook":false,"hideReplay":false,"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/IResult"}},"schemaId":"components/schemas/IResult"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1contract-items~1{contractItemId}~1signed-doc/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/IResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IResult"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contract-items/get_v1_organizations_id_consumers_consumerid_contract-items_contractitemid_signed-doc"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/consumers/{consumerId}/contract-items/{contractItemId}/signed-doc"}],"content":{"contentType":"group","meta":{"name":"Contract Items"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contract Items","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/organizations/{id}/contract-item-rules","summary":"GET_v1_organizations_id_contract-item-rules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contract-items/get_v1_organizations_id_contract-item-rules","deprecated":false},{"title":"/v1/organizations/{id}/contracts/{contractId}/contract-item-rules","summary":"GET_v1_organizations_id_contracts_contractId_contract-item-rules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contract-items/get_v1_organizations_id_contracts_contractid_contract-item-rules","deprecated":false},{"title":"/v1/organizations/{id}/contracts/{contractId}/contract-items","summary":"Create a contract item on given contract","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contract-items/post_v1_organizations_id_contracts_contractid_contract-items","deprecated":false},{"title":"/v1/organizations/{id}/contracts/{contractId}/contract-items","summary":"Returns paginated contract items for a given contract related to the organization with optional filters","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contract-items/get_v1_organizations_id_contracts_contractid_contract-items","deprecated":false},{"title":"/v1/organizations/{id}/contract-items/{contractItemId}","summary":"Returns a contract item related to the organization","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contract-items/get_v1_organizations_id_contract-items_contractitemid","deprecated":false},{"title":"/v1/organizations/{id}/contract-items/{contractItemId}","summary":"Update a contract item","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contract-items/put_v1_organizations_id_contract-items_contractitemid","deprecated":false},{"title":"/v1/organizations/{id}/contract-items/{contractItemId}","summary":"Delete a contract item related to the organization","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/contract-items/delete_v1_organizations_id_contract-items_contractitemid","deprecated":false},{"title":"/v1/organizations/{id}/contract-items/{contractItemId}/onboarding-info","summary":"Returns onboarding info associated with the sku of a contract item related to the organization","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contract-items/get_v1_organizations_id_contract-items_contractitemid_onboarding-info","deprecated":false},{"title":"/v1/organizations/{id}/contract-items/{contractItemId}/billing-model-parameters","summary":"Update billing model params of contract item","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contract-items/put_v1_organizations_id_contract-items_contractitemid_billing-model-parameters","deprecated":false},{"title":"/v1/organizations/{id}/contract-items/{contractItemId}/sku-parameters","summary":"Update sku parameters of contract item","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contract-items/put_v1_organizations_id_contract-items_contractitemid_sku-parameters","deprecated":false},{"title":"/v1/organizations/{id}/contract-items/{contractItemId}/end-date","summary":"Update end date of contract item related to the organization","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contract-items/put_v1_organizations_id_contract-items_contractitemid_end-date","deprecated":false},{"title":"/v1/organizations/{id}/contract-items/{contractItemId}/user-id","summary":"Update user id of contract item related to the organization","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contract-items/put_v1_organizations_id_contract-items_contractitemid_user-id","deprecated":false},{"title":"/v1/organizations/{id}/contract-items/{contractItemId}/subscription-id","summary":"Update subscription id of contract item related to the organization","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contract-items/put_v1_organizations_id_contract-items_contractitemid_subscription-id","deprecated":false},{"title":"/v1/organizations/{id}/contract-items/{contractItemId}/status/active","summary":"Update status of contract item related to the organization to active","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contract-items/put_v1_organizations_id_contract-items_contractitemid_status_active","deprecated":false},{"title":"/v1/organizations/{id}/contract-items/{contractItemId}/provisioning-dry-run","summary":"Perform dry-run validation for a contract item","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contract-items/put_v1_organizations_id_contract-items_contractitemid_provisioning-dry-run","deprecated":false},{"title":"/v1/organizations/{id}/contract-items/{contractItemId}/status/expired","summary":"Update status of contract item related to the organization to expired","prefix":{"name":"put","color":"http-deprecated"},"badges":[],"link":"/contract-items/put_v1_organizations_id_contract-items_contractitemid_status_expired","deprecated":true},{"title":"/v1/organizations/{id}/consumers/{consumerId}/contracts/{contractId}/contract-items","summary":"GET_v1_organizations_id_consumers_consumerId_contracts_contractId_contract-items","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/contract-items/get_v1_organizations_id_consumers_consumerid_contracts_contractid_contract-items","deprecated":true},{"title":"/v1/organizations/{id}/consumers/{consumerId}/contract-items/{contractItemId}/signed-doc","summary":"GET_v1_organizations_id_consumers_consumerId_contract-items_contractItemId_signed-doc","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/contract-items/get_v1_organizations_id_consumers_consumerid_contract-items_contractitemid_signed-doc","deprecated":true}]}]}]}]}},{"type":"group","label":"Contracts","link":"/products/oneplatform/apis/oas/organizations/contracts","routeSlug":"/products/oneplatform/apis/oas/organizations/contracts","items":[{"label":"Return a paginated list of contracts related to the organization as party","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/contracts/get_v1_organizations_id_contracts","routeSlug":"/products/oneplatform/apis/oas/organizations/contracts/get_v1_organizations_id_contracts","metadata":{"seo":{"title":"Return a paginated list of contracts related to the organization as party","description":"Security policies: OrganizationOrGlobalContractView"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_v1_organizations_id_contracts","name":"Return a paginated list of contracts related to the organization as party","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1contracts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return a paginated list of contracts related to the organization as party","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationOrGlobalContractView"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1contracts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"consumerId","in":"query","schemaId":"schema_0","description":"The id of the consumer to be used as second party filter in contracts. (Default: Not applied)"},{"name":"filter","in":"query","schemaId":"schema_0","description":"The filter ODATA expression contracts by. If set exclude all other filters. (Default: Not applied)"},{"name":"legalEntityId","in":"query","schemaId":"schema_0","description":"The id of the legal entity to be used as second party filter in contracts. (Default: Not applied)"},{"name":"issuerId","in":"query","schemaId":"schema_0","description":"The id of the issuer to be used as second party filter in contracts. (Default: Not applied)"},{"name":"ownerId","in":"query","schemaId":"schema_0","description":"The id of the owner to be used as second party filter in contracts. (Default: Not applied)"},{"name":"legalRepresentativeId","in":"query","schemaId":"schema_0","description":"The id of the legal representative to be used as second party filter in contracts. (Default: Not applied)"},{"name":"searchOnAnyRecipientsConsumerId","in":"query","schemaId":"schema_2","description":"search consumer id on billing consumer id, owner id and legal representative id of the contract. (Default: Not applied)"},{"name":"status","in":"query","schemaId":"schema_0","description":"The list of contract statuses for which contracts should be filtered. Is JSON array format. (Default: Not applied)"},{"name":"type","in":"query","schemaId":"schema_0","description":"The list of contract types for which contracts should be filtered. Is JSON array format. (Default: Not applied)"},{"name":"startDateFrom","in":"query","schemaId":"schema_0","description":"The start date from of the contract. Example: 2023-11-28 (Default: Not applied)"},{"name":"startDateTo","in":"query","schemaId":"schema_0","description":"The start date to of the contract. Example: 2023-11-28 (Default: Not applied)"},{"name":"number","in":"query","schemaId":"schema_0","description":"The contract number to be used as filter in contracts. (Default: Not applied)"},{"name":"orderBy","in":"query","schemaId":"schema_0","description":"The order ODATA expression contracts by. If set exclude other sorts. (Default: Not applied)"},{"name":"search","in":"query","schemaId":"schema_0","description":"The search term for filtering items. (Default: Not applied)"},{"name":"exact","in":"query","schemaId":"schema_2","description":"Boolean which defines whether the params name and search must match exactly. (Default: false)"},{"name":"pageNumber","in":"query","schemaId":"schema_1","description":"The page number of pagination. (Default: 1)"},{"name":"pageSize","in":"query","schemaId":"schema_1","description":"The page size of pagination. (Default: 50, Max: 500)"},{"name":"shouldCount","in":"query","schemaId":"schema_2","description":"Indicates whether the query should also return the total count of items (Default: true)"}],"pointer":"/paths/~1v1~1organizations~1{id}~1contracts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/{id}/contracts","servers":[{"url":"/"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"consumerId","in":"query","schemaId":"schema_0"},{"name":"filter","in":"query","schemaId":"schema_0"},{"name":"legalEntityId","in":"query","schemaId":"schema_0"},{"name":"issuerId","in":"query","schemaId":"schema_0"},{"name":"ownerId","in":"query","schemaId":"schema_0"},{"name":"legalRepresentativeId","in":"query","schemaId":"schema_0"},{"name":"searchOnAnyRecipientsConsumerId","in":"query","schemaId":"schema_2"},{"name":"status","in":"query","schemaId":"schema_0"},{"name":"type","in":"query","schemaId":"schema_0"},{"name":"startDateFrom","in":"query","schemaId":"schema_0"},{"name":"startDateTo","in":"query","schemaId":"schema_0"},{"name":"number","in":"query","schemaId":"schema_0"},{"name":"orderBy","in":"query","schemaId":"schema_0"},{"name":"search","in":"query","schemaId":"schema_0"},{"name":"exact","in":"query","schemaId":"schema_2"},{"name":"pageNumber","in":"query","schemaId":"schema_1"},{"name":"pageSize","in":"query","schemaId":"schema_1"},{"name":"shouldCount","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/v1/organizations/{id}/contracts","href":"contracts/get_v1_organizations_id_contracts","openApiOperationId":"GET_v1_organizations_id_contracts","summary":"Return a paginated list of contracts related to the organization as party"},"isWebhook":false,"hideReplay":false,"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/PaginationDtoOfContractDto"}},"schemaId":"components/schemas/PaginationDtoOfContractDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1contracts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaginationDtoOfContractDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationDtoOfContractDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contracts/get_v1_organizations_id_contracts"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/contracts"},{"label":"Create a contract organization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/contracts/post_v1_organizations_id_contracts","routeSlug":"/products/oneplatform/apis/oas/organizations/contracts/post_v1_organizations_id_contracts","metadata":{"seo":{"title":"Create a contract organization","description":"Security policies: OrganizationOrGlobalContractCreate"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_v1_organizations_id_contracts","name":"Create a contract organization","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1contracts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a contract organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationOrGlobalContractCreate"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1contracts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContractCreateDto"}},"schemaId":"components/schemas/ContractCreateDto","pointer":"/paths/~1v1~1organizations~1{id}~1contracts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/organizations/{id}/contracts","servers":[{"url":"/"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContractCreateDto"}},"responseCodes":["200","400","401","403","500"],"pointer":"/v1/organizations/{id}/contracts","href":"contracts/post_v1_organizations_id_contracts","openApiOperationId":"POST_v1_organizations_id_contracts","summary":"Create a contract organization"},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/ContractCreateDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContractCreateDto"}},"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/IdDto"}},"schemaId":"components/schemas/IdDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1contracts/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/IdDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contracts/post_v1_organizations_id_contracts"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/contracts"},{"label":"Return service activation group id by contract id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/contracts/get_v1_organizations_id_contracts_contractid_service-activation-group","routeSlug":"/products/oneplatform/apis/oas/organizations/contracts/get_v1_organizations_id_contracts_contractid_service-activation-group","metadata":{"seo":{"title":"Return service activation group id by contract id","description":"Security policies: OrganizationContractOrGlobalContractDetailsView"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_v1_organizations_id_contracts_contractId_service-activation-group","name":"Return service activation group id by contract id","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}~1service-activation-group/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return service activation group id by contract id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationContractOrGlobalContractDetailsView"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Identifier for a organization","required":true},{"name":"contractId","in":"path","schemaId":"schema_0","description":"Identifier for a contract","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}~1service-activation-group/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/{id}/contracts/{contractId}/service-activation-group","servers":[{"url":"/"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"},{"name":"contractId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/v1/organizations/{id}/contracts/{contractId}/service-activation-group","href":"contracts/get_v1_organizations_id_contracts_contractid_service-activation-group","openApiOperationId":"GET_v1_organizations_id_contracts_contractId_service-activation-group","summary":"Return service activation group id by contract id"},"isWebhook":false,"hideReplay":false,"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/ServiceActivationGroupDto"}},"schemaId":"components/schemas/ServiceActivationGroupDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}~1service-activation-group/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ServiceActivationGroupDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceActivationGroupDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contracts/get_v1_organizations_id_contracts_contractid_service-activation-group"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/contracts/{contractId}/service-activation-group"},{"label":"Return a contract where given organization is party related in contract","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/contracts/get_v1_organizations_id_contracts_contractid","routeSlug":"/products/oneplatform/apis/oas/organizations/contracts/get_v1_organizations_id_contracts_contractid","metadata":{"seo":{"title":"Return a contract where given organization is party related in contract","description":"Security policies: OrganizationContractOrGlobalContractDetailsView"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_v1_organizations_id_contracts_contractId","name":"Return a contract where given organization is party related in contract","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return a contract where given organization is party related in contract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationContractOrGlobalContractDetailsView"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contractId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"signingExtraInfo","in":"query","schemaId":"schema_2"},{"name":"itemsInPendingExtraInfo","in":"query","schemaId":"schema_2"},{"name":"itemsContractDataConflictExtraInfo","in":"query","schemaId":"schema_2"}],"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/{id}/contracts/{contractId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"contractId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"signingExtraInfo","in":"query","schemaId":"schema_2"},{"name":"itemsInPendingExtraInfo","in":"query","schemaId":"schema_2"},{"name":"itemsContractDataConflictExtraInfo","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/v1/organizations/{id}/contracts/{contractId}","href":"contracts/get_v1_organizations_id_contracts_contractid","openApiOperationId":"GET_v1_organizations_id_contracts_contractId","summary":"Return a contract where given organization is party related in contract"},"isWebhook":false,"hideReplay":false,"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/ContractDto"}},"schemaId":"components/schemas/ContractDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContractDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contracts/get_v1_organizations_id_contracts_contractid"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/contracts/{contractId}"},{"label":"Update a contract","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/contracts/put_v1_organizations_id_contracts_contractid","routeSlug":"/products/oneplatform/apis/oas/organizations/contracts/put_v1_organizations_id_contracts_contractid","metadata":{"seo":{"title":"Update a contract","description":"Security policies: OrganizationOrGlobalContractEdit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_v1_organizations_id_contracts_contractId","name":"Update a contract","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a contract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationOrGlobalContractEdit"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contractId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContractCreateDto"}},"schemaId":"components/schemas/ContractCreateDto","pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/organizations/{id}/contracts/{contractId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"contractId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContractCreateDto"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/v1/organizations/{id}/contracts/{contractId}","href":"contracts/put_v1_organizations_id_contracts_contractid","openApiOperationId":"PUT_v1_organizations_id_contracts_contractId","summary":"Update a contract"},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/ContractCreateDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContractCreateDto"}},"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/GuidDto"}},"schemaId":"components/schemas/GuidDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GuidDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuidDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contracts/put_v1_organizations_id_contracts_contractid"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/contracts/{contractId}"},{"label":"Delete an organization's contract","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/contracts/delete_v1_organizations_id_contracts_contractid","routeSlug":"/products/oneplatform/apis/oas/organizations/contracts/delete_v1_organizations_id_contracts_contractid","metadata":{"seo":{"title":"Delete an organization's contract","description":"Security policies: OrganizationOrGlobalContractEdit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_v1_organizations_id_contracts_contractId","name":"Delete an organization's contract","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an organization's contract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationOrGlobalContractEdit"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contractId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/organizations/{id}/contracts/{contractId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"contractId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/v1/organizations/{id}/contracts/{contractId}","href":"contracts/delete_v1_organizations_id_contracts_contractid","openApiOperationId":"DELETE_v1_organizations_id_contracts_contractId","summary":"Delete an organization's contract"},"isWebhook":false,"hideReplay":false,"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/MultiOperationsDto"}},"schemaId":"components/schemas/MultiOperationsDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MultiOperationsDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MultiOperationsDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contracts/delete_v1_organizations_id_contracts_contractid"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/contracts/{contractId}"},{"label":"Update status of contract to final","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/contracts/put_v1_organizations_id_contracts_contractid_status_final","routeSlug":"/products/oneplatform/apis/oas/organizations/contracts/put_v1_organizations_id_contracts_contractid_status_final","metadata":{"seo":{"title":"Update status of contract to final","description":"The main requirement to go in \"Final\" status is to be in “Draft” status and not have any \"Pending\" itemsSecurity policies: OrganizationOrGlobalContractEdit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_v1_organizations_id_contracts_contractId_status_final","name":"Update status of contract to final","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}~1status~1final/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update status of contract to final","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The main requirement to go in \"Final\" status is to be in “Draft” status and not have any \"Pending\" items"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationOrGlobalContractEdit"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contractId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}~1status~1final/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sendNotification","in":"query","schemaId":"schema_2","description":"Optional flag to control whether contract ready email notification should be sent. When false or not provided, no email is sent."}],"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}~1status~1final/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/organizations/{id}/contracts/{contractId}/status/final","servers":[{"url":"/"}],"parameters":{"path":[{"name":"contractId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"sendNotification","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/v1/organizations/{id}/contracts/{contractId}/status/final","href":"contracts/put_v1_organizations_id_contracts_contractid_status_final","openApiOperationId":"PUT_v1_organizations_id_contracts_contractId_status_final","summary":"Update status of contract to final"},"isWebhook":false,"hideReplay":false,"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/ContractStatusUpdateResponseDto"}},"schemaId":"components/schemas/ContractStatusUpdateResponseDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}~1status~1final/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContractStatusUpdateResponseDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractStatusUpdateResponseDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contracts/put_v1_organizations_id_contracts_contractid_status_final"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/contracts/{contractId}/status/final"},{"label":"Update status of organization's contract to expired","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/contracts/put_v1_organizations_id_contracts_contractid_status_expired","routeSlug":"/products/oneplatform/apis/oas/organizations/contracts/put_v1_organizations_id_contracts_contractid_status_expired","metadata":{"seo":{"title":"Update status of organization's contract to expired","description":"The contract must be in Completed statusSecurity policies: OrganizationOrGlobalContractEdit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_v1_organizations_id_contracts_contractId_status_expired","name":"Update status of organization's contract to expired","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}~1status~1expired/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update status of organization's contract to expired","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contract must be in Completed status"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationOrGlobalContractEdit"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contractId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}~1status~1expired/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/organizations/{id}/contracts/{contractId}/status/expired","servers":[{"url":"/"}],"parameters":{"path":[{"name":"contractId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/v1/organizations/{id}/contracts/{contractId}/status/expired","href":"contracts/put_v1_organizations_id_contracts_contractid_status_expired","openApiOperationId":"PUT_v1_organizations_id_contracts_contractId_status_expired","summary":"Update status of organization's contract to expired"},"isWebhook":false,"hideReplay":false,"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/GuidDto"}},"schemaId":"components/schemas/GuidDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}~1status~1expired/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GuidDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuidDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contracts/put_v1_organizations_id_contracts_contractid_status_expired"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/contracts/{contractId}/status/expired"},{"label":"Update end date of contract","deprecated":true,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/contracts/put_v1_organizations_id_contracts_contractid_end-date","routeSlug":"/products/oneplatform/apis/oas/organizations/contracts/put_v1_organizations_id_contracts_contractid_end-date","metadata":{"seo":{"title":"Update end date of contract","description":"🗑️ DEPRECATED (Will no longer be available in the next release) 🗑️: This API is DEPRECATED and will be removed on 2026-05-01. Reason: The end date of a contract has been removed. It doesn't do anything anymore..Security policies: OrganizationOrGlobalContractEdit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_v1_organizations_id_contracts_contractId_end-date","name":"Update end date of contract","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}~1end-date/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update end date of contract","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🗑️ DEPRECATED (Will no longer be available in the next release) 🗑️"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This API is DEPRECATED and will be removed on 2026-05-01. Reason: The end date of a contract has been removed. It doesn't do anything anymore.."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationOrGlobalContractEdit"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contractId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}~1end-date/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContractEndDateDto"}},"schemaId":"components/schemas/ContractEndDateDto","pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}~1end-date/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/organizations/{id}/contracts/{contractId}/end-date","servers":[{"url":"/"}],"parameters":{"path":[{"name":"contractId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContractEndDateDto"}},"responseCodes":["200","401","403"],"pointer":"/v1/organizations/{id}/contracts/{contractId}/end-date","href":"contracts/put_v1_organizations_id_contracts_contractid_end-date","openApiOperationId":"PUT_v1_organizations_id_contracts_contractId_end-date","summary":"Update end date of contract"},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/ContractEndDateDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContractEndDateDto"}},"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/GuidDto"}},"schemaId":"components/schemas/GuidDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}~1end-date/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GuidDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuidDto"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contracts/put_v1_organizations_id_contracts_contractid_end-date"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/contracts/{contractId}/end-date"},{"label":"GET_v1_organizations_id_consumers_consumerId_contracts","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/contracts/get_v1_organizations_id_consumers_consumerid_contracts","routeSlug":"/products/oneplatform/apis/oas/organizations/contracts/get_v1_organizations_id_consumers_consumerid_contracts","metadata":{"seo":{"title":"GET_v1_organizations_id_consumers_consumerId_contracts","description":"🗑️ DEPRECATED (Will no longer be available in the next release) 🗑️: This API is DEPRECATED and will be removed on 2026-04-01, use API GET '/v1/organizations/{id}/contracts' instead.Security policies: OrganizationsConsumerContractsView"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_v1_organizations_id_consumers_consumerId_contracts","name":"GET_v1_organizations_id_consumers_consumerId_contracts","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1contracts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"GET_v1_organizations_id_consumers_consumerId_contracts","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🗑️ DEPRECATED (Will no longer be available in the next release) 🗑️"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This API is DEPRECATED and will be removed on 2026-04-01, use API GET '/v1/organizations/{id}/contracts' instead."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationsConsumerContractsView"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true},{"name":"consumerId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1contracts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_0","description":"The filter ODATA expression contracts by. If set exclude all other filters. (Default: Not applied)"},{"name":"legalEntityId","in":"query","schemaId":"schema_0","description":"The id of the legal entity to be used as second party filter in contracts. (Default: Not applied)"},{"name":"issuerId","in":"query","schemaId":"schema_0","description":"The id of the issuer to be used as second party filter in contracts. (Default: Not applied)"},{"name":"ownerId","in":"query","schemaId":"schema_0","description":"The id of the owner to be used as second party filter in contracts. (Default: Not applied)"},{"name":"legalRepresentativeId","in":"query","schemaId":"schema_0","description":"The id of the legal representative to be used as second party filter in contracts. (Default: Not applied)"},{"name":"searchOnAnyRecipientsConsumerId","in":"query","schemaId":"schema_2","description":"search consumer id on billing consumer id, owner id and legal representative id of the contract. (Default: Not applied)"},{"name":"status","in":"query","schemaId":"schema_0","description":"The list of contract statuses for which contracts should be filtered. Is JSON array format. (Default: Not applied)"},{"name":"type","in":"query","schemaId":"schema_0","description":"The list of contract types for which contracts should be filtered. Is JSON array format. (Default: Not applied)"},{"name":"startDateFrom","in":"query","schemaId":"schema_0","description":"The start date from of the contract. Example: 2023-11-28 (Default: Not applied)"},{"name":"startDateTo","in":"query","schemaId":"schema_0","description":"The start date to of the contract. Example: 2023-11-28 (Default: Not applied)"},{"name":"number","in":"query","schemaId":"schema_0","description":"The contract number to be used as filter in contracts. (Default: Not applied)"},{"name":"orderBy","in":"query","schemaId":"schema_0","description":"The order ODATA expression contracts by. If set exclude other sorts. (Default: Not applied)"},{"name":"search","in":"query","schemaId":"schema_0","description":"The search term for filtering items. (Default: Not applied)"},{"name":"exact","in":"query","schemaId":"schema_2","description":"Boolean which defines whether the params name and search must match exactly. (Default: false)"},{"name":"pageNumber","in":"query","schemaId":"schema_1","description":"The page number of pagination. (Default: 1)"},{"name":"pageSize","in":"query","schemaId":"schema_1","description":"The page size of pagination. (Default: 50, Max: 500)"},{"name":"shouldCount","in":"query","schemaId":"schema_2","description":"Indicates whether the query should also return the total count of items (Default: true)"}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1contracts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/{id}/consumers/{consumerId}/contracts","servers":[{"url":"/"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"},{"name":"consumerId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"filter","in":"query","schemaId":"schema_0"},{"name":"legalEntityId","in":"query","schemaId":"schema_0"},{"name":"issuerId","in":"query","schemaId":"schema_0"},{"name":"ownerId","in":"query","schemaId":"schema_0"},{"name":"legalRepresentativeId","in":"query","schemaId":"schema_0"},{"name":"searchOnAnyRecipientsConsumerId","in":"query","schemaId":"schema_2"},{"name":"status","in":"query","schemaId":"schema_0"},{"name":"type","in":"query","schemaId":"schema_0"},{"name":"startDateFrom","in":"query","schemaId":"schema_0"},{"name":"startDateTo","in":"query","schemaId":"schema_0"},{"name":"number","in":"query","schemaId":"schema_0"},{"name":"orderBy","in":"query","schemaId":"schema_0"},{"name":"search","in":"query","schemaId":"schema_0"},{"name":"exact","in":"query","schemaId":"schema_2"},{"name":"pageNumber","in":"query","schemaId":"schema_1"},{"name":"pageSize","in":"query","schemaId":"schema_1"},{"name":"shouldCount","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/v1/organizations/{id}/consumers/{consumerId}/contracts","href":"contracts/get_v1_organizations_id_consumers_consumerid_contracts","openApiOperationId":"GET_v1_organizations_id_consumers_consumerId_contracts"},"isWebhook":false,"hideReplay":false,"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/PaginationDtoOfContractDto"}},"schemaId":"components/schemas/PaginationDtoOfContractDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1contracts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaginationDtoOfContractDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationDtoOfContractDto"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contracts/get_v1_organizations_id_consumers_consumerid_contracts"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/consumers/{consumerId}/contracts"},{"label":"GET_v1_organizations_id_consumers_consumerId_contracts_contractId","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/contracts/get_v1_organizations_id_consumers_consumerid_contracts_contractid","routeSlug":"/products/oneplatform/apis/oas/organizations/contracts/get_v1_organizations_id_consumers_consumerid_contracts_contractid","metadata":{"seo":{"title":"GET_v1_organizations_id_consumers_consumerId_contracts_contractId","description":"🗑️ DEPRECATED (Will no longer be available in the next release) 🗑️: This API is DEPRECATED and will be removed on 2026-04-01, use API GET '/v1/organizations/{id}/contracts/{contractId}' instead.Security policies: OrganizationsConsumerContractsView"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_v1_organizations_id_consumers_consumerId_contracts_contractId","name":"GET_v1_organizations_id_consumers_consumerId_contracts_contractId","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1contracts~1{contractId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"GET_v1_organizations_id_consumers_consumerId_contracts_contractId","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🗑️ DEPRECATED (Will no longer be available in the next release) 🗑️"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This API is DEPRECATED and will be removed on 2026-04-01, use API GET '/v1/organizations/{id}/contracts/{contractId}' instead."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationsConsumerContractsView"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true},{"name":"consumerId","in":"path","schemaId":"schema_0","required":true},{"name":"contractId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1contracts~1{contractId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/{id}/consumers/{consumerId}/contracts/{contractId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"},{"name":"consumerId","in":"path","required":true,"schemaId":"schema_0"},{"name":"contractId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","500"],"pointer":"/v1/organizations/{id}/consumers/{consumerId}/contracts/{contractId}","href":"contracts/get_v1_organizations_id_consumers_consumerid_contracts_contractid","openApiOperationId":"GET_v1_organizations_id_consumers_consumerId_contracts_contractId"},"isWebhook":false,"hideReplay":false,"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/ContractDto"}},"schemaId":"components/schemas/ContractDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1consumers~1{consumerId}~1contracts~1{contractId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContractDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contracts/get_v1_organizations_id_consumers_consumerid_contracts_contractid"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/consumers/{consumerId}/contracts/{contractId}"},{"label":"Update status of contract to pending","deprecated":true,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/contracts/put_v1_organizations_id_contracts_contractid_status_pending","routeSlug":"/products/oneplatform/apis/oas/organizations/contracts/put_v1_organizations_id_contracts_contractid_status_pending","metadata":{"seo":{"title":"Update status of contract to pending","description":"⚠️ DEPRECATED ⚠️: This API is DEPRECATED and will be removed on 2026-11-01, use API PUT '/v1/contracts/{contractId}/status/final' instead.Security policies: OrganizationOrGlobalContractEdit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_v1_organizations_id_contracts_contractId_status_pending","name":"Update status of contract to pending","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}~1status~1pending/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update status of contract to pending","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ DEPRECATED ⚠️"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This API is DEPRECATED and will be removed on 2026-11-01, use API PUT '/v1/contracts/{contractId}/status/final' instead."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationOrGlobalContractEdit"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contractId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}~1status~1pending/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/organizations/{id}/contracts/{contractId}/status/pending","servers":[{"url":"/"}],"parameters":{"path":[{"name":"contractId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/v1/organizations/{id}/contracts/{contractId}/status/pending","href":"contracts/put_v1_organizations_id_contracts_contractid_status_pending","openApiOperationId":"PUT_v1_organizations_id_contracts_contractId_status_pending","summary":"Update status of contract to pending"},"isWebhook":false,"hideReplay":false,"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/GuidDto"}},"schemaId":"components/schemas/GuidDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1contracts~1{contractId}~1status~1pending/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GuidDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuidDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contracts/put_v1_organizations_id_contracts_contractid_status_pending"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/contracts/{contractId}/status/pending"}],"content":{"contentType":"group","meta":{"name":"Contracts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contracts","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/organizations/{id}/contracts","summary":"Return a paginated list of contracts related to the organization as party","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contracts/get_v1_organizations_id_contracts","deprecated":false},{"title":"/v1/organizations/{id}/contracts","summary":"Create a contract organization","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contracts/post_v1_organizations_id_contracts","deprecated":false},{"title":"/v1/organizations/{id}/contracts/{contractId}/service-activation-group","summary":"Return service activation group id by contract id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contracts/get_v1_organizations_id_contracts_contractid_service-activation-group","deprecated":false},{"title":"/v1/organizations/{id}/contracts/{contractId}","summary":"Return a contract where given organization is party related in contract","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contracts/get_v1_organizations_id_contracts_contractid","deprecated":false},{"title":"/v1/organizations/{id}/contracts/{contractId}","summary":"Update a contract","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contracts/put_v1_organizations_id_contracts_contractid","deprecated":false},{"title":"/v1/organizations/{id}/contracts/{contractId}","summary":"Delete an organization's contract","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/contracts/delete_v1_organizations_id_contracts_contractid","deprecated":false},{"title":"/v1/organizations/{id}/contracts/{contractId}/status/final","summary":"Update status of contract to final","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contracts/put_v1_organizations_id_contracts_contractid_status_final","deprecated":false},{"title":"/v1/organizations/{id}/contracts/{contractId}/status/expired","summary":"Update status of organization's contract to expired","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contracts/put_v1_organizations_id_contracts_contractid_status_expired","deprecated":false},{"title":"/v1/organizations/{id}/contracts/{contractId}/end-date","summary":"Update end date of contract","prefix":{"name":"put","color":"http-deprecated"},"badges":[],"link":"/contracts/put_v1_organizations_id_contracts_contractid_end-date","deprecated":true},{"title":"/v1/organizations/{id}/consumers/{consumerId}/contracts","summary":"GET_v1_organizations_id_consumers_consumerId_contracts","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/contracts/get_v1_organizations_id_consumers_consumerid_contracts","deprecated":true},{"title":"/v1/organizations/{id}/consumers/{consumerId}/contracts/{contractId}","summary":"GET_v1_organizations_id_consumers_consumerId_contracts_contractId","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/contracts/get_v1_organizations_id_consumers_consumerid_contracts_contractid","deprecated":true},{"title":"/v1/organizations/{id}/contracts/{contractId}/status/pending","summary":"Update status of contract to pending","prefix":{"name":"put","color":"http-deprecated"},"badges":[],"link":"/contracts/put_v1_organizations_id_contracts_contractid_status_pending","deprecated":true}]}]}]}]}},{"type":"group","label":"Counters","link":"/products/oneplatform/apis/oas/organizations/counters","routeSlug":"/products/oneplatform/apis/oas/organizations/counters","items":[{"label":"Get product counters as aggregated for a consumer based on related consumer associated to given organization.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/counters/get_v1_organizations_id_counters-aggregated_consumers_consumerid","routeSlug":"/products/oneplatform/apis/oas/organizations/counters/get_v1_organizations_id_counters-aggregated_consumers_consumerid","metadata":{"seo":{"title":"Get product counters as aggregated for a consumer based on related consumer associated to given organization.","description":"Security policies: OrganizationsCountersView"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_v1_organizations_id_counters-aggregated_consumers_consumerId","name":"Get product counters as aggregated for a consumer based on related consumer associated to given organization.","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1counters-aggregated~1consumers~1{consumerId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get product counters as aggregated for a consumer based on related consumer associated to given organization.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationsCountersView"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"The identifier of the organization which associated consumer should be used as parent consumer filter for given\r\nchild consumer\r\naggregated counters.","required":true},{"name":"consumerId","in":"path","schemaId":"schema_0","description":"The consumer identifier for which aggregated counters are desired.","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1counters-aggregated~1consumers~1{consumerId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"productId","in":"query","schemaId":"schema_0","description":"The product identifier for which consumer's aggregated counters should be filtered.","required":true},{"name":"metricId","in":"query","schemaId":"schema_0","description":"The list of metric identifiers for which consumer's aggregated counters should be filtered.\r\nIs JSON array format.","required":true},{"name":"legalEntityId","in":"query","schemaId":"schema_0","description":"The legal entity identifier for which consumer's aggregated consumcountersptions should be\r\nfiltered."},{"name":"rootPath","in":"query","schemaId":"schema_0","description":"The root path for which consumer's aggregated counters should be filtered (activated with\r\nstrict at true)."},{"name":"year","in":"query","schemaId":"schema_1","description":"The year for which consumer's aggregated counters should be filtered.","required":true},{"name":"attributeId","in":"query","schemaId":"schema_0","description":"The attribute identifier for which consumer's aggregated counters should be filtered."},{"name":"strict","in":"query","schemaId":"schema_2","description":"Boolean which defines whether or not to strictly activate given filter params. (Default: false)"},{"name":"integratorId","in":"query","schemaId":"schema_0","description":"The integrator identifier for which aggregated counters are desired (activated with\r\nstrict at true)."},{"name":"owner","in":"query","schemaId":"schema_2","description":"Boolean which defines whether only counters directly owned by provided consumerId should be\r\nreturned (activated with strict at true). (Default: false)"},{"name":"legalEntityMode","in":"query","schemaId":"schema_2"}],"pointer":"/paths/~1v1~1organizations~1{id}~1counters-aggregated~1consumers~1{consumerId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/{id}/counters-aggregated/consumers/{consumerId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"},{"name":"consumerId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"productId","in":"query","required":true,"schemaId":"schema_0"},{"name":"metricId","in":"query","required":true,"schemaId":"schema_0"},{"name":"legalEntityId","in":"query","schemaId":"schema_0"},{"name":"rootPath","in":"query","schemaId":"schema_0"},{"name":"year","in":"query","required":true,"schemaId":"schema_1"},{"name":"attributeId","in":"query","schemaId":"schema_0"},{"name":"strict","in":"query","schemaId":"schema_2"},{"name":"integratorId","in":"query","schemaId":"schema_0"},{"name":"owner","in":"query","schemaId":"schema_2"},{"name":"legalEntityMode","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","500"],"pointer":"/v1/organizations/{id}/counters-aggregated/consumers/{consumerId}","href":"counters/get_v1_organizations_id_counters-aggregated_consumers_consumerid","openApiOperationId":"GET_v1_organizations_id_counters-aggregated_consumers_consumerId","summary":"Get product counters as aggregated for a consumer based on related consumer associated to given organization."},"isWebhook":false,"hideReplay":false,"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/CountersAggregatedConsumerDto"}},"schemaId":"components/schemas/CountersAggregatedConsumerDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1counters-aggregated~1consumers~1{consumerId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CountersAggregatedConsumerDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CountersAggregatedConsumerDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"405","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/counters/get_v1_organizations_id_counters-aggregated_consumers_consumerid"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/counters-aggregated/consumers/{consumerId}"}],"content":{"contentType":"group","meta":{"name":"Counters"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Counters","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/organizations/{id}/counters-aggregated/consumers/{consumerId}","summary":"Get product counters as aggregated for a consumer based on related consumer associated to given organization.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/counters/get_v1_organizations_id_counters-aggregated_consumers_consumerid","deprecated":false}]}]}]}]}},{"type":"group","label":"Product Metrics","link":"/products/oneplatform/apis/oas/organizations/product-metrics","routeSlug":"/products/oneplatform/apis/oas/organizations/product-metrics","items":[{"label":"Get product metrics for a consumer based on related consumer associated to given organization.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/product-metrics/get_v1_organizations_id_product-metrics_consumers_consumerid","routeSlug":"/products/oneplatform/apis/oas/organizations/product-metrics/get_v1_organizations_id_product-metrics_consumers_consumerid","metadata":{"seo":{"title":"Get product metrics for a consumer based on related consumer associated to given organization.","description":"Security policies: OrganizationsMetricsView"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_v1_organizations_id_product-metrics_consumers_consumerId","name":"Get product metrics for a consumer based on related consumer associated to given organization.","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1product-metrics~1consumers~1{consumerId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get product metrics for a consumer based on related consumer associated to given organization.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationsMetricsView"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"The identifier of the organization which associated consumer should be used as parent consumer filter for given\r\nchild consumer\r\nmetrics.","required":true},{"name":"consumerId","in":"path","schemaId":"schema_0","description":"The ID of the consumer for which metrics are desired.","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1product-metrics~1consumers~1{consumerId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"legalEntityMode","in":"query","schemaId":"schema_2"}],"pointer":"/paths/~1v1~1organizations~1{id}~1product-metrics~1consumers~1{consumerId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/{id}/product-metrics/consumers/{consumerId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"},{"name":"consumerId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"legalEntityMode","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/v1/organizations/{id}/product-metrics/consumers/{consumerId}","href":"product-metrics/get_v1_organizations_id_product-metrics_consumers_consumerid","openApiOperationId":"GET_v1_organizations_id_product-metrics_consumers_consumerId","summary":"Get product metrics for a consumer based on related consumer associated to given organization."},"isWebhook":false,"hideReplay":false,"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/ListDtoOfProductMetricsDto"}},"schemaId":"components/schemas/ListDtoOfProductMetricsDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1product-metrics~1consumers~1{consumerId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListDtoOfProductMetricsDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListDtoOfProductMetricsDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-metrics/get_v1_organizations_id_product-metrics_consumers_consumerid"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/product-metrics/consumers/{consumerId}"}],"content":{"contentType":"group","meta":{"name":"Product Metrics"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product Metrics","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/organizations/{id}/product-metrics/consumers/{consumerId}","summary":"Get product metrics for a consumer based on related consumer associated to given organization.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/product-metrics/get_v1_organizations_id_product-metrics_consumers_consumerid","deprecated":false}]}]}]}]}},{"type":"group","label":"Service Activation Groups","link":"/products/oneplatform/apis/oas/organizations/service-activation-groups","routeSlug":"/products/oneplatform/apis/oas/organizations/service-activation-groups","items":[{"label":"Advance status of service activation group to 'Confirmed'","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/service-activation-groups/put_v1_organizations_id_service-activation-groups_serviceactivationgroupid_confirm","routeSlug":"/products/oneplatform/apis/oas/organizations/service-activation-groups/put_v1_organizations_id_service-activation-groups_serviceactivationgroupid_confirm","metadata":{"seo":{"title":"Advance status of service activation group to 'Confirmed'","description":"Security policies: OrganizationOrGlobalContractEditByOrganization"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_v1_organizations_id_service-activation-groups_serviceActivationGroupId_confirm","name":"Advance status of service activation group to 'Confirmed'","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1service-activation-groups~1{serviceActivationGroupId}~1confirm/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Advance status of service activation group to 'Confirmed'","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationOrGlobalContractEditByOrganization"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true},{"name":"serviceActivationGroupId","in":"path","schemaId":"schema_0","description":"Id of group","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1service-activation-groups~1{serviceActivationGroupId}~1confirm/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sendNotification","in":"query","schemaId":"schema_2","description":"Optional flag to control whether contract ready email notification should be sent. When false or not provided, no email is sent."}],"pointer":"/paths/~1v1~1organizations~1{id}~1service-activation-groups~1{serviceActivationGroupId}~1confirm/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/organizations/{id}/service-activation-groups/{serviceActivationGroupId}/confirm","servers":[{"url":"/"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"},{"name":"serviceActivationGroupId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"sendNotification","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/v1/organizations/{id}/service-activation-groups/{serviceActivationGroupId}/confirm","href":"service-activation-groups/put_v1_organizations_id_service-activation-groups_serviceactivationgroupid_confirm","openApiOperationId":"PUT_v1_organizations_id_service-activation-groups_serviceActivationGroupId_confirm","summary":"Advance status of service activation group to 'Confirmed'"},"isWebhook":false,"hideReplay":false,"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/ServiceActivationGroupConfirmResponseDto"}},"schemaId":"components/schemas/ServiceActivationGroupConfirmResponseDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1service-activation-groups~1{serviceActivationGroupId}~1confirm/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ServiceActivationGroupConfirmResponseDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceActivationGroupConfirmResponseDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/service-activation-groups/put_v1_organizations_id_service-activation-groups_serviceactivationgroupid_confirm"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/service-activation-groups/{serviceActivationGroupId}/confirm"},{"label":"Create a service activation group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/service-activation-groups/post_v1_organizations_id_service-activation-groups","routeSlug":"/products/oneplatform/apis/oas/organizations/service-activation-groups/post_v1_organizations_id_service-activation-groups","metadata":{"seo":{"title":"Create a service activation group","description":"Security policies: OrganizationOrGlobalContractCreate"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_v1_organizations_id_service-activation-groups","name":"Create a service activation group","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1service-activation-groups/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a service activation group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationOrGlobalContractCreate"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ServiceActivationGroupBaseDto"}},"schemaId":"components/schemas/ServiceActivationGroupBaseDto","pointer":"/paths/~1v1~1organizations~1{id}~1service-activation-groups/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/organizations/{id}/service-activation-groups","servers":[{"url":"/"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ServiceActivationGroupBaseDto"}},"responseCodes":["200","400","401","403","500"],"pointer":"/v1/organizations/{id}/service-activation-groups","href":"service-activation-groups/post_v1_organizations_id_service-activation-groups","openApiOperationId":"POST_v1_organizations_id_service-activation-groups","summary":"Create a service activation group"},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/ServiceActivationGroupBaseDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ServiceActivationGroupBaseDto"}},"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/GuidDto"}},"schemaId":"components/schemas/GuidDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1service-activation-groups/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GuidDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuidDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/service-activation-groups/post_v1_organizations_id_service-activation-groups"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/service-activation-groups"},{"label":"Add contracts to an existing service activation group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/service-activation-groups/put_v1_organizations_id_service-activation-groups_serviceactivationgroupid_add-contracts","routeSlug":"/products/oneplatform/apis/oas/organizations/service-activation-groups/put_v1_organizations_id_service-activation-groups_serviceactivationgroupid_add-contracts","metadata":{"seo":{"title":"Add contracts to an existing service activation group","description":"Security policies: OrganizationOrGlobalContractEdit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_v1_organizations_id_service-activation-groups_serviceActivationGroupId_add-contracts","name":"Add contracts to an existing service activation group","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1service-activation-groups~1{serviceActivationGroupId}~1add-contracts/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add contracts to an existing service activation group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationOrGlobalContractEdit"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"serviceActivationGroupId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1service-activation-groups~1{serviceActivationGroupId}~1add-contracts/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ServiceActivationGroupContractsDto"}},"schemaId":"components/schemas/ServiceActivationGroupContractsDto","pointer":"/paths/~1v1~1organizations~1{id}~1service-activation-groups~1{serviceActivationGroupId}~1add-contracts/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/organizations/{id}/service-activation-groups/{serviceActivationGroupId}/add-contracts","servers":[{"url":"/"}],"parameters":{"path":[{"name":"serviceActivationGroupId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ServiceActivationGroupContractsDto"}},"responseCodes":["200","400","401","403","404","405","500"],"pointer":"/v1/organizations/{id}/service-activation-groups/{serviceActivationGroupId}/add-contracts","href":"service-activation-groups/put_v1_organizations_id_service-activation-groups_serviceactivationgroupid_add-contracts","openApiOperationId":"PUT_v1_organizations_id_service-activation-groups_serviceActivationGroupId_add-contracts","summary":"Add contracts to an existing service activation group"},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/ServiceActivationGroupContractsDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ServiceActivationGroupContractsDto"}},"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/GuidDto"}},"schemaId":"components/schemas/GuidDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1service-activation-groups~1{serviceActivationGroupId}~1add-contracts/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GuidDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuidDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"405","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/service-activation-groups/put_v1_organizations_id_service-activation-groups_serviceactivationgroupid_add-contracts"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/service-activation-groups/{serviceActivationGroupId}/add-contracts"},{"label":"Remove contracts from an existing service activation group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/oneplatform/apis/oas/organizations/service-activation-groups/put_v1_organizations_id_service-activation-groups_serviceactivationgroupid_remove-contracts","routeSlug":"/products/oneplatform/apis/oas/organizations/service-activation-groups/put_v1_organizations_id_service-activation-groups_serviceactivationgroupid_remove-contracts","metadata":{"seo":{"title":"Remove contracts from an existing service activation group","description":"Security policies: OrganizationOrGlobalContractEdit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_v1_organizations_id_service-activation-groups_serviceActivationGroupId_remove-contracts","name":"Remove contracts from an existing service activation group","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1service-activation-groups~1{serviceActivationGroupId}~1remove-contracts/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove contracts from an existing service activation group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security policies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OrganizationOrGlobalContractEdit"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OpenIdConnect","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"serviceActivationGroupId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1service-activation-groups~1{serviceActivationGroupId}~1remove-contracts/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ServiceActivationGroupContractsDto"}},"schemaId":"components/schemas/ServiceActivationGroupContractsDto","pointer":"/paths/~1v1~1organizations~1{id}~1service-activation-groups~1{serviceActivationGroupId}~1remove-contracts/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/organizations/{id}/service-activation-groups/{serviceActivationGroupId}/remove-contracts","servers":[{"url":"/"}],"parameters":{"path":[{"name":"serviceActivationGroupId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ServiceActivationGroupContractsDto"}},"responseCodes":["200","400","401","403","404","405","500"],"pointer":"/v1/organizations/{id}/service-activation-groups/{serviceActivationGroupId}/remove-contracts","href":"service-activation-groups/put_v1_organizations_id_service-activation-groups_serviceactivationgroupid_remove-contracts","openApiOperationId":"PUT_v1_organizations_id_service-activation-groups_serviceActivationGroupId_remove-contracts","summary":"Remove contracts from an existing service activation group"},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/ServiceActivationGroupContractsDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ServiceActivationGroupContractsDto"}},"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/GuidDto"}},"schemaId":"components/schemas/GuidDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1v1~1organizations~1{id}~1service-activation-groups~1{serviceActivationGroupId}~1remove-contracts/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GuidDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuidDto"}}},{"code":"400","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"405","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/service-activation-groups/put_v1_organizations_id_service-activation-groups_serviceactivationgroupid_remove-contracts"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/service-activation-groups/{serviceActivationGroupId}/remove-contracts"}],"content":{"contentType":"group","meta":{"name":"Service Activation Groups"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Service Activation Groups","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/organizations/{id}/service-activation-groups/{serviceActivationGroupId}/confirm","summary":"Advance status of service activation group to 'Confirmed'","prefix":{"name":"put","color":"put"},"badges":[],"link":"/service-activation-groups/put_v1_organizations_id_service-activation-groups_serviceactivationgroupid_confirm","deprecated":false},{"title":"/v1/organizations/{id}/service-activation-groups","summary":"Create a service activation group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/service-activation-groups/post_v1_organizations_id_service-activation-groups","deprecated":false},{"title":"/v1/organizations/{id}/service-activation-groups/{serviceActivationGroupId}/add-contracts","summary":"Add contracts to an existing service activation group","prefix":{"name":"put","color":"put"},"badges":[],"link":"/service-activation-groups/put_v1_organizations_id_service-activation-groups_serviceactivationgroupid_add-contracts","deprecated":false},{"title":"/v1/organizations/{id}/service-activation-groups/{serviceActivationGroupId}/remove-contracts","summary":"Remove contracts from an existing service activation group","prefix":{"name":"put","color":"put"},"badges":[],"link":"/service-activation-groups/put_v1_organizations_id_service-activation-groups_serviceactivationgroupid_remove-contracts","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/AsnEncodedData":{"id":"components/schemas/AsnEncodedData","kind":"json-schema","title":"AsnEncodedData","data":{"type":"object","properties":{"oid":{"$ref":"#/components/schemas/Oid"},"rawData":{"type":"string","format":"byte"}},"additionalProperties":false}},"components/schemas/AsymmetricAlgorithm":{"id":"components/schemas/AsymmetricAlgorithm","kind":"json-schema","title":"AsymmetricAlgorithm","data":{"type":"object","properties":{"keySize":{"type":"integer","format":"int32"},"legalKeySizes":{"type":"array","items":{"$ref":"#/components/schemas/KeySizes"},"readOnly":true},"signatureAlgorithm":{"type":"string","nullable":true,"readOnly":true},"keyExchangeAlgorithm":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}},"components/schemas/AttributeDto":{"id":"components/schemas/AttributeDto","kind":"json-schema","title":"AttributeDto","data":{"required":["id"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"id of the attribute","example":"your-attribute"},"label":{"type":"object","additionalProperties":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dictionary of attribute's label localized in different languages"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"!!! IMPORTANT !!!"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ENGLISH is the default language, so the label in english must be always present"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. {"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"en\": \"attribute label in english\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"it\": \"label dell'attributo in italiano\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"de\": \"...\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"fr\": \"...\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"es\": \"...\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"pt\": \"...\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"ro\": \"...\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}"},"children":[]}]}]}],"example":{"en":"attribute label in english","it":"label dell'attributo in italiano","de":"...","fr":"...","es":"...","pt":"...","ro":"..."}}},"additionalProperties":false}},"components/schemas/BillingModelBaseDto":{"id":"components/schemas/BillingModelBaseDto","kind":"json-schema","title":"BillingModelBaseDto","data":{"type":"object","properties":{"name":{"type":"string","description":"Unique name identifier of this billing model"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"Description for this billing model"},"parameters":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ContractBaseParameterDto"},"description":"Parameters used for computation of the billing model"},"items":{"type":"array","items":{"$ref":"#/components/schemas/BillingModelItemDto"},"description":"List of skus linked to this billing model"}},"additionalProperties":false}},"components/schemas/BillingModelItemDto":{"id":"components/schemas/BillingModelItemDto","kind":"json-schema","title":"BillingModelItemDto","data":{"type":"object","properties":{"skuId":{"type":"string","description":"Sku code"},"sku":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🗑️ DEPRECATED (Will no longer be available in the next release) 🗑️"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This property is DEPRECATED and will be removed on 2026-04-01, use property 'SkuId' instead."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}],"deprecated":true}},"additionalProperties":false,"description":"Item of sku cluster used in billing model"}},"components/schemas/BusinessRelationDto":{"id":"components/schemas/BusinessRelationDto","kind":"json-schema","title":"BusinessRelationDto","data":{"type":"object","properties":{"productId":{"type":"string","description":"Product identifier.","example":"eSAW"},"legalEntityId":{"type":"string","description":"Legal entity identifier.","example":"4eb8a4d7-ec5a-48ba-b3b4-4cbe913e7691"},"consumerIdsPath":{"type":"string","description":"Path of consumer identifiers.","example":"0d7c80ad-fd7f-40ef-9d97-b05dcf6ef911/2a0e7122-f9d3-42cf-b14e-87b5c26c7f69"},"integratorId":{"type":"string","description":"Integrator identifier (An optional property and default is an empty string).","example":"integrator-id"},"integratorLabel":{"type":"string","description":"Integrator label (An optional property used to replace the provided integratorId with a human-readable label).","example":"integrator-label"},"originId":{"type":"string","description":"Origin business relation identifier.","nullable":true,"example":"2586e4f4-3eb5-4310-ada0-e30033101386"},"resourceType":{"enum":["Consumption","Contract"],"type":"string","description":"Resource type.","format":"int32","example":"Consumption"},"disabled":{"type":"boolean","description":"Whether this business relation is disabled for consumption inputs."},"id":{"type":"string","description":"Identifier of the business relation.","example":"4ec74e45-8262-469c-8182-7c23af8ed44e"},"legalEntityName":{"type":"string","description":"Name of legal entity.","nullable":true,"example":"NAMIRIAL S.P.A."},"consumerNamesPath":{"type":"array","items":{"type":"string"},"description":"Name of consumers in the path of consumer identifiers.","nullable":true},"createdAt":{"type":"string","description":"Date and time indicating when this business relation was created.","format":"date-time","example":"2023-11-28T08:14:32.585Z"},"updatedAt":{"type":"string","description":"Date and time indicating when this business relation was last updated.","format":"date-time","example":"2023-11-28T08:14:32.585Z"}},"additionalProperties":false}},"components/schemas/ConsumerAdditionalInfosDto":{"id":"components/schemas/ConsumerAdditionalInfosDto","kind":"json-schema","title":"ConsumerAdditionalInfosDto","data":{"type":"object","properties":{"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Custom meta data dictionary of the consumer.","example":{"your-property":"value of property"}}},"additionalProperties":false}},"components/schemas/ConsumerBaseWithoutCrmDto":{"id":"components/schemas/ConsumerBaseWithoutCrmDto","kind":"json-schema","title":"ConsumerBaseWithoutCrmDto","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the consumer.\n","example":"NAMIRIAL S.P.A."},"firstName":{"type":"string","description":"First name of the individual customer.\n"},"lastName":{"type":"string","description":"Last name of the individual customer.\n"},"customerType":{"enum":["None","ProfessionalIndividual","Corporate","PublicAdministration","NonProfit","PrivateIndividual"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are: None, PrivateIndividual, ProfessionalIndividual, Corporate, PublicAdministration, NonProfit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the Type is Customer and CustomerType is None the CustomerType is automatically generated according to the following rules:"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| CustomerType........ | TaxCode1  | TaxCode2    | TaxCode3   |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| CustomerType........ | (VAT)     | (TAXNUMBER) | (PANUMBER) |"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| NonProfit........... | empty.... | length 11.. | empty..... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| NonProfit........... | empty.... | length 29.. | empty..... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Corporate........... | length 11 | length 11.. | empty..... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Corporate........... | length 29 | length 11.. | empty..... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Corporate........... | length 29 | length 29.. | empty..... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PrivateIndividual... | empty.... | length 16.. | empty..... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| ProfessionalIndividual | length 11 | length 16.. | empty..... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| ProfessionalIndividual | length 29 | length 16.. | empty..... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | empty.... | length 11.. | length 6.. |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | empty.... | length 29.. | length 6.. |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | length 11 | length 11.. | length 6.. |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | length 29 | length 11.. | length 6.. |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | length 29 | length 29.. | length 6.. |"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Without a type, it is not possible to define a NonProfit with TaxCode1."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is still recommended when you have the type in hand to manually define the CustomerType with the correct type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For FRENCH consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are: PrivateIndividual, ProfessionalIndividual, Corporate"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auto mode is not provided"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For all other consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are: PrivateIndividual, ProfessionalIndividual, Corporate"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEFAULT: None"},"children":[]}]}]}],"format":"int32","example":"Corporate"},"country":{"type":"string","description":"Country of the consumer. The format is ISO 3166-1 alpha-2 (cca2).","example":"IT"},"taxCode1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax code 1 of the consumer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ITALIAN consumers is VAT:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGULAR VAT:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 11 digits."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are digits (0-9)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is validated with Italian specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEMPORARY VAT:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary VAT is used only for customers that do not have a regular VAT yet."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary VAT is composed by a header \"T01\" and a ULID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 29 chars: 3 header chars and 26 ULID chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are 0-9, A-H, J-K, M-N, P-T, V-Z. The format is validated with ULID specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is mandatory for: LegalEntity, Customer-Corporate"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: Customer-PrivateIndividual, Customer-ProfessionalIndividual, Customer-NonProfit, Customer-PublicAdministration"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For FRENCH consumers is TVA:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGULAR TVA:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 13 chars: prefix \"FR\" + 2 chars (A-HJ-NP-Z0-9) + 9 digits."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are digits (0-9) and uppercase letters (A-Z), excluding I and O."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is validated with French specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEMPORARY TVA:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary TVA is used only for customers that do not have a regular TVA yet."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary TVA is composed by a header \"T01\" and a ULID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 29 chars: 3 header chars and 26 ULID chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are 0-9, A-H, J-K, M-N, P-T, V-Z. The format is validated with ULID specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: LegalEntity, Customer-Corporate, Customer-ProfessionalIndividual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: Customer-PrivateIndividual, Customer-NonProfit, Customer-PublicAdministration, InternalUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For all other consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are uppercase letters (A-Z), digits (0-9), symbols dot (.), hyphen (-) and slash (/)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: LegalEntity, Customer-Corporate, Customer-PrivateIndividual, Customer-ProfessionalIndividual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]}]},"taxCode2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax code 2 of the consumer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ITALIAN consumers is TAXNUMBER:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERSON TAXNUMBER:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 16 chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are digits and letters (0-9, A-Z)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is validated with Italian specifications."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only for: Customer-PrivateIndividual, Customer-ProfessionalIndividual"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGULAR TAXNUMBER:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 11 digits."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are digits (0-9)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is validated with Italian specifications."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only for: LegalEntity, Customer-Corporate, Customer-NonProfit, Customer-PublicAdministration"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEMPORARY TAXNUMBER:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary TAXNUMBER is used only for customers that do not have a regular TAXNUMBER yet."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary TAXNUMBER is composed by a header \"T01\" and a ULID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 29 chars: 3 header chars and 26 ULID chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are 0-9, A-H, J-K, M-N, P-T, V-Z. The format is validated with ULID specifications."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only for: Customer-Corporate, Customer-NonProfit, Customer-PublicAdministration"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For FRENCH consumers is SIREN:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGULAR SIREN:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 9 digits."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are digits (0-9)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is validated with French specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEMPORARY SIREN:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary SIREN is used only for customers that do not have a regular SIREN yet."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary SIREN is composed by a header \"T01\" and a ULID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 29 chars: 3 header chars and 26 ULID chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are 0-9, A-H, J-K, M-N, P-T, V-Z. The format is validated with ULID specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: LegalEntity, Customer-Corporate, Customer-ProfessionalIndividual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: Customer-PrivateIndividual, Customer-NonProfit, Customer-PublicAdministration, InternalUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For all other consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are uppercase letters (A-Z), digits (0-9), symbols dot (.), hyphen (-) and slash (/)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: LegalEntity, Customer-Corporate, Customer-PrivateIndividual, Customer-ProfessionalIndividual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]}]},"taxCode3":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax code 3 of the consumer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ITALIAN consumers is PANUMBER:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGULAR PANUMBER:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 6 chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are uppercase letters (A-Z) and digits (0-9)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is validated with Italian specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is mandatory for: Customer-PublicAdministration"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: LegalEntity, Customer-Corporate, Customer-PrivateIndividual, Customer-ProfessionalIndividual, Customer-NonProfit, InternalUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For FRENCH consumers is SIRET:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGULAR SIRET:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 14 digits."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are digits (0-9)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is validated with French specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEMPORARY SIRET:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary SIRET is used only for customers that do not have a regular SIRET yet."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary SIRET is composed by a header \"T01\" and a ULID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 29 chars: 3 header chars and 26 ULID chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are 0-9, A-H, J-K, M-N, P-T, V-Z. The format is validated with ULID specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: LegalEntity, Customer-Corporate, Customer-ProfessionalIndividual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: Customer-PrivateIndividual, Customer-NonProfit, Customer-PublicAdministration, InternalUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For all other consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are uppercase letters (A-Z), digits (0-9), symbols dot (.), hyphen (-) and slash (/)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: LegalEntity, Customer-Corporate, Customer-PrivateIndividual, Customer-ProfessionalIndividual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]}]},"isValidatedTaxCodes":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the tax codes have been validated against country-specific standards"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(VAT/TaxNumber/PaNumber for Italy, Tva/Siren/Siret for France)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assigned exclusively by backend rules — ignored on input."},"children":[]}]}]}]},"type":{"enum":["Customer","LegalEntity","InternalUnit"],"type":"string","description":"Consumer type (Customer, LegalEntity, InternalUnit).\n\r\nIn the creation of a consumer by integrators is forbidden the creation of a consumer with LegalEntity type.\n\n\r\nDEFAULT: Customer\n","format":"int32","example":"Customer"},"billable":{"type":"boolean","description":"Billable consumer.\n\r\nFor InternalUnit type must be false.","example":true},"address":{"type":"string","description":"Billing address of the consumer.\n\r\nIs mandatory when Billable is true.","example":"Via Caduti sul Lavoro, 4"},"state":{"type":"string","description":"Billing state of the consumer.\n\r\nIs mandatory when Billable is true.\n\r\nFor ITALIAN consumers is validated with the italian state list.","example":"AN"},"city":{"type":"string","description":"Billing city of the consumer.\n\r\nIs mandatory when Billable is true.\n\r\nFor ITALIAN consumers is validated with the italian state city list.","example":"Senigallia"},"postalCode":{"type":"string","description":"Billing postal code of the consumer.\n\r\nIs mandatory when Billable is true.\n\r\nFor ITALIAN consumers is validated with the italian state city postal code list.","example":"60019"},"emails":{"type":"array","items":{"type":"string"},"description":"Contact emails of the consumer.\n\r\nOne email is mandatory when Billable is true.","example":["info@namirial.com"]},"pecs":{"type":"array","items":{"type":"string"},"description":"Contact pecs of the consumer.\n","example":["amm.namirial@sicurezzapostale.it"]},"phones":{"type":"array","items":{"type":"string"},"description":"Contact phones of the consumer.\n\r\nIs validated for consumer country.","example":["+3907163494"]},"mobilePhones":{"type":"array","items":{"type":"string"},"description":"Contact mobile phones of the consumer.\n\r\nIs validated for consumer country.","example":["+393384234567"]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Custom meta data dictionary of the consumer.","example":{"your-property":"value of property"}},"birthInfo":{"$ref":"#/components/schemas/ConsumerBirthInfoDto"},"residenceInfo":{"$ref":"#/components/schemas/ConsumerResidenceInfoDto"},"businessType":{"enum":["None","Reseller"],"type":"string","description":"Consumer business type.","format":"int32"}},"additionalProperties":false}},"components/schemas/ConsumerBaseWithoutCrmDtoV1":{"id":"components/schemas/ConsumerBaseWithoutCrmDtoV1","kind":"json-schema","title":"ConsumerBaseWithoutCrmDtoV1","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the consumer.\n","example":"NAMIRIAL S.P.A."},"firstName":{"type":"string","description":"First name of the individual customer.\n"},"lastName":{"type":"string","description":"Last name of the individual customer.\n"},"customerType":{"enum":["None","Individual","Corporate","PublicAdministration","NonProfit"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are: None, Individual, Corporate, PublicAdministration, NonProfit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the Type is Customer and CustomerType is None the CustomerType is automatically generated according to the following rules:"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| CustomerType........ | Vat...... | TaxNumber | PaNumber |"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| NonProfit........... | empty.... | length 11 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| NonProfit........... | empty.... | length 29 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Corporate........... | length 11 | length 11 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Corporate........... | length 29 | length 11 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Corporate........... | length 29 | length 29 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Individual.......... | empty.... | length 16 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Individual.......... | length 11 | length 16 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Individual.......... | length 29 | length 16 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | empty.... | length 11 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | empty.... | length 29 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | length 11 | length 11 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | length 29 | length 11 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | length 29 | length 29 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Without a type, it is not possible to define a NonProfit with Vat."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is still recommended when you have the type in hand to manually define the CustomerType with the correct type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For NO ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are: None, Individual, Corporate"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEFAULT: None"},"children":[]}]}]}],"format":"int32","example":"Corporate"},"country":{"type":"string","description":"Country of the consumer. The format is ISO 3166-1 alpha-2 (cca2).","example":"IT"},"vat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vat of the consumer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGULAR VAT:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 11 chars. The format is validated with italian specifications."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are numbers (0-9)."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEMPORARY VAT:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary VAT is used only for customers that do not have a regular VAT yet."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary VAT is composed by a header \"T01\" and a ULID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 29 chars: 3 header chars and 26 ULID chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are 0-9, A-H, J-K, M-N, P-T, V-Z. The format is validated with ULID specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is mandatory for: LegalEntity, Customer-Corporate"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: Customer-Individual, Customer-NonProfit, Customer-Public-Administration"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For NO ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are uppercase letters (A-Z), numbers (0-9), symbols dot (.), hyphen (-) and slash (/)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: Legal-Entity, Customer-Corporate, Customer-Individual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]}]},"taxNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax number of the consumer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERSON TAXNUMBER (16 chars). Only for Customer-Individual"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 16 chars. The format is validated with italian specifications."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are numbers (0-9, A-Z)."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGULAR TAXNUMBER (11 chars). Only for LegalEntity, Customer-Corporate, Customer-NonProfit, Customer-PublicAdministration"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 11 chars. The format is validated with italian specifications."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are numbers (0-9)."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEMPORARY TAXNUMBER (29 chars). Only for Customer-Corporate, Customer-NonProfit, Customer-PublicAdministration:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary TAXNUMBER is used only for customers that do not have a regular TAXNUMBER yet."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary TAXNUMBER is composed by a header \"T01\" and a ULID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 29 chars: 3 header chars and 26 ULID chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are 0-9, A-H, J-K, M-N, P-T, V-Z. The format is validated with ULID specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For NO ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are uppercase letters (A-Z), numbers (0-9), symbols dot (.), hyphen (-) and slash (/)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: Legal-Entity, Customer-Corporate, Customer-Individual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]}]},"paNumber":{"type":"string","description":"PA number of the consumer.\n\n\r\nFor ITALIAN consumers:\n\r\nValid characters are uppercase letters (A-Z) and numbers (0-9). The format is validated with italian specifications.\n\r\nIs mandatory for: Customer-PublicAdministration\n\r\nMust be empty for: LegalEntity, Customer-Corporate, Customer-Individual, Customer-NonProfit, InternalUnit\n\n\r\nFor all other consumers:\n\r\nValid characters are uppercase letters (A-Z), digits (0-9), symbols dot (.), hyphen (-) and slash (/).\n\r\nIs optional for: LegalEntity, Customer-Corporate, Customer-PrivateIndividual, Customer-ProfessionalIndividual\n\r\nMust be empty for: InternalUnit","example":"UFCGFV"},"type":{"enum":["Customer","LegalEntity","InternalUnit"],"type":"string","description":"Consumer type (Customer, LegalEntity, InternalUnit).\n\r\nIn the creation of a consumer by integrators is forbidden the creation of a consumer with LegalEntity type.\n\n\r\nDEFAULT: Customer\n","format":"int32","example":"Customer"},"billable":{"type":"boolean","description":"Billable consumer.\n\r\nFor InternalUnit type must be false.","example":true},"address":{"type":"string","description":"Billing address of the consumer.\n\r\nIs mandatory when Billable is true.","example":"Via Caduti sul Lavoro, 4"},"state":{"type":"string","description":"Billing state of the consumer.\n\r\nIs mandatory when Billable is true.\n\r\nFor ITALIAN consumers is validated with the italian state list.","example":"AN"},"city":{"type":"string","description":"Billing city of the consumer.\n\r\nIs mandatory when Billable is true.\n\r\nFor ITALIAN consumers is validated with the italian state city list.","example":"Senigallia"},"postalCode":{"type":"string","description":"Billing postal code of the consumer.\n\r\nIs mandatory when Billable is true.\n\r\nFor ITALIAN consumers is validated with the italian state city postal code list.","example":"60019"},"emails":{"type":"array","items":{"type":"string"},"description":"Contact emails of the consumer.\n\r\nOne email is mandatory when Billable is true.","example":["info@namirial.com"]},"pecs":{"type":"array","items":{"type":"string"},"description":"Contact pecs of the consumer.\n","example":["amm.namirial@sicurezzapostale.it"]},"phones":{"type":"array","items":{"type":"string"},"description":"Contact phones of the consumer.\n\r\nIs validated for consumer country.","example":["+3907163494"]},"mobilePhones":{"type":"array","items":{"type":"string"},"description":"Contact mobile phones of the consumer.\n\r\nIs validated for consumer country.","example":["+393384234567"]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Custom meta data dictionary of the consumer.","example":{"your-property":"value of property"}},"birthInfo":{"$ref":"#/components/schemas/ConsumerBirthInfoDto"},"residenceInfo":{"$ref":"#/components/schemas/ConsumerResidenceInfoDto"},"businessType":{"enum":["None","Reseller"],"type":"string","description":"Consumer business type.","format":"int32"}},"additionalProperties":false}},"components/schemas/ConsumerBillingInfosDto":{"id":"components/schemas/ConsumerBillingInfosDto","kind":"json-schema","title":"ConsumerBillingInfosDto","data":{"type":"object","properties":{"billable":{"type":"boolean","description":"Billable consumer.\n\r\nFor InternalUnit type must be false.","example":true},"address":{"type":"string","description":"Billing address of the consumer.\n\r\nIs mandatory when Billable is true.","example":"Via Caduti sul Lavoro, 4"},"state":{"type":"string","description":"Billing state of the consumer.\n\r\nIs mandatory when Billable is true.\n\r\nFor ITALIAN consumers is validated with the italian state list.","example":"AN"},"city":{"type":"string","description":"Billing city of the consumer.\n\r\nIs mandatory when Billable is true.\n\r\nFor ITALIAN consumers is validated with the italian state city list.","example":"Senigallia"},"postalCode":{"type":"string","description":"Billing postal code of the consumer.\n\r\nIs mandatory when Billable is true.\n\r\nFor ITALIAN consumers is validated with the italian state city postal code list.","example":"60019"},"emails":{"type":"array","items":{"type":"string"},"description":"Contact emails of the consumer.\n\r\nOne email is mandatory when Billable is true.","nullable":true,"example":["info@namirial.com"]}},"additionalProperties":false}},"components/schemas/ConsumerBirthInfoDto":{"id":"components/schemas/ConsumerBirthInfoDto","kind":"json-schema","title":"ConsumerBirthInfoDto","data":{"type":"object","properties":{"date":{"type":"string","description":"Date of birth.","format":"date"},"gender":{"enum":["Male","Female"],"type":"string","description":"Gender.","format":"int32"},"country":{"type":"string","description":"Country code of birth."},"state":{"type":"string","description":"State code of birth."},"city":{"type":"string","description":"City of birth."},"postalCode":{"type":"string","description":"Postal code of birth."}},"additionalProperties":false}},"components/schemas/ConsumerContactInfosDto":{"id":"components/schemas/ConsumerContactInfosDto","kind":"json-schema","title":"ConsumerContactInfosDto","data":{"type":"object","properties":{"emails":{"type":"array","items":{"type":"string"},"description":"Contact emails of the consumer.\n\r\nOne email is mandatory when Billable is true.","example":["info@namirial.com"]},"pecs":{"type":"array","items":{"type":"string"},"description":"Contact pecs of the consumer.\n","example":["amm.namirial@sicurezzapostale.it"]},"phones":{"type":"array","items":{"type":"string"},"description":"Contact phones of the consumer.\n\r\nIs validated for consumer country.","example":["+3907163494"]},"mobilePhones":{"type":"array","items":{"type":"string"},"description":"Contact mobile phones of the consumer.\n\r\nIs validated for consumer country.","example":["+393384234567"]}},"additionalProperties":false}},"components/schemas/ConsumerCrmSnapshotDto":{"id":"components/schemas/ConsumerCrmSnapshotDto","kind":"json-schema","title":"ConsumerCrmSnapshotDto","data":{"type":"object","properties":{"id":{"type":"string","description":"CRM consumer identifier."},"name":{"type":"string","description":"CRM consumer name."},"type":{"enum":["Unknown","Corporate","ProfessionalIndividual"],"type":"string","description":"CRM consumer type.","format":"int32"},"country":{"type":"string","description":"CRM consumer country code."},"vat":{"type":"string","description":"CRM consumer VAT number."},"taxNumber":{"type":"string","description":"CRM consumer tax number."},"sdi":{"type":"string","description":"CRM consumer SDI code."},"address":{"type":"string","description":"CRM consumer address."},"city":{"type":"string","description":"CRM consumer city."},"state":{"type":"string","description":"CRM consumer state."},"postalCode":{"type":"string","description":"CRM consumer postal code."},"phones":{"type":"array","items":{"type":"string"},"description":"CRM consumer phones."},"emails":{"type":"array","items":{"type":"string"},"description":"CRM consumer emails."},"pecs":{"type":"array","items":{"type":"string"},"description":"CRM consumer pecs."},"segment":{"type":"string","description":"CRM consumer segment."},"subSegment":{"type":"string","description":"CRM consumer sub-segment."}},"additionalProperties":false}},"components/schemas/ConsumerDto":{"id":"components/schemas/ConsumerDto","kind":"json-schema","title":"ConsumerDto","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the consumer.\n","example":"NAMIRIAL S.P.A."},"firstName":{"type":"string","description":"First name of the individual customer.\n"},"lastName":{"type":"string","description":"Last name of the individual customer.\n"},"customerType":{"enum":["None","ProfessionalIndividual","Corporate","PublicAdministration","NonProfit","PrivateIndividual"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are: None, PrivateIndividual, ProfessionalIndividual, Corporate, PublicAdministration, NonProfit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the Type is Customer and CustomerType is None the CustomerType is automatically generated according to the following rules:"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| CustomerType........ | TaxCode1  | TaxCode2    | TaxCode3   |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| CustomerType........ | (VAT)     | (TAXNUMBER) | (PANUMBER) |"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| NonProfit........... | empty.... | length 11.. | empty..... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| NonProfit........... | empty.... | length 29.. | empty..... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Corporate........... | length 11 | length 11.. | empty..... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Corporate........... | length 29 | length 11.. | empty..... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Corporate........... | length 29 | length 29.. | empty..... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PrivateIndividual... | empty.... | length 16.. | empty..... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| ProfessionalIndividual | length 11 | length 16.. | empty..... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| ProfessionalIndividual | length 29 | length 16.. | empty..... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | empty.... | length 11.. | length 6.. |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | empty.... | length 29.. | length 6.. |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | length 11 | length 11.. | length 6.. |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | length 29 | length 11.. | length 6.. |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | length 29 | length 29.. | length 6.. |"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Without a type, it is not possible to define a NonProfit with TaxCode1."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is still recommended when you have the type in hand to manually define the CustomerType with the correct type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For FRENCH consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are: PrivateIndividual, ProfessionalIndividual, Corporate"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auto mode is not provided"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For all other consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are: PrivateIndividual, ProfessionalIndividual, Corporate"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEFAULT: None"},"children":[]}]}]}],"format":"int32","example":"Corporate"},"country":{"type":"string","description":"Country of the consumer. The format is ISO 3166-1 alpha-2 (cca2).","example":"IT"},"taxCode1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax code 1 of the consumer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ITALIAN consumers is VAT:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGULAR VAT:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 11 digits."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are digits (0-9)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is validated with Italian specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEMPORARY VAT:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary VAT is used only for customers that do not have a regular VAT yet."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary VAT is composed by a header \"T01\" and a ULID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 29 chars: 3 header chars and 26 ULID chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are 0-9, A-H, J-K, M-N, P-T, V-Z. The format is validated with ULID specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is mandatory for: LegalEntity, Customer-Corporate"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: Customer-PrivateIndividual, Customer-ProfessionalIndividual, Customer-NonProfit, Customer-PublicAdministration"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For FRENCH consumers is TVA:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGULAR TVA:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 13 chars: prefix \"FR\" + 2 chars (A-HJ-NP-Z0-9) + 9 digits."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are digits (0-9) and uppercase letters (A-Z), excluding I and O."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is validated with French specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEMPORARY TVA:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary TVA is used only for customers that do not have a regular TVA yet."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary TVA is composed by a header \"T01\" and a ULID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 29 chars: 3 header chars and 26 ULID chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are 0-9, A-H, J-K, M-N, P-T, V-Z. The format is validated with ULID specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: LegalEntity, Customer-Corporate, Customer-ProfessionalIndividual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: Customer-PrivateIndividual, Customer-NonProfit, Customer-PublicAdministration, InternalUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For all other consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are uppercase letters (A-Z), digits (0-9), symbols dot (.), hyphen (-) and slash (/)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: LegalEntity, Customer-Corporate, Customer-PrivateIndividual, Customer-ProfessionalIndividual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]}]},"taxCode2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax code 2 of the consumer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ITALIAN consumers is TAXNUMBER:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERSON TAXNUMBER:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 16 chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are digits and letters (0-9, A-Z)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is validated with Italian specifications."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only for: Customer-PrivateIndividual, Customer-ProfessionalIndividual"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGULAR TAXNUMBER:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 11 digits."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are digits (0-9)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is validated with Italian specifications."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only for: LegalEntity, Customer-Corporate, Customer-NonProfit, Customer-PublicAdministration"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEMPORARY TAXNUMBER:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary TAXNUMBER is used only for customers that do not have a regular TAXNUMBER yet."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary TAXNUMBER is composed by a header \"T01\" and a ULID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 29 chars: 3 header chars and 26 ULID chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are 0-9, A-H, J-K, M-N, P-T, V-Z. The format is validated with ULID specifications."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only for: Customer-Corporate, Customer-NonProfit, Customer-PublicAdministration"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For FRENCH consumers is SIREN:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGULAR SIREN:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 9 digits."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are digits (0-9)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is validated with French specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEMPORARY SIREN:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary SIREN is used only for customers that do not have a regular SIREN yet."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary SIREN is composed by a header \"T01\" and a ULID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 29 chars: 3 header chars and 26 ULID chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are 0-9, A-H, J-K, M-N, P-T, V-Z. The format is validated with ULID specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: LegalEntity, Customer-Corporate, Customer-ProfessionalIndividual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: Customer-PrivateIndividual, Customer-NonProfit, Customer-PublicAdministration, InternalUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For all other consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are uppercase letters (A-Z), digits (0-9), symbols dot (.), hyphen (-) and slash (/)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: LegalEntity, Customer-Corporate, Customer-PrivateIndividual, Customer-ProfessionalIndividual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]}]},"taxCode3":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax code 3 of the consumer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ITALIAN consumers is PANUMBER:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGULAR PANUMBER:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 6 chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are uppercase letters (A-Z) and digits (0-9)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is validated with Italian specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is mandatory for: Customer-PublicAdministration"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: LegalEntity, Customer-Corporate, Customer-PrivateIndividual, Customer-ProfessionalIndividual, Customer-NonProfit, InternalUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For FRENCH consumers is SIRET:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGULAR SIRET:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 14 digits."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are digits (0-9)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is validated with French specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEMPORARY SIRET:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary SIRET is used only for customers that do not have a regular SIRET yet."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary SIRET is composed by a header \"T01\" and a ULID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 29 chars: 3 header chars and 26 ULID chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are 0-9, A-H, J-K, M-N, P-T, V-Z. The format is validated with ULID specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: LegalEntity, Customer-Corporate, Customer-ProfessionalIndividual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: Customer-PrivateIndividual, Customer-NonProfit, Customer-PublicAdministration, InternalUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For all other consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are uppercase letters (A-Z), digits (0-9), symbols dot (.), hyphen (-) and slash (/)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: LegalEntity, Customer-Corporate, Customer-PrivateIndividual, Customer-ProfessionalIndividual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]}]},"isValidatedTaxCodes":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the tax codes have been validated against country-specific standards"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(VAT/TaxNumber/PaNumber for Italy, Tva/Siren/Siret for France)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assigned exclusively by backend rules — ignored on input."},"children":[]}]}]}]},"type":{"enum":["Customer","LegalEntity","InternalUnit"],"type":"string","description":"Consumer type (Customer, LegalEntity, InternalUnit).\n\r\nIn the creation of a consumer by integrators is forbidden the creation of a consumer with LegalEntity type.\n\n\r\nDEFAULT: Customer\n","format":"int32","example":"Customer"},"billable":{"type":"boolean","description":"Billable consumer.\n\r\nFor InternalUnit type must be false.","example":true},"address":{"type":"string","description":"Billing address of the consumer.\n\r\nIs mandatory when Billable is true.","example":"Via Caduti sul Lavoro, 4"},"state":{"type":"string","description":"Billing state of the consumer.\n\r\nIs mandatory when Billable is true.\n\r\nFor ITALIAN consumers is validated with the italian state list.","example":"AN"},"city":{"type":"string","description":"Billing city of the consumer.\n\r\nIs mandatory when Billable is true.\n\r\nFor ITALIAN consumers is validated with the italian state city list.","example":"Senigallia"},"postalCode":{"type":"string","description":"Billing postal code of the consumer.\n\r\nIs mandatory when Billable is true.\n\r\nFor ITALIAN consumers is validated with the italian state city postal code list.","example":"60019"},"emails":{"type":"array","items":{"type":"string"},"description":"Contact emails of the consumer.\n\r\nOne email is mandatory when Billable is true.","example":["info@namirial.com"]},"pecs":{"type":"array","items":{"type":"string"},"description":"Contact pecs of the consumer.\n","example":["amm.namirial@sicurezzapostale.it"]},"phones":{"type":"array","items":{"type":"string"},"description":"Contact phones of the consumer.\n\r\nIs validated for consumer country.","example":["+3907163494"]},"mobilePhones":{"type":"array","items":{"type":"string"},"description":"Contact mobile phones of the consumer.\n\r\nIs validated for consumer country.","example":["+393384234567"]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Custom meta data dictionary of the consumer.","example":{"your-property":"value of property"}},"birthInfo":{"$ref":"#/components/schemas/ConsumerBirthInfoDto"},"residenceInfo":{"$ref":"#/components/schemas/ConsumerResidenceInfoDto"},"businessType":{"enum":["None","Reseller"],"type":"string","description":"Consumer business type.","format":"int32"},"id":{"type":"string","description":"Identifier of the consumer.","example":"6dcd885f-a37b-427f-ab59-d008ae134aab"},"createdAt":{"type":"string","description":"Date and time indicating when this consumer was created.","format":"date-time","example":"2023-11-28T08:14:32.585Z"},"updatedAt":{"type":"string","description":"Date and time indicating when this consumer was last updated.","format":"date-time","example":"2023-11-28T08:14:32.585Z"},"legalEntityId":{"type":"string","description":"Associated legal entity identifier","nullable":true}},"additionalProperties":false}},"components/schemas/ConsumerDtoV1":{"id":"components/schemas/ConsumerDtoV1","kind":"json-schema","title":"ConsumerDtoV1","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the consumer.\n","example":"NAMIRIAL S.P.A."},"firstName":{"type":"string","description":"First name of the individual customer.\n"},"lastName":{"type":"string","description":"Last name of the individual customer.\n"},"customerType":{"enum":["None","Individual","Corporate","PublicAdministration","NonProfit"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are: None, Individual, Corporate, PublicAdministration, NonProfit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the Type is Customer and CustomerType is None the CustomerType is automatically generated according to the following rules:"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| CustomerType........ | Vat...... | TaxNumber | PaNumber |"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| NonProfit........... | empty.... | length 11 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| NonProfit........... | empty.... | length 29 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Corporate........... | length 11 | length 11 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Corporate........... | length 29 | length 11 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Corporate........... | length 29 | length 29 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Individual.......... | empty.... | length 16 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Individual.......... | length 11 | length 16 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Individual.......... | length 29 | length 16 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | empty.... | length 11 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | empty.... | length 29 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | length 11 | length 11 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | length 29 | length 11 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | length 29 | length 29 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Without a type, it is not possible to define a NonProfit with Vat."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is still recommended when you have the type in hand to manually define the CustomerType with the correct type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For NO ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are: None, Individual, Corporate"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEFAULT: None"},"children":[]}]}]}],"format":"int32","example":"Corporate"},"country":{"type":"string","description":"Country of the consumer. The format is ISO 3166-1 alpha-2 (cca2).","example":"IT"},"vat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vat of the consumer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGULAR VAT:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 11 chars. The format is validated with italian specifications."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are numbers (0-9)."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEMPORARY VAT:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary VAT is used only for customers that do not have a regular VAT yet."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary VAT is composed by a header \"T01\" and a ULID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 29 chars: 3 header chars and 26 ULID chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are 0-9, A-H, J-K, M-N, P-T, V-Z. The format is validated with ULID specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is mandatory for: LegalEntity, Customer-Corporate"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: Customer-Individual, Customer-NonProfit, Customer-Public-Administration"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For NO ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are uppercase letters (A-Z), numbers (0-9), symbols dot (.), hyphen (-) and slash (/)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: Legal-Entity, Customer-Corporate, Customer-Individual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]}]},"taxNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax number of the consumer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERSON TAXNUMBER (16 chars). Only for Customer-Individual"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 16 chars. The format is validated with italian specifications."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are numbers (0-9, A-Z)."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGULAR TAXNUMBER (11 chars). Only for LegalEntity, Customer-Corporate, Customer-NonProfit, Customer-PublicAdministration"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 11 chars. The format is validated with italian specifications."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are numbers (0-9)."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEMPORARY TAXNUMBER (29 chars). Only for Customer-Corporate, Customer-NonProfit, Customer-PublicAdministration:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary TAXNUMBER is used only for customers that do not have a regular TAXNUMBER yet."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary TAXNUMBER is composed by a header \"T01\" and a ULID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 29 chars: 3 header chars and 26 ULID chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are 0-9, A-H, J-K, M-N, P-T, V-Z. The format is validated with ULID specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For NO ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are uppercase letters (A-Z), numbers (0-9), symbols dot (.), hyphen (-) and slash (/)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: Legal-Entity, Customer-Corporate, Customer-Individual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]}]},"paNumber":{"type":"string","description":"PA number of the consumer.\n\n\r\nFor ITALIAN consumers:\n\r\nValid characters are uppercase letters (A-Z) and numbers (0-9). The format is validated with italian specifications.\n\r\nIs mandatory for: Customer-PublicAdministration\n\r\nMust be empty for: LegalEntity, Customer-Corporate, Customer-Individual, Customer-NonProfit, InternalUnit\n\n\r\nFor all other consumers:\n\r\nValid characters are uppercase letters (A-Z), digits (0-9), symbols dot (.), hyphen (-) and slash (/).\n\r\nIs optional for: LegalEntity, Customer-Corporate, Customer-PrivateIndividual, Customer-ProfessionalIndividual\n\r\nMust be empty for: InternalUnit","example":"UFCGFV"},"type":{"enum":["Customer","LegalEntity","InternalUnit"],"type":"string","description":"Consumer type (Customer, LegalEntity, InternalUnit).\n\r\nIn the creation of a consumer by integrators is forbidden the creation of a consumer with LegalEntity type.\n\n\r\nDEFAULT: Customer\n","format":"int32","example":"Customer"},"billable":{"type":"boolean","description":"Billable consumer.\n\r\nFor InternalUnit type must be false.","example":true},"address":{"type":"string","description":"Billing address of the consumer.\n\r\nIs mandatory when Billable is true.","example":"Via Caduti sul Lavoro, 4"},"state":{"type":"string","description":"Billing state of the consumer.\n\r\nIs mandatory when Billable is true.\n\r\nFor ITALIAN consumers is validated with the italian state list.","example":"AN"},"city":{"type":"string","description":"Billing city of the consumer.\n\r\nIs mandatory when Billable is true.\n\r\nFor ITALIAN consumers is validated with the italian state city list.","example":"Senigallia"},"postalCode":{"type":"string","description":"Billing postal code of the consumer.\n\r\nIs mandatory when Billable is true.\n\r\nFor ITALIAN consumers is validated with the italian state city postal code list.","example":"60019"},"emails":{"type":"array","items":{"type":"string"},"description":"Contact emails of the consumer.\n\r\nOne email is mandatory when Billable is true.","example":["info@namirial.com"]},"pecs":{"type":"array","items":{"type":"string"},"description":"Contact pecs of the consumer.\n","example":["amm.namirial@sicurezzapostale.it"]},"phones":{"type":"array","items":{"type":"string"},"description":"Contact phones of the consumer.\n\r\nIs validated for consumer country.","example":["+3907163494"]},"mobilePhones":{"type":"array","items":{"type":"string"},"description":"Contact mobile phones of the consumer.\n\r\nIs validated for consumer country.","example":["+393384234567"]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Custom meta data dictionary of the consumer.","example":{"your-property":"value of property"}},"birthInfo":{"$ref":"#/components/schemas/ConsumerBirthInfoDto"},"residenceInfo":{"$ref":"#/components/schemas/ConsumerResidenceInfoDto"},"businessType":{"enum":["None","Reseller"],"type":"string","description":"Consumer business type.","format":"int32"},"id":{"type":"string","description":"Identifier of the consumer.","example":"6dcd885f-a37b-427f-ab59-d008ae134aab"},"createdAt":{"type":"string","description":"Date and time indicating when this consumer was created.","format":"date-time","example":"2023-11-28T08:14:32.585Z"},"updatedAt":{"type":"string","description":"Date and time indicating when this consumer was last updated.","format":"date-time","example":"2023-11-28T08:14:32.585Z"},"legalEntityId":{"type":"string","description":"Associated legal entity identifier.","nullable":true}},"additionalProperties":false}},"components/schemas/ConsumerGeneralInfosDto":{"id":"components/schemas/ConsumerGeneralInfosDto","kind":"json-schema","title":"ConsumerGeneralInfosDto","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the consumer.\n\r\nMax length is 100 chars.","example":"NAMIRIAL S.P.A."},"firstName":{"type":"string","description":"First name of the individual customer.\n"},"lastName":{"type":"string","description":"Last name of the individual customer.\n"},"type":{"enum":["Customer","LegalEntity","InternalUnit"],"type":"string","description":"Consumer type (Customer, LegalEntity, InternalUnit).\n\r\nIn the creation of a consumer by integrators is forbidden the creation of a consumer with LegalEntity type.\n\n\r\nDEFAULT: Customer\n","format":"int32","example":"Customer"},"customerType":{"enum":["None","ProfessionalIndividual","Corporate","PublicAdministration","NonProfit","PrivateIndividual"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are: None, PrivateIndividual, ProfessionalIndividual, Corporate, PublicAdministration, NonProfit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the Type is Customer and CustomerType is None the CustomerType is automatically generated according to the following rules:"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| CustomerType........ | Vat...... | TaxNumber | PaNumber |"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| NonProfit........... | empty.... | length 11 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| NonProfit........... | empty.... | length 29 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Corporate........... | length 11 | length 11 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Corporate........... | length 29 | length 11 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Corporate........... | length 29 | length 29 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PrivateIndividual.. | empty.... | length 16 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| ProfessionalIndividual | length 11 | length 16 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| ProfessionalIndividual | length 29 | length 16 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | empty.... | length 11 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | empty.... | length 29 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | length 11 | length 11 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | length 29 | length 11 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | length 29 | length 29 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Without a type, it is not possible to define a NonProfit with Vat."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is still recommended when you have the type in hand to manually define the CustomerType with the correct type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For NO ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are: None, PrivateIndividual, ProfessionalIndividual, Corporate"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEFAULT: None"},"children":[]}]}]}],"format":"int32","example":"Corporate"},"country":{"type":"string","description":"Country of the consumer. The format is ISO 3166-1 alpha-2 (cca2).","example":"IT"}},"additionalProperties":false}},"components/schemas/ConsumerGeneralInfosDtoV1":{"id":"components/schemas/ConsumerGeneralInfosDtoV1","kind":"json-schema","title":"ConsumerGeneralInfosDtoV1","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the consumer.\n\r\nMax length is 100 chars.","example":"NAMIRIAL S.P.A."},"firstName":{"type":"string","description":"First name of the individual customer.\n"},"lastName":{"type":"string","description":"Last name of the individual customer.\n"},"type":{"enum":["Customer","LegalEntity","InternalUnit"],"type":"string","description":"Consumer type (Customer, LegalEntity, InternalUnit).\n\r\nIn the creation of a consumer by integrators is forbidden the creation of a consumer with LegalEntity type.\n\n\r\nDEFAULT: Customer\n","format":"int32","example":"Customer"},"customerType":{"enum":["None","Individual","Corporate","PublicAdministration","NonProfit"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are: None, Individual, Corporate, PublicAdministration, NonProfit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the Type is Customer and CustomerType is None the CustomerType is automatically generated according to the following rules:"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| CustomerType........ | Vat...... | TaxNumber | PaNumber |"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| NonProfit........... | empty.... | length 11 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| NonProfit........... | empty.... | length 29 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Corporate........... | length 11 | length 11 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Corporate........... | length 29 | length 11 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Corporate........... | length 29 | length 29 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Individual.......... | empty.... | length 16 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Individual.......... | length 11 | length 16 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Individual.......... | length 29 | length 16 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | empty.... | length 11 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | empty.... | length 29 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | length 11 | length 11 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | length 29 | length 11 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | length 29 | length 29 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Without a type, it is not possible to define a NonProfit with Vat."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is still recommended when you have the type in hand to manually define the CustomerType with the correct type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For NO ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are: None, Individual, Corporate"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEFAULT: None"},"children":[]}]}]}],"format":"int32","example":"Corporate"},"country":{"type":"string","description":"Country of the consumer. The format is ISO 3166-1 alpha-2 (cca2).","example":"IT"}},"additionalProperties":false}},"components/schemas/ConsumerPathItemDto":{"id":"components/schemas/ConsumerPathItemDto","kind":"json-schema","title":"ConsumerPathItemDto","data":{"type":"object","properties":{"consumerId":{"type":"string"},"consumerName":{"type":"string"},"legalEntityId":{"type":"string"},"legalEntityName":{"type":"string"},"integratorId":{"type":"string"},"integratorLabel":{"type":"string"},"expand":{"type":"boolean"}},"additionalProperties":false}},"components/schemas/ConsumerPathWithNameDto":{"id":"components/schemas/ConsumerPathWithNameDto","kind":"json-schema","title":"ConsumerPathWithNameDto","data":{"type":"object","properties":{"path":{"type":"string"},"parentConsumerId":{"type":"string"},"consumerId":{"type":"string"},"legalEntityId":{"type":"string"},"parentConsumerName":{"type":"string"},"consumerName":{"type":"string"},"legalEntityName":{"type":"string"}},"additionalProperties":false}},"components/schemas/ConsumerResidenceInfoAndTaxNumberDtoV1":{"id":"components/schemas/ConsumerResidenceInfoAndTaxNumberDtoV1","kind":"json-schema","title":"ConsumerResidenceInfoAndTaxNumberDtoV1","data":{"type":"object","properties":{"country":{"type":"string","description":"Country of residence."},"address":{"type":"string","description":"Address of residence."},"state":{"type":"string","description":"State of residence."},"city":{"type":"string","description":"City of residence."},"postalCode":{"type":"string","description":"Postal code of the city of residence."},"taxNumber":{"type":"string","description":"Tax number of the consumer (maps to TaxCode2).","nullable":true}},"additionalProperties":false}},"components/schemas/ConsumerResidenceInfoDto":{"id":"components/schemas/ConsumerResidenceInfoDto","kind":"json-schema","title":"ConsumerResidenceInfoDto","data":{"type":"object","properties":{"country":{"type":"string","description":"Country of residence."},"address":{"type":"string","description":"Address of residence."},"state":{"type":"string","description":"State of residence."},"city":{"type":"string","description":"City of residence."},"postalCode":{"type":"string","description":"Postal code of the city of residence."},"personalCode":{"type":"string","description":"Personal code of the consumer. (optional)\n\r\nOnly for Customer PrivateIndividual and ProfessionalIndividual consumers.\n\r\nFor ITALIAN consumers with Italian residence: length 16 chars, validated with italian specifications.\n\r\nFor FRENCH consumers with French residence: length 15 chars, validated with french NIR specifications.\n\r\nMust be empty for all other consumer types and for residence countries other than IT/FR."}},"additionalProperties":false}},"components/schemas/ConsumerTaxInfosDto":{"id":"components/schemas/ConsumerTaxInfosDto","kind":"json-schema","title":"ConsumerTaxInfosDto","data":{"type":"object","properties":{"taxCode1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax code 1 of the consumer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ITALIAN consumers is VAT:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGULAR VAT:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 11 digits."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are digits (0-9)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is validated with Italian specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEMPORARY VAT:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary VAT is used only for customers that do not have a regular VAT yet."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary VAT is composed by a header \"T01\" and a ULID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 29 chars: 3 header chars and 26 ULID chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are 0-9, A-H, J-K, M-N, P-T, V-Z. The format is validated with ULID specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is mandatory for: LegalEntity, Customer-Corporate"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: Customer-PrivateIndividual, Customer-ProfessionalIndividual, Customer-NonProfit, Customer-PublicAdministration"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For FRENCH consumers is TVA:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGULAR TVA:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 13 chars: prefix \"FR\" + 2 chars (A-HJ-NP-Z0-9) + 9 digits."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are digits (0-9) and uppercase letters (A-Z), excluding I and O."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is validated with French specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEMPORARY TVA:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary TVA is used only for customers that do not have a regular TVA yet."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary TVA is composed by a header \"T01\" and a ULID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 29 chars: 3 header chars and 26 ULID chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are 0-9, A-H, J-K, M-N, P-T, V-Z. The format is validated with ULID specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: LegalEntity, Customer-Corporate, Customer-ProfessionalIndividual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: Customer-PrivateIndividual, Customer-NonProfit, Customer-PublicAdministration, InternalUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For all other consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are uppercase letters (A-Z), digits (0-9), symbols dot (.), hyphen (-) and slash (/)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: LegalEntity, Customer-Corporate, Customer-PrivateIndividual, Customer-ProfessionalIndividual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]}]},"taxCode2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax code 2 of the consumer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ITALIAN consumers is TAXNUMBER:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERSON TAXNUMBER:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 16 chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are digits and letters (0-9, A-Z)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is validated with Italian specifications."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only for: Customer-PrivateIndividual, Customer-ProfessionalIndividual"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGULAR TAXNUMBER:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 11 digits."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are digits (0-9)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is validated with Italian specifications."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only for: LegalEntity, Customer-Corporate, Customer-NonProfit, Customer-PublicAdministration"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEMPORARY TAXNUMBER:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary TAXNUMBER is used only for customers that do not have a regular TAXNUMBER yet."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary TAXNUMBER is composed by a header \"T01\" and a ULID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 29 chars: 3 header chars and 26 ULID chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are 0-9, A-H, J-K, M-N, P-T, V-Z. The format is validated with ULID specifications."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only for: Customer-Corporate, Customer-NonProfit, Customer-PublicAdministration"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For FRENCH consumers is SIREN:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGULAR SIREN:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 9 digits."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are digits (0-9)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is validated with French specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEMPORARY SIREN:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary SIREN is used only for customers that do not have a regular SIREN yet."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary SIREN is composed by a header \"T01\" and a ULID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 29 chars: 3 header chars and 26 ULID chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are 0-9, A-H, J-K, M-N, P-T, V-Z. The format is validated with ULID specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: LegalEntity, Customer-Corporate, Customer-ProfessionalIndividual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: Customer-PrivateIndividual, Customer-NonProfit, Customer-PublicAdministration, InternalUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For all other consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are uppercase letters (A-Z), digits (0-9), symbols dot (.), hyphen (-) and slash (/)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: LegalEntity, Customer-Corporate, Customer-PrivateIndividual, Customer-ProfessionalIndividual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]}]},"taxCode3":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax code 3 of the consumer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ITALIAN consumers is PANUMBER:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGULAR PANUMBER:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 6 chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are uppercase letters (A-Z) and digits (0-9)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is validated with Italian specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is mandatory for: Customer-PublicAdministration"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: LegalEntity, Customer-Corporate, Customer-PrivateIndividual, Customer-ProfessionalIndividual, Customer-NonProfit, InternalUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For FRENCH consumers is SIRET:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGULAR SIRET:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 14 digits."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are digits (0-9)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is validated with French specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEMPORARY SIRET:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary SIRET is used only for customers that do not have a regular SIRET yet."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary SIRET is composed by a header \"T01\" and a ULID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 29 chars: 3 header chars and 26 ULID chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are 0-9, A-H, J-K, M-N, P-T, V-Z. The format is validated with ULID specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: LegalEntity, Customer-Corporate, Customer-ProfessionalIndividual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: Customer-PrivateIndividual, Customer-NonProfit, Customer-PublicAdministration, InternalUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For all other consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are uppercase letters (A-Z), digits (0-9), symbols dot (.), hyphen (-) and slash (/)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: LegalEntity, Customer-Corporate, Customer-PrivateIndividual, Customer-ProfessionalIndividual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]}],"example":"UFCGFV"}},"additionalProperties":false}},"components/schemas/ConsumerTaxInfosDtoV1":{"id":"components/schemas/ConsumerTaxInfosDtoV1","kind":"json-schema","title":"ConsumerTaxInfosDtoV1","data":{"type":"object","properties":{"vat":{"type":"string","description":"VAT number of the consumer (maps to TaxCode1)."},"taxNumber":{"type":"string","description":"Tax number of the consumer (maps to TaxCode2)."},"paNumber":{"type":"string","description":"PA number of the consumer (maps to TaxCode3)."}},"additionalProperties":false}},"components/schemas/ConsumerWithExtraInfoDto":{"id":"components/schemas/ConsumerWithExtraInfoDto","kind":"json-schema","title":"ConsumerWithExtraInfoDto","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the consumer.\n","example":"NAMIRIAL S.P.A."},"firstName":{"type":"string","description":"First name of the individual customer.\n"},"lastName":{"type":"string","description":"Last name of the individual customer.\n"},"customerType":{"enum":["None","ProfessionalIndividual","Corporate","PublicAdministration","NonProfit","PrivateIndividual"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are: None, PrivateIndividual, ProfessionalIndividual, Corporate, PublicAdministration, NonProfit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the Type is Customer and CustomerType is None the CustomerType is automatically generated according to the following rules:"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| CustomerType........ | TaxCode1  | TaxCode2    | TaxCode3   |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| CustomerType........ | (VAT)     | (TAXNUMBER) | (PANUMBER) |"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| NonProfit........... | empty.... | length 11.. | empty..... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| NonProfit........... | empty.... | length 29.. | empty..... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Corporate........... | length 11 | length 11.. | empty..... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Corporate........... | length 29 | length 11.. | empty..... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Corporate........... | length 29 | length 29.. | empty..... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PrivateIndividual... | empty.... | length 16.. | empty..... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| ProfessionalIndividual | length 11 | length 16.. | empty..... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| ProfessionalIndividual | length 29 | length 16.. | empty..... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | empty.... | length 11.. | length 6.. |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | empty.... | length 29.. | length 6.. |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | length 11 | length 11.. | length 6.. |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | length 29 | length 11.. | length 6.. |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | length 29 | length 29.. | length 6.. |"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Without a type, it is not possible to define a NonProfit with TaxCode1."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is still recommended when you have the type in hand to manually define the CustomerType with the correct type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For FRENCH consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are: PrivateIndividual, ProfessionalIndividual, Corporate"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auto mode is not provided"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For all other consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are: PrivateIndividual, ProfessionalIndividual, Corporate"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEFAULT: None"},"children":[]}]}]}],"format":"int32","example":"Corporate"},"country":{"type":"string","description":"Country of the consumer. The format is ISO 3166-1 alpha-2 (cca2).","example":"IT"},"taxCode1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax code 1 of the consumer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ITALIAN consumers is VAT:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGULAR VAT:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 11 digits."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are digits (0-9)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is validated with Italian specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEMPORARY VAT:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary VAT is used only for customers that do not have a regular VAT yet."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary VAT is composed by a header \"T01\" and a ULID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 29 chars: 3 header chars and 26 ULID chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are 0-9, A-H, J-K, M-N, P-T, V-Z. The format is validated with ULID specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is mandatory for: LegalEntity, Customer-Corporate"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: Customer-PrivateIndividual, Customer-ProfessionalIndividual, Customer-NonProfit, Customer-PublicAdministration"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For FRENCH consumers is TVA:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGULAR TVA:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 13 chars: prefix \"FR\" + 2 chars (A-HJ-NP-Z0-9) + 9 digits."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are digits (0-9) and uppercase letters (A-Z), excluding I and O."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is validated with French specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEMPORARY TVA:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary TVA is used only for customers that do not have a regular TVA yet."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary TVA is composed by a header \"T01\" and a ULID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 29 chars: 3 header chars and 26 ULID chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are 0-9, A-H, J-K, M-N, P-T, V-Z. The format is validated with ULID specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: LegalEntity, Customer-Corporate, Customer-ProfessionalIndividual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: Customer-PrivateIndividual, Customer-NonProfit, Customer-PublicAdministration, InternalUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For all other consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are uppercase letters (A-Z), digits (0-9), symbols dot (.), hyphen (-) and slash (/)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: LegalEntity, Customer-Corporate, Customer-PrivateIndividual, Customer-ProfessionalIndividual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]}]},"taxCode2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax code 2 of the consumer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ITALIAN consumers is TAXNUMBER:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERSON TAXNUMBER:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 16 chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are digits and letters (0-9, A-Z)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is validated with Italian specifications."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only for: Customer-PrivateIndividual, Customer-ProfessionalIndividual"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGULAR TAXNUMBER:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 11 digits."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are digits (0-9)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is validated with Italian specifications."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only for: LegalEntity, Customer-Corporate, Customer-NonProfit, Customer-PublicAdministration"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEMPORARY TAXNUMBER:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary TAXNUMBER is used only for customers that do not have a regular TAXNUMBER yet."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary TAXNUMBER is composed by a header \"T01\" and a ULID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 29 chars: 3 header chars and 26 ULID chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are 0-9, A-H, J-K, M-N, P-T, V-Z. The format is validated with ULID specifications."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only for: Customer-Corporate, Customer-NonProfit, Customer-PublicAdministration"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For FRENCH consumers is SIREN:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGULAR SIREN:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 9 digits."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are digits (0-9)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is validated with French specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEMPORARY SIREN:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary SIREN is used only for customers that do not have a regular SIREN yet."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary SIREN is composed by a header \"T01\" and a ULID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 29 chars: 3 header chars and 26 ULID chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are 0-9, A-H, J-K, M-N, P-T, V-Z. The format is validated with ULID specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: LegalEntity, Customer-Corporate, Customer-ProfessionalIndividual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: Customer-PrivateIndividual, Customer-NonProfit, Customer-PublicAdministration, InternalUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For all other consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are uppercase letters (A-Z), digits (0-9), symbols dot (.), hyphen (-) and slash (/)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: LegalEntity, Customer-Corporate, Customer-PrivateIndividual, Customer-ProfessionalIndividual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]}]},"taxCode3":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax code 3 of the consumer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ITALIAN consumers is PANUMBER:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGULAR PANUMBER:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 6 chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are uppercase letters (A-Z) and digits (0-9)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is validated with Italian specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is mandatory for: Customer-PublicAdministration"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: LegalEntity, Customer-Corporate, Customer-PrivateIndividual, Customer-ProfessionalIndividual, Customer-NonProfit, InternalUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For FRENCH consumers is SIRET:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGULAR SIRET:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 14 digits."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are digits (0-9)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is validated with French specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEMPORARY SIRET:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary SIRET is used only for customers that do not have a regular SIRET yet."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary SIRET is composed by a header \"T01\" and a ULID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 29 chars: 3 header chars and 26 ULID chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are 0-9, A-H, J-K, M-N, P-T, V-Z. The format is validated with ULID specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: LegalEntity, Customer-Corporate, Customer-ProfessionalIndividual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: Customer-PrivateIndividual, Customer-NonProfit, Customer-PublicAdministration, InternalUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For all other consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are uppercase letters (A-Z), digits (0-9), symbols dot (.), hyphen (-) and slash (/)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: LegalEntity, Customer-Corporate, Customer-PrivateIndividual, Customer-ProfessionalIndividual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]}]},"isValidatedTaxCodes":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the tax codes have been validated against country-specific standards"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(VAT/TaxNumber/PaNumber for Italy, Tva/Siren/Siret for France)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assigned exclusively by backend rules — ignored on input."},"children":[]}]}]}]},"type":{"enum":["Customer","LegalEntity","InternalUnit"],"type":"string","description":"Consumer type (Customer, LegalEntity, InternalUnit).\n\r\nIn the creation of a consumer by integrators is forbidden the creation of a consumer with LegalEntity type.\n\n\r\nDEFAULT: Customer\n","format":"int32","example":"Customer"},"billable":{"type":"boolean","description":"Billable consumer.\n\r\nFor InternalUnit type must be false.","example":true},"address":{"type":"string","description":"Billing address of the consumer.\n\r\nIs mandatory when Billable is true.","example":"Via Caduti sul Lavoro, 4"},"state":{"type":"string","description":"Billing state of the consumer.\n\r\nIs mandatory when Billable is true.\n\r\nFor ITALIAN consumers is validated with the italian state list.","example":"AN"},"city":{"type":"string","description":"Billing city of the consumer.\n\r\nIs mandatory when Billable is true.\n\r\nFor ITALIAN consumers is validated with the italian state city list.","example":"Senigallia"},"postalCode":{"type":"string","description":"Billing postal code of the consumer.\n\r\nIs mandatory when Billable is true.\n\r\nFor ITALIAN consumers is validated with the italian state city postal code list.","example":"60019"},"emails":{"type":"array","items":{"type":"string"},"description":"Contact emails of the consumer.\n\r\nOne email is mandatory when Billable is true.","example":["info@namirial.com"]},"pecs":{"type":"array","items":{"type":"string"},"description":"Contact pecs of the consumer.\n","example":["amm.namirial@sicurezzapostale.it"]},"phones":{"type":"array","items":{"type":"string"},"description":"Contact phones of the consumer.\n\r\nIs validated for consumer country.","example":["+3907163494"]},"mobilePhones":{"type":"array","items":{"type":"string"},"description":"Contact mobile phones of the consumer.\n\r\nIs validated for consumer country.","example":["+393384234567"]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Custom meta data dictionary of the consumer.","example":{"your-property":"value of property"}},"birthInfo":{"$ref":"#/components/schemas/ConsumerBirthInfoDto"},"residenceInfo":{"$ref":"#/components/schemas/ConsumerResidenceInfoDto"},"businessType":{"enum":["None","Reseller"],"type":"string","description":"Consumer business type.","format":"int32"},"id":{"type":"string","description":"Identifier of the consumer.","example":"6dcd885f-a37b-427f-ab59-d008ae134aab"},"createdAt":{"type":"string","description":"Date and time indicating when this consumer was created.","format":"date-time","example":"2023-11-28T08:14:32.585Z"},"updatedAt":{"type":"string","description":"Date and time indicating when this consumer was last updated.","format":"date-time","example":"2023-11-28T08:14:32.585Z"},"legalEntityId":{"type":"string","description":"Associated legal entity identifier","nullable":true},"crmId":{"type":"string","description":"CRM consumer identifier."},"crmSnapshot":{"$ref":"#/components/schemas/ConsumerCrmSnapshotDto"},"hasContracts":{"type":"boolean","description":"Indicates whether the consumer has contracts."}},"additionalProperties":false}},"components/schemas/ConsumptionAggregatedDto":{"id":"components/schemas/ConsumptionAggregatedDto","kind":"json-schema","title":"ConsumptionAggregatedDto","data":{"type":"object","properties":{"metricId":{"type":"string","description":"id of the metric on which the consumption has been registered"},"datestamp":{"type":"string","description":"datetime (ISO 8601) on which the consumption has been registered","format":"date-time"},"value":{"type":"number","description":"value of the consumption","format":"double"},"businessRelationId":{"type":"string","description":"business relation when grouping (only if aggregation is of only one business relation)"},"attributeId":{"type":"string","description":"attribute identifier when grouping with attribute id is enabled"},"attributeValue":{"type":"string","description":"attribute value when grouping with attribute id is enabled"},"timestamp":{"type":"string","description":"datestamp on which the consumption has been registered\r\nDeprecated: use Datestamp instead","format":"date-time","readOnly":true}},"additionalProperties":false}},"components/schemas/ConsumptionsAggregatedConsumerDto":{"id":"components/schemas/ConsumptionsAggregatedConsumerDto","kind":"json-schema","title":"ConsumptionsAggregatedConsumerDto","data":{"type":"object","properties":{"productId":{"type":"string"},"attributeId":{"type":"string"},"aggregateType":{"enum":["Daily","Monthly","Yearly"],"type":"string","format":"int32"},"consumptions":{"type":"array","items":{"$ref":"#/components/schemas/ConsumptionAggregatedDto"}},"metricInfos":{"type":"array","items":{"$ref":"#/components/schemas/MetricInfo"}},"consumerId":{"type":"string"}},"additionalProperties":false}},"components/schemas/ConsumptionsAggregatedDto":{"id":"components/schemas/ConsumptionsAggregatedDto","kind":"json-schema","title":"ConsumptionsAggregatedDto","data":{"type":"object","properties":{"productId":{"type":"string"},"attributeId":{"type":"string"},"aggregateType":{"enum":["Daily","Monthly","Yearly"],"type":"string","format":"int32"},"consumptions":{"type":"array","items":{"$ref":"#/components/schemas/ConsumptionAggregatedDto"}},"metricInfos":{"type":"array","items":{"$ref":"#/components/schemas/MetricInfo"}}},"additionalProperties":false}},"components/schemas/ContractBaseParameterDto":{"id":"components/schemas/ContractBaseParameterDto","kind":"json-schema","title":"ContractBaseParameterDto","data":{"type":"object","properties":{"type":{"enum":["String","StringList","Number","Boolean","Date","Datetime","ProductMetric"],"type":"string","description":"Parameter type of parameter","format":"int32","example":"Number"},"label":{"type":"object","additionalProperties":{"type":"string"},"description":"Dictionary of parameter label localized in different languages","example":{"en":"parameter label in english","it":"label del parametro in italiano","de":"...","fr":"...","es":"...","pt":"...","ro":"..."}},"required":{"type":"boolean","description":"Parameter is mandatory","example":true},"async":{"type":"boolean","description":"Whether the parameter can be filled later or not\r\nDEFAULT: \"false\"","example":true},"isConstant":{"type":"boolean","description":"Whether the parameter value is constant and cannot be changed\r\nDEFAULT: \"false\"","example":false},"order":{"type":"integer","description":"Order of the parameter in the list of parameters\r\nDEFAULT: \"Not applied\"","format":"int32","nullable":true,"example":10},"contractTypes":{"type":"array","items":{"enum":["Resell","Direct","Indirect","Distribution"],"type":"string","format":"int32"},"description":"Contract types this parameter will be applied to","example":["Direct","Resell"]},"groupId":{"type":"string","description":"Parameter section identifier this parameter belongs to","nullable":true}},"additionalProperties":false}},"components/schemas/ContractBooleanParameterDto":{"id":"components/schemas/ContractBooleanParameterDto","kind":"json-schema","title":"ContractBooleanParameterDto","data":{"type":"object","properties":{"type":{"enum":["String","StringList","Number","Boolean","Date","Datetime","ProductMetric"],"type":"string","description":"Parameter type of parameter","format":"int32","example":"Number"},"label":{"type":"object","additionalProperties":{"type":"string"},"description":"Dictionary of parameter label localized in different languages","example":{"en":"parameter label in english","it":"label del parametro in italiano","de":"...","fr":"...","es":"...","pt":"...","ro":"..."}},"required":{"type":"boolean","description":"Parameter is mandatory","example":true},"async":{"type":"boolean","description":"Whether the parameter can be filled later or not\r\nDEFAULT: \"false\"","example":true},"isConstant":{"type":"boolean","description":"Whether the parameter value is constant and cannot be changed\r\nDEFAULT: \"false\"","example":false},"order":{"type":"integer","description":"Order of the parameter in the list of parameters\r\nDEFAULT: \"Not applied\"","format":"int32","nullable":true,"example":10},"contractTypes":{"type":"array","items":{"enum":["Resell","Direct","Indirect","Distribution"],"type":"string","format":"int32"},"description":"Contract types this parameter will be applied to","example":["Direct","Resell"]},"groupId":{"type":"string","description":"Parameter section identifier this parameter belongs to","nullable":true},"defaultValue":{"type":"boolean","description":"Default value of parameter","nullable":true}},"additionalProperties":false}},"components/schemas/ContractCreateDto":{"id":"components/schemas/ContractCreateDto","kind":"json-schema","title":"ContractCreateDto","data":{"type":"object","properties":{"description":{"type":"string","description":"Description for this contract"},"startDate":{"type":"string","description":"Date and time indicating starting date for this contract.","format":"date","example":"2023-11-28"},"issuerId":{"type":"string","description":"Issuer identifier for this contract","nullable":true},"legalEntityId":{"type":"string","description":"Legal entity identifier for this contract"},"billingConsumerId":{"type":"string","description":"Billing consumer identifier for this contract (optional)","nullable":true},"ownerId":{"type":"string","description":"Owner (titolare) identifier for this contract (optional)","nullable":true},"legalRepresentativeId":{"type":"string","description":"Legal representative identifier for this contract"},"recipient":{"$ref":"#/components/schemas/ContractRecipientDto"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Metadata key/value pairs for the contract","example":{"your-property":"value of property"}},"resellContractId":{"type":"string","description":"Reseller contract identifier related to this contract","nullable":true},"number":{"type":"string","description":"CRM contract number"},"createOrganization":{"type":"boolean","description":"Indicates that upon completion of the contract, the organization related to the BillingConsumer referred to in the contract should be created"},"type":{"enum":["Resell","Direct","Indirect","Distribution"],"type":"string","description":"Type of contract (e.g. \"distribution\", \"resell\", \"direct\", indirect)","format":"int32"}},"additionalProperties":false}},"components/schemas/ContractDateParameterDto":{"id":"components/schemas/ContractDateParameterDto","kind":"json-schema","title":"ContractDateParameterDto","data":{"type":"object","properties":{"type":{"enum":["String","StringList","Number","Boolean","Date","Datetime","ProductMetric"],"type":"string","description":"Parameter type of parameter","format":"int32","example":"Number"},"label":{"type":"object","additionalProperties":{"type":"string"},"description":"Dictionary of parameter label localized in different languages","example":{"en":"parameter label in english","it":"label del parametro in italiano","de":"...","fr":"...","es":"...","pt":"...","ro":"..."}},"required":{"type":"boolean","description":"Parameter is mandatory","example":true},"async":{"type":"boolean","description":"Whether the parameter can be filled later or not\r\nDEFAULT: \"false\"","example":true},"isConstant":{"type":"boolean","description":"Whether the parameter value is constant and cannot be changed\r\nDEFAULT: \"false\"","example":false},"order":{"type":"integer","description":"Order of the parameter in the list of parameters\r\nDEFAULT: \"Not applied\"","format":"int32","nullable":true,"example":10},"contractTypes":{"type":"array","items":{"enum":["Resell","Direct","Indirect","Distribution"],"type":"string","format":"int32"},"description":"Contract types this parameter will be applied to","example":["Direct","Resell"]},"groupId":{"type":"string","description":"Parameter section identifier this parameter belongs to","nullable":true},"defaultValue":{"type":"string","description":"Default value of parameter","format":"date","nullable":true,"example":"2024-07-18"},"placeholder":{"type":"object","additionalProperties":{"type":"string"},"description":"Placeholder of parameter to see in the input field of UI","nullable":true}},"additionalProperties":false}},"components/schemas/ContractDatetimeParameterDto":{"id":"components/schemas/ContractDatetimeParameterDto","kind":"json-schema","title":"ContractDatetimeParameterDto","data":{"type":"object","properties":{"type":{"enum":["String","StringList","Number","Boolean","Date","Datetime","ProductMetric"],"type":"string","description":"Parameter type of parameter","format":"int32","example":"Number"},"label":{"type":"object","additionalProperties":{"type":"string"},"description":"Dictionary of parameter label localized in different languages","example":{"en":"parameter label in english","it":"label del parametro in italiano","de":"...","fr":"...","es":"...","pt":"...","ro":"..."}},"required":{"type":"boolean","description":"Parameter is mandatory","example":true},"async":{"type":"boolean","description":"Whether the parameter can be filled later or not\r\nDEFAULT: \"false\"","example":true},"isConstant":{"type":"boolean","description":"Whether the parameter value is constant and cannot be changed\r\nDEFAULT: \"false\"","example":false},"order":{"type":"integer","description":"Order of the parameter in the list of parameters\r\nDEFAULT: \"Not applied\"","format":"int32","nullable":true,"example":10},"contractTypes":{"type":"array","items":{"enum":["Resell","Direct","Indirect","Distribution"],"type":"string","format":"int32"},"description":"Contract types this parameter will be applied to","example":["Direct","Resell"]},"groupId":{"type":"string","description":"Parameter section identifier this parameter belongs to","nullable":true},"defaultValue":{"type":"string","description":"Default value of parameter","format":"date-time","nullable":true,"example":"2024-07-18T10:11:23.000Z"},"placeholder":{"type":"object","additionalProperties":{"type":"string"},"description":"Placeholder of parameter to see in the input field of UI","nullable":true}},"additionalProperties":false}},"components/schemas/ContractDto":{"id":"components/schemas/ContractDto","kind":"json-schema","title":"ContractDto","data":{"type":"object","properties":{"description":{"type":"string","description":"Description for this contract"},"startDate":{"type":"string","description":"Date and time indicating starting date for this contract.","format":"date","example":"2023-11-28"},"issuerId":{"type":"string","description":"Issuer identifier for this contract","nullable":true},"legalEntityId":{"type":"string","description":"Legal entity identifier for this contract"},"billingConsumerId":{"type":"string","description":"Billing consumer identifier for this contract (optional)","nullable":true},"ownerId":{"type":"string","description":"Owner (titolare) identifier for this contract (optional)","nullable":true},"legalRepresentativeId":{"type":"string","description":"Legal representative identifier for this contract"},"recipient":{"$ref":"#/components/schemas/ContractRecipientDto"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Metadata key/value pairs for the contract","example":{"your-property":"value of property"}},"resellContractId":{"type":"string","description":"Reseller contract identifier related to this contract","nullable":true},"number":{"type":"string","description":"CRM contract number"},"createOrganization":{"type":"boolean","description":"Indicates that upon completion of the contract, the organization related to the BillingConsumer referred to in the contract should be created"},"type":{"enum":["Resell","Direct","Indirect","Distribution"],"type":"string","description":"Type of contract (e.g. \"distribution\", \"resell\", \"direct\", indirect)","format":"int32"},"status":{"enum":["Draft","Pending","Final","Processing","Completed","Expired","Cancelled","Support"],"type":"string","description":"Indicates the contract status","format":"int32"},"contractItemRuleSnapshots":{"type":"array","items":{"$ref":"#/components/schemas/ContractItemRuleSnapshotDto"},"description":"The list of contract item rule snapshots associated with this contract.\r\nThis represents the state of contract item rules at the time of last modification."},"id":{"type":"string","description":"Unique identifier of this contract"},"businessRelationId":{"type":"string","description":"Indicates the businessRelation related to the contract"},"createdAt":{"type":"string","description":"Date and time indicating when this contract was created.","format":"date-time","example":"2023-11-28T08:14:32.585Z"},"updatedAt":{"type":"string","description":"Date and time indicating when this contract was last updated.","format":"date-time","example":"2023-11-28T08:14:32.585Z"},"legalEntityName":{"type":"string","description":"Legal entity name for this contract","example":"Namirial S.P.A"},"billingConsumerName":{"type":"string","description":"Billing consumer name for this contract","example":"Billable Consumer 1"},"ownerName":{"type":"string","description":"Owner name for this contract","nullable":true,"example":"Owner Consumer 1"},"legalRepresentativeName":{"type":"string","description":"Legal representative name for this contract","nullable":true,"example":"Legal Representative Consumer 1"},"issuerName":{"type":"string","description":"Issuer name for this contract","nullable":true,"example":"Issuer Consumer 1"}},"additionalProperties":false}},"components/schemas/ContractEndDateDto":{"id":"components/schemas/ContractEndDateDto","kind":"json-schema","title":"ContractEndDateDto","data":{"type":"object","properties":{"endDate":{"type":"string","description":"Date and time indicating ending date for this contract.","format":"date","nullable":true,"example":"2023-11-29"}},"additionalProperties":false}},"components/schemas/ContractItemBillingModelParametersDto":{"id":"components/schemas/ContractItemBillingModelParametersDto","kind":"json-schema","title":"ContractItemBillingModelParametersDto","data":{"type":"object","properties":{"billingModelParameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Billing model parameters for this contract item","example":{"your-parameter":"value of parameter"}}},"additionalProperties":false}},"components/schemas/ContractItemCreateDto":{"id":"components/schemas/ContractItemCreateDto","kind":"json-schema","title":"ContractItemCreateDto","data":{"type":"object","properties":{"productId":{"type":"string","description":"Unique identifier of product associated to this contract item"},"resellContractItemId":{"type":"string","description":"Reseller contract item identifier related to this contract item","nullable":true},"parentId":{"type":"string","description":"Parent contract item identifier. When set, onboarding info may be resolved from parent SKU overrides.","nullable":true},"sku":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🗑️ DEPRECATED (Will no longer be available in the next release) 🗑️"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This property is DEPRECATED and will be removed on 2026-04-01, use property 'SkuId' instead."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}],"deprecated":true},"skuId":{"type":"string","description":"Sku identifier code of this contract item"},"description":{"type":"string","description":"Description for this contract item"},"billingModelId":{"type":"string","description":"Billing model identifier for this contract item"},"billingModelParameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Billing model parameters for this contract item","example":{"your-parameter":"value of parameter"}},"businessRelationId":{"type":"string","description":"Business relation model identifier for this contract item"},"channel":{"type":"string","description":"Sales or acquisition channel associated with this contract item","nullable":true},"subscriptionId":{"type":"string","description":"Subscription identifier for this contract item"},"skuParameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Sku parameters for this contract item"},"featureIds":{"type":"array","items":{"type":"string"},"description":"SKU feature identifiers selected for this contract item."},"dataSources":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/ContractStringListParameterValueDto"}},"description":"Values resolved for external data sources referenced by SKU parameters"},"signed":{"type":"boolean","description":"Indicates whether this contract item is signed or not."},"provisioned":{"type":"boolean","description":"Indicates whether this contract item is provisioned or not."},"startDate":{"type":"string","description":"Date and time indicating starting date for this contract item.","format":"date","example":"2023-11-28"},"endDate":{"type":"string","description":"Date and time indicating ending date for this contract item.","format":"date","nullable":true,"example":"2023-11-29"},"quantity":{"type":"integer","description":"Quantity for this contract item.","format":"int32"},"envelopeParameters":{"type":"array","items":{"$ref":"#/components/schemas/ContractItemEnvelopeParametersDto"},"description":"Documents parameters for this contract item."},"onboardingExtraParameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Extra parameters supporting the onboarding process.","nullable":true},"userId":{"type":"string","description":"MyNamirial user identifier of this contract item (optional).","nullable":true}},"additionalProperties":false,"description":"Contract item Create data transfer object"}},"components/schemas/ContractItemDryRunDto":{"id":"components/schemas/ContractItemDryRunDto","kind":"json-schema","title":"ContractItemDryRunDto","data":{"type":"object","properties":{"boundContractItemIds":{"type":"array","items":{"type":"string"},"description":"Identifier of the bounded contract items that must endure the dry-run procedure at the same time as the source contract item."}},"additionalProperties":false}},"components/schemas/ContractItemDto":{"id":"components/schemas/ContractItemDto","kind":"json-schema","title":"ContractItemDto","data":{"type":"object","properties":{"productId":{"type":"string","description":"Unique identifier of product associated to this contract item"},"resellContractItemId":{"type":"string","description":"Reseller contract item identifier related to this contract item","nullable":true},"parentId":{"type":"string","description":"Parent contract item identifier. When set, onboarding info may be resolved from parent SKU overrides.","nullable":true},"sku":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🗑️ DEPRECATED (Will no longer be available in the next release) 🗑️"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This property is DEPRECATED and will be removed on 2026-04-01, use property 'SkuId' instead."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}],"deprecated":true},"skuId":{"type":"string","description":"Sku identifier code of this contract item"},"description":{"type":"string","description":"Description for this contract item"},"billingModelId":{"type":"string","description":"Billing model identifier for this contract item"},"billingModelParameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Billing model parameters for this contract item","example":{"your-parameter":"value of parameter"}},"businessRelationId":{"type":"string","description":"Business relation model identifier for this contract item"},"channel":{"type":"string","description":"Sales or acquisition channel associated with this contract item","nullable":true},"subscriptionId":{"type":"string","description":"Subscription identifier for this contract item"},"skuParameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Sku parameters for this contract item"},"featureIds":{"type":"array","items":{"type":"string"},"description":"SKU feature identifiers selected for this contract item."},"dataSources":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/ContractStringListParameterValueDto"}},"description":"Values resolved for external data sources referenced by SKU parameters"},"signed":{"type":"boolean","description":"Indicates whether this contract item is signed or not."},"provisioned":{"type":"boolean","description":"Indicates whether this contract item is provisioned or not."},"startDate":{"type":"string","description":"Date and time indicating starting date for this contract item.","format":"date","example":"2023-11-28"},"endDate":{"type":"string","description":"Date and time indicating ending date for this contract item.","format":"date","nullable":true,"example":"2023-11-29"},"quantity":{"type":"integer","description":"Quantity for this contract item.","format":"int32"},"envelopeParameters":{"type":"array","items":{"$ref":"#/components/schemas/ContractItemEnvelopeParametersDto"},"description":"Documents parameters for this contract item."},"onboardingExtraParameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Extra parameters supporting the onboarding process.","nullable":true},"userId":{"type":"string","description":"MyNamirial user identifier of this contract item (optional).","nullable":true},"contractId":{"type":"string","description":"Unique identifier of this contract"},"skuAsyncParametersApplied":{"type":"boolean","description":"Flag to indicate if the SKU async parameters have been applied"},"envelopeParametersApplied":{"type":"boolean","description":"Flag to indicate if the envelope parameters have been applied"},"envelope":{"$ref":"#/components/schemas/ContractItemEnvelopeDto"},"status":{"enum":["Ready","Pending","Provisioning","Signing","Active","Expired","Cancelled","Support"],"type":"string","description":"Status for this contract item","format":"int32","example":"Active"},"skuSnapshot":{"$ref":"#/components/schemas/SkuBaseDto"},"billingModelSnapshot":{"$ref":"#/components/schemas/BillingModelBaseDto"},"productCategorySnapshot":{"$ref":"#/components/schemas/ProductCategoryDto"},"provisioningValidationErrors":{"type":"array","items":{"$ref":"#/components/schemas/ProvisioningValidationErrorDto"},"description":"The errors that can occur when validating the parameters of a contract item."},"provisioningError":{"$ref":"#/components/schemas/ErrorDto"},"ownerId":{"type":"string","description":"Owner identifier for this contract item","nullable":true},"legalRepresentativeId":{"type":"string","description":"Legal representative identifier for this contract item","nullable":true},"issuerId":{"type":"string","description":"Issuer identifier for this contract item","nullable":true},"billingConsumerId":{"type":"string","description":"Billing consumer identifier for this contract item","nullable":true},"subscriptionSnapshot":{"$ref":"#/components/schemas/LicenseInternalSubscription"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Metadata for the contract item"},"skuParametersErrors":{"type":"object","additionalProperties":{"enum":["Unknown","MissingRequiredValue"],"type":"string","format":"int32"},"readOnly":true},"billingModelParametersErrors":{"type":"object","additionalProperties":{"enum":["Unknown","MissingRequiredValue"],"type":"string","format":"int32"},"readOnly":true},"id":{"type":"string","description":"Unique identifier of this contract item"},"createdAt":{"type":"string","description":"Date and time indicating when this contract detail was created.","format":"date-time","example":"2023-11-28T08:14:32.585Z"},"updatedAt":{"type":"string","description":"Date and time indicating when this contract details was last updated.","format":"date-time","example":"2023-11-28T08:14:32.585Z"}},"additionalProperties":false,"description":"Contract item data transfer object"}},"components/schemas/ContractItemEndDateDto":{"id":"components/schemas/ContractItemEndDateDto","kind":"json-schema","title":"ContractItemEndDateDto","data":{"type":"object","properties":{"endDate":{"type":"string","description":"Date and time indicating ending date for this contract item.","format":"date","nullable":true,"example":"2023-11-29"}},"additionalProperties":false}},"components/schemas/ContractItemEnvelopeDocumentInfoDto":{"id":"components/schemas/ContractItemEnvelopeDocumentInfoDto","kind":"json-schema","title":"ContractItemEnvelopeDocumentInfoDto","data":{"type":"object","properties":{"fileName":{"type":"string","description":"File name"},"documentNumber":{"type":"integer","description":"Document number","format":"int32"}},"additionalProperties":false}},"components/schemas/ContractItemEnvelopeDto":{"id":"components/schemas/ContractItemEnvelopeDto","kind":"json-schema","title":"ContractItemEnvelopeDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of this envelope"},"status":{"enum":["Canceled","Completed","Expired","Rejected","ActionRequired","WaitingForOthers","ExpiringSoon","Active"],"type":"string","description":"Envelope status","format":"int32"},"documentsInfo":{"type":"array","items":{"$ref":"#/components/schemas/ContractItemEnvelopeDocumentInfoDto"},"description":"Documents info for this envelope"},"auditTrailInfo":{"$ref":"#/components/schemas/ContractItemEnvelopeFileInfoDto"}},"additionalProperties":false}},"components/schemas/ContractItemEnvelopeFileInfoDto":{"id":"components/schemas/ContractItemEnvelopeFileInfoDto","kind":"json-schema","title":"ContractItemEnvelopeFileInfoDto","data":{"type":"object","properties":{"fileName":{"type":"string","description":"File name"}},"additionalProperties":false}},"components/schemas/ContractItemEnvelopeParametersDto":{"id":"components/schemas/ContractItemEnvelopeParametersDto","kind":"json-schema","title":"ContractItemEnvelopeParametersDto","data":{"type":"object","properties":{"documentId":{"type":"string","description":"Document identifier"},"version":{"type":"integer","description":"Document version","format":"int32"},"recipient":{"$ref":"#/components/schemas/ContractItemEnvelopeRecipientDto"},"requestedLanguage":{"type":"string","description":"Requested document language.","nullable":true},"resolvedLanguage":{"type":"string","description":"Resolved document language.","nullable":true},"parameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Document parameters"}},"additionalProperties":false}},"components/schemas/ContractItemEnvelopeRecipientDto":{"id":"components/schemas/ContractItemEnvelopeRecipientDto","kind":"json-schema","title":"ContractItemEnvelopeRecipientDto","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the recipient"},"surname":{"type":"string","description":"Surname of the recipient"},"email":{"type":"string","description":"Email of the recipient"},"phoneNumber":{"type":"string","description":"Phone number of the recipient","nullable":true},"language":{"type":"string","description":"Preferred recipient language or locale.","nullable":true}},"additionalProperties":false}},"components/schemas/ContractItemRuleSnapshotDto":{"id":"components/schemas/ContractItemRuleSnapshotDto","kind":"json-schema","title":"ContractItemRuleSnapshotDto","data":{"type":"object","properties":{"sourceSkuId":{"type":"string","description":"Unique identifier of the source SKU for this contract item rule"},"type":{"enum":["Requires","ConflictsWith"],"type":"string","description":"The type of this contract item rule","format":"int32"},"targetSkuIds":{"type":"array","items":{"type":"string"},"description":"The list of target SKU identifiers for this contract item rule"},"match":{"enum":["All","Any"],"type":"string","description":"The match mode for this contract item rule, indicating whether all target SKUs must match (All) or if any of them can match (Any).","format":"int32","example":"Active"},"contractTypes":{"type":"array","items":{"enum":["Resell","Direct","Indirect","Distribution"],"type":"string","format":"int32"},"description":"The list of contract types to which this rule applies. If null or empty, the rule applies to all contract types.","nullable":true},"ruleId":{"type":"string","description":"Unique identifier of this contract item rule"}},"additionalProperties":false,"description":"Contract item rule snapshot object"}},"components/schemas/ContractItemSkuParametersDto":{"id":"components/schemas/ContractItemSkuParametersDto","kind":"json-schema","title":"ContractItemSkuParametersDto","data":{"type":"object","properties":{"parameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Sku parameters for this contract item"}},"additionalProperties":false}},"components/schemas/ContractNumberParameterDto":{"id":"components/schemas/ContractNumberParameterDto","kind":"json-schema","title":"ContractNumberParameterDto","data":{"type":"object","properties":{"type":{"enum":["String","StringList","Number","Boolean","Date","Datetime","ProductMetric"],"type":"string","description":"Parameter type of parameter","format":"int32","example":"Number"},"label":{"type":"object","additionalProperties":{"type":"string"},"description":"Dictionary of parameter label localized in different languages","example":{"en":"parameter label in english","it":"label del parametro in italiano","de":"...","fr":"...","es":"...","pt":"...","ro":"..."}},"required":{"type":"boolean","description":"Parameter is mandatory","example":true},"async":{"type":"boolean","description":"Whether the parameter can be filled later or not\r\nDEFAULT: \"false\"","example":true},"isConstant":{"type":"boolean","description":"Whether the parameter value is constant and cannot be changed\r\nDEFAULT: \"false\"","example":false},"order":{"type":"integer","description":"Order of the parameter in the list of parameters\r\nDEFAULT: \"Not applied\"","format":"int32","nullable":true,"example":10},"contractTypes":{"type":"array","items":{"enum":["Resell","Direct","Indirect","Distribution"],"type":"string","format":"int32"},"description":"Contract types this parameter will be applied to","example":["Direct","Resell"]},"groupId":{"type":"string","description":"Parameter section identifier this parameter belongs to","nullable":true},"precision":{"type":"integer","description":"Decimal places of parameter","format":"int32","nullable":true},"min":{"type":"number","description":"Minimum value of parameter","format":"double","nullable":true},"max":{"type":"number","description":"Maximum value of parameter","format":"double","nullable":true},"defaultValue":{"type":"number","description":"Default value of parameter","format":"double","nullable":true},"placeholder":{"type":"object","additionalProperties":{"type":"string"},"description":"Placeholder of parameter to see in the input field of UI","nullable":true}},"additionalProperties":false}},"components/schemas/ContractParameterGroupDto":{"id":"components/schemas/ContractParameterGroupDto","kind":"json-schema","title":"ContractParameterGroupDto","data":{"type":"object","properties":{"label":{"type":"object","additionalProperties":{"type":"string"},"description":"Dictionary of parameter section label localized in different languages","example":{"en":"parameter label in english","it":"label del parametro in italiano","de":"...","fr":"...","es":"...","pt":"...","ro":"..."}},"order":{"type":"integer","description":"Order of the parameter section in the list of parameter groups\r\nDEFAULT: \"Not applied\"","format":"int32","nullable":true}},"additionalProperties":false}},"components/schemas/ContractProductMetricParameterDto":{"id":"components/schemas/ContractProductMetricParameterDto","kind":"json-schema","title":"ContractProductMetricParameterDto","data":{"type":"object","properties":{"type":{"enum":["String","StringList","Number","Boolean","Date","Datetime","ProductMetric"],"type":"string","description":"Parameter type of parameter","format":"int32","example":"Number"},"label":{"type":"object","additionalProperties":{"type":"string"},"description":"Dictionary of parameter label localized in different languages","example":{"en":"parameter label in english","it":"label del parametro in italiano","de":"...","fr":"...","es":"...","pt":"...","ro":"..."}},"async":{"type":"boolean","description":"Whether the parameter can be filled later or not\r\nDEFAULT: \"false\"","example":true},"isConstant":{"type":"boolean","description":"Whether the parameter value is constant and cannot be changed\r\nDEFAULT: \"false\"","example":false},"order":{"type":"integer","description":"Order of the parameter in the list of parameters\r\nDEFAULT: \"Not applied\"","format":"int32","nullable":true,"example":10},"contractTypes":{"type":"array","items":{"enum":["Resell","Direct","Indirect","Distribution"],"type":"string","format":"int32"},"description":"Contract types this parameter will be applied to","example":["Direct","Resell"]},"groupId":{"type":"string","description":"Parameter section identifier this parameter belongs to","nullable":true},"placeholder":{"type":"object","additionalProperties":{"type":"string"},"description":"Placeholder of parameter to see in the input field of UI","nullable":true},"required":{"type":"boolean"}},"additionalProperties":false}},"components/schemas/ContractRecipientDto":{"id":"components/schemas/ContractRecipientDto","kind":"json-schema","title":"ContractRecipientDto","data":{"type":"object","properties":{"email":{"type":"string","description":"The recipient email"}},"additionalProperties":false}},"components/schemas/ContractStatusUpdateResponseDto":{"id":"components/schemas/ContractStatusUpdateResponseDto","kind":"json-schema","title":"ContractStatusUpdateResponseDto","data":{"type":"object","properties":{"contractId":{"type":"string","description":"Identifier for the contract."},"provisioningValidationResults":{"type":"array","items":{"$ref":"#/components/schemas/ProvisioningValidationResultDto"},"description":"List of contract items that were updated as part of the operation."}},"additionalProperties":false}},"components/schemas/ContractStatusUpdateSummaryDto":{"id":"components/schemas/ContractStatusUpdateSummaryDto","kind":"json-schema","title":"ContractStatusUpdateSummaryDto","data":{"type":"object","properties":{"contractId":{"type":"string","description":"The contract identifier"},"previousStatus":{"enum":["Draft","Pending","Final","Processing","Completed","Expired","Cancelled","Support"],"type":"string","description":"The contract status before the update","format":"int32"},"currentStatus":{"enum":["Draft","Pending","Final","Processing","Completed","Expired","Cancelled","Support"],"type":"string","description":"The contract status after the update","format":"int32"},"provisioningValidationResults":{"type":"array","items":{"$ref":"#/components/schemas/ProvisioningValidationResultDto"},"description":"Provisioning validation errors for the contract items"}},"additionalProperties":false}},"components/schemas/ContractStringListParameterDto":{"id":"components/schemas/ContractStringListParameterDto","kind":"json-schema","title":"ContractStringListParameterDto","data":{"type":"object","properties":{"type":{"enum":["String","StringList","Number","Boolean","Date","Datetime","ProductMetric"],"type":"string","description":"Parameter type of parameter","format":"int32","example":"Number"},"label":{"type":"object","additionalProperties":{"type":"string"},"description":"Dictionary of parameter label localized in different languages","example":{"en":"parameter label in english","it":"label del parametro in italiano","de":"...","fr":"...","es":"...","pt":"...","ro":"..."}},"required":{"type":"boolean","description":"Parameter is mandatory","example":true},"async":{"type":"boolean","description":"Whether the parameter can be filled later or not\r\nDEFAULT: \"false\"","example":true},"isConstant":{"type":"boolean","description":"Whether the parameter value is constant and cannot be changed\r\nDEFAULT: \"false\"","example":false},"order":{"type":"integer","description":"Order of the parameter in the list of parameters\r\nDEFAULT: \"Not applied\"","format":"int32","nullable":true,"example":10},"contractTypes":{"type":"array","items":{"enum":["Resell","Direct","Indirect","Distribution"],"type":"string","format":"int32"},"description":"Contract types this parameter will be applied to","example":["Direct","Resell"]},"groupId":{"type":"string","description":"Parameter section identifier this parameter belongs to","nullable":true},"values":{"type":"array","items":{"$ref":"#/components/schemas/ContractStringListParameterValueDto"},"description":"Allowed values of parameter"},"multiple":{"type":"boolean","description":"Multiple values can be selected"},"defaultValue":{"type":"array","items":{"type":"string"},"description":"Default value of parameter","nullable":true},"placeholder":{"type":"object","additionalProperties":{"type":"string"},"description":"Placeholder of parameter to see in the input field of UI","nullable":true},"dataSource":{"type":"string","description":"Data source identifier to resolve values dynamically","nullable":true}},"additionalProperties":false}},"components/schemas/ContractStringListParameterValueDto":{"id":"components/schemas/ContractStringListParameterValueDto","kind":"json-schema","title":"ContractStringListParameterValueDto","data":{"type":"object","properties":{"value":{"type":"string","description":"Allowed value of parameter"},"label":{"type":"object","additionalProperties":{"type":"string"},"description":"Label of parameter to see in the UI","nullable":true,"example":{"en":"parameter label in english","it":"label del parametro in italiano","de":"...","fr":"...","es":"...","pt":"...","ro":"..."}}},"additionalProperties":false}},"components/schemas/ContractStringParameterDto":{"id":"components/schemas/ContractStringParameterDto","kind":"json-schema","title":"ContractStringParameterDto","data":{"type":"object","properties":{"type":{"enum":["String","StringList","Number","Boolean","Date","Datetime","ProductMetric"],"type":"string","description":"Parameter type of parameter","format":"int32","example":"Number"},"label":{"type":"object","additionalProperties":{"type":"string"},"description":"Dictionary of parameter label localized in different languages","example":{"en":"parameter label in english","it":"label del parametro in italiano","de":"...","fr":"...","es":"...","pt":"...","ro":"..."}},"required":{"type":"boolean","description":"Parameter is mandatory","example":true},"async":{"type":"boolean","description":"Whether the parameter can be filled later or not\r\nDEFAULT: \"false\"","example":true},"isConstant":{"type":"boolean","description":"Whether the parameter value is constant and cannot be changed\r\nDEFAULT: \"false\"","example":false},"order":{"type":"integer","description":"Order of the parameter in the list of parameters\r\nDEFAULT: \"Not applied\"","format":"int32","nullable":true,"example":10},"contractTypes":{"type":"array","items":{"enum":["Resell","Direct","Indirect","Distribution"],"type":"string","format":"int32"},"description":"Contract types this parameter will be applied to","example":["Direct","Resell"]},"groupId":{"type":"string","description":"Parameter section identifier this parameter belongs to","nullable":true},"defaultValue":{"type":"string","description":"Default value of parameter","nullable":true},"placeholder":{"type":"object","additionalProperties":{"type":"string"},"description":"Placeholder of parameter to see in the input field of UI","nullable":true}},"additionalProperties":false}},"components/schemas/CounterAggregatedDto":{"id":"components/schemas/CounterAggregatedDto","kind":"json-schema","title":"CounterAggregatedDto","data":{"type":"object","properties":{"metricId":{"type":"string","description":"id of the metric on which the counter has been registered"},"timestamp":{"type":"string","description":"datetime (ISO 8601) on which the counter has been registered","format":"date-time"},"value":{"type":"number","description":"value of the counter","format":"double"},"attributeId":{"type":"string","description":"attribute identifier when grouping with attribute id is enabled"},"attributeValue":{"type":"string","description":"attribute value when grouping with attribute id is enabled"}},"additionalProperties":false}},"components/schemas/CounterMetricDto":{"id":"components/schemas/CounterMetricDto","kind":"json-schema","title":"CounterMetricDto","data":{"required":["id"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"id of the counter metric","example":"your-counter-metric"},"label":{"type":"object","additionalProperties":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dictionary of counter metric's label localized in different languages"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"!!! IMPORTANT !!!"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ENGLISH is the default language, so the label in english must be always present"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. {"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"en\": \"counter metric label in english\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"it\": \"label della metrica counter in italiano\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"de\": \"...\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"fr\": \"...\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"es\": \"...\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"pt\": \"...\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"ro\": \"...\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}"},"children":[]}]}]}],"example":{"en":"counter metric label in english","it":"label della metrica counter in italiano","de":"...","fr":"...","es":"...","pt":"...","ro":"..."}},"unit":{"type":"object","additionalProperties":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of measure of the counter metric"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"!!! IMPORTANT !!!"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ENGLISH is the default language, so the label in english must be always present"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. {"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"en\": \"days\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"it\": \"giorni\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"de\": \"...\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"fr\": \"...\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"es\": \"...\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"pt\": \"...\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"ro\": \"...\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}"},"children":[]}]}]}],"nullable":true,"example":{"en":"days","it":"giorni","de":"...","fr":"...","es":"...","pt":"...","ro":"..."}},"iconData":{"type":"string","description":"Icon of the counter metric in data:image format","nullable":true,"example":"data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdC="},"order":{"type":"integer","description":"Order of the counter metric in the list of counter metrics\r\nDEFAULT: \"Not applied\"","format":"int32","nullable":true,"example":10},"unitType":{"enum":["Default","DecimalByte","BinaryByte","ScientificQuantity"],"type":"string","description":"Type of the unit of measure.\r\nDecimalByte ar 1000-based byte (KB, MB, GB, TB, PB, EB, ZB, YB)\r\nBinaryByte are 1024-based byte (KiB, MiB, GiB, TiB, PiB, EiB, ZiB, YiB)\r\nScientificQuantity are 1000-based (K, M, G, T, P, E, Z, Y)\r\nDEFAULT: \"Default\"","format":"int32","example":"DecimalByte, BinaryByte, ScientificQuantity"},"scaleSize":{"enum":["None","K","M","G","T","P","E","Z","Y"],"type":"string","description":"Scale size to be applied to the counter metric value\r\nDEFAULT: None","format":"int32","example":"K, M, G, T, P, E, Z, Y"},"visible":{"type":"boolean","description":"Visibility of the counter metric\r\nDEFAULT: true","example":true},"attributes":{"type":"array","items":{"$ref":"#/components/schemas/AttributeDto"},"description":"Attributes to be associated to the counter metric, used for grouping management"}},"additionalProperties":false}},"components/schemas/CountersAggregatedConsumerDto":{"id":"components/schemas/CountersAggregatedConsumerDto","kind":"json-schema","title":"CountersAggregatedConsumerDto","data":{"type":"object","properties":{"consumerId":{"type":"string"},"productId":{"type":"string"},"attributeId":{"type":"string"},"counters":{"type":"array","items":{"$ref":"#/components/schemas/CounterAggregatedDto"}},"metricInfos":{"type":"array","items":{"$ref":"#/components/schemas/MetricInfo"}}},"additionalProperties":false}},"components/schemas/DocumentCreateDto":{"id":"components/schemas/DocumentCreateDto","kind":"json-schema","title":"DocumentCreateDto","data":{"type":"object","properties":{"fallbackLanguage":{"type":"string","description":"Initial document version fallback language.","example":"it"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description for this document."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"!!! IMPORTANT !!!"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ENGLISH is the default language, so the description in english must be always present"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. {"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"en\": \"description of the document in english\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"it\": \"descrizione del documento in italiano\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"de\": \"...\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"fr\": \"...\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"es\": \"...\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"pt\": \"...\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"ro\": \"...\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}"},"children":[]}]}]}],"example":{"en":"description of the document in english","it":"descrizione del documento in italiano","de":"...","fr":"...","es":"...","pt":"...","ro":"..."}}},"additionalProperties":false}},"components/schemas/ErrorDto":{"id":"components/schemas/ErrorDto","kind":"json-schema","title":"ErrorDto","data":{"type":"object","properties":{"source":{"type":"string"},"title":{"type":"string"},"statusCode":{"type":"integer","format":"int32"},"code":{"type":"string"},"detail":{"type":"string"},"detailObject":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"nullable":true}},"additionalProperties":false}},"components/schemas/FailedOperationDto":{"id":"components/schemas/FailedOperationDto","kind":"json-schema","title":"FailedOperationDto","data":{"type":"object","properties":{"resourceType":{"enum":["Contracts","ContractItems","BusinessRelations","Subscriptions"],"type":"string","format":"int32","nullable":true},"id":{"type":"string"},"error":{"$ref":"#/components/schemas/ErrorDto"}},"additionalProperties":false}},"components/schemas/GuidDto":{"id":"components/schemas/GuidDto","kind":"json-schema","title":"GuidDto","data":{"type":"object","properties":{"id":{"type":"string","description":"GUID identifier.","example":"c6de6777-1a90-45f2-869d-007421d682a2"}},"additionalProperties":false}},"components/schemas/HttpClientSettingsDto":{"id":"components/schemas/HttpClientSettingsDto","kind":"json-schema","title":"HttpClientSettingsDto","data":{"type":"object","properties":{"certificate":{"$ref":"#/components/schemas/X509Certificate2"},"jwtBearerTokenProvider":{"type":"string","description":"The JWT bearer token provider identifier.","nullable":true},"jwtBearerTokenUrl":{"type":"string","description":"The JWT bearer token endpoint.","nullable":true},"jwtBearerClientId":{"type":"string","description":"The JWT bearer client identifier.","nullable":true},"jwtBearerClientSecret":{"type":"string","description":"The JWT bearer client secret.","nullable":true},"basicAuthUser":{"type":"string","description":"The basic auth user.","nullable":true},"basicAuthPassword":{"type":"string","description":"The basic auth password.","nullable":true},"apiKey":{"type":"string","description":"The api key value.","nullable":true},"apiKeyHeaderId":{"type":"string","description":"The api key header id. (default: \"X-API-Key\")","nullable":true},"certificateBase64":{"type":"string","description":"The ssl certificate base 64 encoded.","nullable":true},"certificatePassword":{"type":"string","description":"The ssl certificate password.","nullable":true}},"additionalProperties":false}},"components/schemas/IResult":{"id":"components/schemas/IResult","kind":"json-schema","title":"IResult","data":{"type":"object","additionalProperties":false}},"components/schemas/IdDto":{"id":"components/schemas/IdDto","kind":"json-schema","title":"IdDto","data":{"type":"object","properties":{"id":{"type":"string"}},"additionalProperties":false}},"components/schemas/IntPtr":{"id":"components/schemas/IntPtr","kind":"json-schema","title":"IntPtr","data":{"type":"object","additionalProperties":false}},"components/schemas/KeySizes":{"id":"components/schemas/KeySizes","kind":"json-schema","title":"KeySizes","data":{"type":"object","properties":{"minSize":{"type":"integer","format":"int32"},"maxSize":{"type":"integer","format":"int32"},"skipSize":{"type":"integer","format":"int32"}},"additionalProperties":false}},"components/schemas/LastConsumptionDto":{"id":"components/schemas/LastConsumptionDto","kind":"json-schema","title":"LastConsumptionDto","data":{"type":"object","properties":{"metricId":{"type":"string","description":"id of the metric on which the consumption has been registered"},"timestamp":{"type":"string","description":"datetime (ISO 8601) on which the consumption has been registered","format":"date-time"},"datestamp":{"type":"string","description":"datetime (ISO 8601) on which the consumption has been registered","format":"date-time"},"value":{"type":"number","description":"value of the consumption","format":"double"},"businessRelationId":{"type":"string","description":"Business relation identifier"},"attributes":{"type":"object","additionalProperties":{"type":"string"},"description":"attributes to be associated to the consumptions, used for grouping management","example":{"your-attribute":"attribute value for this consumption"}}},"additionalProperties":false}},"components/schemas/LatestConsumptionsDto":{"id":"components/schemas/LatestConsumptionsDto","kind":"json-schema","title":"LatestConsumptionsDto","data":{"type":"object","properties":{"businessRelationId":{"type":"string"},"consumptions":{"type":"array","items":{"$ref":"#/components/schemas/LastConsumptionDto"}}},"additionalProperties":false}},"components/schemas/LicenseInternalSubscription":{"id":"components/schemas/LicenseInternalSubscription","kind":"json-schema","title":"LicenseInternalSubscription","data":{"type":"object","properties":{"id":{"type":"string"},"status":{"enum":["Unknown","Active","InTrial","NonRenewing","Future","Cancelled","Paused","Transferred"],"type":"string","format":"int32"},"currentTermEnd":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time","nullable":true},"updatedAt":{"type":"string","format":"date-time","nullable":true},"nextBillingAt":{"type":"string","format":"date-time","nullable":true},"startDate":{"type":"string","format":"date-time","nullable":true},"startedAt":{"type":"string","format":"date-time","nullable":true},"cancelledAt":{"type":"string","format":"date-time","nullable":true},"currentTermStart":{"type":"string","format":"date-time","nullable":true},"activatedAt":{"type":"string","format":"date-time","nullable":true},"subscriptionUserId":{"type":"string"},"deleted":{"type":"boolean"}},"additionalProperties":false}},"components/schemas/ListDtoOfConsumerDto":{"id":"components/schemas/ListDtoOfConsumerDto","kind":"json-schema","title":"ListDtoOfConsumerDto","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ConsumerDto"}}},"additionalProperties":false}},"components/schemas/ListDtoOfConsumerPathWithNameDto":{"id":"components/schemas/ListDtoOfConsumerPathWithNameDto","kind":"json-schema","title":"ListDtoOfConsumerPathWithNameDto","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ConsumerPathWithNameDto"}}},"additionalProperties":false}},"components/schemas/ListDtoOfProductMetricsDto":{"id":"components/schemas/ListDtoOfProductMetricsDto","kind":"json-schema","title":"ListDtoOfProductMetricsDto","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ProductMetricsDto"}}},"additionalProperties":false}},"components/schemas/ListDtoOfUserBaseDto":{"id":"components/schemas/ListDtoOfUserBaseDto","kind":"json-schema","title":"ListDtoOfUserBaseDto","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/UserBaseDto"}}},"additionalProperties":false}},"components/schemas/MetricDto":{"id":"components/schemas/MetricDto","kind":"json-schema","title":"MetricDto","data":{"required":["id"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"id of the metric","example":"your-metric"},"label":{"type":"object","additionalProperties":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dictionary of metric's label localized in different languages"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"!!! IMPORTANT !!!"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ENGLISH is the default language, so the label in english must be always present"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. {"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"en\": \"metric label in english\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"it\": \"label della metrica in italiano\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"de\": \"...\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"fr\": \"...\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"es\": \"...\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"pt\": \"...\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"ro\": \"...\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}"},"children":[]}]}]}],"example":{"en":"metric label in english","it":"label della metrica in italiano","de":"...","fr":"...","es":"...","pt":"...","ro":"..."}},"type":{"enum":["Total","Incremental","TotalPersistent"],"type":"string","description":"metric type\r\nDEFAULT: total","format":"int32","example":"Total"},"unit":{"type":"object","additionalProperties":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of measure of the metric"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"!!! IMPORTANT !!!"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ENGLISH is the default language, so the label in english must be always present"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. {"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"en\": \"days\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"it\": \"giorni\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"de\": \"...\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"fr\": \"...\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"es\": \"...\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"pt\": \"...\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"ro\": \"...\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}"},"children":[]}]}]}],"nullable":true,"example":{"en":"days","it":"giorni","de":"...","fr":"...","es":"...","pt":"...","ro":"..."}},"iconData":{"type":"string","description":"Icon of the metric in data:image format","nullable":true,"example":"data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdC="},"order":{"type":"integer","description":"Order of the metric in the list of metrics\r\nDEFAULT: \"Not applied\"","format":"int32","nullable":true,"example":10},"unitType":{"enum":["Default","DecimalByte","BinaryByte","ScientificQuantity"],"type":"string","description":"Type of the unit of measure.\r\nDecimalByte ar 1000-based byte (KB, MB, GB, TB, PB, EB, ZB, YB)\r\nBinaryByte are 1024-based byte (KiB, MiB, GiB, TiB, PiB, EiB, ZiB, YiB)\r\nScientificQuantity are 1000-based (K, M, G, T, P, E, Z, Y)\r\nDEFAULT: \"Default\"","format":"int32","example":"DecimalByte, BinaryByte, ScientificQuantity"},"scaleSize":{"enum":["None","K","M","G","T","P","E","Z","Y"],"type":"string","description":"Scale size to be applied to the metric value\r\nDEFAULT: None","format":"int32","example":"K, M, G, T, P, E, Z, Y"},"aggregationLevel":{"enum":["Daily","Monthly","Yearly"],"type":"string","description":"Navigation period type of the metric\r\nDEFAULT: Daily","format":"int32"},"visible":{"type":"boolean","description":"Visibility of the metric\r\nDEFAULT: true","example":true},"isCredit":{"type":"boolean","description":"Whether the metric represents credit consumption.\r\nIt can be true only for incremental metrics.","example":true},"attributes":{"type":"array","items":{"$ref":"#/components/schemas/AttributeDto"},"description":"Attributes to be associated to the metric, used for grouping management"}},"additionalProperties":false}},"components/schemas/MetricInfo":{"id":"components/schemas/MetricInfo","kind":"json-schema","title":"MetricInfo","data":{"type":"object","properties":{"metricId":{"type":"string"},"lastUpdate":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}},"components/schemas/MultiFailedOperationResponseDto":{"id":"components/schemas/MultiFailedOperationResponseDto","kind":"json-schema","title":"MultiFailedOperationResponseDto","data":{"type":"object","properties":{"id":{"type":"string"},"error":{"$ref":"#/components/schemas/ErrorDto"}},"additionalProperties":false}},"components/schemas/MultiOperationResponseDtoOfProvisioningValidationResultDto":{"id":"components/schemas/MultiOperationResponseDtoOfProvisioningValidationResultDto","kind":"json-schema","title":"MultiOperationResponseDtoOfProvisioningValidationResultDto","data":{"type":"object","properties":{"succeededOperations":{"type":"array","items":{"$ref":"#/components/schemas/ProvisioningValidationResultDto"}},"failedOperations":{"type":"array","items":{"$ref":"#/components/schemas/MultiFailedOperationResponseDto"}}},"additionalProperties":false}},"components/schemas/MultiOperationsDto":{"id":"components/schemas/MultiOperationsDto","kind":"json-schema","title":"MultiOperationsDto","data":{"type":"object","properties":{"succeededOperations":{"type":"array","items":{"$ref":"#/components/schemas/SucceededOperationDto"}},"failedOperations":{"type":"array","items":{"$ref":"#/components/schemas/FailedOperationDto"}}},"additionalProperties":false}},"components/schemas/Oid":{"id":"components/schemas/Oid","kind":"json-schema","title":"Oid","data":{"type":"object","properties":{"value":{"type":"string","nullable":true},"friendlyName":{"type":"string","nullable":true}},"additionalProperties":false}},"components/schemas/OnboardingInfoDto":{"id":"components/schemas/OnboardingInfoDto","kind":"json-schema","title":"OnboardingInfoDto","data":{"type":"object","properties":{"documentIds":{"type":"array","items":{"type":"string"},"description":"Documents used during onboarding."},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"Description for this onboarding info."},"formName":{"type":"string","description":"The FormName of the form that the front-end will use during onboarding.\r\nIf not provided, no form will be used for onboarding.","nullable":true,"example":"OnboardingForm"},"formProps":{"type":"object","additionalProperties":{"type":"string"},"description":"The props of the form that the front-end will use during onboarding."},"useGenericSkuAsyncParametersEditor":{"type":"boolean","description":"Controls whether to use the generic editor for SKU async parameters.\r\nWhen false, the onboarding form is expected to manage them."},"hideVerifyProfile":{"type":"boolean","description":"Controls whether the Verify Profile step is hidden during onboarding. Default: false."},"signatureMethod":{"enum":["ClickToSign","TypeToSign","OneTimePassword"],"type":"string","description":"Preferred signature method for documents in this onboarding info (Default: ClickToSign).","format":"int32"},"authenticationMethod":{"enum":["None","SmsOneTimePassword"],"type":"string","description":"Preferred authentication method for recipients in this onboarding info (Default: None).","format":"int32"},"enableBatchSigning":{"type":"boolean","description":"If true, all signatures are presented in a batch signing dialog (single click for all). Default: true."},"autoFinishAfterRequiredTasksDone":{"type":"boolean","description":"If true, the signing viewer finalizes automatically after all required signatures are done,\r\nwithout requiring an explicit finish confirmation. Default: true."},"id":{"type":"string","description":"The onboarding info identifier."},"createdAt":{"type":"string","description":"Date and time indicating when this onboarding info was created.","format":"date-time","example":"2023-11-28T08:14:32.585Z"},"updatedAt":{"type":"string","description":"Date and time indicating when this onboarding info was updated.","format":"date-time","example":"2023-11-28T08:14:32.585Z"}},"additionalProperties":false}},"components/schemas/OnboardingStateDto":{"id":"components/schemas/OnboardingStateDto","kind":"json-schema","title":"OnboardingStateDto","data":{"type":"object","properties":{"currentStepIndex":{"type":"integer","description":"Zero-based index of the wizard step the user should resume from.","format":"int32","nullable":true},"currentSubStepIndex":{"type":"integer","description":"Zero-based index of the sub-step within the current wizard step the user should resume from.","format":"int32","nullable":true}},"additionalProperties":false,"description":"Persisted onboarding wizard state for a service activation group"}},"components/schemas/PaginationDtoOfBusinessRelationDto":{"id":"components/schemas/PaginationDtoOfBusinessRelationDto","kind":"json-schema","title":"PaginationDtoOfBusinessRelationDto","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/BusinessRelationDto"},"description":"ICollection of the final sorted, filtered and paginated data."},"pageNumber":{"type":"integer","description":"The current page number.","format":"int32"},"pageSize":{"type":"integer","description":"Number or items in a page.","format":"int32"},"totalPages":{"type":"integer","description":"Total number of pages.","format":"int32","readOnly":true},"totalItems":{"type":"integer","description":"Total number of items that exist for the query.","format":"int32"}},"additionalProperties":false,"description":"Stores the filtered, sorted and paginated data for the given entity type."}},"components/schemas/PaginationDtoOfConsumerDto":{"id":"components/schemas/PaginationDtoOfConsumerDto","kind":"json-schema","title":"PaginationDtoOfConsumerDto","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ConsumerDto"},"description":"ICollection of the final sorted, filtered and paginated data."},"pageNumber":{"type":"integer","description":"The current page number.","format":"int32"},"pageSize":{"type":"integer","description":"Number or items in a page.","format":"int32"},"totalPages":{"type":"integer","description":"Total number of pages.","format":"int32","readOnly":true},"totalItems":{"type":"integer","description":"Total number of items that exist for the query.","format":"int32"}},"additionalProperties":false,"description":"Stores the filtered, sorted and paginated data for the given entity type."}},"components/schemas/PaginationDtoOfConsumerDtoV1":{"id":"components/schemas/PaginationDtoOfConsumerDtoV1","kind":"json-schema","title":"PaginationDtoOfConsumerDtoV1","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ConsumerDtoV1"},"description":"ICollection of the final sorted, filtered and paginated data."},"pageNumber":{"type":"integer","description":"The current page number.","format":"int32"},"pageSize":{"type":"integer","description":"Number or items in a page.","format":"int32"},"totalPages":{"type":"integer","description":"Total number of pages.","format":"int32","readOnly":true},"totalItems":{"type":"integer","description":"Total number of items that exist for the query.","format":"int32"}},"additionalProperties":false,"description":"Stores the filtered, sorted and paginated data for the given entity type."}},"components/schemas/PaginationDtoOfConsumerPathItemDto":{"id":"components/schemas/PaginationDtoOfConsumerPathItemDto","kind":"json-schema","title":"PaginationDtoOfConsumerPathItemDto","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ConsumerPathItemDto"},"description":"ICollection of the final sorted, filtered and paginated data."},"pageNumber":{"type":"integer","description":"The current page number.","format":"int32"},"pageSize":{"type":"integer","description":"Number or items in a page.","format":"int32"},"totalPages":{"type":"integer","description":"Total number of pages.","format":"int32","readOnly":true},"totalItems":{"type":"integer","description":"Total number of items that exist for the query.","format":"int32"}},"additionalProperties":false,"description":"Stores the filtered, sorted and paginated data for the given entity type."}},"components/schemas/PaginationDtoOfContractDto":{"id":"components/schemas/PaginationDtoOfContractDto","kind":"json-schema","title":"PaginationDtoOfContractDto","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ContractDto"},"description":"ICollection of the final sorted, filtered and paginated data."},"pageNumber":{"type":"integer","description":"The current page number.","format":"int32"},"pageSize":{"type":"integer","description":"Number or items in a page.","format":"int32"},"totalPages":{"type":"integer","description":"Total number of pages.","format":"int32","readOnly":true},"totalItems":{"type":"integer","description":"Total number of items that exist for the query.","format":"int32"}},"additionalProperties":false,"description":"Stores the filtered, sorted and paginated data for the given entity type."}},"components/schemas/PaginationDtoOfContractItemDto":{"id":"components/schemas/PaginationDtoOfContractItemDto","kind":"json-schema","title":"PaginationDtoOfContractItemDto","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ContractItemDto"},"description":"ICollection of the final sorted, filtered and paginated data."},"pageNumber":{"type":"integer","description":"The current page number.","format":"int32"},"pageSize":{"type":"integer","description":"Number or items in a page.","format":"int32"},"totalPages":{"type":"integer","description":"Total number of pages.","format":"int32","readOnly":true},"totalItems":{"type":"integer","description":"Total number of items that exist for the query.","format":"int32"}},"additionalProperties":false,"description":"Stores the filtered, sorted and paginated data for the given entity type."}},"components/schemas/ProductCategoryDto":{"id":"components/schemas/ProductCategoryDto","kind":"json-schema","title":"ProductCategoryDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of this Product Category"},"name":{"type":"object","additionalProperties":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of this Product Category"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"!!! IMPORTANT !!!"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ENGLISH is the default language, so the name in english must be always present"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. {"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"en\": \"name of the Product Category in english\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"it\": \"nome della Categoria Prodotto in italiano\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"de\": \"...\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"fr\": \"...\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"es\": \"...\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"pt\": \"...\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"ro\": \"...\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}"},"children":[]}]}]}],"example":{"en":"name of the Product Category in english","it":"nome della Categoria Prodotto in italiano","de":"...","fr":"...","es":"...","pt":"...","ro":"..."}},"description":{"type":"object","additionalProperties":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description of this Product Category"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"!!! IMPORTANT !!!"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ENGLISH is the default language, so the description in english must be always present"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. {"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"en\": \"description of the Product Category in english\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"it\": \"descrizione della Categoria Prodotto in italiano\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"de\": \"...\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"fr\": \"...\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"es\": \"...\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"pt\": \"...\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"ro\": \"...\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}"},"children":[]}]}]}],"example":{"en":"description of the Product Category in english","it":"descrizione della Categoria Prodotto in italiano","de":"...","fr":"...","es":"...","pt":"...","ro":"..."}},"provisioningInfo":{"$ref":"#/components/schemas/ProductCategoryProvisioningInfoDto"},"restrictMultipleSkus":{"type":"boolean","description":"Restrict multiple skus"},"uniqueProvisioning":{"type":"boolean","description":"Unique provisioning for product category"}},"additionalProperties":false}},"components/schemas/ProductCategoryProvisioningInfoDto":{"id":"components/schemas/ProductCategoryProvisioningInfoDto","kind":"json-schema","title":"ProductCategoryProvisioningInfoDto","data":{"type":"object","properties":{"url":{"type":"string","description":"Provisioning URL for this product category"},"httpClientSettings":{"$ref":"#/components/schemas/HttpClientSettingsDto"},"payloadVersion":{"enum":["V1","V2","V3","V4"],"type":"string","description":"Provisioning payload version for this product category","format":"int32","nullable":true},"dryRunUrl":{"type":"string","description":"Dry-run URL for this product category - used for validation before provisioning","nullable":true},"dryRunOnContractInPending":{"type":"boolean","description":"Indicates whether a dry-run must be executed also when the contract moves to Pending status."}},"additionalProperties":false}},"components/schemas/ProductMetricsDto":{"id":"components/schemas/ProductMetricsDto","kind":"json-schema","title":"ProductMetricsDto","data":{"required":["productId"],"type":"object","properties":{"productId":{"minLength":1,"type":"string","description":"id of the product on which the given metrics has to be registered","example":"your-product"},"attributes":{"type":"array","items":{"$ref":"#/components/schemas/AttributeDto"},"description":"attributes to be associated to the metrics, used for grouping management"},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/MetricDto"},"description":"metrics to be registered"},"counterMetrics":{"type":"array","items":{"$ref":"#/components/schemas/CounterMetricDto"},"description":"counters to be registered"},"aggregationsIntervalDays":{"type":"integer","description":"interval aggregations days","format":"int32"},"id":{"type":"string"}},"additionalProperties":false}},"components/schemas/ProvisioningPayloadConsumerBirthInfoDtoV2":{"id":"components/schemas/ProvisioningPayloadConsumerBirthInfoDtoV2","kind":"json-schema","title":"ProvisioningPayloadConsumerBirthInfoDtoV2","data":{"type":"object","properties":{"date":{"type":"string","description":"Date of birth.","format":"date"},"gender":{"enum":["Male","Female"],"type":"string","description":"Gender.","format":"int32"},"country":{"type":"string","description":"Country code of birth."},"state":{"type":"string","description":"State code of birth."},"city":{"type":"string","description":"City of birth."},"postalCode":{"type":"string","description":"Postal code of birth."}},"additionalProperties":false,"description":"Birth information payload for Individual consumers in provisioning V2."}},"components/schemas/ProvisioningPayloadConsumerBirthInfoDtoV3":{"id":"components/schemas/ProvisioningPayloadConsumerBirthInfoDtoV3","kind":"json-schema","title":"ProvisioningPayloadConsumerBirthInfoDtoV3","data":{"type":"object","properties":{"date":{"type":"string","description":"Date of birth.","format":"date"},"gender":{"enum":["Male","Female"],"type":"string","description":"Gender.","format":"int32"},"country":{"type":"string","description":"Country code of birth."},"state":{"type":"string","description":"State code of birth."},"city":{"type":"string","description":"City of birth."},"postalCode":{"type":"string","description":"Postal code of birth."}},"additionalProperties":false,"description":"Birth information payload for Individual consumers in provisioning V3."}},"components/schemas/ProvisioningPayloadConsumerBirthInfoDtoV4":{"id":"components/schemas/ProvisioningPayloadConsumerBirthInfoDtoV4","kind":"json-schema","title":"ProvisioningPayloadConsumerBirthInfoDtoV4","data":{"type":"object","properties":{"date":{"type":"string","description":"Date of birth.","format":"date"},"gender":{"enum":["Male","Female"],"type":"string","description":"Gender.","format":"int32"},"country":{"type":"string","description":"Country code of birth."},"state":{"type":"string","description":"State code of birth."},"city":{"type":"string","description":"City of birth."},"postalCode":{"type":"string","description":"Postal code of birth."}},"additionalProperties":false,"description":"Birth information payload for PrivateIndividual and ProfessionalIndividual consumers in provisioning V4."}},"components/schemas/ProvisioningPayloadConsumerResidenceInfoDtoV4":{"id":"components/schemas/ProvisioningPayloadConsumerResidenceInfoDtoV4","kind":"json-schema","title":"ProvisioningPayloadConsumerResidenceInfoDtoV4","data":{"type":"object","properties":{"country":{"type":"string","description":"Country of residence. The format is ISO 3166-1 alpha-2 (cca2)."},"address":{"type":"string","description":"Address of residence."},"state":{"type":"string","description":"State of residence."},"city":{"type":"string","description":"City of residence."},"postalCode":{"type":"string","description":"Postal code of the city of residence."},"personalCode":{"type":"string","description":"Personal code of the consumer.\n\r\nOnly for Customer PrivateIndividual and ProfessionalIndividual consumers.\n\r\nFor ITALIAN consumers with Italian residence: length 16 chars, validated with italian specifications.\n\r\nFor FRENCH consumers with French residence: length 15 chars, validated with french NIR specifications.\n\r\nMust be empty for all other consumer types and for residence countries other than IT/FR."}},"additionalProperties":false,"description":"Residence information payload for PrivateIndividual and ProfessionalIndividual consumers in provisioning V4."}},"components/schemas/ProvisioningPayloadContentBusinessRelationDtoV1":{"id":"components/schemas/ProvisioningPayloadContentBusinessRelationDtoV1","kind":"json-schema","title":"ProvisioningPayloadContentBusinessRelationDtoV1","data":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the business relation.","example":"4ec74e45-8262-469c-8182-7c23af8ed44e"},"resourceType":{"enum":["Consumption","Contract"],"type":"string","format":"int32"},"productId":{"type":"string","description":"Product identifier.","example":"eSAW"},"legalEntityId":{"type":"string","description":"Legal entity identifier.","example":"4eb8a4d7-ec5a-48ba-b3b4-4cbe913e7691"},"consumerIdsPath":{"type":"string","description":"Path of consumer identifiers.","example":"0d7c80ad-fd7f-40ef-9d97-b05dcf6ef911/2a0e7122-f9d3-42cf-b14e-87b5c26c7f69"},"integratorId":{"type":"string","description":"Integrator identifier (An optional property and default is an empty string).","example":"integrator-id"},"integratorLabel":{"type":"string","description":"Integrator label (An optional property used to replace the provided integratorId with a human-readable label).","example":"integrator-label"},"createdAt":{"type":"string","description":"Date and time indicating when this business relation was created.","format":"date-time","example":"2023-11-28T08:14:32.585Z"},"updatedAt":{"type":"string","description":"Date and time indicating when this business relation was last updated.","format":"date-time","example":"2023-11-28T08:14:32.585Z"}},"additionalProperties":false}},"components/schemas/ProvisioningPayloadContentBusinessRelationDtoV2":{"id":"components/schemas/ProvisioningPayloadContentBusinessRelationDtoV2","kind":"json-schema","title":"ProvisioningPayloadContentBusinessRelationDtoV2","data":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the business relation.","example":"4ec74e45-8262-469c-8182-7c23af8ed44e"},"resourceType":{"enum":["Consumption","Contract"],"type":"string","format":"int32"},"productId":{"type":"string","description":"Product identifier.","example":"eSAW"},"legalEntityId":{"type":"string","description":"Legal entity identifier.","example":"4eb8a4d7-ec5a-48ba-b3b4-4cbe913e7691"},"consumerIdsPath":{"type":"string","description":"Path of consumer identifiers.","example":"0d7c80ad-fd7f-40ef-9d97-b05dcf6ef911/2a0e7122-f9d3-42cf-b14e-87b5c26c7f69"},"integratorId":{"type":"string","description":"Integrator identifier (An optional property and default is an empty string).","example":"integrator-id"},"integratorLabel":{"type":"string","description":"Integrator label (An optional property used to replace the provided integratorId with a human-readable label).","example":"integrator-label"},"createdAt":{"type":"string","description":"Date and time indicating when this business relation was created.","format":"date-time","example":"2023-11-28T08:14:32.585Z"},"updatedAt":{"type":"string","description":"Date and time indicating when this business relation was last updated.","format":"date-time","example":"2023-11-28T08:14:32.585Z"}},"additionalProperties":false}},"components/schemas/ProvisioningPayloadContentBusinessRelationDtoV3":{"id":"components/schemas/ProvisioningPayloadContentBusinessRelationDtoV3","kind":"json-schema","title":"ProvisioningPayloadContentBusinessRelationDtoV3","data":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the business relation.","example":"4ec74e45-8262-469c-8182-7c23af8ed44e"},"resourceType":{"enum":["Consumption","Contract"],"type":"string","format":"int32"},"productId":{"type":"string","description":"Product identifier.","example":"eSAW"},"legalEntityId":{"type":"string","description":"Legal entity identifier.","example":"4eb8a4d7-ec5a-48ba-b3b4-4cbe913e7691"},"consumerIdsPath":{"type":"string","description":"Path of consumer identifiers.","example":"0d7c80ad-fd7f-40ef-9d97-b05dcf6ef911/2a0e7122-f9d3-42cf-b14e-87b5c26c7f69"},"integratorId":{"type":"string","description":"Integrator identifier (An optional property and default is an empty string).","example":"integrator-id"},"integratorLabel":{"type":"string","description":"Integrator label (An optional property used to replace the provided integratorId with a human-readable label).","example":"integrator-label"},"createdAt":{"type":"string","description":"Date and time indicating when this business relation was created.","format":"date-time","example":"2023-11-28T08:14:32.585Z"},"updatedAt":{"type":"string","description":"Date and time indicating when this business relation was last updated.","format":"date-time","example":"2023-11-28T08:14:32.585Z"}},"additionalProperties":false}},"components/schemas/ProvisioningPayloadContentBusinessRelationDtoV4":{"id":"components/schemas/ProvisioningPayloadContentBusinessRelationDtoV4","kind":"json-schema","title":"ProvisioningPayloadContentBusinessRelationDtoV4","data":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the business relation.","example":"4ec74e45-8262-469c-8182-7c23af8ed44e"},"resourceType":{"enum":["Consumption","Contract"],"type":"string","format":"int32"},"productId":{"type":"string","description":"Product identifier.","example":"eSAW"},"legalEntityId":{"type":"string","description":"Legal entity identifier.","example":"4eb8a4d7-ec5a-48ba-b3b4-4cbe913e7691"},"consumerIdsPath":{"type":"string","description":"Path of consumer identifiers.","example":"0d7c80ad-fd7f-40ef-9d97-b05dcf6ef911/2a0e7122-f9d3-42cf-b14e-87b5c26c7f69"},"integratorId":{"type":"string","description":"Integrator identifier (An optional property and default is an empty string).","example":"integrator-id"},"integratorLabel":{"type":"string","description":"Integrator label (An optional property used to replace the provided integratorId with a human-readable label).","example":"integrator-label"},"createdAt":{"type":"string","description":"Date and time indicating when this business relation was created.","format":"date-time","example":"2023-11-28T08:14:32.585Z"},"updatedAt":{"type":"string","description":"Date and time indicating when this business relation was last updated.","format":"date-time","example":"2023-11-28T08:14:32.585Z"}},"additionalProperties":false}},"components/schemas/ProvisioningPayloadContentConsumerDtoV1":{"id":"components/schemas/ProvisioningPayloadContentConsumerDtoV1","kind":"json-schema","title":"ProvisioningPayloadContentConsumerDtoV1","data":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the consumer.","example":"6dcd885f-a37b-427f-ab59-d008ae134aab"},"createdAt":{"type":"string","description":"Date and time indicating when this consumer was created.","format":"date-time","example":"2023-11-28T08:14:32.585Z"},"updatedAt":{"type":"string","description":"Date and time indicating when this consumer was last updated.","format":"date-time","example":"2023-11-28T08:14:32.585Z"},"legalEntityId":{"type":"string","description":"Associated legal entity identifier","nullable":true},"name":{"type":"string","description":"Name of the consumer.","example":"NAMIRIAL S.P.A."},"type":{"enum":["Customer","LegalEntity","InternalUnit"],"type":"string","description":"Consumer type (Customer, LegalEntity, InternalUnit).\n\r\nIn the creation of a consumer by integrators is forbidden the creation of a consumer with LegalEntity type.\n\n\r\nDEFAULT: Customer\n","format":"int32","example":"Customer"},"customerType":{"enum":["None","ProfessionalIndividual","Corporate","PublicAdministration","NonProfit","PrivateIndividual"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are: None, Individual, Corporate, PublicAdministration, NonProfit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the Type is Customer and CustomerType is None the CustomerType is automatically generated according to the following rules:"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| CustomerType........ | Vat...... | TaxNumber | PaNumber |"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| NonProfit........... | empty.... | length 11 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| NonProfit........... | empty.... | length 29 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Corporate........... | length 11 | length 11 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Corporate........... | length 29 | length 11 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Corporate........... | length 29 | length 29 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Individual.......... | empty.... | length 16 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Individual.......... | length 11 | length 16 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Individual.......... | length 29 | length 16 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | empty.... | length 11 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | empty.... | length 29 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | length 11 | length 11 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | length 29 | length 11 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | length 29 | length 29 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Without a type, it is not possible to define a NonProfit with Vat."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is still recommended when you have the type in hand to manually define the CustomerType with the correct type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For NO ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are: None, Individual, Corporate"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEFAULT: None"},"children":[]}]}]}],"format":"int32","example":"Corporate"},"country":{"type":"string","description":"Country of the consumer. The format is ISO 3166-1 alpha-2 (cca2).","example":"IT"},"vat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vat of the consumer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGULAR VAT:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 11 chars. The format is validated with italian specifications."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are numbers (0-9)."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEMPORARY VAT:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary VAT is used only for customers that do not have a regular VAT yet."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary VAT is composed by a header \"T01\" and a ULID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 29 chars: 3 header chars and 26 ULID chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are 0-9, A-H, J-K, M-N, P-T, V-Z. The format is validated with ULID specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is mandatory for: LegalEntity, Customer-Corporate"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: Customer-Individual, Customer-NonProfit, Customer-Public-Administration"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For NO ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are uppercase letters (A-Z), numbers (0-9), symbols dot (.), hyphen (-) and slash (/)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: Legal-Entity, Customer-Corporate, Customer-Individual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]}]},"taxNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax number of the consumer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERSON TAXNUMBER (16 chars). Only for Customer-Individual"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 16 chars. The format is validated with italian specifications."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are numbers (0-9, A-Z)."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGULAR TAXNUMBER (11 chars). Only for LegalEntity, Customer-Corporate, Customer-NonProfit, Customer-PublicAdministration"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 11 chars. The format is validated with italian specifications."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are numbers (0-9)."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEMPORARY TAXNUMBER (29 chars). Only for Customer-Corporate, Customer-NonProfit, Customer-PublicAdministration:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary TAXNUMBER is used only for customers that do not have a regular TAXNUMBER yet."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary TAXNUMBER is composed by a header \"T01\" and a ULID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 29 chars: 3 header chars and 26 ULID chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are 0-9, A-H, J-K, M-N, P-T, V-Z. The format is validated with ULID specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For NO ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are uppercase letters (A-Z), numbers (0-9), symbols dot (.), hyphen (-) and slash (/)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: Legal-Entity, Customer-Corporate, Customer-Individual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]}]},"paNumber":{"type":"string","description":"PA Number of the consumer.\n\n\r\nFor ITALIAN consumers:\n\r\nValid characters are uppercase letters (A-Z) and numbers (0-9). The format is validated with italian specifications.\n\r\nIs mandatory for: Customer-PublicAdministration\n\r\nMust be empty for: LegalEntity, Customer-Corporate, Customer-Individual, Customer-NonProfit, InternalUnit\n\n\r\nFor all other consumers:\n\r\nValid characters are uppercase letters (A-Z), digits (0-9), symbols dot (.), hyphen (-) and slash (/).\n\r\nIs optional for: LegalEntity, Customer-Corporate, Customer-PrivateIndividual, Customer-ProfessionalIndividual\n\r\nMust be empty for: InternalUnit","example":"UFCGFV"},"billable":{"type":"boolean","description":"Billable consumer.\n\r\nFor InternalUnit type must be false.","example":true},"address":{"type":"string","description":"Billing address of the consumer.\n\r\nIs mandatory when Billable is true.","example":"Via Caduti sul Lavoro, 4"},"state":{"type":"string","description":"Billing state of the consumer.\n\r\nIs mandatory when Billable is true.\n\r\nFor ITALIAN consumers is validated with the italian state list.","example":"AN"},"city":{"type":"string","description":"Billing city of the consumer.\n\r\nIs mandatory when Billable is true.\n\r\nFor ITALIAN consumers is validated with the italian state city list.","example":"Senigallia"},"postalCode":{"type":"string","description":"Billing postal code of the consumer.\n\r\nIs mandatory when Billable is true.\n\r\nFor ITALIAN consumers is validated with the italian state city postal code list.","example":"60019"},"emails":{"type":"array","items":{"type":"string"},"description":"Contact emails of the consumer.\n\r\nOne email is mandatory when Billable is true.","example":["info@namirial.com"]},"pecs":{"type":"array","items":{"type":"string"},"description":"Contact pecs of the consumer.\n","example":["amm.namirial@sicurezzapostale.it"]},"phones":{"type":"array","items":{"type":"string"},"description":"Contact phones of the consumer.\n","example":["+3907163494"]},"mobilePhones":{"type":"array","items":{"type":"string"},"description":"Contact mobile phones of the consumer.\n","example":["+393384234567"]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Custom meta data dictionary of the consumer."},"crmId":{"type":"string","description":"CRM consumer identifier."},"businessType":{"enum":["None","Reseller"],"type":"string","description":"Consumer business type.","format":"int32"}},"additionalProperties":false}},"components/schemas/ProvisioningPayloadContentConsumerDtoV2":{"id":"components/schemas/ProvisioningPayloadContentConsumerDtoV2","kind":"json-schema","title":"ProvisioningPayloadContentConsumerDtoV2","data":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the consumer.","example":"6dcd885f-a37b-427f-ab59-d008ae134aab"},"createdAt":{"type":"string","description":"Date and time indicating when this consumer was created.","format":"date-time","example":"2023-11-28T08:14:32.585Z"},"updatedAt":{"type":"string","description":"Date and time indicating when this consumer was last updated.","format":"date-time","example":"2023-11-28T08:14:32.585Z"},"legalEntityId":{"type":"string","description":"Associated legal entity identifier","nullable":true},"name":{"type":"string","description":"Name of the consumer.","example":"NAMIRIAL S.P.A."},"firstName":{"type":"string","description":"Name of the consumer for individual customers.\n","example":"Mario"},"lastName":{"type":"string","description":"Last name of the consumer for individual customers.\n","example":"Rossi"},"type":{"enum":["Customer","LegalEntity","InternalUnit"],"type":"string","description":"Consumer type (Customer, LegalEntity, InternalUnit).\n\r\nIn the creation of a consumer by integrators is forbidden the creation of a consumer with LegalEntity type.\n\n\r\nDEFAULT: Customer\n","format":"int32","example":"Customer"},"customerType":{"enum":["None","Individual","Corporate","PublicAdministration","NonProfit"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are: None, Individual, Corporate, PublicAdministration, NonProfit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the Type is Customer and CustomerType is None the CustomerType is automatically generated according to the following rules:"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| CustomerType........ | Vat...... | TaxNumber | PaNumber |"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| NonProfit........... | empty.... | length 11 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| NonProfit........... | empty.... | length 29 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Corporate........... | length 11 | length 11 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Corporate........... | length 29 | length 11 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Corporate........... | length 29 | length 29 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Individual.......... | empty.... | length 16 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Individual.......... | length 11 | length 16 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Individual.......... | length 29 | length 16 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | empty.... | length 11 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | empty.... | length 29 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | length 11 | length 11 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | length 29 | length 11 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | length 29 | length 29 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Without a type, it is not possible to define a NonProfit with Vat."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is still recommended when you have the type in hand to manually define the CustomerType with the correct type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For NO ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are: None, Individual, Corporate"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEFAULT: None"},"children":[]}]}]}],"format":"int32","example":"Corporate"},"country":{"type":"string","description":"Country of the consumer. The format is ISO 3166-1 alpha-2 (cca2).","example":"IT"},"vat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vat of the consumer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGULAR VAT:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 11 chars. The format is validated with italian specifications."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are numbers (0-9)."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEMPORARY VAT:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary VAT is used only for customers that do not have a regular VAT yet."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary VAT is composed by a header \"T01\" and a ULID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 29 chars: 3 header chars and 26 ULID chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are 0-9, A-H, J-K, M-N, P-T, V-Z. The format is validated with ULID specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is mandatory for: LegalEntity, Customer-Corporate"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: Customer-Individual, Customer-NonProfit, Customer-Public-Administration"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For NO ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are uppercase letters (A-Z), numbers (0-9), symbols dot (.), hyphen (-) and slash (/)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: Legal-Entity, Customer-Corporate, Customer-Individual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]}]},"taxNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax number of the consumer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERSON TAXNUMBER (16 chars). Only for Customer-Individual"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 16 chars. The format is validated with italian specifications."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are numbers (0-9, A-Z)."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGULAR TAXNUMBER (11 chars). Only for LegalEntity, Customer-Corporate, Customer-NonProfit, Customer-PublicAdministration"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 11 chars. The format is validated with italian specifications."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are numbers (0-9)."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEMPORARY TAXNUMBER (29 chars). Only for Customer-Corporate, Customer-NonProfit, Customer-PublicAdministration:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary TAXNUMBER is used only for customers that do not have a regular TAXNUMBER yet."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary TAXNUMBER is composed by a header \"T01\" and a ULID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 29 chars: 3 header chars and 26 ULID chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are 0-9, A-H, J-K, M-N, P-T, V-Z. The format is validated with ULID specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For NO ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are uppercase letters (A-Z), numbers (0-9), symbols dot (.), hyphen (-) and slash (/)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: Legal-Entity, Customer-Corporate, Customer-Individual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]}]},"paNumber":{"type":"string","description":"PA Number of the consumer.\n\n\r\nFor ITALIAN consumers:\n\r\nValid characters are uppercase letters (A-Z) and numbers (0-9). The format is validated with italian specifications.\n\r\nIs mandatory for: Customer-PublicAdministration\n\r\nMust be empty for: LegalEntity, Customer-Corporate, Customer-Individual, Customer-NonProfit, InternalUnit\n\n\r\nFor all other consumers:\n\r\nValid characters are uppercase letters (A-Z), digits (0-9), symbols dot (.), hyphen (-) and slash (/).\n\r\nIs optional for: LegalEntity, Customer-Corporate, Customer-PrivateIndividual, Customer-ProfessionalIndividual\n\r\nMust be empty for: InternalUnit","example":"UFCGFV"},"billable":{"type":"boolean","description":"Billable consumer.\n\r\nFor InternalUnit type must be false.","example":true},"address":{"type":"string","description":"Billing address of the consumer.\n\r\nIs mandatory when Billable is true.","example":"Via Caduti sul Lavoro, 4"},"state":{"type":"string","description":"Billing state of the consumer.\n\r\nIs mandatory when Billable is true.\n\r\nFor ITALIAN consumers is validated with the italian state list.","example":"AN"},"city":{"type":"string","description":"Billing city of the consumer.\n\r\nIs mandatory when Billable is true.\n\r\nFor ITALIAN consumers is validated with the italian state city list.","example":"Senigallia"},"postalCode":{"type":"string","description":"Billing postal code of the consumer.\n\r\nIs mandatory when Billable is true.\n\r\nFor ITALIAN consumers is validated with the italian state city postal code list.","example":"60019"},"emails":{"type":"array","items":{"type":"string"},"description":"Contact emails of the consumer.\n\r\nOne email is mandatory when Billable is true.","example":["info@namirial.com"]},"pecs":{"type":"array","items":{"type":"string"},"description":"Contact pecs of the consumer.\n","example":["amm.namirial@sicurezzapostale.it"]},"phones":{"type":"array","items":{"type":"string"},"description":"Contact phones of the consumer.\n","example":["+3907163494"]},"mobilePhones":{"type":"array","items":{"type":"string"},"description":"Contact mobile phones of the consumer.\n","example":["+393384234567"]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Custom meta data dictionary of the consumer."},"crmId":{"type":"string","description":"CRM consumer identifier."},"businessType":{"enum":["None","Reseller"],"type":"string","description":"Consumer business type.","format":"int32"},"birthInfo":{"$ref":"#/components/schemas/ProvisioningPayloadConsumerBirthInfoDtoV2"}},"additionalProperties":false}},"components/schemas/ProvisioningPayloadContentConsumerDtoV3":{"id":"components/schemas/ProvisioningPayloadContentConsumerDtoV3","kind":"json-schema","title":"ProvisioningPayloadContentConsumerDtoV3","data":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the consumer.","example":"6dcd885f-a37b-427f-ab59-d008ae134aab"},"createdAt":{"type":"string","description":"Date and time indicating when this consumer was created.","format":"date-time","example":"2023-11-28T08:14:32.585Z"},"updatedAt":{"type":"string","description":"Date and time indicating when this consumer was last updated.","format":"date-time","example":"2023-11-28T08:14:32.585Z"},"legalEntityId":{"type":"string","description":"Associated legal entity identifier","nullable":true},"name":{"type":"string","description":"Name of the consumer.","example":"NAMIRIAL S.P.A."},"firstName":{"type":"string","description":"Name of the consumer for individual customers.\n","example":"Mario"},"lastName":{"type":"string","description":"Last name of the consumer for individual customers.\n","example":"Rossi"},"type":{"enum":["Customer","LegalEntity","InternalUnit"],"type":"string","description":"Consumer type (Customer, LegalEntity, InternalUnit).\n\r\nIn the creation of a consumer by integrators is forbidden the creation of a consumer with LegalEntity type.\n\n\r\nDEFAULT: Customer\n","format":"int32","example":"Customer"},"customerType":{"enum":["None","Individual","Corporate","PublicAdministration","NonProfit"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are: None, Individual, Corporate, PublicAdministration, NonProfit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the Type is Customer and CustomerType is None the CustomerType is automatically generated according to the following rules:"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| CustomerType........ | Vat...... | TaxNumber | PaNumber |"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| NonProfit........... | empty.... | length 11 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| NonProfit........... | empty.... | length 29 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Corporate........... | length 11 | length 11 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Corporate........... | length 29 | length 11 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Corporate........... | length 29 | length 29 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Individual.......... | empty.... | length 16 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Individual.......... | length 11 | length 16 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Individual.......... | length 29 | length 16 | empty... |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | empty.... | length 11 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | empty.... | length 29 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | length 11 | length 11 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | length 29 | length 11 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| PublicAdministration | length 29 | length 29 | length 6 |"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Without a type, it is not possible to define a NonProfit with Vat."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is still recommended when you have the type in hand to manually define the CustomerType with the correct type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For NO ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are: None, Individual, Corporate"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEFAULT: None"},"children":[]}]}]}],"format":"int32","example":"Corporate"},"country":{"type":"string","description":"Country of the consumer. The format is ISO 3166-1 alpha-2 (cca2).","example":"IT"},"vat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vat of the consumer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGULAR VAT:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 11 chars. The format is validated with italian specifications."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are numbers (0-9)."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEMPORARY VAT:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary VAT is used only for customers that do not have a regular VAT yet."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary VAT is composed by a header \"T01\" and a ULID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 29 chars: 3 header chars and 26 ULID chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are 0-9, A-H, J-K, M-N, P-T, V-Z. The format is validated with ULID specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is mandatory for: LegalEntity, Customer-Corporate"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: Customer-Individual, Customer-NonProfit, Customer-Public-Administration"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For NO ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are uppercase letters (A-Z), numbers (0-9), symbols dot (.), hyphen (-) and slash (/)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: Legal-Entity, Customer-Corporate, Customer-Individual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]}]},"taxNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax number of the consumer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERSON TAXNUMBER (16 chars). Only for Customer-Individual"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 16 chars. The format is validated with italian specifications."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are numbers (0-9, A-Z)."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGULAR TAXNUMBER (11 chars). Only for LegalEntity, Customer-Corporate, Customer-NonProfit, Customer-PublicAdministration"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 11 chars. The format is validated with italian specifications."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are numbers (0-9)."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEMPORARY TAXNUMBER (29 chars). Only for Customer-Corporate, Customer-NonProfit, Customer-PublicAdministration:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary TAXNUMBER is used only for customers that do not have a regular TAXNUMBER yet."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary TAXNUMBER is composed by a header \"T01\" and a ULID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is 29 chars: 3 header chars and 26 ULID chars."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are 0-9, A-H, J-K, M-N, P-T, V-Z. The format is validated with ULID specifications."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For NO ITALIAN consumers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid characters are uppercase letters (A-Z), numbers (0-9), symbols dot (.), hyphen (-) and slash (/)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is optional for: Legal-Entity, Customer-Corporate, Customer-Individual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be empty for: InternalUnit"},"children":[]}]}]}]},"paNumber":{"type":"string","description":"PA Number of the consumer.\n\n\r\nFor ITALIAN consumers:\n\r\nValid characters are uppercase letters (A-Z) and numbers (0-9). The format is validated with italian specifications.\n\r\nIs mandatory for: Customer-PublicAdministration\n\r\nMust be empty for: LegalEntity, Customer-Corporate, Customer-Individual, Customer-NonProfit, InternalUnit\n\n\r\nFor all other consumers:\n\r\nValid characters are uppercase letters (A-Z), digits (0-9), symbols dot (.), hyphen (-) and slash (/).\n\r\nIs optional for: LegalEntity, Customer-Corporate, Customer-PrivateIndividual, Customer-ProfessionalIndividual\n\r\nMust be empty for: InternalUnit","example":"UFCGFV"},"billable":{"type":"boolean","description":"Billable consumer.\n\r\nFor InternalUnit type must be false.","example":true},"address":{"type":"string","description":"Billing address of the consumer.\n\r\nIs mandatory when Billable is true.","example":"Via Caduti sul Lavoro, 4"},"state":{"type":"string","description":"Billing state of the consumer.\n\r\nIs mandatory when Billable is true.\n\r\nFor ITALIAN consumers is validated with the italian state list.","example":"AN"},"city":{"type":"string","description":"Billing city of the consumer.\n\r\nIs mandatory when Billable is true.\n\r\nFor ITALIAN consumers is validated with the italian state city list.","example":"Senigallia"},"postalCode":{"type":"string","description":"Billing postal code of the consumer.\n\r\nIs mandatory when Billable is true.\n\r\nFor ITALIAN consumers is validated with the italian state city postal code list.","example":"60019"},"emails":{"type":"array","items":{"type":"string"},"description":"Contact emails of the consumer.\n\r\nOne email is mandatory when Billable is true.","example":["info@namirial.com"]},"pecs":{"type":"array","items":{"type":"string"},"description":"Contact pecs of the consumer.\n","example":["amm.namirial@sicurezzapostale.it"]},"phones":{"type":"array","items":{"type":"string"},"description":"Contact phones of the consumer.\n","example":["+3907163494"]},"mobilePhones":{"type":"array","items":{"type":"string"},"description":"Contact mobile phones of the consumer.\n","example":["+393384234567"]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Custom meta data dictionary of the consumer."},"crmId":{"type":"string","description":"CRM consumer identifier."},"businessType":{"enum":["None","Reseller"],"type":"string","description":"Consumer business type.","format":"int32"},"birthInfo":{"$ref":"#/components/schemas/ProvisioningPayloadConsumerBirthInfoDtoV3"}},"additionalProperties":false}},"components/schemas/ProvisioningPayloadContentConsumerDtoV4":{"id":"components/schemas/ProvisioningPayloadContentConsumerDtoV4","kind":"json-schema","title":"ProvisioningPayloadContentConsumerDtoV4","data":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the consumer.","example":"6dcd885f-a37b-427f-ab59-d008ae134aab"},"createdAt":{"type":"string","description":"Date and time indicating when this consumer was created.","format":"date-time","example":"2023-11-28T08:14:32.585Z"},"updatedAt":{"type":"string","description":"Date and time indicating when this consumer was last updated.","format":"date-time","example":"2023-11-28T08:14:32.585Z"},"legalEntityId":{"type":"string","description":"Associated legal entity identifier","nullable":true},"name":{"type":"string","description":"Name of the consumer.","example":"NAMIRIAL S.P.A."},"firstName":{"type":"string","description":"Name of the consumer for individual customers.","example":"Mario"},"lastName":{"type":"string","description":"Last name of the consumer for individual customers.","example":"Rossi"},"type":{"enum":["Customer","LegalEntity","InternalUnit"],"type":"string","description":"Consumer type (Customer, LegalEntity, InternalUnit).","format":"int32","example":"Customer"},"customerType":{"enum":["None","ProfessionalIndividual","Corporate","PublicAdministration","NonProfit","PrivateIndividual"],"type":"string","description":"Customer type.","format":"int32","example":"Corporate"},"country":{"type":"string","description":"Country of the consumer. The format is ISO 3166-1 alpha-2 (cca2).","example":"IT"},"taxCode1":{"type":"string","description":"Tax code 1 of the consumer."},"taxCode2":{"type":"string","description":"Tax code 2 of the consumer."},"taxCode3":{"type":"string","description":"Tax code 3 of the consumer."},"billable":{"type":"boolean","description":"Billable consumer.","example":true},"address":{"type":"string","description":"Billing address of the consumer.","example":"Via Caduti sul Lavoro, 4"},"state":{"type":"string","description":"Billing state of the consumer.","example":"AN"},"city":{"type":"string","description":"Billing city of the consumer.","example":"Senigallia"},"postalCode":{"type":"string","description":"Billing postal code of the consumer.","example":"60019"},"emails":{"type":"array","items":{"type":"string"},"description":"Contact emails of the consumer.","example":["info@namirial.com"]},"pecs":{"type":"array","items":{"type":"string"},"description":"Contact pecs of the consumer.","example":["amm.namirial@sicurezzapostale.it"]},"phones":{"type":"array","items":{"type":"string"},"description":"Contact phones of the consumer.","example":["+3907163494"]},"mobilePhones":{"type":"array","items":{"type":"string"},"description":"Contact mobile phones of the consumer.","example":["+393384234567"]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Custom meta data dictionary of the consumer."},"crmId":{"type":"string","description":"CRM consumer identifier."},"businessType":{"enum":["None","Reseller"],"type":"string","description":"Consumer business type.","format":"int32"},"birthInfo":{"$ref":"#/components/schemas/ProvisioningPayloadConsumerBirthInfoDtoV4"},"residenceInfo":{"$ref":"#/components/schemas/ProvisioningPayloadConsumerResidenceInfoDtoV4"}},"additionalProperties":false}},"components/schemas/ProvisioningPayloadContentContractDtoV1":{"id":"components/schemas/ProvisioningPayloadContentContractDtoV1","kind":"json-schema","title":"ProvisioningPayloadContentContractDtoV1","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of this contract"},"businessRelationId":{"type":"string","description":"The business relation identifier related to the contract"},"status":{"enum":["Draft","Pending","Final","Processing","Completed","Expired","Cancelled","Support"],"type":"string","description":"Indicates the contract status","format":"int32"},"description":{"type":"string","description":"Description for this contract"},"startDate":{"type":"string","description":"Date and time indicating starting date for this contract.","format":"date","example":"2023-11-28"},"endDate":{"type":"string","description":"Date and time indicating ending date for this contract.","format":"date","nullable":true,"example":"2023-11-29"},"issuerId":{"type":"string","description":"Issuer identifier for this contract","nullable":true},"legalEntityId":{"type":"string","description":"Legal entity identifier for this contract"},"billingConsumerId":{"type":"string","description":"Billing consumer identifier for this contract"},"resellContractId":{"type":"string","description":"Reseller contract identifier related to this contract","nullable":true},"number":{"type":"string","description":"CRM contract number"},"type":{"enum":["Resell","Direct","Indirect","Distribution"],"type":"string","description":"Type of contract (e.g. \"distribution\", \"resell\", \"direct\", indirect)","format":"int32"},"businessRelation":{"$ref":"#/components/schemas/ProvisioningPayloadContentBusinessRelationDtoV1"},"createdAt":{"type":"string","description":"Date and time indicating when this contract was created.","format":"date-time","example":"2023-11-28T08:14:32.585Z"},"updatedAt":{"type":"string","description":"Date and time indicating when this contract was last updated.","format":"date-time","example":"2023-11-28T08:14:32.585Z"}},"additionalProperties":false}},"components/schemas/ProvisioningPayloadContentContractDtoV2":{"id":"components/schemas/ProvisioningPayloadContentContractDtoV2","kind":"json-schema","title":"ProvisioningPayloadContentContractDtoV2","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of this contract"},"businessRelationId":{"type":"string","description":"The business relation identifier related to the contract"},"status":{"enum":["Draft","Pending","Final","Processing","Completed","Expired","Cancelled","Support"],"type":"string","description":"Indicates the contract status","format":"int32"},"description":{"type":"string","description":"Description for this contract"},"startDate":{"type":"string","description":"Date and time indicating starting date for this contract.","format":"date","example":"2023-11-28"},"issuerId":{"type":"string","description":"Issuer identifier for this contract","nullable":true},"legalEntityId":{"type":"string","description":"Legal entity identifier for this contract"},"billingConsumerId":{"type":"string","description":"Billing consumer identifier for this contract","nullable":true},"ownerId":{"type":"string","description":"Owner (titolare) identifier for this contract (optional)","nullable":true},"legalRepresentativeId":{"type":"string","description":"Legal representative identifier for this contract (optional)","nullable":true},"resellContractId":{"type":"string","description":"Reseller contract identifier related to this contract","nullable":true},"number":{"type":"string","description":"CRM contract number"},"type":{"enum":["Resell","Direct","Indirect","Distribution"],"type":"string","description":"Type of contract (e.g. \"distribution\", \"resell\", \"direct\", indirect)","format":"int32"},"businessRelation":{"$ref":"#/components/schemas/ProvisioningPayloadContentBusinessRelationDtoV2"},"createdAt":{"type":"string","description":"Date and time indicating when this contract was created.","format":"date-time","example":"2023-11-28T08:14:32.585Z"},"updatedAt":{"type":"string","description":"Date and time indicating when this contract was last updated.","format":"date-time","example":"2023-11-28T08:14:32.585Z"}},"additionalProperties":false}},"components/schemas/ProvisioningPayloadContentContractDtoV3":{"id":"components/schemas/ProvisioningPayloadContentContractDtoV3","kind":"json-schema","title":"ProvisioningPayloadContentContractDtoV3","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of this contract"},"businessRelationId":{"type":"string","description":"The business relation identifier related to the contract"},"status":{"enum":["Draft","Pending","Final","Processing","Completed","Expired","Cancelled","Support"],"type":"string","description":"Indicates the contract status","format":"int32"},"description":{"type":"string","description":"Description for this contract"},"startDate":{"type":"string","description":"Date and time indicating starting date for this contract.","format":"date","example":"2023-11-28"},"issuerId":{"type":"string","description":"Issuer identifier for this contract","nullable":true},"legalEntityId":{"type":"string","description":"Legal entity identifier for this contract"},"billingConsumerId":{"type":"string","description":"Billing consumer identifier for this contract","nullable":true},"ownerId":{"type":"string","description":"Owner (titolare) identifier for this contract (optional)","nullable":true},"legalRepresentativeId":{"type":"string","description":"Legal representative identifier for this contract (optional)","nullable":true},"resellContractId":{"type":"string","description":"Reseller contract identifier related to this contract","nullable":true},"number":{"type":"string","description":"CRM contract number"},"type":{"enum":["Resell","Direct","Indirect","Distribution"],"type":"string","description":"Type of contract (e.g. \"distribution\", \"resell\", \"direct\", indirect)","format":"int32"},"businessRelation":{"$ref":"#/components/schemas/ProvisioningPayloadContentBusinessRelationDtoV3"},"createdAt":{"type":"string","description":"Date and time indicating when this contract was created.","format":"date-time","example":"2023-11-28T08:14:32.585Z"},"updatedAt":{"type":"string","description":"Date and time indicating when this contract was last updated.","format":"date-time","example":"2023-11-28T08:14:32.585Z"}},"additionalProperties":false}},"components/schemas/ProvisioningPayloadContentContractDtoV4":{"id":"components/schemas/ProvisioningPayloadContentContractDtoV4","kind":"json-schema","title":"ProvisioningPayloadContentContractDtoV4","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of this contract"},"businessRelationId":{"type":"string","description":"The business relation identifier related to the contract"},"status":{"enum":["Draft","Pending","Final","Processing","Completed","Expired","Cancelled","Support"],"type":"string","description":"Indicates the contract status","format":"int32"},"description":{"type":"string","description":"Description for this contract"},"startDate":{"type":"string","description":"Date and time indicating starting date for this contract.","format":"date","example":"2023-11-28"},"issuerId":{"type":"string","description":"Issuer identifier for this contract","nullable":true},"legalEntityId":{"type":"string","description":"Legal entity identifier for this contract"},"billingConsumerId":{"type":"string","description":"Billing consumer identifier for this contract","nullable":true},"ownerId":{"type":"string","description":"Owner (titolare) identifier for this contract (optional)","nullable":true},"legalRepresentativeId":{"type":"string","description":"Legal representative identifier for this contract (optional)","nullable":true},"resellContractId":{"type":"string","description":"Reseller contract identifier related to this contract","nullable":true},"number":{"type":"string","description":"CRM contract number"},"type":{"enum":["Resell","Direct","Indirect","Distribution"],"type":"string","description":"Type of contract (e.g. \"distribution\", \"resell\", \"direct\", indirect)","format":"int32"},"businessRelation":{"$ref":"#/components/schemas/ProvisioningPayloadContentBusinessRelationDtoV4"},"createdAt":{"type":"string","description":"Date and time indicating when this contract was created.","format":"date-time","example":"2023-11-28T08:14:32.585Z"},"updatedAt":{"type":"string","description":"Date and time indicating when this contract was last updated.","format":"date-time","example":"2023-11-28T08:14:32.585Z"}},"additionalProperties":false}},"components/schemas/ProvisioningPayloadContentContractItemDtoV1":{"id":"components/schemas/ProvisioningPayloadContentContractItemDtoV1","kind":"json-schema","title":"ProvisioningPayloadContentContractItemDtoV1","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of this contract item"},"contractId":{"type":"string","description":"Unique identifier of this contract"},"description":{"type":"string","description":"Description for this contract item"},"resellContractItemId":{"type":"string","description":"Reseller contract item identifier related to this contract item","nullable":true},"sku":{"type":"string","description":"Sku code of this contract item"},"billingModelId":{"type":"string","description":"Billing model identifier for this contract item"},"billingModelParameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Billing model parameters for this contract item"},"businessRelationId":{"type":"string","description":"Business relation model identifier for this contract item"},"skuParameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Sku parameters for this contract item"},"onboardingExtraParameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Extra parameters supporting the onboarding process.","nullable":true},"status":{"enum":["Ready","Pending","Provisioning","Signing","Active","Expired","Cancelled","Support"],"type":"string","description":"Status for this contract item","format":"int32"},"paymentStatus":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🗑️ DEPRECATED (Will no longer be available in the next release) 🗑️"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This property is DEPRECATED and will be removed on 2026-04-01."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}],"deprecated":true},"signed":{"type":"boolean","description":"Indicates whether this contract item is signed or not."},"provisioned":{"type":"boolean","description":"Indicates whether this contract item is provisioned or not."},"startDate":{"type":"string","description":"Date and time indicating starting date for this contract item.","format":"date","example":"2024-11-28"},"endDate":{"type":"string","description":"Date and time indicating ending date for this contract item.","format":"date","nullable":true,"example":"2024-11-29"},"quantity":{"type":"integer","description":"Quantity for this contract item.","format":"int32"},"createdAt":{"type":"string","description":"Date and time indicating when this contract detail was created.","format":"date-time","example":"2024-11-28T08:14:32.585Z"},"updatedAt":{"type":"string","description":"Date and time indicating when this contract details was last updated.","format":"date-time","example":"2024-11-28T08:14:32.585Z"}},"additionalProperties":false}},"components/schemas/ProvisioningPayloadContentContractItemDtoV2":{"id":"components/schemas/ProvisioningPayloadContentContractItemDtoV2","kind":"json-schema","title":"ProvisioningPayloadContentContractItemDtoV2","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of this contract item"},"contractId":{"type":"string","description":"Unique identifier of this contract"},"description":{"type":"string","description":"Description for this contract item"},"resellContractItemId":{"type":"string","description":"Reseller contract item identifier related to this contract item","nullable":true},"sku":{"type":"string","description":"Sku code of this contract item"},"subscriptionId":{"type":"string","description":"Subscription identifier related to this contract item","nullable":true},"billingModelId":{"type":"string","description":"Billing model identifier for this contract item","nullable":true},"billingModelParameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Billing model parameters for this contract item"},"businessRelationId":{"type":"string","description":"Business relation model identifier for this contract item","nullable":true},"skuParameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Sku parameters for this contract item"},"onboardingExtraParameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Extra parameters supporting the onboarding process.","nullable":true},"status":{"enum":["Ready","Pending","Provisioning","Signing","Active","Expired","Cancelled","Support"],"type":"string","description":"Status for this contract item","format":"int32"},"paymentStatus":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🗑️ DEPRECATED (Will no longer be available in the next release) 🗑️"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This property is DEPRECATED and will be removed on 2026-04-01."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}],"deprecated":true},"signed":{"type":"boolean","description":"Indicates whether this contract item is signed or not."},"provisioned":{"type":"boolean","description":"Indicates whether this contract item is provisioned or not."},"startDate":{"type":"string","description":"Date and time indicating starting date for this contract item.","format":"date","example":"2024-11-28"},"endDate":{"type":"string","description":"Date and time indicating ending date for this contract item.","format":"date","nullable":true,"example":"2024-11-29"},"quantity":{"type":"integer","description":"Quantity for this contract item.","format":"int32"},"envelopeParameters":{"type":"array","items":{"$ref":"#/components/schemas/ProvisioningPayloadContractItemEnvelopeParametersDtoV2"},"description":"Documents parameters for this contract item."},"envelope":{"$ref":"#/components/schemas/ProvisioningPayloadContractItemEnvelopeDtoV2"},"createdAt":{"type":"string","description":"Date and time indicating when this contract detail was created.","format":"date-time","example":"2024-11-28T08:14:32.585Z"},"updatedAt":{"type":"string","description":"Date and time indicating when this contract details was last updated.","format":"date-time","example":"2024-11-28T08:14:32.585Z"}},"additionalProperties":false}},"components/schemas/ProvisioningPayloadContentContractItemDtoV3":{"id":"components/schemas/ProvisioningPayloadContentContractItemDtoV3","kind":"json-schema","title":"ProvisioningPayloadContentContractItemDtoV3","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of this contract item"},"contractId":{"type":"string","description":"Unique identifier of this contract"},"description":{"type":"string","description":"Description for this contract item"},"resellContractItemId":{"type":"string","description":"Reseller contract item identifier related to this contract item","nullable":true},"parentId":{"type":"string","description":"Parent contract item identifier related to this contract item","nullable":true},"sku":{"type":"string","description":"Sku code of this contract item"},"subscriptionId":{"type":"string","description":"Subscription identifier related to this contract item","nullable":true},"billingModelId":{"type":"string","description":"Billing model identifier for this contract item","nullable":true},"billingModelParameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Billing model parameters for this contract item"},"businessRelationId":{"type":"string","description":"Business relation model identifier for this contract item","nullable":true},"skuParameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Sku parameters for this contract item"},"onboardingExtraParameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Extra parameters supporting the onboarding process.","nullable":true},"featureIds":{"type":"array","items":{"type":"string"},"description":"SKU feature identifiers selected for this contract item."},"status":{"enum":["Ready","Pending","Provisioning","Signing","Active","Expired","Cancelled","Support"],"type":"string","description":"Status for this contract item","format":"int32"},"signed":{"type":"boolean","description":"Indicates whether this contract item is signed or not."},"provisioned":{"type":"boolean","description":"Indicates whether this contract item is provisioned or not."},"startDate":{"type":"string","description":"Date and time indicating starting date for this contract item.","format":"date","example":"2024-11-28"},"endDate":{"type":"string","description":"Date and time indicating ending date for this contract item.","format":"date","nullable":true,"example":"2024-11-29"},"quantity":{"type":"integer","description":"Quantity for this contract item.","format":"int32"},"envelopeParameters":{"type":"array","items":{"$ref":"#/components/schemas/ProvisioningPayloadContractItemEnvelopeParametersDtoV3"},"description":"Documents parameters for this contract item."},"envelope":{"$ref":"#/components/schemas/ProvisioningPayloadContractItemEnvelopeDtoV3"},"createdAt":{"type":"string","description":"Date and time indicating when this contract detail was created.","format":"date-time","example":"2024-11-28T08:14:32.585Z"},"updatedAt":{"type":"string","description":"Date and time indicating when this contract details was last updated.","format":"date-time","example":"2024-11-28T08:14:32.585Z"}},"additionalProperties":false}},"components/schemas/ProvisioningPayloadContentContractItemDtoV4":{"id":"components/schemas/ProvisioningPayloadContentContractItemDtoV4","kind":"json-schema","title":"ProvisioningPayloadContentContractItemDtoV4","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of this contract item"},"contractId":{"type":"string","description":"Unique identifier of this contract"},"description":{"type":"string","description":"Description for this contract item"},"resellContractItemId":{"type":"string","description":"Reseller contract item identifier related to this contract item","nullable":true},"parentId":{"type":"string","description":"Parent contract item identifier related to this contract item","nullable":true},"sku":{"type":"string","description":"Sku code of this contract item"},"subscriptionId":{"type":"string","description":"Subscription identifier related to this contract item","nullable":true},"billingModelId":{"type":"string","description":"Billing model identifier for this contract item","nullable":true},"billingModelParameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Billing model parameters for this contract item"},"businessRelationId":{"type":"string","description":"Business relation model identifier for this contract item","nullable":true},"skuParameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Sku parameters for this contract item"},"onboardingExtraParameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Extra parameters supporting the onboarding process.","nullable":true},"status":{"enum":["Ready","Pending","Provisioning","Signing","Active","Expired","Cancelled","Support"],"type":"string","description":"Status for this contract item","format":"int32"},"signed":{"type":"boolean","description":"Indicates whether this contract item is signed or not."},"provisioned":{"type":"boolean","description":"Indicates whether this contract item is provisioned or not."},"startDate":{"type":"string","description":"Date and time indicating starting date for this contract item.","format":"date","example":"2024-11-28"},"endDate":{"type":"string","description":"Date and time indicating ending date for this contract item.","format":"date","nullable":true,"example":"2024-11-29"},"quantity":{"type":"integer","description":"Quantity for this contract item.","format":"int32"},"envelopeParameters":{"type":"array","items":{"$ref":"#/components/schemas/ProvisioningPayloadContractItemEnvelopeParametersDtoV4"},"description":"Documents parameters for this contract item."},"envelope":{"$ref":"#/components/schemas/ProvisioningPayloadContractItemEnvelopeDtoV4"},"createdAt":{"type":"string","description":"Date and time indicating when this contract detail was created.","format":"date-time","example":"2024-11-28T08:14:32.585Z"},"updatedAt":{"type":"string","description":"Date and time indicating when this contract details was last updated.","format":"date-time","example":"2024-11-28T08:14:32.585Z"}},"additionalProperties":false}},"components/schemas/ProvisioningPayloadContentDtoV1":{"id":"components/schemas/ProvisioningPayloadContentDtoV1","kind":"json-schema","title":"ProvisioningPayloadContentDtoV1","data":{"type":"object","properties":{"contract":{"$ref":"#/components/schemas/ProvisioningPayloadContentContractDtoV1"},"contractItem":{"$ref":"#/components/schemas/ProvisioningPayloadContentContractItemDtoV1"},"businessRelation":{"$ref":"#/components/schemas/ProvisioningPayloadContentBusinessRelationDtoV1"},"consumers":{"type":"array","items":{"$ref":"#/components/schemas/ProvisioningPayloadContentConsumerDtoV1"},"description":"Consumers involved in the provisioning"},"users":{"type":"array","items":{"$ref":"#/components/schemas/ProvisioningPayloadContentUserDtoV1"},"description":"Users involved in the provisioning"}},"additionalProperties":false}},"components/schemas/ProvisioningPayloadContentDtoV2":{"id":"components/schemas/ProvisioningPayloadContentDtoV2","kind":"json-schema","title":"ProvisioningPayloadContentDtoV2","data":{"type":"object","properties":{"contract":{"$ref":"#/components/schemas/ProvisioningPayloadContentContractDtoV2"},"contractItem":{"$ref":"#/components/schemas/ProvisioningPayloadContentContractItemDtoV2"},"businessRelation":{"$ref":"#/components/schemas/ProvisioningPayloadContentBusinessRelationDtoV2"},"consumers":{"type":"array","items":{"$ref":"#/components/schemas/ProvisioningPayloadContentConsumerDtoV2"},"description":"Consumers involved in the provisioning"},"users":{"type":"array","items":{"$ref":"#/components/schemas/ProvisioningPayloadContentUserDtoV2"},"description":"Users involved in the provisioning"}},"additionalProperties":false}},"components/schemas/ProvisioningPayloadContentDtoV3":{"id":"components/schemas/ProvisioningPayloadContentDtoV3","kind":"json-schema","title":"ProvisioningPayloadContentDtoV3","data":{"type":"object","properties":{"contract":{"$ref":"#/components/schemas/ProvisioningPayloadContentContractDtoV3"},"contractItem":{"$ref":"#/components/schemas/ProvisioningPayloadContentContractItemDtoV3"},"businessRelation":{"$ref":"#/components/schemas/ProvisioningPayloadContentBusinessRelationDtoV3"},"relatedContractItems":{"type":"array","items":{"$ref":"#/components/schemas/ProvisioningPayloadContentContractItemDtoV3"},"description":"Contract items related to the provisioning context (with lower onboarding priority)."},"consumers":{"type":"array","items":{"$ref":"#/components/schemas/ProvisioningPayloadContentConsumerDtoV3"},"description":"Consumers involved in the provisioning"},"users":{"type":"array","items":{"$ref":"#/components/schemas/ProvisioningPayloadContentUserDtoV3"},"description":"Users involved in the provisioning"}},"additionalProperties":false}},"components/schemas/ProvisioningPayloadContentDtoV4":{"id":"components/schemas/ProvisioningPayloadContentDtoV4","kind":"json-schema","title":"ProvisioningPayloadContentDtoV4","data":{"type":"object","properties":{"contract":{"$ref":"#/components/schemas/ProvisioningPayloadContentContractDtoV4"},"contractItem":{"$ref":"#/components/schemas/ProvisioningPayloadContentContractItemDtoV4"},"businessRelation":{"$ref":"#/components/schemas/ProvisioningPayloadContentBusinessRelationDtoV4"},"relatedContractItems":{"type":"array","items":{"$ref":"#/components/schemas/ProvisioningPayloadContentContractItemDtoV4"},"description":"Contract items related to the provisioning context (with lower onboarding priority)."},"consumers":{"type":"array","items":{"$ref":"#/components/schemas/ProvisioningPayloadContentConsumerDtoV4"},"description":"Consumers involved in the provisioning"},"users":{"type":"array","items":{"$ref":"#/components/schemas/ProvisioningPayloadContentUserDtoV4"},"description":"Users involved in the provisioning"}},"additionalProperties":false}},"components/schemas/ProvisioningPayloadContentUserDtoV1":{"id":"components/schemas/ProvisioningPayloadContentUserDtoV1","kind":"json-schema","title":"ProvisioningPayloadContentUserDtoV1","data":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the user"},"email":{"type":"string","description":"Email of the user"},"consumerId":{"type":"string","description":"Consumer identifiers of the user","nullable":true}},"additionalProperties":false}},"components/schemas/ProvisioningPayloadContentUserDtoV2":{"id":"components/schemas/ProvisioningPayloadContentUserDtoV2","kind":"json-schema","title":"ProvisioningPayloadContentUserDtoV2","data":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the user"},"email":{"type":"string","description":"Email of the user"},"consumerIds":{"type":"array","items":{"type":"string"},"description":"Consumer identifiers of the user","nullable":true}},"additionalProperties":false}},"components/schemas/ProvisioningPayloadContentUserDtoV3":{"id":"components/schemas/ProvisioningPayloadContentUserDtoV3","kind":"json-schema","title":"ProvisioningPayloadContentUserDtoV3","data":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the user"},"email":{"type":"string","description":"Email of the user"},"consumerIds":{"type":"array","items":{"type":"string"},"description":"Consumer identifiers of the user","nullable":true}},"additionalProperties":false}},"components/schemas/ProvisioningPayloadContentUserDtoV4":{"id":"components/schemas/ProvisioningPayloadContentUserDtoV4","kind":"json-schema","title":"ProvisioningPayloadContentUserDtoV4","data":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the user"},"email":{"type":"string","description":"Email of the user"},"consumerIds":{"type":"array","items":{"type":"string"},"description":"Consumer identifiers of the user","nullable":true}},"additionalProperties":false}},"components/schemas/ProvisioningPayloadContractItemEnvelopeDtoV2":{"id":"components/schemas/ProvisioningPayloadContractItemEnvelopeDtoV2","kind":"json-schema","title":"ProvisioningPayloadContractItemEnvelopeDtoV2","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of this envelope"}},"additionalProperties":false}},"components/schemas/ProvisioningPayloadContractItemEnvelopeDtoV3":{"id":"components/schemas/ProvisioningPayloadContractItemEnvelopeDtoV3","kind":"json-schema","title":"ProvisioningPayloadContractItemEnvelopeDtoV3","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of this envelope"}},"additionalProperties":false}},"components/schemas/ProvisioningPayloadContractItemEnvelopeDtoV4":{"id":"components/schemas/ProvisioningPayloadContractItemEnvelopeDtoV4","kind":"json-schema","title":"ProvisioningPayloadContractItemEnvelopeDtoV4","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of this envelope"}},"additionalProperties":false}},"components/schemas/ProvisioningPayloadContractItemEnvelopeParametersDtoV2":{"id":"components/schemas/ProvisioningPayloadContractItemEnvelopeParametersDtoV2","kind":"json-schema","title":"ProvisioningPayloadContractItemEnvelopeParametersDtoV2","data":{"type":"object","properties":{"documentId":{"type":"string","description":"Document identifier"},"version":{"type":"integer","description":"Document version","format":"int32"},"recipient":{"$ref":"#/components/schemas/ProvisioningPayloadContractItemEnvelopeRecipientDtoV2"},"parameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Document parameters"}},"additionalProperties":false}},"components/schemas/ProvisioningPayloadContractItemEnvelopeParametersDtoV3":{"id":"components/schemas/ProvisioningPayloadContractItemEnvelopeParametersDtoV3","kind":"json-schema","title":"ProvisioningPayloadContractItemEnvelopeParametersDtoV3","data":{"type":"object","properties":{"documentId":{"type":"string","description":"Document identifier"},"version":{"type":"integer","description":"Document version","format":"int32"},"recipient":{"$ref":"#/components/schemas/ProvisioningPayloadContractItemEnvelopeRecipientDtoV3"},"parameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Document parameters"}},"additionalProperties":false}},"components/schemas/ProvisioningPayloadContractItemEnvelopeParametersDtoV4":{"id":"components/schemas/ProvisioningPayloadContractItemEnvelopeParametersDtoV4","kind":"json-schema","title":"ProvisioningPayloadContractItemEnvelopeParametersDtoV4","data":{"type":"object","properties":{"documentId":{"type":"string","description":"Document identifier"},"version":{"type":"integer","description":"Document version","format":"int32"},"recipient":{"$ref":"#/components/schemas/ProvisioningPayloadContractItemEnvelopeRecipientDtoV4"},"parameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Document parameters"}},"additionalProperties":false}},"components/schemas/ProvisioningPayloadContractItemEnvelopeRecipientDtoV2":{"id":"components/schemas/ProvisioningPayloadContractItemEnvelopeRecipientDtoV2","kind":"json-schema","title":"ProvisioningPayloadContractItemEnvelopeRecipientDtoV2","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the recipient"},"surname":{"type":"string","description":"Surname of the recipient"},"email":{"type":"string","description":"Email of the recipient"},"phoneNumber":{"type":"string","description":"Phone number of the recipient","nullable":true}},"additionalProperties":false}},"components/schemas/ProvisioningPayloadContractItemEnvelopeRecipientDtoV3":{"id":"components/schemas/ProvisioningPayloadContractItemEnvelopeRecipientDtoV3","kind":"json-schema","title":"ProvisioningPayloadContractItemEnvelopeRecipientDtoV3","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the recipient"},"surname":{"type":"string","description":"Surname of the recipient"},"email":{"type":"string","description":"Email of the recipient"},"phoneNumber":{"type":"string","description":"Phone number of the recipient","nullable":true}},"additionalProperties":false}},"components/schemas/ProvisioningPayloadContractItemEnvelopeRecipientDtoV4":{"id":"components/schemas/ProvisioningPayloadContractItemEnvelopeRecipientDtoV4","kind":"json-schema","title":"ProvisioningPayloadContractItemEnvelopeRecipientDtoV4","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the recipient"},"surname":{"type":"string","description":"Surname of the recipient"},"email":{"type":"string","description":"Email of the recipient"},"phoneNumber":{"type":"string","description":"Phone number of the recipient","nullable":true}},"additionalProperties":false}},"components/schemas/ProvisioningPayloadDtoOfT":{"id":"components/schemas/ProvisioningPayloadDtoOfT","kind":"json-schema","title":"ProvisioningPayloadDtoOfT","data":{"type":"object","properties":{"version":{"enum":["V1","V2","V3","V4"],"type":"string","description":"Payload version","format":"int32"},"type":{"enum":["Provisioning"],"type":"string","description":"Payload type","format":"int32"},"content":{"$ref":"#/components/schemas/T"}},"additionalProperties":false}},"components/schemas/ProvisioningValidationErrorDto":{"id":"components/schemas/ProvisioningValidationErrorDto","kind":"json-schema","title":"ProvisioningValidationErrorDto","data":{"type":"object","properties":{"path":{"type":"string","description":"The JSONPath to the field that has the error"},"errorCode":{"type":"string","description":"The error code"},"message":{"type":"object","additionalProperties":{"type":"string"},"description":"The human-readable error message"}},"additionalProperties":false}},"components/schemas/ProvisioningValidationResultDto":{"id":"components/schemas/ProvisioningValidationResultDto","kind":"json-schema","title":"ProvisioningValidationResultDto","data":{"type":"object","properties":{"contractItemId":{"type":"string","description":"The ID of the contract item that was validated"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ProvisioningValidationErrorDto"},"description":"List of validation errors, if any"}},"additionalProperties":false}},"components/schemas/PublicKey":{"id":"components/schemas/PublicKey","kind":"json-schema","title":"PublicKey","data":{"type":"object","properties":{"encodedKeyValue":{"$ref":"#/components/schemas/AsnEncodedData"},"encodedParameters":{"$ref":"#/components/schemas/AsnEncodedData"},"key":{"$ref":"#/components/schemas/AsymmetricAlgorithm"},"oid":{"$ref":"#/components/schemas/Oid"}},"additionalProperties":false}},"components/schemas/ReadOnlyMemoryOfByte":{"id":"components/schemas/ReadOnlyMemoryOfByte","kind":"json-schema","title":"ReadOnlyMemoryOfByte","data":{"type":"object","properties":{"length":{"type":"integer","format":"int32","readOnly":true},"isEmpty":{"type":"boolean","readOnly":true},"span":{"$ref":"#/components/schemas/ReadOnlySpanOfByte"}},"additionalProperties":false}},"components/schemas/ReadOnlySpanOfByte":{"id":"components/schemas/ReadOnlySpanOfByte","kind":"json-schema","title":"ReadOnlySpanOfByte","data":{"type":"object","properties":{"length":{"type":"integer","format":"int32","readOnly":true},"isEmpty":{"type":"boolean","readOnly":true}},"additionalProperties":false}},"components/schemas/ResourceEventContractItemDtoV1":{"id":"components/schemas/ResourceEventContractItemDtoV1","kind":"json-schema","title":"ResourceEventContractItemDtoV1","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of this contract item"},"contractId":{"type":"string","description":"Unique identifier of this contract"},"skuId":{"type":"string","description":"Sku identifier code of this contract item"},"skuSnapshot":{"$ref":"#/components/schemas/SkuBaseDto"},"skuParameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Sku parameters for this contract item"},"featureIds":{"type":"array","items":{"type":"string"},"description":"SKU feature identifiers selected for this contract item."},"ownerId":{"type":"string","description":"Owner identifier for this contract item","nullable":true},"userId":{"type":"string","description":"MyNamirial user identifier of this contract item","nullable":true},"channel":{"type":"string","description":"Sales or acquisition channel associated with this contract item","nullable":true},"status":{"enum":["Ready","Pending","Provisioning","Signing","Active","Expired","Cancelled","Support"],"type":"string","description":"Status for this contract item","format":"int32","example":"Active"},"startDate":{"type":"string","description":"Date and time indicating starting date for this contract item.","format":"date","example":"2023-11-28"},"endDate":{"type":"string","description":"Date and time indicating ending date for this contract item.","format":"date","nullable":true,"example":"2023-11-29"},"quantity":{"type":"integer","description":"Quantity for this contract item.","format":"int32"},"subscriptionId":{"type":"string","description":"Subscription identifier for this contract item.","nullable":true},"subscriptionSnapshot":{"$ref":"#/components/schemas/ResourceEventSubscriptionDtoV1"}},"additionalProperties":false}},"components/schemas/ResourceEventContractItemProvisioningDataDtoV1":{"id":"components/schemas/ResourceEventContractItemProvisioningDataDtoV1","kind":"json-schema","title":"ResourceEventContractItemProvisioningDataDtoV1","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of this contract item provisioning data document."},"data":{"type":"object","additionalProperties":{"oneOf":[{"type":"string"},{"type":"number","format":"double"},{"type":"integer","format":"int64"},{"type":"boolean"},{"type":"object","additionalProperties":{}},{"type":"array","items":{}}],"nullable":true},"description":"Generic provisioning data payload.","example":{"customKey":"customValue","customNestedKey":{"customKey2":"customValue","customKey3":true}}},"contractItemSnapshot":{"$ref":"#/components/schemas/ResourceEventContractItemDtoV1"},"createdAt":{"type":"string","description":"Creation date and time.","format":"date-time"},"updatedAt":{"type":"string","description":"Last update date and time.","format":"date-time"}},"additionalProperties":false}},"components/schemas/ResourceEventDataDtoV1":{"id":"components/schemas/ResourceEventDataDtoV1","kind":"json-schema","title":"ResourceEventDataDtoV1","data":{"type":"object","properties":{"contractItem":{"$ref":"#/components/schemas/ResourceEventContractItemDtoV1"},"contractItemBeforeOperation":{"$ref":"#/components/schemas/ResourceEventContractItemDtoV1"},"contractItemProvisioningData":{"$ref":"#/components/schemas/ResourceEventContractItemProvisioningDataDtoV1"},"contractItemProvisioningDataBeforeOperation":{"$ref":"#/components/schemas/ResourceEventContractItemProvisioningDataDtoV1"}},"additionalProperties":false}},"components/schemas/ResourceEventSubscriptionDtoV1":{"id":"components/schemas/ResourceEventSubscriptionDtoV1","kind":"json-schema","title":"ResourceEventSubscriptionDtoV1","data":{"type":"object","properties":{"id":{"type":"string","description":"Subscription identifier"},"subscriptionUserId":{"type":"string","description":"Subscription customer identifier"},"status":{"enum":["Unknown","Active","InTrial","NonRenewing","Future","Cancelled","Paused","Transferred"],"type":"string","description":"Subscription status","format":"int32"},"startDate":{"type":"string","description":"Subscription start date","format":"date-time","nullable":true},"currentTermStart":{"type":"string","description":"Current term start date","format":"date-time","nullable":true},"currentTermEnd":{"type":"string","description":"Current term end date","format":"date-time","nullable":true},"nextBillingAt":{"type":"string","description":"Next billing date","format":"date-time","nullable":true},"cancelledAt":{"type":"string","description":"Cancellation date","format":"date-time","nullable":true},"activatedAt":{"type":"string","description":"Activation date","format":"date-time","nullable":true},"deleted":{"type":"boolean","description":"Whether the subscription is deleted"}},"additionalProperties":false}},"components/schemas/ServiceActivationGroupBaseDto":{"id":"components/schemas/ServiceActivationGroupBaseDto","kind":"json-schema","title":"ServiceActivationGroupBaseDto","data":{"type":"object","properties":{"description":{"type":"object","additionalProperties":{"type":"string"},"description":"The name for this service activation group","nullable":true},"afterSignRedirectUri":{"type":"string","description":"The URI to which OP should redirect user after service activation group has been signed (default: no redirect)","nullable":true},"contractIds":{"type":"array","items":{"type":"string"},"description":"Identifier of the contracts in this service activation group"}},"additionalProperties":false}},"components/schemas/ServiceActivationGroupConfirmResponseDto":{"id":"components/schemas/ServiceActivationGroupConfirmResponseDto","kind":"json-schema","title":"ServiceActivationGroupConfirmResponseDto","data":{"type":"object","properties":{"groupId":{"type":"string","description":"The Service Activation Group identifier"},"status":{"enum":["Draft","Onboarding","Signing","Provisioning","Completed","Support"],"type":"string","description":"The current status of the Service Activation Group","format":"int32"},"processedContracts":{"type":"array","items":{"$ref":"#/components/schemas/ContractStatusUpdateSummaryDto"},"description":"Summary of all processed contracts in the group"}},"additionalProperties":false}},"components/schemas/ServiceActivationGroupContractsDto":{"id":"components/schemas/ServiceActivationGroupContractsDto","kind":"json-schema","title":"ServiceActivationGroupContractsDto","data":{"type":"object","properties":{"contractIds":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"components/schemas/ServiceActivationGroupDto":{"id":"components/schemas/ServiceActivationGroupDto","kind":"json-schema","title":"ServiceActivationGroupDto","data":{"type":"object","properties":{"description":{"type":"object","additionalProperties":{"type":"string"},"description":"The name for this service activation group","nullable":true},"afterSignRedirectUri":{"type":"string","description":"The URI to which OP should redirect user after service activation group has been signed (default: no redirect)","nullable":true},"contractIds":{"type":"array","items":{"type":"string"},"description":"Identifier of the contracts in this service activation group"},"id":{"type":"string","description":"Unique identifier of this service activation group."},"createdAt":{"type":"string","description":"Date and time indicating when this service activation group was created.","format":"date-time","example":"2023-11-28T08:14:32.585Z"},"updatedAt":{"type":"string","description":"Date and time indicating when this service activation group was last updated.","format":"date-time","example":"2023-11-28T08:14:32.585Z"},"onboardingState":{"$ref":"#/components/schemas/OnboardingStateDto"}},"additionalProperties":false}},"components/schemas/SkuBaseDto":{"id":"components/schemas/SkuBaseDto","kind":"json-schema","title":"SkuBaseDto","data":{"type":"object","properties":{"productCategoryId":{"type":"string","description":"ProductCategory identifier related to this sku"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"Description for this sku"},"parameterGroups":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ContractParameterGroupDto"},"description":"Definition of SKU parameter groups"},"parameters":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ContractBaseParameterDto"},"description":"Definition of SKU parameters"},"features":{"type":"array","items":{"$ref":"#/components/schemas/SkuFeatureDto"},"description":"Selectable feature definitions for this SKU."},"featureRules":{"type":"array","items":{"$ref":"#/components/schemas/SkuFeatureRuleDto"},"description":"Dependency and incompatibility rules for this SKU features."},"toBeProvisioned":{"type":"boolean","description":"Flag to decide if this sku needs provisioning"},"autoCreateBusinessRelation":{"type":"boolean","description":"Flag to decide if this sku needs to automatically create a business relation at SAG confirmation"},"hideInOnboarding":{"type":"boolean","description":"Flag to decide if this sku should be hidden during onboarding."},"onboardingPriority":{"type":"integer","description":"Priority used to sort contract items during onboarding. Lower values are shown first.","format":"int32"},"onboardingInfo":{"type":"object","properties":{"Resell":{"type":"string"},"Direct":{"type":"string"},"Indirect":{"type":"string"},"Distribution":{"type":"string"}},"additionalProperties":false,"description":"Identifier of the onboarding info associated to this sku by contract type","nullable":true}},"additionalProperties":false}},"components/schemas/SkuFeatureDto":{"id":"components/schemas/SkuFeatureDto","kind":"json-schema","title":"SkuFeatureDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of this SKU feature."},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"Localized description for this SKU feature.","nullable":true},"contractTypes":{"type":"array","items":{"enum":["Resell","Direct","Indirect","Distribution"],"type":"string","format":"int32"},"description":"Contract types this feature can be selected for. Empty means all contract types.","nullable":true},"order":{"type":"integer","description":"Optional value used to sort features. Lower values are shown first.","format":"int32","nullable":true},"defaultSelected":{"type":"boolean","description":"Whether this feature should be selected by default when creating a contract item."}},"additionalProperties":false}},"components/schemas/SkuFeatureRuleDto":{"id":"components/schemas/SkuFeatureRuleDto","kind":"json-schema","title":"SkuFeatureRuleDto","data":{"type":"object","properties":{"featureId":{"type":"string","description":"Feature identifier governed by this rule. ConflictsWith disallows coexistence between FeatureId and targets;\r\nwhen an existing selection must be sanitized, FeatureId is removed and targets are kept."},"type":{"enum":["Requires","ConflictsWith"],"type":"string","description":"Feature rule type.","format":"int32"},"match":{"enum":["All","Any"],"type":"string","description":"Defines how target feature identifiers are matched.","format":"int32"},"targetFeatureIds":{"type":"array","items":{"type":"string"},"description":"Target feature identifiers required by this feature or incompatible with this feature, depending on the rule\r\ntype."}},"additionalProperties":false}},"components/schemas/SubscriptionIdDto":{"id":"components/schemas/SubscriptionIdDto","kind":"json-schema","title":"SubscriptionIdDto","data":{"type":"object","properties":{"subscriptionId":{"type":"string"}},"additionalProperties":false}},"components/schemas/SucceededOperationDto":{"id":"components/schemas/SucceededOperationDto","kind":"json-schema","title":"SucceededOperationDto","data":{"type":"object","properties":{"resourceType":{"enum":["Contracts","ContractItems","BusinessRelations","Subscriptions"],"type":"string","format":"int32","nullable":true},"id":{"type":"string"}},"additionalProperties":false}},"components/schemas/T":{"id":"components/schemas/T","kind":"json-schema","title":"T","data":{"type":"object","additionalProperties":false}},"components/schemas/UserBaseDto":{"id":"components/schemas/UserBaseDto","kind":"json-schema","title":"UserBaseDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the user"},"email":{"type":"string","description":"Email of the user"},"consumerIds":{"type":"array","items":{"type":"string"},"description":"Consumer identifiers of the user","nullable":true},"subscriptionUserId":{"type":"string","description":"Subscription identifier of the user"},"createdAt":{"type":"string","description":"Date and time indicating when this user was created.","format":"date-time","example":"2023-11-28T08:14:32.585Z"},"updatedAt":{"type":"string","description":"Date and time indicating when this user was last updated.","format":"date-time","example":"2023-11-28T08:14:32.585Z"}},"additionalProperties":false}},"components/schemas/UserIdDto":{"id":"components/schemas/UserIdDto","kind":"json-schema","title":"UserIdDto","data":{"type":"object","properties":{"userId":{"type":"string"}},"additionalProperties":false}},"components/schemas/X500DistinguishedName":{"id":"components/schemas/X500DistinguishedName","kind":"json-schema","title":"X500DistinguishedName","data":{"type":"object","properties":{"oid":{"$ref":"#/components/schemas/Oid"},"rawData":{"type":"string","format":"byte"},"name":{"type":"string","readOnly":true}},"additionalProperties":false}},"components/schemas/X509Certificate2":{"id":"components/schemas/X509Certificate2","kind":"json-schema","title":"X509Certificate2","data":{"type":"object","properties":{"handle":{"$ref":"#/components/schemas/IntPtr"},"issuer":{"type":"string","readOnly":true},"subject":{"type":"string","readOnly":true},"serialNumberBytes":{"$ref":"#/components/schemas/ReadOnlyMemoryOfByte"},"archived":{"type":"boolean"},"extensions":{"type":"array","items":{"$ref":"#/components/schemas/X509Extension"},"readOnly":true},"friendlyName":{"type":"string"},"hasPrivateKey":{"type":"boolean","readOnly":true},"privateKey":{"$ref":"#/components/schemas/AsymmetricAlgorithm"},"issuerName":{"$ref":"#/components/schemas/X500DistinguishedName"},"notAfter":{"type":"string","format":"date-time","readOnly":true},"notBefore":{"type":"string","format":"date-time","readOnly":true},"publicKey":{"$ref":"#/components/schemas/PublicKey"},"rawData":{"type":"string","format":"byte","readOnly":true},"rawDataMemory":{"$ref":"#/components/schemas/ReadOnlyMemoryOfByte"},"serialNumber":{"type":"string","readOnly":true},"signatureAlgorithm":{"$ref":"#/components/schemas/Oid"},"subjectName":{"$ref":"#/components/schemas/X500DistinguishedName"},"thumbprint":{"type":"string","readOnly":true},"version":{"type":"integer","format":"int32","readOnly":true}},"additionalProperties":false}},"components/schemas/X509Extension":{"id":"components/schemas/X509Extension","kind":"json-schema","title":"X509Extension","data":{"type":"object","properties":{"oid":{"$ref":"#/components/schemas/Oid"},"rawData":{"type":"string","format":"byte"},"critical":{"type":"boolean"}},"additionalProperties":false}},"schema_0":{"kind":"json-schema","data":{"type":"string"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"integer","format":"int32"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"enum":["LegalEntity","BillingConsumer","Issuer","LegalRepresentative","Owner"],"type":"string","format":"int32"},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ConsumerDtoV1"}},"id":"schema_4"}},"exampleStore":{},"securitySchemeStore":{"OpenIdConnect":{"id":"OpenIdConnect","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/auth","tokenUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","refreshUrl":"https://auth-preprod.namirial.app/realms/namirial/protocol/openid-connect/token","scopes":{}}}},"BasicAuthentication":{"id":"BasicAuthentication","type":"http","scheme":"Basic"}},"specVersion":"3.0.1","specType":"openapi"},"options":{"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/products/oneplatform/apis/oas/organizations.json?download"},{"url":"/_bundle/products/oneplatform/apis/oas/organizations.yaml?download"}],"excludeFromSearch":false,"rbac":{"redocly-team-mantainers":"write","anonymous":"read","authenticated":"read"},"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Monitoring - One Platform Organizations Integration API","description":"Monitoring - Public endpoints to integrate Organization with One Platform"}},"baseSlug":"/products/oneplatform/apis/oas/organizations","routesMapping":{}}