Create Bill
post
https://server:port/spl/rest/apis/customer/financials/bills/
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object-
account: object
account
-
accountingDate: string
(date)
Accounting Date defines the financial period to which the canceled and new bill segments' financial transactions are booked.Example:
2021-10-05 -
areEstimatesAllowed: boolean
Allow Estimates is defined as true if the system is allowed to estimate consumption when a meter read cannot be retrieved.Example:
false -
billDate: string
(date)
Bill Date is the business date used when the bill was completed.Example:
2001-05-01 -
billId: string
Maximum Length:
12Bill ID is the system-assigned unique identifier of the bill.Example:549133128888 -
billRoutings: object
billRoutings
-
billSegmentStatus: string
Maximum Length:
30Bill Segment Status is the bill segment's status. -
billStatus: string
Allowed Values:
[ "C ", "P " ]Bill Status is the bill's status. A bill is initially saved in the Pending state. One or more bill segments can be created for the account's service agreements at this point. A bill becomes Complete when it is ready to be sent to the customer. * `C ` - Complete, * `P ` - PendingExample:C -
cancelReason: string
Maximum Length:
4Cancel Reason defines why bill segments are being canceled. -
characteristics: object
characteristics
-
completedDatetime: string
(date-time)
Completion Date/Time is the date and time on which the bill was completed.Example:
2002-10-24T16:51:56-04:00 -
creationDateTime: string
(date-time)
Create Date/Time is the date and time on which the bill was originally created.Example:
2002-10-24T16:51:58-04:00 -
creditNoteDate: string
(date)
Bill Date is the business date that was used when the bill was completed.
-
currency: object
currency
Currency Code defines the currency in which the account's financial transactions are expressed.
-
cutOffDate: string
(date)
Cutoff Date is the last possible day of each bill period for a bill segment.Example:
2021-10-05 -
dueDate: string
(date)
Due Date is the date on which the bill is due.Example:
2001-05-16 -
hasBillingOption: boolean
Billing Option defines how the system looks for meter reads.Example:
false -
isLatePaymentCharge: boolean
Eligible for Late Payment Charge is defined as true if a charge is levied for late payment.Example:
false -
isLatestBill: boolean
Latest Bill is defined as true if the bill is the most recent bill.Example:
false -
latePaymentChargeDate: string
(date)
Late Payment Charge Date is the date on which the system will levy a late payment charge if payment is not received.Example:
2001-05-21 -
messages: object
messages
-
nextActions: array
nextActions
-
nextCreditReviewDate: string
(date)
Next Credit Review Date is the next date on which the account's debt will be reviewed by the account debt monitor.Example:
2001-05-21 -
numberOfUnbalancedItems: number
Minimum Value:
0Maximum Value:999999Number of Unbalanced Items contains the count of financial transactions linked to this bill that are linked to unbalanced match events.Example:0 -
numberOfUnmatchedItems: number
Minimum Value:
0Maximum Value:999999Number of Unmatched Items contains the count of financial transactions linked to this bill that are not linked to any match event.Example:0 -
openItemCurrentCharges: number
Total Current Billing Charges is the total amount of frozen bill segment financial transactions linked to this bill.Example:
0 -
openItemTotalAdjustments: number
Total Adjustments is the total amount of frozen or canceled adjustment financial transactions linked to this bill.Example:
0 -
openItemTotalCorrections: number
Total Bill Corrections is the total amount of canceled or rebilled bill segment financial transactions linked to this billExample:
0 -
processDate: string
(date)
Process DateExample:
2021-10-05 -
totalAmount: number
The Total Amount contains the sum of the current amount of the bill segments.Example:
0 -
totalGeneratedCharge: number
Minimum Value:
0Maximum Value:0Total Generated Charge represents the total amount of the bill segments.Example:35 -
version: number
Minimum Value:
-99999Maximum Value:99999The Version number is used for internal concurrency checks.Example:1
Nested Schema : account
Type:
Show Source
object-
accountId: string
Maximum Length:
10Account ID identifies the customer who is responsible for the bill.Example:5499331599
Nested Schema : currency
Type:
objectCurrency Code defines the currency in which the account's financial transactions are expressed.
Show Source
-
currency: string
Maximum Length:
3Currency Code defines the currency in which the account's financial transactions are expressed.Example:USD
Nested Schema : items
Type:
Show Source
object-
addressInformation: object
addressInformation
-
billRoutingMethod: string
Allowed Values:
[ "EM ", "FX ", "P " ]Bill Routing Method is the method used to transmit the bill to the customer. * `EM ` - Email, * `FX ` - Fax, * `P ` - PostalExample:EM -
billRoutingParameters: object
billRoutingParameters
-
person: object
person
Nested Schema : addressInformation
Type:
Show Source
object-
address1: string
Maximum Length:
254Address -
address2: string
Maximum Length:
254The second line of the address for the bill mailing. -
address3: string
Maximum Length:
254The third line of the address for the bill mailing. -
address4: string
Maximum Length:
254The fourth line of the address for the bill mailing. -
city: string
Maximum Length:
90City -
country: object
country
-
county: string
Maximum Length:
90The county of the address for the bill mailing. -
geographicCode: string
Maximum Length:
15Geographic code used to apply proper taxation rules to the physical address location. -
houseType: string
Allowed Values:
[ "AB ", "WW " ]House Type indicates the type of house if applicable for this address. * `AB ` - House Boat References, * `WW ` - House Trailer ReferenceExample:AB -
inCityLimit: boolean
In City Limit
-
name1: string
Maximum Length:
254Name 1 -
name2: string
Maximum Length:
254Name 2 -
name3: string
Maximum Length:
254Name 3 -
number1: string
Maximum Length:
6Number 1 -
number2: string
Maximum Length:
4Number 2 -
postal: string
Maximum Length:
12Postal -
state: string
Maximum Length:
6The state of the address for the bill mailing.Example:CA
Nested Schema : billRoutingParameters
Type:
Show Source
object-
batchControl: object
batchControl
-
batchNumber: number
Minimum Value:
-9.999999999E9Maximum Value:9.999999999E9Batch Number is used to view information and statistics on the batch run's threads.Example:223 -
billFormat: string
Allowed Values:
[ "D ", "S " ]Bill Format Indicates if the customer should receive a detailed or a summary bill. * `D ` - Detailed, * `S ` - SummaryExample:D -
billPrintIntercept: object
billPrintIntercept
-
billRouteType: object
billRouteType
-
copies: number
Minimum Value:
-99Maximum Value:99Number of Bill Copies -
customerPOId: string
Maximum Length:
20PO ID is the purchase order Id the customer wants printed on their copy of the bill. -
doNotExtract: boolean
Define Do Not Extract as true if the bill should not be routed to the individual.Example:
false -
isReprint: boolean
Reprint
-
sequence: number
Minimum Value:
-99999Maximum Value:99999Sequence is the system-assigned identifier assigned to this bill routing.Example:2
Nested Schema : person
Type:
Show Source
object-
personId: string
Maximum Length:
10Person ID identifies the person who was originally associated with the routing record.
Nested Schema : batchControl
Type:
Show Source
object-
batchControl: string
Maximum Length:
8Batch Control
Nested Schema : billPrintIntercept
Type:
Show Source
object-
billPrintIntercept: string
Maximum Length:
8User
Nested Schema : billRouteType
Type:
Show Source
object-
billRouteType: string
Maximum Length:
8Bill Route Type
Nested Schema : items
Type:
Show Source
object-
characteristicType: object
characteristicType
-
characteristicValue: object
characteristicValue
-
sequence: number
Minimum Value:
-999Maximum Value:999Sequence Controls the order in which characteristics of the same type are displayed. -
typeOfCharacteristicValue: string
Maximum Length:
4Type of Char Value -
version: number
Minimum Value:
-99999Maximum Value:99999The Version number is used for internal concurrency checks.Example:1
Nested Schema : characteristicType
Type:
Show Source
object-
characteristicType: string
Maximum Length:
8Characteristic Type must be a type of characteristic defined as permissible on a bill record.Example:ZZDUEDT2
Nested Schema : characteristicValue
Type:
Show Source
object-
_link: string
(_link)
-
value: string
Maximum Length:
254Adhoc Characteristic Value -
value2: string
Maximum Length:
50Foreign Key Value 2 -
value3: string
Maximum Length:
50Foreign Key Value 3 -
value4: string
Maximum Length:
50Foreign Key Value 4 -
value5: string
Maximum Length:
50Foreign Key Value 5
Nested Schema : items
Type:
Show Source
object-
billMessageCode: object
billMessageCode
-
insert: string
Maximum Length:
8Insert Code defines if the bill message causes an insert in the envelope. -
messageOnBill: string
Maximum Length:
254Message On Bill is the message associated with the code.Example:Please call (123) 111-9111 if you have any questions about your rate -
messagePriority: string
Allowed Values:
[ "10 ", "20 ", "30 ", "40 ", "50 ", "60 ", "70 ", "80 ", "90 " ]Priority is the bill messages priority (on the printed bill). * `10 ` - Priority 10 -- Lowest, * `20 ` - Priority 20, * `30 ` - Priority 30, * `40 ` - Priority 40, * `50 ` - Priority 50, * `60 ` - Priority 60, * `70 ` - Priority 70, * `80 ` - Priority 80, * `90 ` - Priority 90 -- HighestExample:10 -
version: number
Minimum Value:
-99999Maximum Value:99999The Version number is used for internal concurrency checks.Example:1
Nested Schema : billMessageCode
Type:
Show Source
object-
billMessageCode: string
Maximum Length:
4Bill Message is the code that identifies the bill message.Example:RES
Nested Schema : items
Type:
Show Source
object-
action: string
Allowed Values:
[ "C1CF", "C1CR", "C1DE", "C1DS", "C1FR", "C1IC", "C1RB", "C1RC", "C1RO", "C1SA", "C1SV", "C1TR", "F1CN", "F1CO", "F1GN" ]Web Service Action: * `C1CF` - Cancel Frozen, * `C1CR` - Credit Note, * `C1DE` - Delete, * `C1DS` - Distribute, * `C1FR` - Freeze, * `C1IC` - Init Cancel, * `C1RB` - Rebill, * `C1RC` - Recommend Budget, * `C1RO` - ReOpen, * `C1SA` - Submit For Approval, * `C1SV` - Save, * `C1TR` - Transfer, * `F1CN` - Cancel, * `F1CO` - Complete, * `F1GN` - Generate
Root Schema : schema
Type:
Show Source
object-
account: object
account
-
accountingDate: string
(date)
Accounting Date defines the financial period to which the canceled and new bill segments' financial transactions are booked.Example:
2021-10-05 -
areEstimatesAllowed: boolean
Allow Estimates is defined as true if the system is allowed to estimate consumption when a meter read cannot be retrieved.Example:
false -
billDate: string
(date)
Bill Date is the business date used when the bill was completed.Example:
2001-05-01 -
billId: string
Maximum Length:
12Bill ID is the system-assigned unique identifier of the bill.Example:549133128888 -
billRoutings: object
billRoutings
-
billSegmentStatus: string
Maximum Length:
30Bill Segment Status is the bill segment's status. -
billStatus: string
Allowed Values:
[ "C ", "P " ]Bill Status is the bill's status. A bill is initially saved in the Pending state. One or more bill segments can be created for the account's service agreements at this point. A bill becomes Complete when it is ready to be sent to the customer. * `C ` - Complete, * `P ` - PendingExample:C -
cancelReason: string
Maximum Length:
4Cancel Reason defines why bill segments are being canceled. -
characteristics: object
characteristics
-
completedDatetime: string
(date-time)
Completion Date/Time is the date and time on which the bill was completed.Example:
2002-10-24T16:51:56-04:00 -
creationDateTime: string
(date-time)
Create Date/Time is the date and time on which the bill was originally created.Example:
2002-10-24T16:51:58-04:00 -
creditNoteDate: string
(date)
Bill Date is the business date that was used when the bill was completed.
-
currency: object
currency
Currency Code defines the currency in which the account's financial transactions are expressed.
-
cutOffDate: string
(date)
Cutoff Date is the last possible day of each bill period for a bill segment.Example:
2021-10-05 -
dueDate: string
(date)
Due Date is the date on which the bill is due.Example:
2001-05-16 -
hasBillingOption: boolean
Billing Option defines how the system looks for meter reads.Example:
false -
isLatePaymentCharge: boolean
Eligible for Late Payment Charge is defined as true if a charge is levied for late payment.Example:
false -
isLatestBill: boolean
Latest Bill is defined as true if the bill is the most recent bill.Example:
false -
latePaymentChargeDate: string
(date)
Late Payment Charge Date is the date on which the system will levy a late payment charge if payment is not received.Example:
2001-05-21 -
messages: object
messages
-
nextActions: array
nextActions
-
nextCreditReviewDate: string
(date)
Next Credit Review Date is the next date on which the account's debt will be reviewed by the account debt monitor.Example:
2001-05-21 -
numberOfUnbalancedItems: number
Minimum Value:
0Maximum Value:999999Number of Unbalanced Items contains the count of financial transactions linked to this bill that are linked to unbalanced match events.Example:0 -
numberOfUnmatchedItems: number
Minimum Value:
0Maximum Value:999999Number of Unmatched Items contains the count of financial transactions linked to this bill that are not linked to any match event.Example:0 -
openItemCurrentCharges: number
Total Current Billing Charges is the total amount of frozen bill segment financial transactions linked to this bill.Example:
0 -
openItemTotalAdjustments: number
Total Adjustments is the total amount of frozen or canceled adjustment financial transactions linked to this bill.Example:
0 -
openItemTotalCorrections: number
Total Bill Corrections is the total amount of canceled or rebilled bill segment financial transactions linked to this billExample:
0 -
processDate: string
(date)
Process DateExample:
2021-10-05 -
totalAmount: number
The Total Amount contains the sum of the current amount of the bill segments.Example:
0 -
totalGeneratedCharge: number
Minimum Value:
0Maximum Value:0Total Generated Charge represents the total amount of the bill segments.Example:35 -
version: number
Minimum Value:
-99999Maximum Value:99999The Version number is used for internal concurrency checks.Example:1
Nested Schema : account
Type:
Show Source
object-
accountId: string
Maximum Length:
10Account ID identifies the customer who is responsible for the bill.Example:5499331599
Nested Schema : currency
Type:
objectCurrency Code defines the currency in which the account's financial transactions are expressed.
Show Source
-
currency: string
Maximum Length:
3Currency Code defines the currency in which the account's financial transactions are expressed.Example:USD
Nested Schema : items
Type:
Show Source
object-
addressInformation: object
addressInformation
-
billRoutingMethod: string
Allowed Values:
[ "EM ", "FX ", "P " ]Bill Routing Method is the method used to transmit the bill to the customer. * `EM ` - Email, * `FX ` - Fax, * `P ` - PostalExample:EM -
billRoutingParameters: object
billRoutingParameters
-
person: object
person
Nested Schema : addressInformation
Type:
Show Source
object-
address1: string
Maximum Length:
254Address -
address2: string
Maximum Length:
254The second line of the address for the bill mailing. -
address3: string
Maximum Length:
254The third line of the address for the bill mailing. -
address4: string
Maximum Length:
254The fourth line of the address for the bill mailing. -
city: string
Maximum Length:
90City -
country: object
country
-
county: string
Maximum Length:
90The county of the address for the bill mailing. -
geographicCode: string
Maximum Length:
15Geographic code used to apply proper taxation rules to the physical address location. -
houseType: string
Allowed Values:
[ "AB ", "WW " ]House Type indicates the type of house if applicable for this address. * `AB ` - House Boat References, * `WW ` - House Trailer ReferenceExample:AB -
inCityLimit: boolean
In City Limit
-
name1: string
Maximum Length:
254Name 1 -
name2: string
Maximum Length:
254Name 2 -
name3: string
Maximum Length:
254Name 3 -
number1: string
Maximum Length:
6Number 1 -
number2: string
Maximum Length:
4Number 2 -
postal: string
Maximum Length:
12Postal -
state: string
Maximum Length:
6The state of the address for the bill mailing.Example:CA
Nested Schema : billRoutingParameters
Type:
Show Source
object-
batchControl: object
batchControl
-
batchNumber: number
Minimum Value:
-9.999999999E9Maximum Value:9.999999999E9Batch Number is used to view information and statistics on the batch run's threads.Example:223 -
billFormat: string
Allowed Values:
[ "D ", "S " ]Bill Format Indicates if the customer should receive a detailed or a summary bill. * `D ` - Detailed, * `S ` - SummaryExample:D -
billPrintIntercept: object
billPrintIntercept
-
billRouteType: object
billRouteType
-
copies: number
Minimum Value:
-99Maximum Value:99Number of Bill Copies -
customerPOId: string
Maximum Length:
20PO ID is the purchase order Id the customer wants printed on their copy of the bill. -
doNotExtract: boolean
Define Do Not Extract as true if the bill should not be routed to the individual.Example:
false -
isReprint: boolean
Reprint
-
sequence: number
Minimum Value:
-99999Maximum Value:99999Sequence is the system-assigned identifier assigned to this bill routing.Example:2
Nested Schema : person
Type:
Show Source
object-
personId: string
Maximum Length:
10Person ID identifies the person who was originally associated with the routing record.
Nested Schema : batchControl
Type:
Show Source
object-
batchControl: string
Maximum Length:
8Batch Control
Nested Schema : billPrintIntercept
Type:
Show Source
object-
billPrintIntercept: string
Maximum Length:
8User
Nested Schema : billRouteType
Type:
Show Source
object-
billRouteType: string
Maximum Length:
8Bill Route Type
Nested Schema : items
Type:
Show Source
object-
characteristicType: object
characteristicType
-
characteristicValue: object
characteristicValue
-
sequence: number
Minimum Value:
-999Maximum Value:999Sequence Controls the order in which characteristics of the same type are displayed. -
typeOfCharacteristicValue: string
Maximum Length:
4Type of Char Value -
version: number
Minimum Value:
-99999Maximum Value:99999The Version number is used for internal concurrency checks.Example:1
Nested Schema : characteristicType
Type:
Show Source
object-
characteristicType: string
Maximum Length:
8Characteristic Type must be a type of characteristic defined as permissible on a bill record.Example:ZZDUEDT2
Nested Schema : characteristicValue
Type:
Show Source
object-
_link: string
(_link)
-
value: string
Maximum Length:
254Adhoc Characteristic Value -
value2: string
Maximum Length:
50Foreign Key Value 2 -
value3: string
Maximum Length:
50Foreign Key Value 3 -
value4: string
Maximum Length:
50Foreign Key Value 4 -
value5: string
Maximum Length:
50Foreign Key Value 5
Nested Schema : items
Type:
Show Source
object-
billMessageCode: object
billMessageCode
-
insert: string
Maximum Length:
8Insert Code defines if the bill message causes an insert in the envelope. -
messageOnBill: string
Maximum Length:
254Message On Bill is the message associated with the code.Example:Please call (123) 111-9111 if you have any questions about your rate -
messagePriority: string
Allowed Values:
[ "10 ", "20 ", "30 ", "40 ", "50 ", "60 ", "70 ", "80 ", "90 " ]Priority is the bill messages priority (on the printed bill). * `10 ` - Priority 10 -- Lowest, * `20 ` - Priority 20, * `30 ` - Priority 30, * `40 ` - Priority 40, * `50 ` - Priority 50, * `60 ` - Priority 60, * `70 ` - Priority 70, * `80 ` - Priority 80, * `90 ` - Priority 90 -- HighestExample:10 -
version: number
Minimum Value:
-99999Maximum Value:99999The Version number is used for internal concurrency checks.Example:1
Nested Schema : billMessageCode
Type:
Show Source
object-
billMessageCode: string
Maximum Length:
4Bill Message is the code that identifies the bill message.Example:RES
Nested Schema : items
Type:
Show Source
object-
action: string
Allowed Values:
[ "C1CF", "C1CR", "C1DE", "C1DS", "C1FR", "C1IC", "C1RB", "C1RC", "C1RO", "C1SA", "C1SV", "C1TR", "F1CN", "F1CO", "F1GN" ]Web Service Action: * `C1CF` - Cancel Frozen, * `C1CR` - Credit Note, * `C1DE` - Delete, * `C1DS` - Distribute, * `C1FR` - Freeze, * `C1IC` - Init Cancel, * `C1RB` - Rebill, * `C1RC` - Recommend Budget, * `C1RO` - ReOpen, * `C1SA` - Submit For Approval, * `C1SV` - Save, * `C1TR` - Transfer, * `F1CN` - Cancel, * `F1CO` - Complete, * `F1GN` - Generate
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1-Bill
Type:
Show Source
object-
_self: string
_self
-
account: object
account
-
accountingDate: string
(date)
Accounting Date defines the financial period to which the canceled and new bill segments' financial transactions are booked.Example:
2021-10-05 -
areEstimatesAllowed: boolean
Allow Estimates is defined as true if the system is allowed to estimate consumption when a meter read cannot be retrieved.Example:
false -
billDate: string
(date)
Bill Date is the business date used when the bill was completed.Example:
2001-05-01 -
billId: string
Maximum Length:
12Bill ID is the system-assigned unique identifier of the bill.Example:549133128888 -
billRoutings: object
billRoutings
-
billSegmentStatus: string
Maximum Length:
30Bill Segment Status is the bill segment's status. -
billStatus: string
Allowed Values:
[ "C ", "P " ]Bill Status is the bill's status. A bill is initially saved in the Pending state. One or more bill segments can be created for the account's service agreements at this point. A bill becomes Complete when it is ready to be sent to the customer. * `C ` - Complete, * `P ` - PendingExample:C -
cancelReason: string
Maximum Length:
4Cancel Reason defines why bill segments are being canceled. -
characteristics: object
characteristics
-
completedDatetime: string
(date-time)
Completion Date/Time is the date and time on which the bill was completed.Example:
2002-10-24T16:51:56-04:00 -
creationDateTime: string
(date-time)
Create Date/Time is the date and time on which the bill was originally created.Example:
2002-10-24T16:51:58-04:00 -
creditNoteDate: string
(date)
Bill Date is the business date that was used when the bill was completed.
-
currency: object
currency
Currency Code defines the currency in which the account's financial transactions are expressed.
-
dueDate: string
(date)
Due Date is the date on which the bill is due.Example:
2001-05-16 -
hasBillingOption: boolean
Billing Option defines how the system looks for meter reads.Example:
false -
isLatePaymentCharge: boolean
Eligible for Late Payment Charge is defined as true if a charge is levied for late payment.Example:
false -
isLatestBill: boolean
Latest Bill is defined as true if the bill is the most recent bill.Example:
false -
latePaymentChargeDate: string
(date)
Late Payment Charge Date is the date on which the system will levy a late payment charge if payment is not received.Example:
2001-05-21 -
messages: object
messages
-
nextActions: array
nextActions
-
nextCreditReviewDate: string
(date)
Next Credit Review Date is the next date on which the account's debt will be reviewed by the account debt monitor.Example:
2001-05-21 -
numberOfUnbalancedItems: number
Minimum Value:
0Maximum Value:999999Number of Unbalanced Items contains the count of financial transactions linked to this bill that are linked to unbalanced match events.Example:0 -
numberOfUnmatchedItems: number
Minimum Value:
0Maximum Value:999999Number of Unmatched Items contains the count of financial transactions linked to this bill that are not linked to any match event.Example:0 -
openItemCurrentCharges: number
Total Current Billing Charges is the total amount of frozen bill segment financial transactions linked to this bill.Example:
0 -
openItemTotalAdjustments: number
Total Adjustments is the total amount of frozen or canceled adjustment financial transactions linked to this bill.Example:
0 -
openItemTotalCorrections: number
Total Bill Corrections is the total amount of canceled or rebilled bill segment financial transactions linked to this billExample:
0 -
processDate: string
(date)
Process DateExample:
2021-10-05 -
totalAmount: number
The Total Amount contains the sum of the current amount of the bill segments.Example:
0 -
totalGeneratedCharge: number
Minimum Value:
0Maximum Value:0Total Generated Charge represents the total amount of the bill segments.Example:35 -
version: number
Minimum Value:
-99999Maximum Value:99999The Version number is used for internal concurrency checks.Example:1
Nested Schema : account
Type:
Show Source
object-
_link: string
_link
-
accountId: string
Maximum Length:
10Account ID identifies the customer who is responsible for the bill.Example:5499331599
Nested Schema : currency
Type:
objectCurrency Code defines the currency in which the account's financial transactions are expressed.
Show Source
-
_link: string
_link
-
currency: string
Maximum Length:
3Currency Code defines the currency in which the account's financial transactions are expressed.Example:USD
Nested Schema : items
Type:
Show Source
object-
addressInformation: object
addressInformation
-
billRoutingMethod: string
Allowed Values:
[ "EM ", "FX ", "P " ]Bill Routing Method is the method used to transmit the bill to the customer. * `EM ` - Email, * `FX ` - Fax, * `P ` - PostalExample:EM -
billRoutingParameters: object
billRoutingParameters
-
person: object
person
Nested Schema : addressInformation
Type:
Show Source
object-
address1: string
Maximum Length:
254Address -
address2: string
Maximum Length:
254The second line of the address for the bill mailing. -
address3: string
Maximum Length:
254The third line of the address for the bill mailing. -
address4: string
Maximum Length:
254The fourth line of the address for the bill mailing. -
city: string
Maximum Length:
90City -
country: object
country
-
county: string
Maximum Length:
90The county of the address for the bill mailing. -
geographicCode: string
Maximum Length:
15Geographic code used to apply proper taxation rules to the physical address location. -
houseType: string
Allowed Values:
[ "AB ", "WW " ]House Type indicates the type of house if applicable for this address. * `AB ` - House Boat References, * `WW ` - House Trailer ReferenceExample:AB -
inCityLimit: boolean
In City Limit
-
name1: string
Maximum Length:
254Name 1 -
name2: string
Maximum Length:
254Name 2 -
name3: string
Maximum Length:
254Name 3 -
number1: string
Maximum Length:
6Number 1 -
number2: string
Maximum Length:
4Number 2 -
postal: string
Maximum Length:
12Postal -
state: string
Maximum Length:
6The state of the address for the bill mailing.Example:CA
Nested Schema : billRoutingParameters
Type:
Show Source
object-
batchControl: object
batchControl
-
batchNumber: number
Minimum Value:
-9.999999999E9Maximum Value:9.999999999E9Batch Number is used to view information and statistics on the batch run's threads.Example:223 -
billFormat: string
Allowed Values:
[ "D ", "S " ]Bill Format Indicates if the customer should receive a detailed or a summary bill. * `D ` - Detailed, * `S ` - SummaryExample:D -
billPrintIntercept: object
billPrintIntercept
-
billRouteType: object
billRouteType
-
copies: number
Minimum Value:
-99Maximum Value:99Number of Bill Copies -
customerPOId: string
Maximum Length:
20PO ID is the purchase order Id the customer wants printed on their copy of the bill. -
doNotExtract: boolean
Define Do Not Extract as true if the bill should not be routed to the individual.Example:
false -
isReprint: boolean
Reprint
-
sequence: number
Minimum Value:
-99999Maximum Value:99999Sequence is the system-assigned identifier assigned to this bill routing.Example:2
Nested Schema : person
Type:
Show Source
object-
_link: string
_link
-
personId: string
Maximum Length:
10Person ID identifies the person who was originally associated with the routing record.
Nested Schema : country
Type:
Show Source
object-
_link: string
_link
-
country: string
Maximum Length:
3Country
Nested Schema : batchControl
Type:
Show Source
object-
_link: string
_link
-
batchControl: string
Maximum Length:
8Batch Control
Nested Schema : billPrintIntercept
Type:
Show Source
object-
_link: string
_link
-
billPrintIntercept: string
Maximum Length:
8User
Nested Schema : billRouteType
Type:
Show Source
object-
_link: string
_link
-
billRouteType: string
Maximum Length:
8Bill Route Type
Nested Schema : items
Type:
Show Source
object-
characteristicType: object
characteristicType
-
characteristicValue: object
characteristicValue
-
sequence: number
Minimum Value:
-999Maximum Value:999Sequence Controls the order in which characteristics of the same type are displayed. -
typeOfCharacteristicValue: string
Maximum Length:
4Type of Char Value -
version: number
Minimum Value:
-99999Maximum Value:99999The Version number is used for internal concurrency checks.Example:1
Nested Schema : characteristicType
Type:
Show Source
object-
_link: string
_link
-
characteristicType: string
Maximum Length:
8Characteristic Type must be a type of characteristic defined as permissible on a bill record.Example:ZZDUEDT2
Nested Schema : characteristicValue
Type:
Show Source
object-
_link: string
(_link)
-
value: string
Maximum Length:
254Adhoc Characteristic Value -
value2: string
Maximum Length:
50Foreign Key Value 2 -
value3: string
Maximum Length:
50Foreign Key Value 3 -
value4: string
Maximum Length:
50Foreign Key Value 4 -
value5: string
Maximum Length:
50Foreign Key Value 5
Nested Schema : items
Type:
Show Source
object-
billMessageCode: object
billMessageCode
-
insert: string
Maximum Length:
8Insert Code defines if the bill message causes an insert in the envelope. -
messageOnBill: string
Maximum Length:
254Message On Bill is the message associated with the code.Example:Please call (123) 111-9111 if you have any questions about your rate -
messagePriority: string
Allowed Values:
[ "10 ", "20 ", "30 ", "40 ", "50 ", "60 ", "70 ", "80 ", "90 " ]Priority is the bill messages priority (on the printed bill). * `10 ` - Priority 10 -- Lowest, * `20 ` - Priority 20, * `30 ` - Priority 30, * `40 ` - Priority 40, * `50 ` - Priority 50, * `60 ` - Priority 60, * `70 ` - Priority 70, * `80 ` - Priority 80, * `90 ` - Priority 90 -- HighestExample:10 -
version: number
Minimum Value:
-99999Maximum Value:99999The Version number is used for internal concurrency checks.Example:1
Nested Schema : billMessageCode
Type:
Show Source
object-
_link: string
_link
-
billMessageCode: string
Maximum Length:
4Bill Message is the code that identifies the bill message.Example:RES
Nested Schema : items
Type:
Show Source
object-
action: string
Allowed Values:
[ "C1CF", "C1CR", "C1DE", "C1DS", "C1FR", "C1IC", "C1RB", "C1RC", "C1RO", "C1SA", "C1SV", "C1TR", "F1CN", "F1CO", "F1GN" ]Web Service Action: * `C1CF` - Cancel Frozen, * `C1CR` - Credit Note, * `C1DE` - Delete, * `C1DS` - Distribute, * `C1FR` - Freeze, * `C1IC` - Init Cancel, * `C1RB` - Rebill, * `C1RC` - Recommend Budget, * `C1RO` - ReOpen, * `C1SA` - Submit For Approval, * `C1SV` - Save, * `C1TR` - Transfer, * `F1CN` - Cancel, * `F1CO` - Complete, * `F1GN` - Generate
400 Response
Bad Request
Root Schema : problemDetailDocument
Type:
Show Source
object-
detail: string
Maximum Length:
60The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0Maximum Value:9999The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60Fully 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:
60URL 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:
60The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object-
callSequence: string
Maximum Length:
60Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0Maximum Value:0Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999Maximum Value:99999Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60Name of the program that encountered the error.
500 Response
Internal Server Error
Root Schema : problemDetailDocument
Type:
Show Source
object-
detail: string
Maximum Length:
60The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0Maximum Value:9999The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60Fully 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:
60URL 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:
60The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object-
callSequence: string
Maximum Length:
60Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0Maximum Value:0Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999Maximum Value:99999Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60Name of the program that encountered the error.