{ "openapi": "3.0.1", "info": { "title": "TMF 666 Account Management", "description": "This is Swagger UI environment generated for the TMF Account Management specification", "license": { "name": "Apache 2.0", "url": "https://osl.etsi.org" }, "version": "4.0.0" }, "externalDocs": { "description": "TMF API Tables", "url": "https://www.tmforum.org/oda/open-apis/table" }, "servers": [ { "url": "https://portal.openslice.eu/tmf-api", "description": "Generated server url" } ], "security": [ { "security_auth": [] } ], "tags": [ { "name": "billingCycleSpecification", "description": "the billingCycleSpecification API" }, { "name": "billingAccount", "description": "the billingAccount API" }, { "name": "billPresentationMedia", "description": "the billPresentationMedia API" }, { "name": "partyAccount", "description": "the partyAccount API" }, { "name": "financialAccount", "description": "the financialAccount API" }, { "name": "listener", "description": "the listener API" }, { "name": "settlementAccount", "description": "the settlementAccount API" }, { "name": "billFormat", "description": "the billFormat API" }, { "name": "hub", "description": "the hub API" } ], "paths": { "/accountManagement/v4/settlementAccount": { "get": { "tags": [ "settlementAccount" ], "summary": "List or find SettlementAccount objects", "description": "This operation list or find SettlementAccount entities", "operationId": "listSettlementAccount", "parameters": [ { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Requested index for start of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Requested number of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SettlementAccount" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SettlementAccount" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SettlementAccount" } } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SettlementAccount" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SettlementAccount" } } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SettlementAccount" } } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SettlementAccount" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SettlementAccount" } } } } } } }, "post": { "tags": [ "settlementAccount" ], "summary": "Creates a SettlementAccount", "description": "This operation creates a SettlementAccount entity.", "operationId": "createSettlementAccount", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/SettlementAccountCreate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/SettlementAccount" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/SettlementAccount" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/SettlementAccount" } } } }, "400": { "description": "Created", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/SettlementAccount" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/SettlementAccount" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/SettlementAccount" } } } } } } }, "/accountManagement/v4/partyAccount": { "get": { "tags": [ "partyAccount" ], "summary": "List or find PartyAccount objects", "description": "This operation list or find PartyAccount entities", "operationId": "listPartyAccount", "parameters": [ { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Requested index for start of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Requested number of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PartyAccount" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PartyAccount" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PartyAccount" } } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PartyAccount" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PartyAccount" } } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PartyAccount" } } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PartyAccount" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PartyAccount" } } } } } } }, "post": { "tags": [ "partyAccount" ], "summary": "Creates a PartyAccount", "description": "This operation creates a PartyAccount entity.", "operationId": "createPartyAccount", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartyAccountCreate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartyAccount" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartyAccount" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartyAccount" } } } }, "400": { "description": "Created", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartyAccount" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartyAccount" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartyAccount" } } } } } } }, "/accountManagement/v4/listener/settlementAccountStateChangeEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity SettlementAccountStateChangeEvent", "description": "Example of a client listener for receiving the notification SettlementAccountStateChangeEvent", "operationId": "listenToSettlementAccountStateChangeEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/SettlementAccountStateChangeEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/accountManagement/v4/listener/settlementAccountAttributeValueChangeEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity SettlementAccountAttributeValueChangeEvent", "description": "Example of a client listener for receiving the notification SettlementAccountAttributeValueChangeEvent", "operationId": "listenToSettlementAccountAttributeValueChangeEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/SettlementAccountAttributeValueChangeEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/accountManagement/v4/listener/partyAccountStateChangeEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity PartyAccountStateChangeEvent", "description": "Example of a client listener for receiving the notification PartyAccountStateChangeEvent", "operationId": "listenToPartyAccountStateChangeEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartyAccountStateChangeEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/accountManagement/v4/listener/partyAccountAttributeValueChangeEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity PartyAccountAttributeValueChangeEvent", "description": "Example of a client listener for receiving the notification PartyAccountAttributeValueChangeEvent", "operationId": "listenToPartyAccountAttributeValueChangeEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartyAccountAttributeValueChangeEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/accountManagement/v4/listener/financialAccountStateChangeEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity FinancialAccountStateChangeEvent", "description": "Example of a client listener for receiving the notification FinancialAccountStateChangeEvent", "operationId": "listenToFinancialAccountStateChangeEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/FinancialAccountStateChangeEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/accountManagement/v4/listener/financialAccountDeleteEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity FinancialAccountDeleteEvent", "description": "Example of a client listener for receiving the notification FinancialAccountDeleteEvent", "operationId": "listenToFinancialAccountDeleteEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/FinancialAccountDeleteEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/accountManagement/v4/listener/financialAccountCreateEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity FinancialAccountCreateEvent", "description": "Example of a client listener for receiving the notification FinancialAccountCreateEvent", "operationId": "listenToFinancialAccountCreateEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/FinancialAccountCreateEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/accountManagement/v4/listener/financialAccountAttributeValueChangeEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity FinancialAccountAttributeValueChangeEvent", "description": "Example of a client listener for receiving the notification FinancialAccountAttributeValueChangeEvent", "operationId": "listenToFinancialAccountAttributeValueChangeEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/FinancialAccountAttributeValueChangeEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/accountManagement/v4/listener/billingAccountStateChangeEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity BillingAccountStateChangeEvent", "description": "Example of a client listener for receiving the notification BillingAccountStateChangeEvent", "operationId": "listenToBillingAccountStateChangeEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingAccountStateChangeEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/accountManagement/v4/listener/billingAccountAttributeValueChangeEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity BillingAccountAttributeValueChangeEvent", "description": "Example of a client listener for receiving the notification BillingAccountAttributeValueChangeEvent", "operationId": "listenToBillingAccountAttributeValueChangeEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingAccountAttributeValueChangeEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/accountManagement/v4/hub": { "post": { "tags": [ "hub", "events subscription" ], "summary": "Register a listener", "description": "Sets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics.", "operationId": "registerListener", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscriptionInput" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Subscribed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/accountManagement/v4/financialAccount": { "get": { "tags": [ "financialAccount" ], "summary": "List or find FinancialAccount objects", "description": "This operation list or find FinancialAccount entities", "operationId": "listFinancialAccount", "parameters": [ { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Requested index for start of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Requested number of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FinancialAccount" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FinancialAccount" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FinancialAccount" } } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FinancialAccount" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FinancialAccount" } } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FinancialAccount" } } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FinancialAccount" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FinancialAccount" } } } } } } }, "post": { "tags": [ "financialAccount" ], "summary": "Creates a FinancialAccount", "description": "This operation creates a FinancialAccount entity.", "operationId": "createFinancialAccount", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/FinancialAccountCreate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/FinancialAccount" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/FinancialAccount" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/FinancialAccount" } } } }, "400": { "description": "Created", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/FinancialAccount" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/FinancialAccount" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/FinancialAccount" } } } } } } }, "/accountManagement/v4/billingCycleSpecification": { "get": { "tags": [ "billingCycleSpecification" ], "summary": "List or find BillingCycleSpecification objects", "description": "This operation list or find BillingCycleSpecification entities", "operationId": "listBillingCycleSpecification", "parameters": [ { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Requested index for start of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Requested number of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingCycleSpecification" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingCycleSpecification" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingCycleSpecification" } } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingCycleSpecification" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingCycleSpecification" } } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingCycleSpecification" } } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingCycleSpecification" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingCycleSpecification" } } } } } } }, "post": { "tags": [ "billingCycleSpecification" ], "summary": "Creates a BillingCycleSpecification", "description": "This operation creates a BillingCycleSpecification entity.", "operationId": "createBillingCycleSpecification", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingCycleSpecificationCreate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingCycleSpecification" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingCycleSpecification" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingCycleSpecification" } } } }, "400": { "description": "Created", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingCycleSpecification" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingCycleSpecification" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingCycleSpecification" } } } } } } }, "/accountManagement/v4/billingAccount": { "get": { "tags": [ "billingAccount" ], "summary": "List or find BillingAccount objects", "description": "This operation list or find BillingAccount entities", "operationId": "listBillingAccount", "parameters": [ { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Requested index for start of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Requested number of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingAccount" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingAccount" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingAccount" } } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingAccount" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingAccount" } } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingAccount" } } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingAccount" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingAccount" } } } } } } }, "post": { "tags": [ "billingAccount" ], "summary": "Creates a BillingAccount", "description": "This operation creates a BillingAccount entity.", "operationId": "createBillingAccount", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingAccountCreate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingAccount" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingAccount" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingAccount" } } } }, "400": { "description": "Created", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingAccount" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingAccount" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingAccount" } } } } } } }, "/accountManagement/v4/billPresentationMedia": { "get": { "tags": [ "billPresentationMedia" ], "summary": "List or find BillPresentationMedia objects", "description": "This operation list or find BillPresentationMedia entities", "operationId": "listBillPresentationMedia", "parameters": [ { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Requested index for start of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Requested number of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillPresentationMedia" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillPresentationMedia" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillPresentationMedia" } } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillPresentationMedia" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillPresentationMedia" } } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillPresentationMedia" } } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillPresentationMedia" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillPresentationMedia" } } } } } } }, "post": { "tags": [ "billPresentationMedia" ], "summary": "Creates a BillPresentationMedia", "description": "This operation creates a BillPresentationMedia entity.", "operationId": "createBillPresentationMedia", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillPresentationMediaCreate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillPresentationMedia" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillPresentationMedia" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillPresentationMedia" } } } }, "400": { "description": "Created", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillPresentationMedia" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillPresentationMedia" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillPresentationMedia" } } } } } } }, "/accountManagement/v4/billFormat": { "get": { "tags": [ "billFormat" ], "summary": "List or find BillFormat objects", "description": "This operation list or find BillFormat entities", "operationId": "listBillFormat", "parameters": [ { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Requested index for start of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Requested number of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillFormat" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillFormat" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillFormat" } } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillFormat" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillFormat" } } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillFormat" } } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillFormat" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillFormat" } } } } } } }, "post": { "tags": [ "billFormat" ], "summary": "Creates a BillFormat", "description": "This operation creates a BillFormat entity.", "operationId": "createBillFormat", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillFormatCreate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillFormat" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillFormat" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillFormat" } } } }, "400": { "description": "Created", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillFormat" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillFormat" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillFormat" } } } } } } }, "/accountManagement/v4/settlementAccount/{id}": { "get": { "tags": [ "settlementAccount" ], "summary": "Retrieves a SettlementAccount by ID", "description": "This operation retrieves a SettlementAccount entity. Attribute selection is enabled for all first level attributes.", "operationId": "retrieveSettlementAccount", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the SettlementAccount", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated properties to provide in response", "required": false, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/SettlementAccount" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/SettlementAccount" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/SettlementAccount" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/SettlementAccount" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/SettlementAccount" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/SettlementAccount" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/SettlementAccount" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/SettlementAccount" } } } } } }, "delete": { "tags": [ "settlementAccount" ], "summary": "Deletes a SettlementAccount", "description": "This operation deletes a SettlementAccount entity.", "operationId": "deleteSettlementAccount", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the SettlementAccount", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error" }, "204": { "description": "Deleted" }, "409": { "description": "Conflict" }, "404": { "description": "Not Found" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "405": { "description": "Method Not allowed" }, "401": { "description": "Unauthorized" } } }, "patch": { "tags": [ "settlementAccount" ], "summary": "Updates partially a SettlementAccount", "description": "This operation updates partially a SettlementAccount entity.", "operationId": "patchSettlementAccount", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the SettlementAccount", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/SettlementAccountUpdate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/SettlementAccount" } } } }, "200": { "description": "Updated", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/SettlementAccount" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/SettlementAccount" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/SettlementAccount" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/SettlementAccount" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/SettlementAccount" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/SettlementAccount" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/SettlementAccount" } } } } } } }, "/accountManagement/v4/partyAccount/{id}": { "get": { "tags": [ "partyAccount" ], "summary": "Retrieves a PartyAccount by ID", "description": "This operation retrieves a PartyAccount entity. Attribute selection is enabled for all first level attributes.", "operationId": "retrievePartyAccount", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the PartyAccount", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated properties to provide in response", "required": false, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartyAccount" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartyAccount" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartyAccount" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartyAccount" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartyAccount" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartyAccount" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartyAccount" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartyAccount" } } } } } }, "delete": { "tags": [ "partyAccount" ], "summary": "Deletes a PartyAccount", "description": "This operation deletes a PartyAccount entity.", "operationId": "deletePartyAccount", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the PartyAccount", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error" }, "204": { "description": "Deleted" }, "409": { "description": "Conflict" }, "404": { "description": "Not Found" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "405": { "description": "Method Not allowed" }, "401": { "description": "Unauthorized" } } }, "patch": { "tags": [ "partyAccount" ], "summary": "Updates partially a PartyAccount", "description": "This operation updates partially a PartyAccount entity.", "operationId": "patchPartyAccount", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the PartyAccount", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartyAccountUpdate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartyAccount" } } } }, "200": { "description": "Updated", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartyAccount" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartyAccount" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartyAccount" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartyAccount" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartyAccount" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartyAccount" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartyAccount" } } } } } } }, "/accountManagement/v4/financialAccount/{id}": { "get": { "tags": [ "financialAccount" ], "summary": "Retrieves a FinancialAccount by ID", "description": "This operation retrieves a FinancialAccount entity. Attribute selection is enabled for all first level attributes.", "operationId": "retrieveFinancialAccount", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the FinancialAccount", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated properties to provide in response", "required": false, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/FinancialAccount" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/FinancialAccount" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/FinancialAccount" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/FinancialAccount" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/FinancialAccount" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/FinancialAccount" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/FinancialAccount" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/FinancialAccount" } } } } } }, "delete": { "tags": [ "financialAccount" ], "summary": "Deletes a FinancialAccount", "description": "This operation deletes a FinancialAccount entity.", "operationId": "deleteFinancialAccount", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the FinancialAccount", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error" }, "204": { "description": "Deleted" }, "409": { "description": "Conflict" }, "404": { "description": "Not Found" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "405": { "description": "Method Not allowed" }, "401": { "description": "Unauthorized" } } }, "patch": { "tags": [ "financialAccount" ], "summary": "Updates partially a FinancialAccount", "description": "This operation updates partially a FinancialAccount entity.", "operationId": "patchFinancialAccount", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the FinancialAccount", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/FinancialAccountUpdate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/FinancialAccount" } } } }, "200": { "description": "Updated", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/FinancialAccount" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/FinancialAccount" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/FinancialAccount" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/FinancialAccount" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/FinancialAccount" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/FinancialAccount" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/FinancialAccount" } } } } } } }, "/accountManagement/v4/billingCycleSpecification/{id}": { "get": { "tags": [ "billingCycleSpecification" ], "summary": "Retrieves a BillingCycleSpecification by ID", "description": "This operation retrieves a BillingCycleSpecification entity. Attribute selection is enabled for all first level attributes.", "operationId": "retrieveBillingCycleSpecification", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the BillingCycleSpecification", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated properties to provide in response", "required": false, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingCycleSpecification" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingCycleSpecification" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingCycleSpecification" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingCycleSpecification" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingCycleSpecification" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingCycleSpecification" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingCycleSpecification" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingCycleSpecification" } } } } } }, "delete": { "tags": [ "billingCycleSpecification" ], "summary": "Deletes a BillingCycleSpecification", "description": "This operation deletes a BillingCycleSpecification entity.", "operationId": "deleteBillingCycleSpecification", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the BillingCycleSpecification", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error" }, "204": { "description": "Deleted" }, "409": { "description": "Conflict" }, "404": { "description": "Not Found" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "405": { "description": "Method Not allowed" }, "401": { "description": "Unauthorized" } } }, "patch": { "tags": [ "billingCycleSpecification" ], "summary": "Updates partially a BillingCycleSpecification", "description": "This operation updates partially a BillingCycleSpecification entity.", "operationId": "patchBillingCycleSpecification", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the BillingCycleSpecification", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingCycleSpecificationUpdate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingCycleSpecification" } } } }, "200": { "description": "Updated", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingCycleSpecification" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingCycleSpecification" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingCycleSpecification" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingCycleSpecification" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingCycleSpecification" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingCycleSpecification" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingCycleSpecification" } } } } } } }, "/accountManagement/v4/billingAccount/{id}": { "get": { "tags": [ "billingAccount" ], "summary": "Retrieves a BillingAccount by ID", "description": "This operation retrieves a BillingAccount entity. Attribute selection is enabled for all first level attributes.", "operationId": "retrieveBillingAccount", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the BillingAccount", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated properties to provide in response", "required": false, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingAccount" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingAccount" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingAccount" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingAccount" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingAccount" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingAccount" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingAccount" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingAccount" } } } } } }, "delete": { "tags": [ "billingAccount" ], "summary": "Deletes a BillingAccount", "description": "This operation deletes a BillingAccount entity.", "operationId": "deleteBillingAccount", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the BillingAccount", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error" }, "204": { "description": "Deleted" }, "409": { "description": "Conflict" }, "404": { "description": "Not Found" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "405": { "description": "Method Not allowed" }, "401": { "description": "Unauthorized" } } }, "patch": { "tags": [ "billingAccount" ], "summary": "Updates partially a BillingAccount", "description": "This operation updates partially a BillingAccount entity.", "operationId": "patchBillingAccount", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the BillingAccount", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingAccountUpdate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingAccount" } } } }, "200": { "description": "Updated", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingAccount" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingAccount" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingAccount" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingAccount" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingAccount" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingAccount" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillingAccount" } } } } } } }, "/accountManagement/v4/billPresentationMedia/{id}": { "get": { "tags": [ "billPresentationMedia" ], "summary": "Retrieves a BillPresentationMedia by ID", "description": "This operation retrieves a BillPresentationMedia entity. Attribute selection is enabled for all first level attributes.", "operationId": "retrieveBillPresentationMedia", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the BillPresentationMedia", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated properties to provide in response", "required": false, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillPresentationMedia" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillPresentationMedia" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillPresentationMedia" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillPresentationMedia" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillPresentationMedia" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillPresentationMedia" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillPresentationMedia" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillPresentationMedia" } } } } } }, "delete": { "tags": [ "billPresentationMedia" ], "summary": "Deletes a BillPresentationMedia", "description": "This operation deletes a BillPresentationMedia entity.", "operationId": "deleteBillPresentationMedia", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the BillPresentationMedia", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error" }, "204": { "description": "Deleted" }, "409": { "description": "Conflict" }, "404": { "description": "Not Found" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "405": { "description": "Method Not allowed" }, "401": { "description": "Unauthorized" } } }, "patch": { "tags": [ "billPresentationMedia" ], "summary": "Updates partially a BillPresentationMedia", "description": "This operation updates partially a BillPresentationMedia entity.", "operationId": "patchBillPresentationMedia", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the BillPresentationMedia", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillPresentationMediaUpdate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillPresentationMedia" } } } }, "200": { "description": "Updated", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillPresentationMedia" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillPresentationMedia" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillPresentationMedia" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillPresentationMedia" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillPresentationMedia" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillPresentationMedia" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillPresentationMedia" } } } } } } }, "/accountManagement/v4/billFormat/{id}": { "get": { "tags": [ "billFormat" ], "summary": "Retrieves a BillFormat by ID", "description": "This operation retrieves a BillFormat entity. Attribute selection is enabled for all first level attributes.", "operationId": "retrieveBillFormat", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the BillFormat", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated properties to provide in response", "required": false, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillFormat" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillFormat" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillFormat" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillFormat" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillFormat" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillFormat" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillFormat" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillFormat" } } } } } }, "delete": { "tags": [ "billFormat" ], "summary": "Deletes a BillFormat", "description": "This operation deletes a BillFormat entity.", "operationId": "deleteBillFormat", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the BillFormat", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error" }, "204": { "description": "Deleted" }, "409": { "description": "Conflict" }, "404": { "description": "Not Found" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "405": { "description": "Method Not allowed" }, "401": { "description": "Unauthorized" } } }, "patch": { "tags": [ "billFormat" ], "summary": "Updates partially a BillFormat", "description": "This operation updates partially a BillFormat entity.", "operationId": "patchBillFormat", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the BillFormat", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillFormatUpdate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillFormat" } } } }, "200": { "description": "Updated", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillFormat" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillFormat" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillFormat" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillFormat" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillFormat" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillFormat" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/BillFormat" } } } } } } }, "/accountManagement/v4/hub/{id}": { "delete": { "tags": [ "hub", "events subscription" ], "summary": "Unregister a listener", "description": "Resets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics.", "operationId": "unregisterListener", "parameters": [ { "name": "id", "in": "path", "description": "The id of the registered listener", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error" }, "400": { "description": "Bad request" }, "204": { "description": "Deleted" }, "405": { "description": "Method not allowed" }, "404": { "description": "Not Found" }, "403": { "description": "Forbidden" }, "401": { "description": "Unauthorized" } } } } }, "components": { "schemas": { "AccountBalance": { "required": [ "amount", "balanceType", "validFor" ], "type": "object", "properties": { "balanceType": { "type": "string", "description": "Type of the balance : deposit balance, disputed balance, loyalty balance, receivable balance..." }, "amount": { "$ref": "#/components/schemas/Money" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "Balances linked to the account" }, "AccountRef": { "required": [ "id" ], "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "id": { "type": "string", "description": "Unique identifier of the account" }, "description": { "type": "string", "description": "Detailed description of the account" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "Account reference. A account may be a party account or a financial account." }, "AccountRelationship": { "required": [ "relationshipType", "validFor" ], "type": "object", "properties": { "relationshipType": { "type": "string", "description": "Type of relationship" }, "account": { "$ref": "#/components/schemas/AccountRef" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "Significant connection between accounts. For instance an aggregating account for a list of shop branches each having its own billing account." }, "AccountTaxExemption": { "required": [ "issuingJurisdiction", "validFor" ], "type": "object", "properties": { "certificateNumber": { "type": "string", "description": "Identifier of a document that shows proof of exemption from taxes for the taxing jurisdiction" }, "issuingJurisdiction": { "type": "string", "description": "Name of the taxing jurisdiction for which taxes are exempt" }, "reason": { "type": "string", "description": "Reason of the tax exemption" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "Proof of freedom from taxes imposed by a taxing jurisdiction" }, "BillFormatRefOrValue": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the bill format" }, "href": { "type": "string", "description": "Reference of the bill format" }, "description": { "type": "string", "description": "An explanatory text for this bill format" }, "name": { "type": "string", "description": "A short descriptive name" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "An attachment by value or by reference." }, "BillPresentationMediaRefOrValue": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the bill presentation media" }, "href": { "type": "string", "description": "Reference of the bill presentation media" }, "description": { "type": "string", "description": "An explanatory text describing this bill presentation media" }, "name": { "type": "string", "description": "A short descriptive name" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "An attachment by value or by reference." }, "BillStructure": { "type": "object", "properties": { "cycleSpecification": { "$ref": "#/components/schemas/BillingCycleSpecificationRefOrValue" }, "format": { "$ref": "#/components/schemas/BillFormatRefOrValue" }, "presentationMedia": { "type": "array", "items": { "$ref": "#/components/schemas/BillPresentationMediaRefOrValue" } }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "The structure of the bill for party accounts (billing or settlement)." }, "BillingCycleSpecificationRefOrValue": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the billing cycle specification" }, "href": { "type": "string", "description": "Reference of the billing cycle specification" }, "billingDateShift": { "type": "integer", "description": "An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period.", "format": "int32" }, "billingPeriod": { "type": "string", "description": "A billing time period. It can be recurring, for example: week, month, quarter of year, year ." }, "chargeDateOffset": { "type": "integer", "description": "An offset of a date through which charges previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod.", "format": "int32" }, "creditDateOffset": { "type": "integer", "description": "An offset of a date through which credits previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod.", "format": "int32" }, "dateShift": { "type": "integer", "description": "An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period.", "format": "int32" }, "description": { "type": "string", "description": "An explanation regarding this billing cycle specification" }, "frequency": { "type": "string", "description": "Frequency of the billing cycle (monthly for instance)" }, "mailingDateOffset": { "type": "integer", "description": "An offset of a customer bill mailing date. The offset is expressed as number of days with regard to the start of the BillingPeriod.", "format": "int32" }, "name": { "type": "string", "description": "A short descriptive name" }, "paymentDueDateOffset": { "type": "integer", "description": "An offset of a payment due date. The offset is expressed as number of days with regard to the start of the BillingPeriod.", "format": "int32" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "An attachment by value or by reference." }, "Contact": { "required": [ "contactType", "validFor" ], "type": "object", "properties": { "contactName": { "type": "string", "description": "A displayable name for that contact" }, "contactType": { "type": "string", "description": "Type of contact (primary, secondary...)" }, "partyRoleType": { "type": "string", "description": "Identifies what kind of party role type is linked to the contact (a account manager...)" }, "contactMedium": { "type": "array", "items": { "$ref": "#/components/schemas/ContactMedium" } }, "relatedParty": { "$ref": "#/components/schemas/RelatedParty" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "An individual or an organization used as a contact point for a given account and accessed via some contact medium." }, "ContactMedium": { "type": "object", "properties": { "mediumType": { "type": "string", "description": "Type of the contact medium, such as: email address, telephone number, postal address" }, "preferred": { "type": "boolean", "description": "If true, indicates that is the preferred contact medium" }, "characteristic": { "$ref": "#/components/schemas/MediumCharacteristic" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "Indicates the contact medium that could be used to contact the party." }, "FinancialAccountRef": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the account" }, "href": { "type": "string", "description": "Unique reference of the account" }, "name": { "type": "string", "description": "Name of the account" }, "accountBalance": { "$ref": "#/components/schemas/AccountBalance" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "AccountReceivable reference. An account of money owed by a party to another entity in exchange for goods or services that have been delivered or used. An account receivable aggregates the amounts of one or more party accounts (billing or settlement) owned by a given party." }, "MediumCharacteristic": { "type": "object", "properties": { "city": { "type": "string", "description": "The city" }, "contactType": { "type": "string", "description": "The type of contact, for example: phone number such as mobile, fixed home, fixed office. postal address such as shipping instalation\u2026" }, "country": { "type": "string", "description": "The country" }, "emailAddress": { "type": "string", "description": "Full email address in standard format" }, "faxNumber": { "type": "string", "description": "The fax number of the contact" }, "phoneNumber": { "type": "string", "description": "The primary phone number of the contact" }, "postCode": { "type": "string", "description": "Postcode" }, "socialNetworkId": { "type": "string", "description": "Identifier as a member of a social network" }, "stateOrProvince": { "type": "string", "description": "State or province" }, "street1": { "type": "string", "description": "Describes the street" }, "street2": { "type": "string", "description": "Complementary street description" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "Describes the contact medium characteristics that could be used to contact a party (an individual or an organization)" }, "Money": { "type": "object", "properties": { "unit": { "type": "string", "description": "Currency (ISO4217 norm uses 3 letters to define the currency)" }, "value": { "type": "number", "description": "A positive floating point number", "format": "float" } }, "description": "A base / value business entity used to represent money" }, "PaymentMethodRef": { "required": [ "id" ], "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "id": { "type": "string", "description": "Unique identifier of the payment mean" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit)." }, "PaymentPlan": { "type": "object", "properties": { "numberOfPayments": { "type": "integer", "description": "Number of payments used to spread the global payment", "format": "int32" }, "paymentFrequency": { "type": "string", "description": "Frequency of the payments, such as monthly and bimonthly" }, "planType": { "type": "string", "description": "Type of payment plan" }, "priority": { "type": "integer", "description": "Priority of the payment plan", "format": "int32" }, "status": { "type": "string", "description": "Status of the payment plan (effective, ineffective)" }, "paymentMethod": { "$ref": "#/components/schemas/PaymentMethodRef" }, "totalAmount": { "$ref": "#/components/schemas/Money" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "Defines a plan for payment (when a party wants to spread his payments)" }, "RelatedParty": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "role": { "type": "string", "description": "Role of the related party." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "id": { "type": "string" }, "extendedInfo": { "type": "string" } }, "description": "RelatedParty reference. A related party defines party or party role linked to a specific entity." }, "SettlementAccountCreate": { "required": [ "name", "relatedParty" ], "type": "object", "properties": { "accountType": { "type": "string", "description": "A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values." }, "description": { "type": "string", "description": "Detailed description of the party account" }, "lastModified": { "type": "string", "format": "date-time" }, "name": { "type": "string", "description": "Name of the account" }, "paymentStatus": { "type": "string", "description": "The condition of the account, such as due, paid, in arrears." }, "state": { "type": "string", "description": "Contains the lifecycle state such as: Active, Closed, Suspended and so on." }, "accountBalance": { "type": "array", "items": { "$ref": "#/components/schemas/AccountBalance" } }, "accountRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/AccountRelationship" } }, "billStructure": { "$ref": "#/components/schemas/BillStructure" }, "contact": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } }, "creditLimit": { "$ref": "#/components/schemas/Money" }, "defaultPaymentMethod": { "$ref": "#/components/schemas/PaymentMethodRef" }, "financialAccount": { "$ref": "#/components/schemas/FinancialAccountRef" }, "paymentPlan": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentPlan" } }, "relatedParty": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "taxExemption": { "type": "array", "items": { "$ref": "#/components/schemas/AccountTaxExemption" } }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "The SettlementAccount to be created" }, "TimePeriod": { "type": "object", "properties": { "endDateTime": { "type": "string", "description": "End of the time period, using IETC-RFC-3339 format" }, "startDateTime": { "type": "string", "description": "Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end" } }, "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both" }, "SettlementAccount": { "required": [ "name", "relatedParty" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the account" }, "href": { "type": "string", "description": "Unique reference of the account" }, "accountType": { "type": "string", "description": "A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values." }, "description": { "type": "string", "description": "Detailed description of the party account" }, "lastModified": { "type": "string", "format": "date-time" }, "name": { "type": "string", "description": "Name of the account" }, "paymentStatus": { "type": "string", "description": "The condition of the account, such as due, paid, in arrears." }, "state": { "type": "string", "description": "Contains the lifecycle state such as: Active, Closed, Suspended and so on." }, "accountBalance": { "type": "array", "items": { "$ref": "#/components/schemas/AccountBalance" } }, "accountRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/AccountRelationship" } }, "billStructure": { "$ref": "#/components/schemas/BillStructure" }, "contact": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } }, "creditLimit": { "$ref": "#/components/schemas/Money" }, "defaultPaymentMethod": { "$ref": "#/components/schemas/PaymentMethodRef" }, "financialAccount": { "$ref": "#/components/schemas/FinancialAccountRef" }, "paymentPlan": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentPlan" } }, "relatedParty": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "taxExemption": { "type": "array", "items": { "$ref": "#/components/schemas/AccountTaxExemption" } }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "A party account used for settlement purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specialization of entity PartyAccount." }, "PartyAccountCreate": { "required": [ "name", "relatedParty" ], "type": "object", "properties": { "accountType": { "type": "string", "description": "A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values." }, "description": { "type": "string", "description": "Detailed description of the party account" }, "lastModified": { "type": "string", "format": "date-time" }, "name": { "type": "string", "description": "Name of the account" }, "paymentStatus": { "type": "string", "description": "The condition of the account, such as due, paid, in arrears." }, "state": { "type": "string", "description": "Contains the lifecycle state such as: Active, Closed, Suspended and so on." }, "accountBalance": { "type": "array", "items": { "$ref": "#/components/schemas/AccountBalance" } }, "accountRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/AccountRelationship" } }, "billStructure": { "$ref": "#/components/schemas/BillStructure" }, "contact": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } }, "creditLimit": { "$ref": "#/components/schemas/Money" }, "defaultPaymentMethod": { "$ref": "#/components/schemas/PaymentMethodRef" }, "financialAccount": { "$ref": "#/components/schemas/FinancialAccountRef" }, "paymentPlan": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentPlan" } }, "relatedParty": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "taxExemption": { "type": "array", "items": { "$ref": "#/components/schemas/AccountTaxExemption" } }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "The PartyAccount to be created" }, "PartyAccount": { "required": [ "name", "relatedParty" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the account" }, "href": { "type": "string", "description": "Unique reference of the account" }, "accountType": { "type": "string", "description": "A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values." }, "description": { "type": "string", "description": "Detailed description of the party account" }, "lastModified": { "type": "string", "format": "date-time" }, "name": { "type": "string", "description": "Name of the account" }, "paymentStatus": { "type": "string", "description": "The condition of the account, such as due, paid, in arrears." }, "state": { "type": "string", "description": "Contains the lifecycle state such as: Active, Closed, Suspended and so on." }, "accountBalance": { "type": "array", "items": { "$ref": "#/components/schemas/AccountBalance" } }, "accountRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/AccountRelationship" } }, "billStructure": { "$ref": "#/components/schemas/BillStructure" }, "contact": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } }, "creditLimit": { "$ref": "#/components/schemas/Money" }, "defaultPaymentMethod": { "$ref": "#/components/schemas/PaymentMethodRef" }, "financialAccount": { "$ref": "#/components/schemas/FinancialAccountRef" }, "paymentPlan": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentPlan" } }, "relatedParty": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "taxExemption": { "type": "array", "items": { "$ref": "#/components/schemas/AccountTaxExemption" } }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "Account used for billing or for settlement purposes concerning a given party (an organization or an individual). It is a specialization of entity Account." }, "SettlementAccountStateChangeEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the resource involved in the event" }, "href": { "type": "string", "description": "Reference of the resource involved in the event" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explanatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "event": { "$ref": "#/components/schemas/SettlementAccountStateChangeEventPayload" } }, "description": "The event data" }, "SettlementAccountStateChangeEventPayload": { "type": "object", "properties": { "tlementAccount": { "$ref": "#/components/schemas/SettlementAccountStateChangeEventPayload" }, "settlementAccount": { "$ref": "#/components/schemas/SettlementAccount" } }, "description": "The event data structure" }, "EventSubscription": { "required": [ "callback", "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "Id of the listener" }, "callback": { "type": "string", "description": "The callback being registered." }, "query": { "type": "string", "description": "additional data to be passed" } }, "description": "Sets the communication endpoint address the service instance must use to deliver notification information" }, "SettlementAccountAttributeValueChangeEvent": { "type": "object", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explanatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "fieldPath": { "type": "string", "description": "The path identifying the object field concerned by this notification." }, "event": { "$ref": "#/components/schemas/SettlementAccountAttributeValueChangeEventPayload" } }, "description": "The event data" }, "SettlementAccountAttributeValueChangeEventPayload": { "type": "object", "properties": { "tlementAccount": { "$ref": "#/components/schemas/SettlementAccountAttributeValueChangeEventPayload" }, "settlementAccount": { "$ref": "#/components/schemas/SettlementAccount" } }, "description": "The event data structure" }, "PartyAccountStateChangeEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the resource involved in the event" }, "href": { "type": "string", "description": "Reference of the resource involved in the event" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explanatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "event": { "$ref": "#/components/schemas/PartyAccountStateChangeEventPayload" } }, "description": "The event data" }, "PartyAccountStateChangeEventPayload": { "type": "object", "properties": { "partyAccount": { "$ref": "#/components/schemas/PartyAccount" } }, "description": "The event data structure" }, "PartyAccountAttributeValueChangeEvent": { "type": "object", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explanatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "fieldPath": { "type": "string", "description": "The path identifying the object field concerned by this notification." }, "event": { "$ref": "#/components/schemas/PartyAccountAttributeValueChangeEventPayload" } }, "description": "The event data" }, "PartyAccountAttributeValueChangeEventPayload": { "type": "object", "properties": { "partyAccount": { "$ref": "#/components/schemas/PartyAccount" } }, "description": "The event data structure" }, "FinancialAccount": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the account" }, "href": { "type": "string", "description": "Unique reference of the account" }, "accountType": { "type": "string", "description": "A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values." }, "description": { "type": "string", "description": "Detailed description of the party account" }, "lastModified": { "type": "string", "format": "date-time" }, "name": { "type": "string", "description": "Name of the account" }, "state": { "type": "string", "description": "Contains the lifecycle state such as: Active, Closed, Suspended and so on." }, "accountBalance": { "type": "array", "items": { "$ref": "#/components/schemas/AccountBalance" } }, "accountRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/AccountRelationship" } }, "contact": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } }, "creditLimit": { "$ref": "#/components/schemas/Money" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "taxExemption": { "type": "array", "items": { "$ref": "#/components/schemas/AccountTaxExemption" } }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "An account of money owed by a party to another entity in exchange for goods or services that have been delivered or used. A financial (account receivable account/account payable) aggregates the amounts of one or more party accounts (billing or settlement) owned by a given party. It is a specialization of entity Account." }, "FinancialAccountStateChangeEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the resource involved in the event" }, "href": { "type": "string", "description": "Reference of the resource involved in the event" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explanatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "event": { "$ref": "#/components/schemas/FinancialAccountStateChangeEventPayload" } }, "description": "The event data" }, "FinancialAccountStateChangeEventPayload": { "type": "object", "properties": { "financialAccount": { "$ref": "#/components/schemas/FinancialAccount" } }, "description": "The event data structure" }, "FinancialAccountDeleteEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the resource involved in the event" }, "href": { "type": "string", "description": "Reference of the resource involved in the event" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explanatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "event": { "$ref": "#/components/schemas/FinancialAccountDeleteEventPayload" } }, "description": "The event data" }, "FinancialAccountDeleteEventPayload": { "type": "object", "properties": { "financialAccount": { "$ref": "#/components/schemas/FinancialAccount" } }, "description": "The event data structure" }, "FinancialAccountCreateEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the resource involved in the event" }, "href": { "type": "string", "description": "Reference of the resource involved in the event" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explanatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "event": { "$ref": "#/components/schemas/FinancialAccountCreateEventPayload" } }, "description": "The event data" }, "FinancialAccountCreateEventPayload": { "type": "object", "properties": { "financialAccount": { "$ref": "#/components/schemas/FinancialAccount" } }, "description": "The event data structure" }, "FinancialAccountAttributeValueChangeEvent": { "type": "object", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explanatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "fieldPath": { "type": "string", "description": "The path identifying the object field concerned by this notification." }, "event": { "$ref": "#/components/schemas/FinancialAccountAttributeValueChangeEventPayload" } }, "description": "The event data" }, "FinancialAccountAttributeValueChangeEventPayload": { "type": "object", "properties": { "financialAccount": { "$ref": "#/components/schemas/FinancialAccount" } }, "description": "The event data structure" }, "BillingAccount": { "required": [ "name", "relatedParty" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the account" }, "href": { "type": "string", "description": "Unique reference of the account" }, "accountType": { "type": "string", "description": "A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values." }, "description": { "type": "string", "description": "Detailed description of the party account" }, "lastModified": { "type": "string", "format": "date-time" }, "name": { "type": "string", "description": "Name of the account" }, "paymentStatus": { "type": "string", "description": "The condition of the account, such as due, paid, in arrears." }, "ratingType": { "type": "string", "description": "Indicates whether the account follows a specific payment option such as prepaid or postpaid" }, "state": { "type": "string", "description": "Contains the lifecycle state such as: Active, Closed, Suspended and so on." }, "accountBalance": { "type": "array", "items": { "$ref": "#/components/schemas/AccountBalance" } }, "accountRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/AccountRelationship" } }, "billStructure": { "$ref": "#/components/schemas/BillStructure" }, "contact": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } }, "creditLimit": { "$ref": "#/components/schemas/Money" }, "defaultPaymentMethod": { "$ref": "#/components/schemas/PaymentMethodRef" }, "financialAccount": { "$ref": "#/components/schemas/FinancialAccountRef" }, "paymentPlan": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentPlan" } }, "relatedParty": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "taxExemption": { "type": "array", "items": { "$ref": "#/components/schemas/AccountTaxExemption" } }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "A party account used for billing purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specialization of entity PartyAccount." }, "BillingAccountStateChangeEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the resource involved in the event" }, "href": { "type": "string", "description": "Reference of the resource involved in the event" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explanatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "event": { "$ref": "#/components/schemas/BillingAccountStateChangeEventPayload" } }, "description": "The event data" }, "BillingAccountStateChangeEventPayload": { "type": "object", "properties": { "billingAccount": { "$ref": "#/components/schemas/BillingAccount" } }, "description": "The event data structure" }, "BillingAccountAttributeValueChangeEvent": { "type": "object", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explanatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "fieldPath": { "type": "string", "description": "The path identifying the object field concerned by this notification." }, "event": { "$ref": "#/components/schemas/BillingAccountAttributeValueChangeEventPayload" } }, "description": "The event data" }, "BillingAccountAttributeValueChangeEventPayload": { "type": "object", "properties": { "billingAccount": { "$ref": "#/components/schemas/BillingAccount" } }, "description": "The event data structure" }, "EventSubscriptionInput": { "required": [ "callback" ], "type": "object", "properties": { "callback": { "type": "string", "description": "The callback being registered." }, "query": { "type": "string", "description": "additional data to be passed" } }, "description": "Data containing the callback endpoint to deliver the information" }, "FinancialAccountCreate": { "required": [ "name" ], "type": "object", "properties": { "accountType": { "type": "string", "description": "A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values." }, "description": { "type": "string", "description": "Detailed description of the party account" }, "lastModified": { "type": "string", "format": "date-time" }, "name": { "type": "string", "description": "Name of the account" }, "state": { "type": "string", "description": "Contains the lifecycle state such as: Active, Closed, Suspended and so on." }, "accountBalance": { "type": "array", "items": { "$ref": "#/components/schemas/AccountBalance" } }, "accountRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/AccountRelationship" } }, "contact": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } }, "creditLimit": { "$ref": "#/components/schemas/Money" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "taxExemption": { "type": "array", "items": { "$ref": "#/components/schemas/AccountTaxExemption" } }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "The FinancialAccount to be created" }, "BillingCycleSpecificationCreate": { "required": [ "name" ], "type": "object", "properties": { "billingDateShift": { "type": "integer", "description": "An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period.", "format": "int32" }, "billingPeriod": { "type": "string", "description": "A billing time period. It can be recurring, for example: week, month, quarter of year, year ." }, "chargeDateOffset": { "type": "integer", "description": "An offset of a date through which charges previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod.", "format": "int32" }, "creditDateOffset": { "type": "integer", "description": "An offset of a date through which credits previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod.", "format": "int32" }, "description": { "type": "string", "description": "An explanation regarding this billing cycle specification" }, "frequency": { "type": "string", "description": "Frequency of the billing cycle (monthly for instance)" }, "mailingDateOffset": { "type": "integer", "description": "An offset of a customer bill mailing date. The offset is expressed as number of days with regard to the start of the BillingPeriod.", "format": "int32" }, "name": { "type": "string", "description": "A short descriptive name" }, "paymentDueDateOffset": { "type": "integer", "description": "An offset of a payment due date. The offset is expressed as number of days with regard to the start of the BillingPeriod.", "format": "int32" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "The BillingCycleSpecification to be created" }, "BillingCycleSpecification": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the billing cycle specification" }, "href": { "type": "string", "description": "Reference of the billing cycle specification" }, "billingDateShift": { "type": "integer", "description": "An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period.", "format": "int32" }, "billingPeriod": { "type": "string", "description": "A billing time period. It can be recurring, for example: week, month, quarter of year, year ." }, "chargeDateOffset": { "type": "integer", "description": "An offset of a date through which charges previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod.", "format": "int32" }, "creditDateOffset": { "type": "integer", "description": "An offset of a date through which credits previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod.", "format": "int32" }, "description": { "type": "string", "description": "An explanation regarding this billing cycle specification" }, "frequency": { "type": "string", "description": "Frequency of the billing cycle (monthly for instance)" }, "mailingDateOffset": { "type": "integer", "description": "An offset of a customer bill mailing date. The offset is expressed as number of days with regard to the start of the BillingPeriod.", "format": "int32" }, "name": { "type": "string", "description": "A short descriptive name" }, "paymentDueDateOffset": { "type": "integer", "description": "An offset of a payment due date. The offset is expressed as number of days with regard to the start of the BillingPeriod.", "format": "int32" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "A detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle." }, "BillingAccountCreate": { "required": [ "name", "relatedParty" ], "type": "object", "properties": { "accountType": { "type": "string", "description": "A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values." }, "description": { "type": "string", "description": "Detailed description of the party account" }, "lastModified": { "type": "string", "format": "date-time" }, "name": { "type": "string", "description": "Name of the account" }, "paymentStatus": { "type": "string", "description": "The condition of the account, such as due, paid, in arrears." }, "ratingType": { "type": "string", "description": "Indicates whether the account follows a specific payment option such as prepaid or postpaid" }, "state": { "type": "string", "description": "Contains the lifecycle state such as: Active, Closed, Suspended and so on." }, "accountBalance": { "type": "array", "items": { "$ref": "#/components/schemas/AccountBalance" } }, "accountRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/AccountRelationship" } }, "billStructure": { "$ref": "#/components/schemas/BillStructure" }, "contact": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } }, "creditLimit": { "$ref": "#/components/schemas/Money" }, "defaultPaymentMethod": { "$ref": "#/components/schemas/PaymentMethodRef" }, "financialAccount": { "$ref": "#/components/schemas/FinancialAccountRef" }, "paymentPlan": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentPlan" } }, "relatedParty": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "taxExemption": { "type": "array", "items": { "$ref": "#/components/schemas/AccountTaxExemption" } }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "The BillingAccount to be created" }, "BillPresentationMediaCreate": { "required": [ "name" ], "type": "object", "properties": { "description": { "type": "string", "description": "An explanatory text describing this bill presentation media" }, "name": { "type": "string", "description": "A short descriptive name" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "The BillPresentationMedia to be created" }, "BillPresentationMedia": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the bill presentation media" }, "href": { "type": "string", "description": "Reference of the bill presentation media" }, "description": { "type": "string", "description": "An explanatory text describing this bill presentation media" }, "name": { "type": "string", "description": "A short descriptive name" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "A mean of communicating a bill, supported by the associated bill format. For example, post mail, email, web page." }, "BillFormatCreate": { "required": [ "name" ], "type": "object", "properties": { "description": { "type": "string", "description": "An explanatory text for this bill format" }, "name": { "type": "string", "description": "A short descriptive name" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "The BillFormat to be created" }, "BillFormat": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the bill format" }, "href": { "type": "string", "description": "Reference of the bill format" }, "description": { "type": "string", "description": "An explanatory text for this bill format" }, "name": { "type": "string", "description": "A short descriptive name" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "A detailed description of the way in which a bill is presented." }, "SettlementAccountUpdate": { "required": [ "name", "relatedParty" ], "type": "object", "properties": { "accountType": { "type": "string", "description": "A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values." }, "description": { "type": "string", "description": "Detailed description of the party account" }, "lastModified": { "type": "string", "format": "date-time" }, "name": { "type": "string", "description": "Name of the account" }, "paymentStatus": { "type": "string", "description": "The condition of the account, such as due, paid, in arrears." }, "state": { "type": "string", "description": "Contains the lifecycle state such as: Active, Closed, Suspended and so on." }, "accountRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/AccountRelationship" } }, "billStructure": { "$ref": "#/components/schemas/BillStructure" }, "contact": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } }, "creditLimit": { "$ref": "#/components/schemas/Money" }, "defaultPaymentMethod": { "$ref": "#/components/schemas/PaymentMethodRef" }, "financialAccount": { "$ref": "#/components/schemas/FinancialAccountRef" }, "paymentPlan": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentPlan" } }, "relatedParty": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "taxExemption": { "type": "array", "items": { "$ref": "#/components/schemas/AccountTaxExemption" } }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "The SettlementAccount to be updated" }, "PartyAccountUpdate": { "required": [ "name", "relatedParty" ], "type": "object", "properties": { "accountType": { "type": "string", "description": "A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values." }, "description": { "type": "string", "description": "Detailed description of the party account" }, "lastModified": { "type": "string", "format": "date-time" }, "name": { "type": "string", "description": "Name of the account" }, "paymentStatus": { "type": "string", "description": "The condition of the account, such as due, paid, in arrears." }, "state": { "type": "string", "description": "Contains the lifecycle state such as: Active, Closed, Suspended and so on." }, "accountRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/AccountRelationship" } }, "billStructure": { "$ref": "#/components/schemas/BillStructure" }, "contact": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } }, "creditLimit": { "$ref": "#/components/schemas/Money" }, "defaultPaymentMethod": { "$ref": "#/components/schemas/PaymentMethodRef" }, "financialAccount": { "$ref": "#/components/schemas/FinancialAccountRef" }, "paymentPlan": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentPlan" } }, "relatedParty": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "taxExemption": { "type": "array", "items": { "$ref": "#/components/schemas/AccountTaxExemption" } }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "The PartyAccount to be updated" }, "FinancialAccountUpdate": { "required": [ "name" ], "type": "object", "properties": { "accountType": { "type": "string", "description": "A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values." }, "description": { "type": "string", "description": "Detailed description of the party account" }, "name": { "type": "string", "description": "Name of the account" }, "state": { "type": "string", "description": "Contains the lifecycle state such as: Active, Closed, Suspended and so on." }, "accountBalance": { "type": "array", "items": { "$ref": "#/components/schemas/AccountBalance" } }, "accountRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/AccountRelationship" } }, "contact": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } }, "creditLimit": { "$ref": "#/components/schemas/Money" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "taxExemption": { "type": "array", "items": { "$ref": "#/components/schemas/AccountTaxExemption" } }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "The FinancialAccount to be updated" }, "BillingCycleSpecificationUpdate": { "required": [ "name" ], "type": "object", "properties": { "billingDateShift": { "type": "integer", "description": "An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period.", "format": "int32" }, "billingPeriod": { "type": "string", "description": "A billing time period. It can be recurring, for example: week, month, quarter of year, year ." }, "chargeDateOffset": { "type": "integer", "description": "An offset of a date through which charges previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod.", "format": "int32" }, "creditDateOffset": { "type": "integer", "description": "An offset of a date through which credits previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod.", "format": "int32" }, "description": { "type": "string", "description": "An explanation regarding this billing cycle specification" }, "frequency": { "type": "string", "description": "Frequency of the billing cycle (monthly for instance)" }, "mailingDateOffset": { "type": "integer", "description": "An offset of a customer bill mailing date. The offset is expressed as number of days with regard to the start of the BillingPeriod.", "format": "int32" }, "name": { "type": "string", "description": "A short descriptive name" }, "paymentDueDateOffset": { "type": "integer", "description": "An offset of a payment due date. The offset is expressed as number of days with regard to the start of the BillingPeriod.", "format": "int32" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "The BillingCycleSpecification to be updated" }, "BillingAccountUpdate": { "required": [ "name", "relatedParty" ], "type": "object", "properties": { "accountType": { "type": "string", "description": "A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values." }, "description": { "type": "string", "description": "Detailed description of the party account" }, "lastModified": { "type": "string", "format": "date-time" }, "name": { "type": "string", "description": "Name of the account" }, "paymentStatus": { "type": "string", "description": "The condition of the account, such as due, paid, in arrears." }, "ratingType": { "type": "string", "description": "Indicates whether the account follows a specific payment option such as prepaid or postpaid" }, "state": { "type": "string", "description": "Contains the lifecycle state such as: Active, Closed, Suspended and so on." }, "accountRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/AccountRelationship" } }, "billStructure": { "$ref": "#/components/schemas/BillStructure" }, "contact": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } }, "creditLimit": { "$ref": "#/components/schemas/Money" }, "defaultPaymentMethod": { "$ref": "#/components/schemas/PaymentMethodRef" }, "financialAccount": { "$ref": "#/components/schemas/FinancialAccountRef" }, "paymentPlan": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentPlan" } }, "relatedParty": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "taxExemption": { "type": "array", "items": { "$ref": "#/components/schemas/AccountTaxExemption" } }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "The BillingAccount to be updated" }, "BillPresentationMediaUpdate": { "required": [ "name" ], "type": "object", "properties": { "description": { "type": "string", "description": "An explanatory text describing this bill presentation media" }, "name": { "type": "string", "description": "A short descriptive name" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "The BillPresentationMedia to be updated" }, "BillFormatUpdate": { "required": [ "name" ], "type": "object", "properties": { "description": { "type": "string", "description": "An explanatory text for this bill format" }, "name": { "type": "string", "description": "A short descriptive name" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "The BillFormat to be updated" } }, "securitySchemes": { "security_auth": { "type": "oauth2", "scheme": "bearer", "bearerFormat": "JWT", "flows": { "authorizationCode": { "authorizationUrl": "https://portal.openslice.eu/auth/realms/openslice/protocol/openid-connect/auth", "tokenUrl": "https://portal.openslice.eu/auth/realms/openslice/protocol/openid-connect/token", "scopes": { "read": "read scope", "write": "write scope" } } } } } } }