1. REST API Reference for Launch Cloud Service
  2. Tasks
  3. Balance Element

Get all balance elements

get

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/balanceElement

Request

Query Parameters
  • Balance element Type
  • The description of the resource.
  • Project Id
  • The comma-separated field names that are returned in the response. The field names are the names that you specify when you create or retrieve a resource.
  • The unique identifier of the resource item.
  • The current lifecycle status of the resource.
  • The number of resources to be returned in the response. The minimum value that can be specified is 1, and the maximum value that can be specified is 100,000. If the specified value is greater than 100,000, then it defaults to 100,000.
  • The name of the resource.
  • The record number from which the retrieval starts. The default value is zero. If no value is specified, then it defaults to zero. The value zero indicates that the retrieval will start from the beginning of the collection.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : BalanceElementOracle
Type: object
Title: BalanceElementOracle
Balance element represenst the currency and non currency units units used in Pricing
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
Project Reference
Show Source
Nested Schema : relatedParty
Type: array
Show Source
Nested Schema : TimePeriod
Type: object
Title: TimePeriod
The period for which the productOffering is valid
Show Source
Nested Schema : RelatedParty
Type: object
Title: RelatedParty
RelatedParty reference. A related party defines party or party role linked to a specific entity.
Show Source
Nested Schema : partyOrPartyRole
Type: array
Show Source

400 Response

Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

404 Response

Your request includes a resource URI that doesn't exist.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

405 Response

HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

500 Response

The server encountered something unexpected that prevented it from completing the request.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source
Back to Top

Examples

The following example shows how to retrieve details of all balance elements by submitting a get request on the REST resource using cURL.

curl -u username:password -X GET https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/balanceElement/

Example of Response Body

The following example shows the contents of the response body in JSON format.

[
    {
        "id": "USDCurrency",
        "name": "USD Currency",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/balanceElement/USDCurrency",
        "version": "1.0",
        "lifecycleStatus": "In design",
        "created": "2025-01-03T08:36:43.001Z",
        "createdBy": "booth",
        "lastUpdate": "2025-03-06T13:33:06.079Z",
        "lastUpdatedBy": "booth",
        "@type": "BalanceElementOracle",
        "validFor": {
            "startDateTime": "2024-08-09T00:00:00.000Z",
            "endDateTime": "2028-08-09T00:00:00.000Z"
        },
        "project": {
            "id": "DBE_RI_ProdModel_PreSeed_PSP",
            "name": "DBE RI Product Model Preseed",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_RI_ProdModel_PreSeed_PSP",
            "version": "1.0",
            "@referredType": "ProjectOracle"
        },
        "consumptionRule": "LST",
        "balanceElementType": "CURRENCY",
        "code": "USD",
        "numericCode": 840,
        "symbol": "$",
        "roundingMethod": "CALC",
        "decimalPlaces": "3",
        "relatedParty": [
            {
                "role": "ROLE1",
                "partyOrPartyRole": {
                    "id": "PartyRoleID",
                    "name": "PartyRoleName",
                    "partyId": "partyid123",
                    "partyName": "partyName",
                    "@referredType": "PartyRole",
                    "@type": "PartyRoleRef"
                },
                "@type": "RelatedPartyRefOrPartyRoleRef"
            }
        ]
    },
    {
        "id": "EuroCurrency",
        "name": "Euro Currency",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/balanceElement/EuroCurrency",
        "version": "1.0",
        "lifecycleStatus": "In design",
        "created": "2025-01-03T08:36:43.001Z",
        "createdBy": "booth",
        "lastUpdate": "2025-03-06T13:33:06.079Z",
        "lastUpdatedBy": "booth",
        "@type": "BalanceElementOracle",
        "validFor": {
            "startDateTime": "2024-08-09T00:00:00.000Z",
            "endDateTime": "2028-08-09T00:00:00.000Z"
        },
        "project": {
            "id": "DBE_RI_ProdModel_PreSeed_PSP",
            "name": "DBE RI Product Model Preseed",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_RI_ProdModel_PreSeed_PSP",
            "version": "1.0",
            "@referredType": "ProjectOracle"
        },
        "consumptionRule": "LST",
        "balanceElementType": "CURRENCY",
        "code": "EUR",
        "numericCode": 978,
        "symbol": "€",
        "roundingMethod": "CALC",
        "decimalPlaces": "2",
        "relatedParty": [
            {
                "role": "ROLE1",
                "partyOrPartyRole": {
                    "id": "PartyRoleID",
                    "name": "PartyRoleName",
                    "partyId": "partyid123",
                    "partyName": "partyName",
                    "@referredType": "PartyRole",
                    "@type": "PartyRoleRef"
                },
                "@type": "RelatedPartyRefOrPartyRoleRef"
            }
        ]
    }
]
Back to Top