Oracle Utilities REST API for Metering and Customer Information

Update Bill Routings

put

/rest/apis/customer/financials/bills/{billId}/routings/{sequence}

Request

Path Parameters

billId(required): string
Bill ID is the system-assigned unique identifier of the bill.
Example:
```
549133128888
```
sequence(required): number
Sequence is the system-assigned identifier assigned to this bill routing.
Example:
```
2
```

Supported Media Types

application/xml
application/json

Root Schema : schema

Type: object

Show Source

addressInformation: object addressInformation
billRoutingParameters: object billRoutingParameters
person: object person
sequence: number

Minimum Value: -99999

Maximum Value: 99999

Sequence is the system-assigned identifier assigned to this bill routing.

Example: 2
version: number

Minimum Value: -99999

Maximum Value: 99999

The Version number is used for internal concurrency checks.

Example: 1

{
    "type":"object",
    "properties":{
        "person":{
            "type":"object",
            "properties":{
                "personId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Person ID identifies the person who was originally associated with the routing record."
                }
            }
        },
        "sequence":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Sequence is the system-assigned identifier assigned to this bill routing.",
            "example":"2"
        },
        "billRoutingParameters":{
            "type":"object",
            "properties":{
                "billRouteType":{
                    "type":"object",
                    "description":"Bill Route Type is the method used to transmit the bill to the customer.",
                    "properties":{
                        "billRouteType":{
                            "type":"string",
                            "maxLength":8,
                            "description":"Bill Route Type is the method used to transmit the bill to the customer."
                        }
                    }
                },
                "billRoutingMethod":{
                    "type":"string",
                    "enum":[
                        "EB  ",
                        "EM  ",
                        "FX  ",
                        "P   "
                    ],
                    "description":"Bill Routing Method is the method used to transmit the bill to the customer.\n* `EB  ` - EDI Billing,\n* `EM  ` - Email,\n* `FX  ` - Fax,\n* `P   ` - Postal",
                    "example":"EM"
                },
                "batchControl":{
                    "type":"object",
                    "description":"Batch Control is the identifier of the batch of bills in which the recipient's copy was downloaded.",
                    "properties":{
                        "batchControl":{
                            "type":"string",
                            "maxLength":8,
                            "description":"Batch Control is the identifier of the batch of bills in which the recipient's copy was downloaded.",
                            "example":"POSTROUT"
                        }
                    }
                },
                "batchNumber":{
                    "type":"number",
                    "maximum":"9999999999",
                    "minimum":"-9999999999",
                    "description":"Batch Number is used to view information and statistics on the batch run's threads.",
                    "example":"223"
                },
                "billPrintIntercept":{
                    "type":"object",
                    "description":"Intercept is the User ID of the individual who wants to review the bill before it is sent to the customer.",
                    "properties":{
                        "billPrintIntercept":{
                            "type":"string",
                            "maxLength":8,
                            "description":"Intercept is the User ID of the individual who wants to review the bill before it is sent to the customer."
                        }
                    }
                },
                "billFormat":{
                    "type":"string",
                    "enum":[
                        "D   ",
                        "S   "
                    ],
                    "description":"Bill Format Indicates if the customer should receive a detailed or a summary bill.\n* `D   ` - Detailed,\n* `S   ` - Summary",
                    "example":"D"
                },
                "numberOfCopies":{
                    "type":"number",
                    "maximum":99,
                    "minimum":-99,
                    "description":"Number of Bill Copies indicates how many copies of the bill the person receives.",
                    "example":"1"
                },
                "isReprint":{
                    "type":"boolean",
                    "description":"Reprint is defined as true if a user created this routing. This option is populated by the system and is always protected.",
                    "example":"false"
                },
                "customerPOId":{
                    "type":"string",
                    "maxLength":20,
                    "description":"PO ID is the purchase order Id the customer wants printed on their copy of the bill."
                },
                "doNotExtract":{
                    "type":"boolean",
                    "description":"Define Do Not Extract as true if the bill should not be routed to the individual.",
                    "example":"false"
                },
                "extractDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Date Time that the bill was extracted for delivery to the recipient."
                }
            }
        },
        "addressInformation":{
            "type":"object",
            "properties":{
                "name1":{
                    "type":"string",
                    "maxLength":254,
                    "description":"If the recipient has an override mailing name, Name1, Name2, and Name3 contain the person's override mailing name. Otherwise, Name1 contains the recipient's primary name.",
                    "example":"Bill,Louie"
                },
                "name2":{
                    "type":"string",
                    "maxLength":254,
                    "description":"If the recipient has an override mailing name, Name1, Name2, and Name3 contain the person's override mailing name."
                },
                "name3":{
                    "type":"string",
                    "maxLength":254,
                    "description":"If the recipient has an override mailing name, Name1, Name2, and Name3 contain the person's override mailing name."
                },
                "country":{
                    "type":"object",
                    "description":"Country retrieves its default value from the installation options. The address constituents may differ depending on the Country.",
                    "properties":{
                        "country":{
                            "type":"string",
                            "maxLength":3,
                            "description":"Country retrieves its default value from the installation options. The address constituents may differ depending on the Country.",
                            "example":"USA"
                        }
                    }
                },
                "postal":{
                    "type":"string",
                    "maxLength":12,
                    "description":"The postal code of the address for the bill mailing."
                },
                "address1":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The first line of the address for the bill mailing."
                },
                "address2":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The second line of the address for the bill mailing."
                },
                "address3":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The third line of the address for the bill mailing."
                },
                "address4":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The fourth line of the address for the bill mailing."
                },
                "city":{
                    "type":"string",
                    "maxLength":90,
                    "description":"The city of the address for the bill mailing.",
                    "example":"San Francisco"
                },
                "number1":{
                    "type":"string",
                    "maxLength":6,
                    "description":"The first street number line of the address for the bill mailing."
                },
                "number2":{
                    "type":"string",
                    "maxLength":4,
                    "description":"The second street number line of the address for the bill mailing."
                },
                "houseType":{
                    "type":"string",
                    "enum":[
                    ],
                    "description":"House Type indicates the type of house if applicable for this address.\n",
                    "example":"AB"
                },
                "county":{
                    "type":"string",
                    "maxLength":90,
                    "description":"The county of the address for the bill mailing."
                },
                "state":{
                    "type":"string",
                    "maxLength":6,
                    "description":"The state of the address for the bill mailing.",
                    "example":"CA"
                },
                "inCityLimit":{
                    "type":"boolean",
                    "description":"In City Limit switch is on if the address is considered within the physical city limits.",
                    "example":"true"
                },
                "taxVendorGeographicalCode":{
                    "type":"string",
                    "maxLength":11,
                    "description":"Geographical Code"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks.",
            "example":"1"
        }
    },
    "xml":{
        "name":"C1BillRoutgs"
    }
}

