Jump to

• Request
• Response

Get Payment Summary

get

https://server:port/spl/rest/apis/customer/financials/payments/{paymentId}/summary

Request

Path Parameters

• paymentId(required): string
  Payment ID is the system-assigned unique identifier of the payment.

  Example:

  317896608844

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1PaySumry

Type: object

Show Source

• currency: object currency
• httpMethod: string
  Allowed Values: [ "DELT", "GET ", "POST", "PTCH", "PUT " ]

  HTTP Method * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - Put

  Example: GET
• payment: object payment
• paymentAmount: number
  Payment Amount is the amount of the payment. This field is gray after the payment is frozen.

  Example: 300
• paymentDate: string (date)
  Payment Date is the business date associated with the payment event.

  Example: 2000-10-16
• paymentStatus: string
  Allowed Values: [ "10 ", "20 ", "30 ", "50 ", "60 " ]

  Payment Status is the payment's status. * `10 ` - Incomplete, * `20 ` - Error, * `30 ` - Freezable, * `50 ` - Frozen, * `60 ` - Canceled

  Example: 30
• paymentStatusDescription: string
  Maximum Length: 60

  Description for payment status.

  Example: Frozen
• paymentSummary: object paymentSummary
• paymentTenders: array paymentTenders
• paySegments: array paySegments

