TM Forum

opencollection: 1.0.0
info:
  name: Account Management
  version: 4.0.0
items:
- info:
    name: partyAccount
    type: folder
  items:
  - info:
      name: List or find PartyAccount objects
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/partyAccount'
      params:
      - name: fields
        value: ''
        type: query
        description: Comma-separated properties to be provided in response
      - name: offset
        value: ''
        type: query
        description: Requested index for start of resources to be provided in response
      - name: limit
        value: ''
        type: query
        description: Requested number of resources to be provided in response
    docs: This operation list or find PartyAccount entities
  - info:
      name: Creates a PartyAccount
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/partyAccount'
    docs: This operation creates a PartyAccount entity.
  - info:
      name: Retrieves a PartyAccount by ID
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/partyAccount/:id'
      params:
      - name: id
        value: ''
        type: path
        description: Identifier of the PartyAccount
      - name: fields
        value: ''
        type: query
        description: Comma-separated properties to provide in response
    docs: This operation retrieves a PartyAccount entity. Attribute selection is enabled for all first level attributes.
  - info:
      name: Updates partially a PartyAccount
      type: http
    http:
      method: PATCH
      url: '{{baseUrl}}/partyAccount/:id'
      params:
      - name: id
        value: ''
        type: path
        description: Identifier of the PartyAccount
    docs: This operation updates partially a PartyAccount entity.
  - info:
      name: Deletes a PartyAccount
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/partyAccount/:id'
      params:
      - name: id
        value: ''
        type: path
        description: Identifier of the PartyAccount
    docs: This operation deletes a PartyAccount entity.
- info:
    name: billingAccount
    type: folder
  items:
  - info:
      name: List or find BillingAccount objects
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/billingAccount'
      params:
      - name: fields
        value: ''
        type: query
        description: Comma-separated properties to be provided in response
      - name: offset
        value: ''
        type: query
        description: Requested index for start of resources to be provided in response
      - name: limit
        value: ''
        type: query
        description: Requested number of resources to be provided in response
    docs: This operation list or find BillingAccount entities
  - info:
      name: Creates a BillingAccount
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/billingAccount'
    docs: This operation creates a BillingAccount entity.
  - info:
      name: Retrieves a BillingAccount by ID
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/billingAccount/:id'
      params:
      - name: id
        value: ''
        type: path
        description: Identifier of the BillingAccount
      - name: fields
        value: ''
        type: query
        description: Comma-separated properties to provide in response
    docs: This operation retrieves a BillingAccount entity. Attribute selection is enabled for all first level attributes.
  - info:
      name: Updates partially a BillingAccount
      type: http
    http:
      method: PATCH
      url: '{{baseUrl}}/billingAccount/:id'
      params:
      - name: id
        value: ''
        type: path
        description: Identifier of the BillingAccount
    docs: This operation updates partially a BillingAccount entity.
  - info:
      name: Deletes a BillingAccount
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/billingAccount/:id'
      params:
      - name: id
        value: ''
        type: path
        description: Identifier of the BillingAccount
    docs: This operation deletes a BillingAccount entity.
- info:
    name: settlementAccount
    type: folder
  items:
  - info:
      name: List or find SettlementAccount objects
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/settlementAccount'
      params:
      - name: fields
        value: ''
        type: query
        description: Comma-separated properties to be provided in response
      - name: offset
        value: ''
        type: query
        description: Requested index for start of resources to be provided in response
      - name: limit
        value: ''
        type: query
        description: Requested number of resources to be provided in response
    docs: This operation list or find SettlementAccount entities
  - info:
      name: Creates a SettlementAccount
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/settlementAccount'
    docs: This operation creates a SettlementAccount entity.
  - info:
      name: Retrieves a SettlementAccount by ID
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/settlementAccount/:id'
      params:
      - name: id
        value: ''
        type: path
        description: Identifier of the SettlementAccount
      - name: fields
        value: ''
        type: query
        description: Comma-separated properties to provide in response
    docs: This operation retrieves a SettlementAccount entity. Attribute selection is enabled for all first level attributes.
  - info:
      name: Updates partially a SettlementAccount
      type: http
    http:
      method: PATCH
      url: '{{baseUrl}}/settlementAccount/:id'
      params:
      - name: id
        value: ''
        type: path
        description: Identifier of the SettlementAccount
    docs: This operation updates partially a SettlementAccount entity.
  - info:
      name: Deletes a SettlementAccount
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/settlementAccount/:id'
      params:
      - name: id
        value: ''
        type: path
        description: Identifier of the SettlementAccount
    docs: This operation deletes a SettlementAccount entity.