Nested Schema : addressInformation

Type: object

Show Source

address1: string

Maximum Length: 254

The first line of the address for the bill mailing.
address2: string

Maximum Length: 254

The second line of the address for the bill mailing.
address3: string

Maximum Length: 254

The third line of the address for the bill mailing.
address4: string

Maximum Length: 254

The fourth line of the address for the bill mailing.
city: string

Maximum Length: 90

The city of the address for the bill mailing.

Example: San Francisco
country: object country

Country retrieves its default value from the installation options. The address constituents may differ depending on the Country.
county: string

Maximum Length: 90

The county of the address for the bill mailing.
houseType: string

House Type indicates the type of house if applicable for this address.

Example: AB
inCityLimit: boolean

In City Limit switch is on if the address is considered within the physical city limits.

Example: true
name1: string

Maximum Length: 254

If the recipient has an override mailing name, Name1, Name2, and Name3 contain the person's override mailing name. Otherwise, Name1 contains the recipient's primary name.

Example: Bill,Louie
name2: string

Maximum Length: 254

If the recipient has an override mailing name, Name1, Name2, and Name3 contain the person's override mailing name.
name3: string

Maximum Length: 254

If the recipient has an override mailing name, Name1, Name2, and Name3 contain the person's override mailing name.
number1: string

Maximum Length: 6

The first street number line of the address for the bill mailing.
number2: string

Maximum Length: 4

The second street number line of the address for the bill mailing.
postal: string

Maximum Length: 12

The postal code of the address for the bill mailing.
state: string

Maximum Length: 6

The state of the address for the bill mailing.

Example: CA
taxVendorGeographicalCode: string

Maximum Length: 11

Geographical Code

{
    "type":"object",
    "properties":{
        "name1":{
            "type":"string",
            "maxLength":254,
            "description":"If the recipient has an override mailing name, Name1, Name2, and Name3 contain the person's override mailing name. Otherwise, Name1 contains the recipient's primary name.",
            "example":"Bill,Louie"
        },
        "name2":{
            "type":"string",
            "maxLength":254,
            "description":"If the recipient has an override mailing name, Name1, Name2, and Name3 contain the person's override mailing name."
        },
        "name3":{
            "type":"string",
            "maxLength":254,
            "description":"If the recipient has an override mailing name, Name1, Name2, and Name3 contain the person's override mailing name."
        },
        "country":{
            "type":"object",
            "description":"Country retrieves its default value from the installation options. The address constituents may differ depending on the Country.",
            "properties":{
                "country":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Country retrieves its default value from the installation options. The address constituents may differ depending on the Country.",
                    "example":"USA"
                }
            }
        },
        "postal":{
            "type":"string",
            "maxLength":12,
            "description":"The postal code of the address for the bill mailing."
        },
        "address1":{
            "type":"string",
            "maxLength":254,
            "description":"The first line of the address for the bill mailing."
        },
        "address2":{
            "type":"string",
            "maxLength":254,
            "description":"The second line of the address for the bill mailing."
        },
        "address3":{
            "type":"string",
            "maxLength":254,
            "description":"The third line of the address for the bill mailing."
        },
        "address4":{
            "type":"string",
            "maxLength":254,
            "description":"The fourth line of the address for the bill mailing."
        },
        "city":{
            "type":"string",
            "maxLength":90,
            "description":"The city of the address for the bill mailing.",
            "example":"San Francisco"
        },
        "number1":{
            "type":"string",
            "maxLength":6,
            "description":"The first street number line of the address for the bill mailing."
        },
        "number2":{
            "type":"string",
            "maxLength":4,
            "description":"The second street number line of the address for the bill mailing."
        },
        "houseType":{
            "type":"string",
            "enum":[
            ],
            "description":"House Type indicates the type of house if applicable for this address.\n",
            "example":"AB"
        },
        "county":{
            "type":"string",
            "maxLength":90,
            "description":"The county of the address for the bill mailing."
        },
        "state":{
            "type":"string",
            "maxLength":6,
            "description":"The state of the address for the bill mailing.",
            "example":"CA"
        },
        "inCityLimit":{
            "type":"boolean",
            "description":"In City Limit switch is on if the address is considered within the physical city limits.",
            "example":"true"
        },
        "taxVendorGeographicalCode":{
            "type":"string",
            "maxLength":11,
            "description":"Geographical Code"
        }
    }
}

Nested Schema : billRoutingParameters

Type: object

Show Source

batchControl: object batchControl

Batch Control is the identifier of the batch of bills in which the recipient's copy was downloaded.
batchNumber: number

Minimum Value: -9999999999

Maximum Value: 9999999999