{
    "type":"object",
    "properties":{
        "httpMethod":{
            "type":"string",
            "enum":[
                "DELT",
                "GET ",
                "POST",
                "PTCH",
                "PUT "
            ],
            "description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put",
            "example":"GET"
        },
        "payment":{
            "type":"object",
            "properties":{
                "paymentId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Payment ID is the system-assigned unique identifier of the payment.",
                    "example":"317896608844"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "paymentStatus":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "50  ",
                "60  "
            ],
            "description":"Payment Status is the payment's status.\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `50  ` - Frozen,\n* `60  ` - Canceled",
            "example":"30"
        },
        "paymentStatusDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Description for payment status.",
            "example":"Frozen"
        },
        "paymentAmount":{
            "type":"number",
            "description":"Payment Amount is the amount of the payment. This field is gray after the payment is frozen.",
            "example":"300"
        },
        "currency":{
            "type":"object",
            "properties":{
                "currency":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Currency Code"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "paymentDate":{
            "type":"string",
            "format":"date",
            "description":"Payment Date is the business date associated with the payment event.",
            "example":"2000-10-16"
        },
        "paymentSummary":{
            "type":"object",
            "properties":{
                "tenderCount":{
                    "type":"number",
                    "maximum":999,
                    "minimum":0,
                    "description":"Tender Count",
                    "example":"1"
                },
                "segmentCount":{
                    "type":"number",
                    "maximum":999,
                    "minimum":0,
                    "description":"Segment Count",
                    "example":"1"
                },
                "paymentByServiceType":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "serviceType":{
                                "type":"string",
                                "maxLength":80,
                                "description":"Service Type defines the type of service associated with the SA type.",
                                "example":"E"
                            },
                            "segmentCount":{
                                "type":"number",
                                "maximum":999,
                                "minimum":0,
                                "description":"Segment Count",
                                "example":"1"
                            },
                            "totalDistributedAmount":{
                                "type":"number",
                                "description":"Total distributed amount",
                                "example":"75"
                            }
                        }
                    }
                }
            }
        },
        "paySegments":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "paySegmentId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Pay Segment ID"
                    },
                    "serviceAgreement":{
                        "type":"object",
                        "properties":{
                            "serviceAgreementId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"SA ID is the bill segment's service agreement.",
                                "example":"0340281111"
                            },
                            "statusCode":{
                                "type":"string",
                                "enum":[
                                    "05  ",
                                    "10  ",
                                    "20  ",
                                    "30  ",
                                    "40  ",
                                    "50  ",
                                    "60  ",
                                    "70  "
                                ],
                                "description":"SA ID is the bill segment's service agreement.\n* `05  ` - Incomplete,\n* `10  ` - Pending Start,\n* `20  ` - Active,\n* `30  ` - Pending Stop,\n* `40  ` - Stopped,\n* `50  ` - Reactivated,\n* `60  ` - Closed,\n* `70  ` - Canceled",
                                "example":"0340281111"
                            },
                            "statusCodeDescription":{
                                "type":"string",
                                "maxLength":60,
                                "description":"SA ID is the bill segment's service agreement.",
                                "example":"0340281111"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "serviceAgreementType":{
                        "type":"object",
                        "description":"Service Agreement Type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
                        "properties":{
                            "division":{
                                "type":"string",
                                "maxLength":5,
                                "description":"CIS Division defines the jurisdiction that governs the account.",
                                "example":"CA"
                            },
                            "divisionDescription":{
                                "type":"string",
                                "maxLength":1,
                                "description":"CIS Division defines the jurisdiction that governs the account.",
                                "example":"CA"
                            },
                            "serviceAgreementType":{
                                "type":"string",
                                "maxLength":8,
                                "description":"CIS Division defines the jurisdiction that governs the account.",
                                "example":"CA"
                            },
                            "serviceAgreementTypeDescription":{
                                "type":"string",
                                "maxLength":30,
                                "description":"CIS Division defines the jurisdiction that governs the account.",
                                "example":"CA"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "serviceType":{
                        "type":"object",
                        "description":"Service Type defines the type of service associated with the SA type.",
                        "properties":{
                            "serviceType":{
                                "type":"string",
                                "maxLength":80,
                                "description":"Service Type defines the type of service associated with the SA type.",
                                "example":"E"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "premise":{
                        "type":"object",
                        "properties":{
                            "premiseId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement."
                            },
                            "premiseAddress":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement."
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "distributedAmount":{
                        "type":"number",
                        "description":"Total distributed amount",
                        "example":"75"
                    }
                }
            }
        },
        "paymentTenders":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "payorAccountName":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Payor Account Name"
                    },
                    "currency":{
                        "type":"object",
                        "properties":{
                            "currency":{
                                "type":"string",
                                "maxLength":3,
                                "description":"Currency Code"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "tenderType":{
                        "type":"object",
                        "description":"Tender Type describes what was remitted. For example, cash or check.",
                        "properties":{
                            "tenderType":{
                                "type":"string",
                                "maxLength":4,
                                "description":"Tender Type describes what was remitted. For example, cash or check.",
                                "example":"CHEC"
                            },
                            "tenderTypeDescription":{
                                "type":"string",
                                "maxLength":60,
                                "description":"Tender Type describes what was remitted. For example, cash or check.",
                                "example":"CHEC"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "tenderAmount":{
                        "type":"number",
                        "description":"Tender Amount is the amount of the tender.",
                        "example":"125"
                    },
                    "tenderStatus":{
                        "type":"string",
                        "maxLength":2,
                        "description":"Tender Status is the tender's status.",
                        "example":"25"
                    },
                    "tenderStatusDescription":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Description for tender status.",
                        "example":"Valid"
                    },
                    "cancelReason":{
                        "type":"object",
                        "properties":{
                            "cancelReason":{
                                "type":"string",
                                "maxLength":4,
                                "description":"Cancel Reason"
                            },
                            "cancelReasonDescription":{
                                "type":"string",
                                "maxLength":100,
                                "description":"Cancel Reason Description"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "autopayIndicator":{
                        "type":"boolean",
                        "description":"AutopayIndicator indicates if payment was triggered by autopay processing from the TenderType field 'generates AutoPay'.",
                        "example":"false"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1PaySumry"
    }
}

Nested Schema : currency

Type: object

Show Source

• _link: string
  _link
• currency: string
  Maximum Length: 3

  Currency Code

{
    "type":"object",
    "properties":{
        "currency":{
            "type":"string",
            "maxLength":3,
            "description":"Currency Code"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : payment

Type: object

Show Source

• _link: string
  _link
• paymentId: string
  Maximum Length: 12

  Payment ID is the system-assigned unique identifier of the payment.

  Example: 317896608844

{
    "type":"object",
    "properties":{
        "paymentId":{
            "type":"string",
            "maxLength":12,
            "description":"Payment ID is the system-assigned unique identifier of the payment.",
            "example":"317896608844"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : paymentSummary

Type: object

Show Source

• paymentByServiceType: array paymentByServiceType
• segmentCount: number
  Minimum Value: 0

  Maximum Value: 999

  Segment Count

  Example: 1
• tenderCount: number
  Minimum Value: 0

  Maximum Value: 999

  Tender Count

  Example: 1

{
    "type":"object",
    "properties":{
        "tenderCount":{
            "type":"number",
            "maximum":999,
            "minimum":0,
            "description":"Tender Count",
            "example":"1"
        },
        "segmentCount":{
            "type":"number",
            "maximum":999,
            "minimum":0,
            "description":"Segment Count",
            "example":"1"
        },
        "paymentByServiceType":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "serviceType":{
                        "type":"string",
                        "maxLength":80,
                        "description":"Service Type defines the type of service associated with the SA type.",
                        "example":"E"
                    },
                    "segmentCount":{
                        "type":"number",
                        "maximum":999,
                        "minimum":0,
                        "description":"Segment Count",
                        "example":"1"
                    },
                    "totalDistributedAmount":{
                        "type":"number",
                        "description":"Total distributed amount",
                        "example":"75"
                    }
                }
            }
        }
    }
}

Nested Schema : paymentTenders

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "payorAccountName":{
                "type":"string",
                "maxLength":30,
                "description":"Payor Account Name"
            },
            "currency":{
                "type":"object",
                "properties":{
                    "currency":{
                        "type":"string",
                        "maxLength":3,
                        "description":"Currency Code"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "tenderType":{
                "type":"object",
                "description":"Tender Type describes what was remitted. For example, cash or check.",
                "properties":{
                    "tenderType":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Tender Type describes what was remitted. For example, cash or check.",
                        "example":"CHEC"
                    },
                    "tenderTypeDescription":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Tender Type describes what was remitted. For example, cash or check.",
                        "example":"CHEC"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "tenderAmount":{
                "type":"number",
                "description":"Tender Amount is the amount of the tender.",
                "example":"125"
            },
            "tenderStatus":{
                "type":"string",
                "maxLength":2,
                "description":"Tender Status is the tender's status.",
                "example":"25"
            },
            "tenderStatusDescription":{
                "type":"string",
                "maxLength":60,
                "description":"Description for tender status.",
                "example":"Valid"
            },
            "cancelReason":{
                "type":"object",
                "properties":{
                    "cancelReason":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Cancel Reason"
                    },
                    "cancelReasonDescription":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Cancel Reason Description"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "autopayIndicator":{
                "type":"boolean",
                "description":"AutopayIndicator indicates if payment was triggered by autopay processing from the TenderType field 'generates AutoPay'.",
                "example":"false"
            }
        }
    }
}

Nested Schema : paySegments

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "paySegmentId":{
                "type":"string",
                "maxLength":12,
                "description":"Pay Segment ID"
            },
            "serviceAgreement":{
                "type":"object",
                "properties":{
                    "serviceAgreementId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"SA ID is the bill segment's service agreement.",
                        "example":"0340281111"
                    },
                    "statusCode":{
                        "type":"string",
                        "enum":[
                            "05  ",
                            "10  ",
                            "20  ",
                            "30  ",
                            "40  ",
                            "50  ",
                            "60  ",
                            "70  "
                        ],
                        "description":"SA ID is the bill segment's service agreement.\n* `05  ` - Incomplete,\n* `10  ` - Pending Start,\n* `20  ` - Active,\n* `30  ` - Pending Stop,\n* `40  ` - Stopped,\n* `50  ` - Reactivated,\n* `60  ` - Closed,\n* `70  ` - Canceled",
                        "example":"0340281111"
                    },
                    "statusCodeDescription":{
                        "type":"string",
                        "maxLength":60,
                        "description":"SA ID is the bill segment's service agreement.",
                        "example":"0340281111"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "serviceAgreementType":{
                "type":"object",
                "description":"Service Agreement Type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
                "properties":{
                    "division":{
                        "type":"string",
                        "maxLength":5,
                        "description":"CIS Division defines the jurisdiction that governs the account.",
                        "example":"CA"
                    },
                    "divisionDescription":{
                        "type":"string",
                        "maxLength":1,
                        "description":"CIS Division defines the jurisdiction that governs the account.",
                        "example":"CA"
                    },
                    "serviceAgreementType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"CIS Division defines the jurisdiction that governs the account.",
                        "example":"CA"
                    },
                    "serviceAgreementTypeDescription":{
                        "type":"string",
                        "maxLength":30,
                        "description":"CIS Division defines the jurisdiction that governs the account.",
                        "example":"CA"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "serviceType":{
                "type":"object",
                "description":"Service Type defines the type of service associated with the SA type.",
                "properties":{
                    "serviceType":{
                        "type":"string",
                        "maxLength":80,
                        "description":"Service Type defines the type of service associated with the SA type.",
                        "example":"E"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "premise":{
                "type":"object",
                "properties":{
                    "premiseId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement."
                    },
                    "premiseAddress":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement."
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "distributedAmount":{
                "type":"number",
                "description":"Total distributed amount",
                "example":"75"
            }
        }
    }
}

Nested Schema : paymentByServiceType

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "serviceType":{
                "type":"string",
                "maxLength":80,
                "description":"Service Type defines the type of service associated with the SA type.",
                "example":"E"
            },
            "segmentCount":{
                "type":"number",
                "maximum":999,
                "minimum":0,
                "description":"Segment Count",
                "example":"1"
            },
            "totalDistributedAmount":{
                "type":"number",
                "description":"Total distributed amount",
                "example":"75"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• segmentCount: number
  Minimum Value: 0

  Maximum Value: 999

  Segment Count

  Example: 1
• serviceType: string
  Maximum Length: 80

  Service Type defines the type of service associated with the SA type.

  Example: E
• totalDistributedAmount: number
  Total distributed amount

  Example: 75

{
    "type":"object",
    "properties":{
        "serviceType":{
            "type":"string",
            "maxLength":80,
            "description":"Service Type defines the type of service associated with the SA type.",
            "example":"E"
        },
        "segmentCount":{
            "type":"number",
            "maximum":999,
            "minimum":0,
            "description":"Segment Count",
            "example":"1"
        },
        "totalDistributedAmount":{
            "type":"number",
            "description":"Total distributed amount",
            "example":"75"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• autopayIndicator: boolean
  AutopayIndicator indicates if payment was triggered by autopay processing from the TenderType field 'generates AutoPay'.

  Example: false
• cancelReason: object cancelReason
• currency: object currency
• payorAccountName: string
  Maximum Length: 30

  Payor Account Name
• tenderAmount: number
  Tender Amount is the amount of the tender.

  Example: 125
• tenderStatus: string
  Maximum Length: 2

  Tender Status is the tender's status.

  Example: 25
• tenderStatusDescription: string
  Maximum Length: 60

  Description for tender status.

  Example: Valid
• tenderType: object tenderType
  Tender Type describes what was remitted. For example, cash or check.

{
    "type":"object",
    "properties":{
        "payorAccountName":{
            "type":"string",
            "maxLength":30,
            "description":"Payor Account Name"
        },
        "currency":{
            "type":"object",
            "properties":{
                "currency":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Currency Code"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "tenderType":{
            "type":"object",
            "description":"Tender Type describes what was remitted. For example, cash or check.",
            "properties":{
                "tenderType":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Tender Type describes what was remitted. For example, cash or check.",
                    "example":"CHEC"
                },
                "tenderTypeDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Tender Type describes what was remitted. For example, cash or check.",
                    "example":"CHEC"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "tenderAmount":{
            "type":"number",
            "description":"Tender Amount is the amount of the tender.",
            "example":"125"
        },
        "tenderStatus":{
            "type":"string",
            "maxLength":2,
            "description":"Tender Status is the tender's status.",
            "example":"25"
        },
        "tenderStatusDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Description for tender status.",
            "example":"Valid"
        },
        "cancelReason":{
            "type":"object",
            "properties":{
                "cancelReason":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Cancel Reason"
                },
                "cancelReasonDescription":{
                    "type":"string",
                    "maxLength":100,
                    "description":"Cancel Reason Description"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "autopayIndicator":{
            "type":"boolean",
            "description":"AutopayIndicator indicates if payment was triggered by autopay processing from the TenderType field 'generates AutoPay'.",
            "example":"false"
        }
    }
}

Nested Schema : cancelReason

Type: object

Show Source

• _link: string
  _link
• cancelReason: string
  Maximum Length: 4

  Cancel Reason
• cancelReasonDescription: string
  Maximum Length: 100

  Cancel Reason Description

{
    "type":"object",
    "properties":{
        "cancelReason":{
            "type":"string",
            "maxLength":4,
            "description":"Cancel Reason"
        },
        "cancelReasonDescription":{
            "type":"string",
            "maxLength":100,
            "description":"Cancel Reason Description"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : currency

Type: object

Show Source

• _link: string
  _link
• currency: string
  Maximum Length: 3

  Currency Code

{
    "type":"object",
    "properties":{
        "currency":{
            "type":"string",
            "maxLength":3,
            "description":"Currency Code"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : tenderType

Type: object

Tender Type describes what was remitted. For example, cash or check.

Show Source

• _link: string
  _link
• tenderType: string
  Maximum Length: 4

  Tender Type describes what was remitted. For example, cash or check.

  Example: CHEC
• tenderTypeDescription: string
  Maximum Length: 60

  Tender Type describes what was remitted. For example, cash or check.

  Example: CHEC

{
    "type":"object",
    "description":"Tender Type describes what was remitted. For example, cash or check.",
    "properties":{
        "tenderType":{
            "type":"string",
            "maxLength":4,
            "description":"Tender Type describes what was remitted. For example, cash or check.",
            "example":"CHEC"
        },
        "tenderTypeDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Tender Type describes what was remitted. For example, cash or check.",
            "example":"CHEC"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• distributedAmount: number
  Total distributed amount

  Example: 75
• paySegmentId: string
  Maximum Length: 12

  Pay Segment ID
• premise: object premise
• serviceAgreement: object serviceAgreement
• serviceAgreementType: object serviceAgreementType
  Service Agreement Type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.
• serviceType: object serviceType
  Service Type defines the type of service associated with the SA type.

{
    "type":"object",
    "properties":{
        "paySegmentId":{
            "type":"string",
            "maxLength":12,
            "description":"Pay Segment ID"
        },
        "serviceAgreement":{
            "type":"object",
            "properties":{
                "serviceAgreementId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"SA ID is the bill segment's service agreement.",
                    "example":"0340281111"
                },
                "statusCode":{
                    "type":"string",
                    "enum":[
                        "05  ",
                        "10  ",
                        "20  ",
                        "30  ",
                        "40  ",
                        "50  ",
                        "60  ",
                        "70  "
                    ],
                    "description":"SA ID is the bill segment's service agreement.\n* `05  ` - Incomplete,\n* `10  ` - Pending Start,\n* `20  ` - Active,\n* `30  ` - Pending Stop,\n* `40  ` - Stopped,\n* `50  ` - Reactivated,\n* `60  ` - Closed,\n* `70  ` - Canceled",
                    "example":"0340281111"
                },
                "statusCodeDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"SA ID is the bill segment's service agreement.",
                    "example":"0340281111"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "serviceAgreementType":{
            "type":"object",
            "description":"Service Agreement Type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
            "properties":{
                "division":{
                    "type":"string",
                    "maxLength":5,
                    "description":"CIS Division defines the jurisdiction that governs the account.",
                    "example":"CA"
                },
                "divisionDescription":{
                    "type":"string",
                    "maxLength":1,
                    "description":"CIS Division defines the jurisdiction that governs the account.",
                    "example":"CA"
                },
                "serviceAgreementType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"CIS Division defines the jurisdiction that governs the account.",
                    "example":"CA"
                },
                "serviceAgreementTypeDescription":{
                    "type":"string",
                    "maxLength":30,
                    "description":"CIS Division defines the jurisdiction that governs the account.",
                    "example":"CA"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "serviceType":{
            "type":"object",
            "description":"Service Type defines the type of service associated with the SA type.",
            "properties":{
                "serviceType":{
                    "type":"string",
                    "maxLength":80,
                    "description":"Service Type defines the type of service associated with the SA type.",
                    "example":"E"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "premise":{
            "type":"object",
            "properties":{
                "premiseId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement."
                },
                "premiseAddress":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement."
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "distributedAmount":{
            "type":"number",
            "description":"Total distributed amount",
            "example":"75"
        }
    }
}

Nested Schema : premise

Type: object

Show Source

• _link: string
  _link
• premiseAddress: string
  Maximum Length: 254

  Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.
• premiseId: string
  Maximum Length: 10

  Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.

{
    "type":"object",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement."
        },
        "premiseAddress":{
            "type":"string",
            "maxLength":254,
            "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement."
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : serviceAgreement

Type: object

Show Source

• _link: string
  _link
• serviceAgreementId: string
  Maximum Length: 10

  SA ID is the bill segment's service agreement.

  Example: 0340281111
• statusCode: string
  Allowed Values: [ "05 ", "10 ", "20 ", "30 ", "40 ", "50 ", "60 ", "70 " ]

  SA ID is the bill segment's service agreement. * `05 ` - Incomplete, * `10 ` - Pending Start, * `20 ` - Active, * `30 ` - Pending Stop, * `40 ` - Stopped, * `50 ` - Reactivated, * `60 ` - Closed, * `70 ` - Canceled

  Example: 0340281111
• statusCodeDescription: string
  Maximum Length: 60

  SA ID is the bill segment's service agreement.

  Example: 0340281111

{
    "type":"object",
    "properties":{
        "serviceAgreementId":{
            "type":"string",
            "maxLength":10,
            "description":"SA ID is the bill segment's service agreement.",
            "example":"0340281111"
        },
        "statusCode":{
            "type":"string",
            "enum":[
                "05  ",
                "10  ",
                "20  ",
                "30  ",
                "40  ",
                "50  ",
                "60  ",
                "70  "
            ],
            "description":"SA ID is the bill segment's service agreement.\n* `05  ` - Incomplete,\n* `10  ` - Pending Start,\n* `20  ` - Active,\n* `30  ` - Pending Stop,\n* `40  ` - Stopped,\n* `50  ` - Reactivated,\n* `60  ` - Closed,\n* `70  ` - Canceled",
            "example":"0340281111"
        },
        "statusCodeDescription":{
            "type":"string",
            "maxLength":60,
            "description":"SA ID is the bill segment's service agreement.",
            "example":"0340281111"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : serviceAgreementType

Type: object

Service Agreement Type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.

Show Source

• _link: string
  _link
• division: string
  Maximum Length: 5

  CIS Division defines the jurisdiction that governs the account.

  Example: CA
• divisionDescription: string
  Maximum Length: 1

  CIS Division defines the jurisdiction that governs the account.

  Example: CA
• serviceAgreementType: string
  Maximum Length: 8

  CIS Division defines the jurisdiction that governs the account.

  Example: CA
• serviceAgreementTypeDescription: string
  Maximum Length: 30

  CIS Division defines the jurisdiction that governs the account.

  Example: CA

{
    "type":"object",
    "description":"Service Agreement Type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
    "properties":{
        "division":{
            "type":"string",
            "maxLength":5,
            "description":"CIS Division defines the jurisdiction that governs the account.",
            "example":"CA"
        },
        "divisionDescription":{
            "type":"string",
            "maxLength":1,
            "description":"CIS Division defines the jurisdiction that governs the account.",
            "example":"CA"
        },
        "serviceAgreementType":{
            "type":"string",
            "maxLength":8,
            "description":"CIS Division defines the jurisdiction that governs the account.",
            "example":"CA"
        },
        "serviceAgreementTypeDescription":{
            "type":"string",
            "maxLength":30,
            "description":"CIS Division defines the jurisdiction that governs the account.",
            "example":"CA"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : serviceType

Type: object

Service Type defines the type of service associated with the SA type.

Show Source

• _link: string
  _link
• serviceType: string
  Maximum Length: 80

  Service Type defines the type of service associated with the SA type.

  Example: E

{
    "type":"object",
    "description":"Service Type defines the type of service associated with the SA type.",
    "properties":{
        "serviceType":{
            "type":"string",
            "maxLength":80,
            "description":"Service Type defines the type of service associated with the SA type.",
            "example":"E"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• httpStatus: number
  Minimum Value: 0

  Maximum Value: 9999

  The HTTP Status code for the error.
• problemInstance: string
  Maximum Length: 60

  Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
• problemType: string
  Maximum Length: 60

  URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
• serverMessage: object serverMessage
• stackTrace: string
  Maximum Length: 60

  The stack trace shows where the error occurs during the execution of a program.
• title: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

  Delimited sequence of programs called.
• longDescription: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• messageCategory: number
  Minimum Value: 0

  Maximum Value: 0

  Message Category within Oracle Utilities Application Framework.
• messageNbr: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• messageText: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• programName: string
  Maximum Length: 60

  Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• httpStatus: number
  Minimum Value: 0

  Maximum Value: 9999

  The HTTP Status code for the error.
• problemInstance: string
  Maximum Length: 60

  Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
• problemType: string
  Maximum Length: 60

  URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
• serverMessage: object serverMessage
• stackTrace: string
  Maximum Length: 60

  The stack trace shows where the error occurs during the execution of a program.
• title: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

  Delimited sequence of programs called.
• longDescription: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• messageCategory: number
  Minimum Value: 0

  Maximum Value: 0

  Message Category within Oracle Utilities Application Framework.
• messageNbr: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• messageText: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• programName: string
  Maximum Length: 60

  Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

Back to Top