- info:
    name: financialAccount
    type: folder
  items:
  - info:
      name: List or find FinancialAccount objects
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/financialAccount'
      params:
      - name: fields
        value: ''
        type: query
        description: Comma-separated properties to be provided in response
      - name: offset
        value: ''
        type: query
        description: Requested index for start of resources to be provided in response
      - name: limit
        value: ''
        type: query
        description: Requested number of resources to be provided in response
    docs: This operation list or find FinancialAccount entities
  - info:
      name: Creates a FinancialAccount
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/financialAccount'
    docs: This operation creates a FinancialAccount entity.
  - info:
      name: Retrieves a FinancialAccount by ID
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/financialAccount/:id'
      params:
      - name: id
        value: ''
        type: path
        description: Identifier of the FinancialAccount
      - name: fields
        value: ''
        type: query
        description: Comma-separated properties to provide in response
    docs: This operation retrieves a FinancialAccount entity. Attribute selection is enabled for all first level attributes.
  - info:
      name: Updates partially a FinancialAccount
      type: http
    http:
      method: PATCH
      url: '{{baseUrl}}/financialAccount/:id'
      params:
      - name: id
        value: ''
        type: path
        description: Identifier of the FinancialAccount
    docs: This operation updates partially a FinancialAccount entity.
  - info:
      name: Deletes a FinancialAccount
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/financialAccount/:id'
      params:
      - name: id
        value: ''
        type: path
        description: Identifier of the FinancialAccount
    docs: This operation deletes a FinancialAccount entity.
- info:
    name: billingCycleSpecification
    type: folder
  items:
  - info:
      name: List or find BillingCycleSpecification objects
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/billingCycleSpecification'
      params:
      - name: fields
        value: ''
        type: query
        description: Comma-separated properties to be provided in response
      - name: offset
        value: ''
        type: query
        description: Requested index for start of resources to be provided in response
      - name: limit
        value: ''
        type: query
        description: Requested number of resources to be provided in response
    docs: This operation list or find BillingCycleSpecification entities
  - info:
      name: Creates a BillingCycleSpecification
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/billingCycleSpecification'
    docs: This operation creates a BillingCycleSpecification entity.
  - info:
      name: Retrieves a BillingCycleSpecification by ID
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/billingCycleSpecification/:id'
      params:
      - name: id
        value: ''
        type: path
        description: Identifier of the BillingCycleSpecification
      - name: fields
        value: ''
        type: query
        description: Comma-separated properties to provide in response
    docs: This operation retrieves a BillingCycleSpecification entity. Attribute selection is enabled for all first level
      attributes.
  - info:
      name: Updates partially a BillingCycleSpecification
      type: http
    http:
      method: PATCH
      url: '{{baseUrl}}/billingCycleSpecification/:id'
      params:
      - name: id
        value: ''
        type: path
        description: Identifier of the BillingCycleSpecification
    docs: This operation updates partially a BillingCycleSpecification entity.
  - info:
      name: Deletes a BillingCycleSpecification
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/billingCycleSpecification/:id'
      params:
      - name: id
        value: ''
        type: path
        description: Identifier of the BillingCycleSpecification
    docs: This operation deletes a BillingCycleSpecification entity.
- info:
    name: billFormat
    type: folder
  items:
  - info:
      name: List or find BillFormat objects
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/billFormat'
      params:
      - name: fields
        value: ''
        type: query
        description: Comma-separated properties to be provided in response
      - name: offset
        value: ''
        type: query
        description: Requested index for start of resources to be provided in response
      - name: limit
        value: ''
        type: query
        description: Requested number of resources to be provided in response
    docs: This operation list or find BillFormat entities
  - info:
      name: Creates a BillFormat
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/billFormat'
    docs: This operation creates a BillFormat entity.
  - info:
      name: Retrieves a BillFormat by ID
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/billFormat/:id'
      params:
      - name: id
        value: ''
        type: path
        description: Identifier of the BillFormat
      - name: fields
        value: ''
        type: query
        description: Comma-separated properties to provide in response
    docs: This operation retrieves a BillFormat entity. Attribute selection is enabled for all first level attributes.
  - info:
      name: Updates partially a BillFormat
      type: http
    http:
      method: PATCH
      url: '{{baseUrl}}/billFormat/:id'
      params:
      - name: id
        value: ''
        type: path
        description: Identifier of the BillFormat
    docs: This operation updates partially a BillFormat entity.
  - info:
      name: Deletes a BillFormat
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/billFormat/:id'
      params:
      - name: id
        value: ''
        type: path
        description: Identifier of the BillFormat
    docs: This operation deletes a BillFormat entity.