Batch 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 ` - Summary

Example: D
billPrintIntercept: object billPrintIntercept

Intercept is the User ID of the individual who wants to review the bill before it is sent to the customer.
billRouteType: object billRouteType

Bill Route Type is the method used to transmit the bill to the customer.
billRoutingMethod: string

Allowed Values: [ "EB ", "EM ", "FX ", "P " ]

Bill Routing Method is the method used to transmit the bill to the customer. * `EB ` - EDI Billing, * `EM ` - Email, * `FX ` - Fax, * `P ` - Postal

Example: EM
customerPOId: string

Maximum Length: 20

PO 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
extractDateTime: string (date-time)

Date Time that the bill was extracted for delivery to the recipient.
isReprint: boolean

Reprint is defined as true if a user created this routing. This option is populated by the system and is always protected.

Example: false
numberOfCopies: number

Minimum Value: -99

Maximum Value: 99

Number of Bill Copies indicates how many copies of the bill the person receives.

Example: 1

{
    "type":"object",
    "properties":{
        "billRouteType":{
            "type":"object",
            "description":"Bill Route Type is the method used to transmit the bill to the customer.",
            "properties":{
                "billRouteType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Bill Route Type is the method used to transmit the bill to the customer."
                }
            }
        },
        "billRoutingMethod":{
            "type":"string",
            "enum":[
                "EB  ",
                "EM  ",
                "FX  ",
                "P   "
            ],
            "description":"Bill Routing Method is the method used to transmit the bill to the customer.\n* `EB  ` - EDI Billing,\n* `EM  ` - Email,\n* `FX  ` - Fax,\n* `P   ` - Postal",
            "example":"EM"
        },
        "batchControl":{
            "type":"object",
            "description":"Batch Control is the identifier of the batch of bills in which the recipient's copy was downloaded.",
            "properties":{
                "batchControl":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Batch Control is the identifier of the batch of bills in which the recipient's copy was downloaded.",
                    "example":"POSTROUT"
                }
            }
        },
        "batchNumber":{
            "type":"number",
            "maximum":"9999999999",
            "minimum":"-9999999999",
            "description":"Batch Number is used to view information and statistics on the batch run's threads.",
            "example":"223"
        },
        "billPrintIntercept":{
            "type":"object",
            "description":"Intercept is the User ID of the individual who wants to review the bill before it is sent to the customer.",
            "properties":{
                "billPrintIntercept":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Intercept is the User ID of the individual who wants to review the bill before it is sent to the customer."
                }
            }
        },
        "billFormat":{
            "type":"string",
            "enum":[
                "D   ",
                "S   "
            ],
            "description":"Bill Format Indicates if the customer should receive a detailed or a summary bill.\n* `D   ` - Detailed,\n* `S   ` - Summary",
            "example":"D"
        },
        "numberOfCopies":{
            "type":"number",
            "maximum":99,
            "minimum":-99,
            "description":"Number of Bill Copies indicates how many copies of the bill the person receives.",
            "example":"1"
        },
        "isReprint":{
            "type":"boolean",
            "description":"Reprint is defined as true if a user created this routing. This option is populated by the system and is always protected.",
            "example":"false"
        },
        "customerPOId":{
            "type":"string",
            "maxLength":20,
            "description":"PO ID is the purchase order Id the customer wants printed on their copy of the bill."
        },
        "doNotExtract":{
            "type":"boolean",
            "description":"Define Do Not Extract as true if the bill should not be routed to the individual.",
            "example":"false"
        },
        "extractDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Date Time that the bill was extracted for delivery to the recipient."
        }
    }
}

Nested Schema : person

Type: object

Show Source

personId: string

Maximum Length: 10

Person ID identifies the person who was originally associated with the routing record.

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID identifies the person who was originally associated with the routing record."
        }
    }
}

Nested Schema : country

Type: object

Country retrieves its default value from the installation options. The address constituents may differ depending on the Country.

Show Source

country: string

Maximum Length: 3

Country retrieves its default value from the installation options. The address constituents may differ depending on the Country.

Example: USA

{
    "type":"object",
    "description":"Country retrieves its default value from the installation options. The address constituents may differ depending on the Country.",
    "properties":{
        "country":{
            "type":"string",
            "maxLength":3,
            "description":"Country retrieves its default value from the installation options. The address constituents may differ depending on the Country.",
            "example":"USA"
        }
    }
}

Nested Schema : batchControl

Type: object

Batch Control is the identifier of the batch of bills in which the recipient's copy was downloaded.

Show Source

batchControl: string

Maximum Length: 8

Batch Control is the identifier of the batch of bills in which the recipient's copy was downloaded.

Example: POSTROUT

{
    "type":"object",
    "description":"Batch Control is the identifier of the batch of bills in which the recipient's copy was downloaded.",
    "properties":{
        "batchControl":{
            "type":"string",
            "maxLength":8,
            "description":"Batch Control is the identifier of the batch of bills in which the recipient's copy was downloaded.",
            "example":"POSTROUT"
        }
    }
}

Nested Schema : billPrintIntercept

Type: object

Intercept is the User ID of the individual who wants to review the bill before it is sent to the customer.

Show Source

billPrintIntercept: string

Maximum Length: 8

Intercept is the User ID of the individual who wants to review the bill before it is sent to the customer.

{
    "type":"object",
    "description":"Intercept is the User ID of the individual who wants to review the bill before it is sent to the customer.",
    "properties":{
        "billPrintIntercept":{
            "type":"string",
            "maxLength":8,
            "description":"Intercept is the User ID of the individual who wants to review the bill before it is sent to the customer."
        }
    }
}

Nested Schema : billRouteType

Type: object

Bill Route Type is the method used to transmit the bill to the customer.

Show Source

billRouteType: string

Maximum Length: 8

Bill Route Type is the method used to transmit the bill to the customer.

{
    "type":"object",
    "description":"Bill Route Type is the method used to transmit the bill to the customer.",
    "properties":{
        "billRouteType":{
            "type":"string",
            "maxLength":8,
            "description":"Bill Route Type is the method used to transmit the bill to the customer."
        }
    }
}

Root Schema : schema

Type: object

Show Source

addressInformation: object addressInformation
billRoutingParameters: object billRoutingParameters
person: object person
sequence: number

Minimum Value: -99999

Maximum Value: 99999

Sequence is the system-assigned identifier assigned to this bill routing.

Example: 2
version: number

Minimum Value: -99999

Maximum Value: 99999

The Version number is used for internal concurrency checks.

Example: 1

{
    "type":"object",
    "properties":{
        "person":{
            "type":"object",
            "properties":{
                "personId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Person ID identifies the person who was originally associated with the routing record."
                }
            }
        },
        "sequence":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Sequence is the system-assigned identifier assigned to this bill routing.",
            "example":"2"
        },
        "billRoutingParameters":{
            "type":"object",
            "properties":{
                "billRouteType":{
                    "type":"object",
                    "description":"Bill Route Type is the method used to transmit the bill to the customer.",
                    "properties":{
                        "billRouteType":{
                            "type":"string",
                            "maxLength":8,
                            "description":"Bill Route Type is the method used to transmit the bill to the customer."
                        }
                    }
                },
                "billRoutingMethod":{
                    "type":"string",
                    "enum":[
                        "EB  ",
                        "EM  ",
                        "FX  ",
                        "P   "
                    ],
                    "description":"Bill Routing Method is the method used to transmit the bill to the customer.\n* `EB  ` - EDI Billing,\n* `EM  ` - Email,\n* `FX  ` - Fax,\n* `P   ` - Postal",
                    "example":"EM"
                },
                "batchControl":{
                    "type":"object",
                    "description":"Batch Control is the identifier of the batch of bills in which the recipient's copy was downloaded.",
                    "properties":{
                        "batchControl":{
                            "type":"string",
                            "maxLength":8,
                            "description":"Batch Control is the identifier of the batch of bills in which the recipient's copy was downloaded.",
                            "example":"POSTROUT"
                        }
                    }
                },
                "batchNumber":{
                    "type":"number",
                    "maximum":"9999999999",
                    "minimum":"-9999999999",
                    "description":"Batch Number is used to view information and statistics on the batch run's threads.",
                    "example":"223"
                },
                "billPrintIntercept":{
                    "type":"object",
                    "description":"Intercept is the User ID of the individual who wants to review the bill before it is sent to the customer.",
                    "properties":{
                        "billPrintIntercept":{
                            "type":"string",
                            "maxLength":8,
                            "description":"Intercept is the User ID of the individual who wants to review the bill before it is sent to the customer."
                        }
                    }
                },
                "billFormat":{
                    "type":"string",
                    "enum":[
                        "D   ",
                        "S   "
                    ],
                    "description":"Bill Format Indicates if the customer should receive a detailed or a summary bill.\n* `D   ` - Detailed,\n* `S   ` - Summary",
                    "example":"D"
                },
                "numberOfCopies":{
                    "type":"number",
                    "maximum":99,
                    "minimum":-99,
                    "description":"Number of Bill Copies indicates how many copies of the bill the person receives.",
                    "example":"1"
                },
                "isReprint":{
                    "type":"boolean",
                    "description":"Reprint is defined as true if a user created this routing. This option is populated by the system and is always protected.",
                    "example":"false"
                },
                "customerPOId":{
                    "type":"string",
                    "maxLength":20,
                    "description":"PO ID is the purchase order Id the customer wants printed on their copy of the bill."
                },
                "doNotExtract":{
                    "type":"boolean",
                    "description":"Define Do Not Extract as true if the bill should not be routed to the individual.",
                    "example":"false"
                },
                "extractDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Date Time that the bill was extracted for delivery to the recipient."
                }
            }
        },
        "addressInformation":{
            "type":"object",
            "properties":{
                "name1":{
                    "type":"string",
                    "maxLength":254,
                    "description":"If the recipient has an override mailing name, Name1, Name2, and Name3 contain the person's override mailing name. Otherwise, Name1 contains the recipient's primary name.",
                    "example":"Bill,Louie"
                },
                "name2":{
                    "type":"string",
                    "maxLength":254,
                    "description":"If the recipient has an override mailing name, Name1, Name2, and Name3 contain the person's override mailing name."
                },
                "name3":{
                    "type":"string",
                    "maxLength":254,
                    "description":"If the recipient has an override mailing name, Name1, Name2, and Name3 contain the person's override mailing name."
                },
                "country":{
                    "type":"object",
                    "description":"Country retrieves its default value from the installation options. The address constituents may differ depending on the Country.",
                    "properties":{
                        "country":{
                            "type":"string",
                            "maxLength":3,
                            "description":"Country retrieves its default value from the installation options. The address constituents may differ depending on the Country.",
                            "example":"USA"
                        }
                    }
                },
                "postal":{
                    "type":"string",
                    "maxLength":12,
                    "description":"The postal code of the address for the bill mailing."
                },
                "address1":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The first line of the address for the bill mailing."
                },
                "address2":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The second line of the address for the bill mailing."
                },
                "address3":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The third line of the address for the bill mailing."
                },
                "address4":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The fourth line of the address for the bill mailing."
                },
                "city":{
                    "type":"string",
                    "maxLength":90,
                    "description":"The city of the address for the bill mailing.",
                    "example":"San Francisco"
                },
                "number1":{
                    "type":"string",
                    "maxLength":6,
                    "description":"The first street number line of the address for the bill mailing."
                },
                "number2":{
                    "type":"string",
                    "maxLength":4,
                    "description":"The second street number line of the address for the bill mailing."
                },
                "houseType":{
                    "type":"string",
                    "enum":[
                    ],
                    "description":"House Type indicates the type of house if applicable for this address.\n",
                    "example":"AB"
                },
                "county":{
                    "type":"string",
                    "maxLength":90,
                    "description":"The county of the address for the bill mailing."
                },
                "state":{
                    "type":"string",
                    "maxLength":6,
                    "description":"The state of the address for the bill mailing.",
                    "example":"CA"
                },
                "inCityLimit":{
                    "type":"boolean",
                    "description":"In City Limit switch is on if the address is considered within the physical city limits.",
                    "example":"true"
                },
                "taxVendorGeographicalCode":{
                    "type":"string",
                    "maxLength":11,
                    "description":"Geographical Code"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks.",
            "example":"1"
        }
    },
    "xml":{
        "name":"C1BillRoutgs"
    }
}

Nested Schema : addressInformation

Type: object

Show Source

address1: string

Maximum Length: 254

The first line of the address for the bill mailing.
address2: string

Maximum Length: 254

The second line of the address for the bill mailing.
address3: string

Maximum Length: 254

The third line of the address for the bill mailing.
address4: string

Maximum Length: 254

The fourth line of the address for the bill mailing.
city: string

Maximum Length: 90

The city of the address for the bill mailing.

Example: San Francisco
country: object country

Country retrieves its default value from the installation options. The address constituents may differ depending on the Country.
county: string

Maximum Length: 90

The county of the address for the bill mailing.
houseType: string

House Type indicates the type of house if applicable for this address.

Example: AB
inCityLimit: boolean

In City Limit switch is on if the address is considered within the physical city limits.

Example: true
name1: string

Maximum Length: 254

If the recipient has an override mailing name, Name1, Name2, and Name3 contain the person's override mailing name. Otherwise, Name1 contains the recipient's primary name.

Example: Bill,Louie
name2: string

Maximum Length: 254

If the recipient has an override mailing name, Name1, Name2, and Name3 contain the person's override mailing name.
name3: string

Maximum Length: 254

If the recipient has an override mailing name, Name1, Name2, and Name3 contain the person's override mailing name.
number1: string

Maximum Length: 6

The first street number line of the address for the bill mailing.
number2: string

Maximum Length: 4

The second street number line of the address for the bill mailing.
postal: string

Maximum Length: 12

The postal code of the address for the bill mailing.
state: string

Maximum Length: 6

The state of the address for the bill mailing.

Example: CA
taxVendorGeographicalCode: string

Maximum Length: 11

Geographical Code

{
    "type":"object",
    "properties":{
        "name1":{
            "type":"string",
            "maxLength":254,
            "description":"If the recipient has an override mailing name, Name1, Name2, and Name3 contain the person's override mailing name. Otherwise, Name1 contains the recipient's primary name.",
            "example":"Bill,Louie"
        },
        "name2":{
            "type":"string",
            "maxLength":254,
            "description":"If the recipient has an override mailing name, Name1, Name2, and Name3 contain the person's override mailing name."
        },
        "name3":{
            "type":"string",
            "maxLength":254,
            "description":"If the recipient has an override mailing name, Name1, Name2, and Name3 contain the person's override mailing name."
        },
        "country":{
            "type":"object",
            "description":"Country retrieves its default value from the installation options. The address constituents may differ depending on the Country.",
            "properties":{
                "country":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Country retrieves its default value from the installation options. The address constituents may differ depending on the Country.",
                    "example":"USA"
                }
            }
        },
        "postal":{
            "type":"string",
            "maxLength":12,
            "description":"The postal code of the address for the bill mailing."
        },
        "address1":{
            "type":"string",
            "maxLength":254,
            "description":"The first line of the address for the bill mailing."
        },
        "address2":{
            "type":"string",
            "maxLength":254,
            "description":"The second line of the address for the bill mailing."
        },
        "address3":{
            "type":"string",
            "maxLength":254,
            "description":"The third line of the address for the bill mailing."
        },
        "address4":{
            "type":"string",
            "maxLength":254,
            "description":"The fourth line of the address for the bill mailing."
        },
        "city":{
            "type":"string",
            "maxLength":90,
            "description":"The city of the address for the bill mailing.",
            "example":"San Francisco"
        },
        "number1":{
            "type":"string",
            "maxLength":6,
            "description":"The first street number line of the address for the bill mailing."
        },
        "number2":{
            "type":"string",
            "maxLength":4,
            "description":"The second street number line of the address for the bill mailing."
        },
        "houseType":{
            "type":"string",
            "enum":[
            ],
            "description":"House Type indicates the type of house if applicable for this address.\n",
            "example":"AB"
        },
        "county":{
            "type":"string",
            "maxLength":90,
            "description":"The county of the address for the bill mailing."
        },
        "state":{
            "type":"string",
            "maxLength":6,
            "description":"The state of the address for the bill mailing.",
            "example":"CA"
        },
        "inCityLimit":{
            "type":"boolean",
            "description":"In City Limit switch is on if the address is considered within the physical city limits.",
            "example":"true"
        },
        "taxVendorGeographicalCode":{
            "type":"string",
            "maxLength":11,
            "description":"Geographical Code"
        }
    }
}

Nested Schema : billRoutingParameters

Type: object

Show Source

batchControl: object batchControl

Batch Control is the identifier of the batch of bills in which the recipient's copy was downloaded.
batchNumber: number

Minimum Value: -9999999999

Maximum Value: 9999999999

Batch 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 ` - Summary

