Jump to

• Request
• Response

Simulate a Bill

post

/bills/simulation/simulate

Runs synchronous bill simulation. Request dates use the ISO-8601 date format.

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• accountRef(required): object ResourceRef
• billInfoRef: object ResourceRef
• billRef: object ResourceRef
• billSimulationOffers: array billSimulationOffers
• effectiveDate: string (date-time)
• flag: integer (int32)
• jobRef: object ResourceRef
• periodEndDate: string (date-time)
• periodStartDate: string (date-time)
• simulationId: string

{
    "required":[
        "accountRef"
    ],
    "type":"object",
    "properties":{
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "jobRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "simulationId":{
            "type":"string"
        },
        "flag":{
            "type":"integer",
            "format":"int32"
        },
        "billInfoRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "billRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "effectiveDate":{
            "type":"string",
            "format":"date-time"
        },
        "periodStartDate":{
            "type":"string",
            "format":"date-time"
        },
        "periodEndDate":{
            "type":"string",
            "format":"date-time"
        },
        "billSimulationOffers":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BillSimulationOffer"
            }
        }
    },
    "xml":{
        "name":"simulateBills",
        "namespace":"http://xmlns.oracle.com/cgbu/schemas/BusinessObjs"
    }
}

Nested Schema : ResourceRef

Type: object

Show Source

• id(required): string
  The ID.
• uri: string
  The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"The Uniform Resource Identifier (URI) associated with the resource."
        }
    }
}

Nested Schema : billSimulationOffers

Type: array

Show Source

• Array of: object BillSimulationOffer

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BillSimulationOffer"
    }
}

Nested Schema : BillSimulationOffer

Type: object

Show Source

• sourceRef: object ResourceRef
• targetRef(required): object ResourceRef
• validFrom: string (date-time)
• validTo: string (date-time)

{
    "required":[
        "targetRef"
    ],
    "type":"object",
    "properties":{
        "sourceRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "targetRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "validFrom":{
            "type":"string",
            "format":"date-time"
        },
        "validTo":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• accountRef(required): object ResourceRef
• billInfoRef: object ResourceRef
• billRef: object ResourceRef
• billSimulationOffers: array billSimulationOffers
• effectiveDate: string (date-time)
• flag: integer (int32)
• jobRef: object ResourceRef
• periodEndDate: string (date-time)
• periodStartDate: string (date-time)
• simulationId: string

{
    "required":[
        "accountRef"
    ],
    "type":"object",
    "properties":{
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "jobRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "simulationId":{
            "type":"string"
        },
        "flag":{
            "type":"integer",
            "format":"int32"
        },
        "billInfoRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "billRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "effectiveDate":{
            "type":"string",
            "format":"date-time"
        },
        "periodStartDate":{
            "type":"string",
            "format":"date-time"
        },
        "periodEndDate":{
            "type":"string",
            "format":"date-time"
        },
        "billSimulationOffers":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BillSimulationOffer"
            }
        }
    },
    "xml":{
        "name":"simulateBills",
        "namespace":"http://xmlns.oracle.com/cgbu/schemas/BusinessObjs"
    }
}

Nested Schema : ResourceRef

Type: object

Show Source

• id(required): string
  The ID.
• uri: string
  The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"The Uniform Resource Identifier (URI) associated with the resource."
        }
    }
}

Nested Schema : billSimulationOffers

Type: array

Show Source

• Array of: object BillSimulationOffer

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BillSimulationOffer"
    }
}

Nested Schema : BillSimulationOffer

Type: object

Show Source

• sourceRef: object ResourceRef
• targetRef(required): object ResourceRef
• validFrom: string (date-time)
• validTo: string (date-time)

{
    "required":[
        "targetRef"
    ],
    "type":"object",
    "properties":{
        "sourceRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "targetRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "validFrom":{
            "type":"string",
            "format":"date-time"
        },
        "validTo":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The bill was simulated.

Body ()

Root Schema : billSimulationResult

Type: object

Show Source

• endDate: string (date-time)
• results: array results
• simulationId: string

{
    "type":"object",
    "properties":{
        "simulationId":{
            "type":"string"
        },
        "endDate":{
            "type":"string",
            "format":"date-time"
        },
        "results":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BillSimulationReference"
            }
        }
    },
    "xml":{
        "name":"billSimulationResult",
        "namespace":"http://xmlns.oracle.com/cgbu/schemas/BusinessObjs"
    }
}

Nested Schema : results

Type: array

Show Source

• Array of: object BillSimulationReference

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BillSimulationReference"
    }
}

Nested Schema : BillSimulationReference

Type: object

Show Source

• accountRef: object ResourceRef
• billInfoRef: object ResourceRef
• billRef: object ResourceRef
• billSimulationRef: object ResourceRef
• jobRef: object ResourceRef

{
    "type":"object",
    "properties":{
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "jobRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "billInfoRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "billRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "billSimulationRef":{
            "$ref":"#/components/schemas/ResourceRef"
        }
    }
}

Nested Schema : ResourceRef

Type: object

Show Source

• id(required): string
  The ID.
• uri: string
  The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"The Uniform Resource Identifier (URI) associated with the resource."
        }
    }
}

400 Response

The request isn't valid.

403 Response

Access isn't granted.

500 Response

An internal server error occurred.

Back to Top