- info:
    name: billPresentationMedia
    type: folder
  items:
  - info:
      name: List or find BillPresentationMedia objects
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/billPresentationMedia'
      params:
      - name: fields
        value: ''
        type: query
        description: Comma-separated properties to be provided in response
      - name: offset
        value: ''
        type: query
        description: Requested index for start of resources to be provided in response
      - name: limit
        value: ''
        type: query
        description: Requested number of resources to be provided in response
    docs: This operation list or find BillPresentationMedia entities
  - info:
      name: Creates a BillPresentationMedia
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/billPresentationMedia'
    docs: This operation creates a BillPresentationMedia entity.
  - info:
      name: Retrieves a BillPresentationMedia by ID
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/billPresentationMedia/:id'
      params:
      - name: id
        value: ''
        type: path
        description: Identifier of the BillPresentationMedia
      - name: fields
        value: ''
        type: query
        description: Comma-separated properties to provide in response
    docs: This operation retrieves a BillPresentationMedia entity. Attribute selection is enabled for all first level attributes.
  - info:
      name: Updates partially a BillPresentationMedia
      type: http
    http:
      method: PATCH
      url: '{{baseUrl}}/billPresentationMedia/:id'
      params:
      - name: id
        value: ''
        type: path
        description: Identifier of the BillPresentationMedia
    docs: This operation updates partially a BillPresentationMedia entity.
  - info:
      name: Deletes a BillPresentationMedia
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/billPresentationMedia/:id'
      params:
      - name: id
        value: ''
        type: path
        description: Identifier of the BillPresentationMedia
    docs: This operation deletes a BillPresentationMedia entity.
- info:
    name: events subscription
    type: folder
  items:
  - info:
      name: Register a listener
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/hub'
    docs: Sets the communication endpoint address the service instance must use to deliver information about its health state,
      execution state, failures and metrics.
  - info:
      name: Unregister a listener
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/hub/:id'
      params:
      - name: id
        value: ''
        type: path
        description: The id of the registered listener
    docs: Resets the communication endpoint address the service instance must use to deliver information about its health
      state, execution state, failures and metrics.
- info:
    name: notification listeners (client side)
    type: folder
  items:
  - info:
      name: Client listener for entity PartyAccountAttributeValueChangeEvent
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/listener/partyAccountAttributeValueChangeEvent'
    docs: Example of a client listener for receiving the notification PartyAccountAttributeValueChangeEvent
  - info:
      name: Client listener for entity PartyAccountStateChangeEvent
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/listener/partyAccountStateChangeEvent'
    docs: Example of a client listener for receiving the notification PartyAccountStateChangeEvent
  - info:
      name: Client listener for entity BillingAccountAttributeValueChangeEvent
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/listener/billingAccountAttributeValueChangeEvent'
    docs: Example of a client listener for receiving the notification BillingAccountAttributeValueChangeEvent
  - info:
      name: Client listener for entity BillingAccountStateChangeEvent
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/listener/billingAccountStateChangeEvent'
    docs: Example of a client listener for receiving the notification BillingAccountStateChangeEvent
  - info:
      name: Client listener for entity SettlementAccountAttributeValueChangeEvent
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/listener/settlementAccountAttributeValueChangeEvent'
    docs: Example of a client listener for receiving the notification SettlementAccountAttributeValueChangeEvent
  - info:
      name: Client listener for entity SettlementAccountStateChangeEvent
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/listener/settlementAccountStateChangeEvent'
    docs: Example of a client listener for receiving the notification SettlementAccountStateChangeEvent
  - info:
      name: Client listener for entity FinancialAccountCreateEvent
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/listener/financialAccountCreateEvent'
    docs: Example of a client listener for receiving the notification FinancialAccountCreateEvent
  - info:
      name: Client listener for entity FinancialAccountAttributeValueChangeEvent
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/listener/financialAccountAttributeValueChangeEvent'
    docs: Example of a client listener for receiving the notification FinancialAccountAttributeValueChangeEvent
  - info:
      name: Client listener for entity FinancialAccountStateChangeEvent
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/listener/financialAccountStateChangeEvent'
    docs: Example of a client listener for receiving the notification FinancialAccountStateChangeEvent
  - info:
      name: Client listener for entity FinancialAccountDeleteEvent
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/listener/financialAccountDeleteEvent'
    docs: Example of a client listener for receiving the notification FinancialAccountDeleteEvent
bundled: true