Example: D
billPrintIntercept: object billPrintIntercept

Intercept is the User ID of the individual who wants to review the bill before it is sent to the customer.
billRouteType: object billRouteType

Bill Route Type is the method used to transmit the bill to the customer.
billRoutingMethod: string

Allowed Values: [ "EB ", "EM ", "FX ", "P " ]

Bill Routing Method is the method used to transmit the bill to the customer. * `EB ` - EDI Billing, * `EM ` - Email, * `FX ` - Fax, * `P ` - Postal

Example: EM
customerPOId: string

Maximum Length: 20

PO 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
extractDateTime: string (date-time)

Date Time that the bill was extracted for delivery to the recipient.
isReprint: boolean

Reprint is defined as true if a user created this routing. This option is populated by the system and is always protected.

Example: false
numberOfCopies: number

Minimum Value: -99

Maximum Value: 99

Number of Bill Copies indicates how many copies of the bill the person receives.

Example: 1

{
    "type":"object",
    "properties":{
        "billRouteType":{
            "type":"object",
            "description":"Bill Route Type is the method used to transmit the bill to the customer.",
            "properties":{
                "billRouteType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Bill Route Type is the method used to transmit the bill to the customer."
                }
            }
        },
        "billRoutingMethod":{
            "type":"string",
            "enum":[
                "EB  ",
                "EM  ",
                "FX  ",
                "P   "
            ],
            "description":"Bill Routing Method is the method used to transmit the bill to the customer.\n* `EB  ` - EDI Billing,\n* `EM  ` - Email,\n* `FX  ` - Fax,\n* `P   ` - Postal",
            "example":"EM"
        },
        "batchControl":{
            "type":"object",
            "description":"Batch Control is the identifier of the batch of bills in which the recipient's copy was downloaded.",
            "properties":{
                "batchControl":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Batch Control is the identifier of the batch of bills in which the recipient's copy was downloaded.",
                    "example":"POSTROUT"
                }
            }
        },
        "batchNumber":{
            "type":"number",
            "maximum":"9999999999",
            "minimum":"-9999999999",
            "description":"Batch Number is used to view information and statistics on the batch run's threads.",
            "example":"223"
        },
        "billPrintIntercept":{
            "type":"object",
            "description":"Intercept is the User ID of the individual who wants to review the bill before it is sent to the customer.",
            "properties":{
                "billPrintIntercept":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Intercept is the User ID of the individual who wants to review the bill before it is sent to the customer."
                }
            }
        },
        "billFormat":{
            "type":"string",
            "enum":[
                "D   ",
                "S   "
            ],
            "description":"Bill Format Indicates if the customer should receive a detailed or a summary bill.\n* `D   ` - Detailed,\n* `S   ` - Summary",
            "example":"D"
        },
        "numberOfCopies":{
            "type":"number",
            "maximum":99,
            "minimum":-99,
            "description":"Number of Bill Copies indicates how many copies of the bill the person receives.",
            "example":"1"
        },
        "isReprint":{
            "type":"boolean",
            "description":"Reprint is defined as true if a user created this routing. This option is populated by the system and is always protected.",
            "example":"false"
        },
        "customerPOId":{
            "type":"string",
            "maxLength":20,
            "description":"PO ID is the purchase order Id the customer wants printed on their copy of the bill."
        },
        "doNotExtract":{
            "type":"boolean",
            "description":"Define Do Not Extract as true if the bill should not be routed to the individual.",
            "example":"false"
        },
        "extractDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Date Time that the bill was extracted for delivery to the recipient."
        }
    }
}

