Jump to

• Request
• Response

Get Charge Bulk Data Headers

get

/rest/v19/pricingSetup/pricingBulkDataHeaders/charge

Use this endpoint to retrieve Charge attributes to define CSV headers for bulk data service uploads.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : Charge

Type: object

Show Source

• Charge Definition Code: string()
  Title: Charge Definition Code

  The unique code of the Charge Definition.
• Dynamic Pricing Type: string()
  Title: Dynamic Pricing Type

  The dynamic pricing type of the charge. This must always be 'static'.
• End Date: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: End Date

  The date at which the Charge will end.
• Integration Id: string()
  Title: Integration Id

  Rate Plan ID from Fusion Pricer.
• Price: string()
  Title: Price

  The Price from Fusion Pricer.
• Price Model Item Integration Id: string()
  Title: Price Model Item Integration Id

  The parent Price List Item ID from Fusion Pricer. Only relevant for Price List Item Charges and Price List Component Item Charges.
• pricePeriod: string()
  Title: Price Period

  The billing period.
• Rate Plan Integration Id: string()
  Title: Rate Plan Integration Id

  The parent Rate Plan ID from Fusion Pricer. Only relevant for Rate Plan Charges.
• Start Date: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Start Date

  The date from which the Charge will be applicable.
• usageUOM: string()
  Title: Usage UOM

  The unit of measure for the charge.

{
    "properties":{
        "Integration Id":{
            "type":"string",
            "format":"",
            "description":"Rate Plan ID from Fusion Pricer.",
            "title":"Integration Id"
        },
        "Price Model Item Integration Id":{
            "type":"string",
            "format":"",
            "description":"The parent Price List Item ID from Fusion Pricer. Only relevant for Price List Item Charges and Price List Component Item Charges.",
            "title":"Price Model Item Integration Id"
        },
        "Rate Plan Integration Id":{
            "type":"string",
            "format":"",
            "description":"The parent Rate Plan ID from Fusion Pricer. Only relevant for Rate Plan Charges.",
            "title":"Rate Plan Integration Id"
        },
        "pricePeriod":{
            "type":"string",
            "format":"",
            "description":"The billing period.",
            "title":"Price Period"
        },
        "usageUOM":{
            "type":"string",
            "format":"",
            "description":"The unit of measure for the charge.",
            "title":"Usage UOM"
        },
        "Dynamic Pricing Type":{
            "type":"string",
            "format":"",
            "description":"The dynamic pricing type of the charge. This must always be 'static'.",
            "title":"Dynamic Pricing Type"
        },
        "Price":{
            "type":"string",
            "format":"",
            "description":"The Price from Fusion Pricer.",
            "title":"Price"
        },
        "Start Date":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"The date from which the Charge will be applicable.",
            "title":"Start Date"
        },
        "End Date":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"The date at which the Charge will end.",
            "title":"End Date"
        },
        "Charge Definition Code":{
            "type":"string",
            "format":"",
            "description":"The unique code of the Charge Definition.",
            "title":"Charge Definition Code"
        }
    }
}

Back to Top