Nested Schema : person

Type: object

Show Source

personId: string

Maximum Length: 10

Person ID identifies the person who was originally associated with the routing record.

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID identifies the person who was originally associated with the routing record."
        }
    }
}

Nested Schema : country

Type: object

Country retrieves its default value from the installation options. The address constituents may differ depending on the Country.

Show Source

country: string

Maximum Length: 3

Country retrieves its default value from the installation options. The address constituents may differ depending on the Country.

Example: USA

{
    "type":"object",
    "description":"Country retrieves its default value from the installation options. The address constituents may differ depending on the Country.",
    "properties":{
        "country":{
            "type":"string",
            "maxLength":3,
            "description":"Country retrieves its default value from the installation options. The address constituents may differ depending on the Country.",
            "example":"USA"
        }
    }
}

Nested Schema : batchControl

Type: object

Batch Control is the identifier of the batch of bills in which the recipient's copy was downloaded.

Show Source

batchControl: string

Maximum Length: 8

Batch Control is the identifier of the batch of bills in which the recipient's copy was downloaded.

Example: POSTROUT

{
    "type":"object",
    "description":"Batch Control is the identifier of the batch of bills in which the recipient's copy was downloaded.",
    "properties":{
        "batchControl":{
            "type":"string",
            "maxLength":8,
            "description":"Batch Control is the identifier of the batch of bills in which the recipient's copy was downloaded.",
            "example":"POSTROUT"
        }
    }
}

Nested Schema : billPrintIntercept

Type: object

Intercept is the User ID of the individual who wants to review the bill before it is sent to the customer.

Show Source

billPrintIntercept: string

Maximum Length: 8

Intercept is the User ID of the individual who wants to review the bill before it is sent to the customer.

{
    "type":"object",
    "description":"Intercept is the User ID of the individual who wants to review the bill before it is sent to the customer.",
    "properties":{
        "billPrintIntercept":{
            "type":"string",
            "maxLength":8,
            "description":"Intercept is the User ID of the individual who wants to review the bill before it is sent to the customer."
        }
    }
}

Nested Schema : billRouteType

Type: object

Bill Route Type is the method used to transmit the bill to the customer.

Show Source

billRouteType: string

Maximum Length: 8

Bill Route Type is the method used to transmit the bill to the customer.

{
    "type":"object",
    "description":"Bill Route Type is the method used to transmit the bill to the customer.",
    "properties":{
        "billRouteType":{
            "type":"string",
            "maxLength":8,
            "description":"Bill Route Type is the method used to transmit the bill to the customer."
        }
    }
}

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : C1BillRoutgs

Type: object

Show Source

_self: string

_self
addressInformation: object addressInformation
billRoutingParameters: object billRoutingParameters
person: object person
sequence: number

Minimum Value: -99999

Maximum Value: 99999

Sequence is the system-assigned identifier assigned to this bill routing.

Example: 2
version: number

Minimum Value: -99999

Maximum Value: 99999

The Version number is used for internal concurrency checks.

Example: 1

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "person":{
            "type":"object",
            "properties":{
                "personId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Person ID identifies the person who was originally associated with the routing record."
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "sequence":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Sequence is the system-assigned identifier assigned to this bill routing.",
            "example":"2"
        },
        "billRoutingParameters":{
            "type":"object",
            "properties":{
                "billRouteType":{
                    "type":"object",
                    "description":"Bill Route Type is the method used to transmit the bill to the customer.",
                    "properties":{
                        "billRouteType":{
                            "type":"string",
                            "maxLength":8,
                            "description":"Bill Route Type is the method used to transmit the bill to the customer."
                        },
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        }
                    }
                },
                "billRoutingMethod":{
                    "type":"string",
                    "enum":[
                        "EB  ",
                        "EM  ",
                        "FX  ",
                        "P   "
                    ],
                    "description":"Bill Routing Method is the method used to transmit the bill to the customer.\n* `EB  ` - EDI Billing,\n* `EM  ` - Email,\n* `FX  ` - Fax,\n* `P   ` - Postal",
                    "example":"EM"
                },
                "batchControl":{
                    "type":"object",
                    "description":"Batch Control is the identifier of the batch of bills in which the recipient's copy was downloaded.",
                    "properties":{
                        "batchControl":{
                            "type":"string",
                            "maxLength":8,
                            "description":"Batch Control is the identifier of the batch of bills in which the recipient's copy was downloaded.",
                            "example":"POSTROUT"
                        },
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        }
                    }
                },
                "batchNumber":{
                    "type":"number",
                    "maximum":"9999999999",
                    "minimum":"-9999999999",
                    "description":"Batch Number is used to view information and statistics on the batch run's threads.",
                    "example":"223"
                },
                "billPrintIntercept":{
                    "type":"object",
                    "description":"Intercept is the User ID of the individual who wants to review the bill before it is sent to the customer.",
                    "properties":{
                        "billPrintIntercept":{
                            "type":"string",
                            "maxLength":8,
                            "description":"Intercept is the User ID of the individual who wants to review the bill before it is sent to the customer."
                        },
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        }
                    }
                },
                "billFormat":{
                    "type":"string",
                    "enum":[
                        "D   ",
                        "S   "
                    ],
                    "description":"Bill Format Indicates if the customer should receive a detailed or a summary bill.\n* `D   ` - Detailed,\n* `S   ` - Summary",
                    "example":"D"
                },
                "numberOfCopies":{
                    "type":"number",
                    "maximum":99,
                    "minimum":-99,
                    "description":"Number of Bill Copies indicates how many copies of the bill the person receives.",
                    "example":"1"
                },
                "isReprint":{
                    "type":"boolean",
                    "description":"Reprint is defined as true if a user created this routing. This option is populated by the system and is always protected.",
                    "example":"false"
                },
                "customerPOId":{
                    "type":"string",
                    "maxLength":20,
                    "description":"PO ID is the purchase order Id the customer wants printed on their copy of the bill."
                },
                "doNotExtract":{
                    "type":"boolean",
                    "description":"Define Do Not Extract as true if the bill should not be routed to the individual.",
                    "example":"false"
                },
                "extractDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Date Time that the bill was extracted for delivery to the recipient."
                }
            }
        },
        "addressInformation":{
            "type":"object",
            "properties":{
                "name1":{
                    "type":"string",
                    "maxLength":254,
                    "description":"If the recipient has an override mailing name, Name1, Name2, and Name3 contain the person's override mailing name. Otherwise, Name1 contains the recipient's primary name.",
                    "example":"Bill,Louie"
                },
                "name2":{
                    "type":"string",
                    "maxLength":254,
                    "description":"If the recipient has an override mailing name, Name1, Name2, and Name3 contain the person's override mailing name."
                },
                "name3":{
                    "type":"string",
                    "maxLength":254,
                    "description":"If the recipient has an override mailing name, Name1, Name2, and Name3 contain the person's override mailing name."
                },
                "country":{
                    "type":"object",
                    "description":"Country retrieves its default value from the installation options. The address constituents may differ depending on the Country.",
                    "properties":{
                        "country":{
                            "type":"string",
                            "maxLength":3,
                            "description":"Country retrieves its default value from the installation options. The address constituents may differ depending on the Country.",
                            "example":"USA"
                        },
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        }
                    }
                },
                "postal":{
                    "type":"string",
                    "maxLength":12,
                    "description":"The postal code of the address for the bill mailing."
                },
                "address1":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The first line of the address for the bill mailing."
                },
                "address2":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The second line of the address for the bill mailing."
                },
                "address3":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The third line of the address for the bill mailing."
                },
                "address4":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The fourth line of the address for the bill mailing."
                },
                "city":{
                    "type":"string",
                    "maxLength":90,
                    "description":"The city of the address for the bill mailing.",
                    "example":"San Francisco"
                },
                "number1":{
                    "type":"string",
                    "maxLength":6,
                    "description":"The first street number line of the address for the bill mailing."
                },
                "number2":{
                    "type":"string",
                    "maxLength":4,
                    "description":"The second street number line of the address for the bill mailing."
                },
                "houseType":{
                    "type":"string",
                    "enum":[
                    ],
                    "description":"House Type indicates the type of house if applicable for this address.\n",
                    "example":"AB"
                },
                "county":{
                    "type":"string",
                    "maxLength":90,
                    "description":"The county of the address for the bill mailing."
                },
                "state":{
                    "type":"string",
                    "maxLength":6,
                    "description":"The state of the address for the bill mailing.",
                    "example":"CA"
                },
                "inCityLimit":{
                    "type":"boolean",
                    "description":"In City Limit switch is on if the address is considered within the physical city limits.",
                    "example":"true"
                },
                "taxVendorGeographicalCode":{
                    "type":"string",
                    "maxLength":11,
                    "description":"Geographical Code"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks.",
            "example":"1"
        }
    },
    "xml":{
        "name":"C1BillRoutgs"
    }
}

Nested Schema : addressInformation

Type: object

Show Source

address1: string

Maximum Length: 254

The first line of the address for the bill mailing.
address2: string

Maximum Length: 254

The second line of the address for the bill mailing.
address3: string

Maximum Length: 254

The third line of the address for the bill mailing.
address4: string

Maximum Length: 254

The fourth line of the address for the bill mailing.
city: string

Maximum Length: 90

The city of the address for the bill mailing.

Example: San Francisco
country: object country

Country retrieves its default value from the installation options. The address constituents may differ depending on the Country.
county: string

Maximum Length: 90

The county of the address for the bill mailing.
houseType: string

House Type indicates the type of house if applicable for this address.

Example: AB
inCityLimit: boolean

In City Limit switch is on if the address is considered within the physical city limits.

Example: true
name1: string

Maximum Length: 254

If the recipient has an override mailing name, Name1, Name2, and Name3 contain the person's override mailing name. Otherwise, Name1 contains the recipient's primary name.

Example: Bill,Louie
name2: string

Maximum Length: 254

If the recipient has an override mailing name, Name1, Name2, and Name3 contain the person's override mailing name.
name3: string

Maximum Length: 254

If the recipient has an override mailing name, Name1, Name2, and Name3 contain the person's override mailing name.
number1: string

Maximum Length: 6

The first street number line of the address for the bill mailing.
number2: string

Maximum Length: 4

The second street number line of the address for the bill mailing.
postal: string

Maximum Length: 12

The postal code of the address for the bill mailing.
state: string

Maximum Length: 6

The state of the address for the bill mailing.

Example: CA
taxVendorGeographicalCode: string

Maximum Length: 11

Geographical Code

{
    "type":"object",
    "properties":{
        "name1":{
            "type":"string",
            "maxLength":254,
            "description":"If the recipient has an override mailing name, Name1, Name2, and Name3 contain the person's override mailing name. Otherwise, Name1 contains the recipient's primary name.",
            "example":"Bill,Louie"
        },
        "name2":{
            "type":"string",
            "maxLength":254,
            "description":"If the recipient has an override mailing name, Name1, Name2, and Name3 contain the person's override mailing name."
        },
        "name3":{
            "type":"string",
            "maxLength":254,
            "description":"If the recipient has an override mailing name, Name1, Name2, and Name3 contain the person's override mailing name."
        },
        "country":{
            "type":"object",
            "description":"Country retrieves its default value from the installation options. The address constituents may differ depending on the Country.",
            "properties":{
                "country":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Country retrieves its default value from the installation options. The address constituents may differ depending on the Country.",
                    "example":"USA"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "postal":{
            "type":"string",
            "maxLength":12,
            "description":"The postal code of the address for the bill mailing."
        },
        "address1":{
            "type":"string",
            "maxLength":254,
            "description":"The first line of the address for the bill mailing."
        },
        "address2":{
            "type":"string",
            "maxLength":254,
            "description":"The second line of the address for the bill mailing."
        },
        "address3":{
            "type":"string",
            "maxLength":254,
            "description":"The third line of the address for the bill mailing."
        },
        "address4":{
            "type":"string",
            "maxLength":254,
            "description":"The fourth line of the address for the bill mailing."
        },
        "city":{
            "type":"string",
            "maxLength":90,
            "description":"The city of the address for the bill mailing.",
            "example":"San Francisco"
        },
        "number1":{
            "type":"string",
            "maxLength":6,
            "description":"The first street number line of the address for the bill mailing."
        },
        "number2":{
            "type":"string",
            "maxLength":4,
            "description":"The second street number line of the address for the bill mailing."
        },
        "houseType":{
            "type":"string",
            "enum":[
            ],
            "description":"House Type indicates the type of house if applicable for this address.\n",
            "example":"AB"
        },
        "county":{
            "type":"string",
            "maxLength":90,
            "description":"The county of the address for the bill mailing."
        },
        "state":{
            "type":"string",
            "maxLength":6,
            "description":"The state of the address for the bill mailing.",
            "example":"CA"
        },
        "inCityLimit":{
            "type":"boolean",
            "description":"In City Limit switch is on if the address is considered within the physical city limits.",
            "example":"true"
        },
        "taxVendorGeographicalCode":{
            "type":"string",
            "maxLength":11,
            "description":"Geographical Code"
        }
    }
}

Nested Schema : billRoutingParameters

Type: object

Show Source

batchControl: object batchControl

Batch Control is the identifier of the batch of bills in which the recipient's copy was downloaded.
batchNumber: number

Minimum Value: -9999999999

Maximum Value: 9999999999

Batch 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 ` - Summary

Example: D
billPrintIntercept: object billPrintIntercept

Intercept is the User ID of the individual who wants to review the bill before it is sent to the customer.
billRouteType: object billRouteType

Bill Route Type is the method used to transmit the bill to the customer.
billRoutingMethod: string

Allowed Values: [ "EB ", "EM ", "FX ", "P " ]

Bill Routing Method is the method used to transmit the bill to the customer. * `EB ` - EDI Billing, * `EM ` - Email, * `FX ` - Fax, * `P ` - Postal

Example: EM
customerPOId: string

Maximum Length: 20

PO 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
extractDateTime: string (date-time)

Date Time that the bill was extracted for delivery to the recipient.
isReprint: boolean

Reprint is defined as true if a user created this routing. This option is populated by the system and is always protected.

Example: false
numberOfCopies: number

Minimum Value: -99

Maximum Value: 99

Number of Bill Copies indicates how many copies of the bill the person receives.

Example: 1

{
    "type":"object",
    "properties":{
        "billRouteType":{
            "type":"object",
            "description":"Bill Route Type is the method used to transmit the bill to the customer.",
            "properties":{
                "billRouteType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Bill Route Type is the method used to transmit the bill to the customer."
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "billRoutingMethod":{
            "type":"string",
            "enum":[
                "EB  ",
                "EM  ",
                "FX  ",
                "P   "
            ],
            "description":"Bill Routing Method is the method used to transmit the bill to the customer.\n* `EB  ` - EDI Billing,\n* `EM  ` - Email,\n* `FX  ` - Fax,\n* `P   ` - Postal",
            "example":"EM"
        },
        "batchControl":{
            "type":"object",
            "description":"Batch Control is the identifier of the batch of bills in which the recipient's copy was downloaded.",
            "properties":{
                "batchControl":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Batch Control is the identifier of the batch of bills in which the recipient's copy was downloaded.",
                    "example":"POSTROUT"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "batchNumber":{
            "type":"number",
            "maximum":"9999999999",
            "minimum":"-9999999999",
            "description":"Batch Number is used to view information and statistics on the batch run's threads.",
            "example":"223"
        },
        "billPrintIntercept":{
            "type":"object",
            "description":"Intercept is the User ID of the individual who wants to review the bill before it is sent to the customer.",
            "properties":{
                "billPrintIntercept":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Intercept is the User ID of the individual who wants to review the bill before it is sent to the customer."
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "billFormat":{
            "type":"string",
            "enum":[
                "D   ",
                "S   "
            ],
            "description":"Bill Format Indicates if the customer should receive a detailed or a summary bill.\n* `D   ` - Detailed,\n* `S   ` - Summary",
            "example":"D"
        },
        "numberOfCopies":{
            "type":"number",
            "maximum":99,
            "minimum":-99,
            "description":"Number of Bill Copies indicates how many copies of the bill the person receives.",
            "example":"1"
        },
        "isReprint":{
            "type":"boolean",
            "description":"Reprint is defined as true if a user created this routing. This option is populated by the system and is always protected.",
            "example":"false"
        },
        "customerPOId":{
            "type":"string",
            "maxLength":20,
            "description":"PO ID is the purchase order Id the customer wants printed on their copy of the bill."
        },
        "doNotExtract":{
            "type":"boolean",
            "description":"Define Do Not Extract as true if the bill should not be routed to the individual.",
            "example":"false"
        },
        "extractDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Date Time that the bill was extracted for delivery to the recipient."
        }
    }
}

Nested Schema : person

Type: object

Show Source

_link: string

_link
personId: string

Maximum Length: 10

Person ID identifies the person who was originally associated with the routing record.

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID identifies the person who was originally associated with the routing record."
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : country

Type: object

Country retrieves its default value from the installation options. The address constituents may differ depending on the Country.

Show Source

_link: string

_link
country: string

Maximum Length: 3

Country retrieves its default value from the installation options. The address constituents may differ depending on the Country.

Example: USA

{
    "type":"object",
    "description":"Country retrieves its default value from the installation options. The address constituents may differ depending on the Country.",
    "properties":{
        "country":{
            "type":"string",
            "maxLength":3,
            "description":"Country retrieves its default value from the installation options. The address constituents may differ depending on the Country.",
            "example":"USA"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : batchControl

Type: object

Batch Control is the identifier of the batch of bills in which the recipient's copy was downloaded.

Show Source

_link: string

_link
batchControl: string

Maximum Length: 8

Batch Control is the identifier of the batch of bills in which the recipient's copy was downloaded.

Example: POSTROUT

{
    "type":"object",
    "description":"Batch Control is the identifier of the batch of bills in which the recipient's copy was downloaded.",
    "properties":{
        "batchControl":{
            "type":"string",
            "maxLength":8,
            "description":"Batch Control is the identifier of the batch of bills in which the recipient's copy was downloaded.",
            "example":"POSTROUT"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : billPrintIntercept

Type: object

Intercept is the User ID of the individual who wants to review the bill before it is sent to the customer.

Show Source

_link: string

_link
billPrintIntercept: string

Maximum Length: 8

Intercept is the User ID of the individual who wants to review the bill before it is sent to the customer.

{
    "type":"object",
    "description":"Intercept is the User ID of the individual who wants to review the bill before it is sent to the customer.",
    "properties":{
        "billPrintIntercept":{
            "type":"string",
            "maxLength":8,
            "description":"Intercept is the User ID of the individual who wants to review the bill before it is sent to the customer."
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : billRouteType

Type: object

Bill Route Type is the method used to transmit the bill to the customer.

Show Source

_link: string

_link
billRouteType: string

Maximum Length: 8

Bill Route Type is the method used to transmit the bill to the customer.

{
    "type":"object",
    "description":"Bill Route Type is the method used to transmit the bill to the customer.",
    "properties":{
        "billRouteType":{
            "type":"string",
            "maxLength":8,
            "description":"Bill Route Type is the method used to transmit the bill to the customer."
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

400 Response

Bad Request

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

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."
        }
    }
}