Jump to

• Request
• Response
• Examples

Get Tax Details for an Account

get

/bcws/webresources/v1.0/accounts/taxinfo/{id}

Gets the tax details for the account that matches the specified ID.

Request

Path Parameters

• id(required): string
  The ID of an account, such as 0.0.0.1+-account+123123.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The account's tax details were returned successfully.

Body ()

Root Schema : taxInfo

Type: object

Show Source

• businessAccount: boolean
  Whether this is a business account (true) or not (false).
• extension: object extension
  The extended attributes.
• insideIncorporatedArea: boolean
  Whether the customer is located inside the incorporated area of a city (true) or not (false).
• notes: object Notes
• taxExemptDetails: array taxExemptDetails
  The details associated with a tax exemption.

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "businessAccount":{
            "type":"boolean",
            "description":"Whether this is a business account (<b>true</b>) or not (<b>false</b>).",
            "xml":{
                "name":"BusinessAccount"
            }
        },
        "insideIncorporatedArea":{
            "type":"boolean",
            "description":"Whether the customer is located inside the incorporated area of a city (<b>true</b>) or not (<b>false</b>).",
            "xml":{
                "name":"InsideIncorporatedArea"
            }
        },
        "notes":{
            "$ref":"#/components/schemas/Notes"
        },
        "taxExemptDetails":{
            "type":"array",
            "description":"The details associated with a tax exemption.",
            "items":{
                "$ref":"#/components/schemas/TaxExemptDetails"
            }
        }
    },
    "xml":{
        "name":"taxInfo"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : Notes

Type: object

Show Source

• accountId(required): string
  The ID of the account associated with the note.
• amount: number
  The amount associated with the note. It can be a payment amount, adjustment amount, or so on.
• billId: string
  The ID of the bill associated with the note.
• billUnitId: string
  The ID of the bill unit associated with the note.
• closedDate: string (date-time)
  The date and time the note was resolved.
• comments: array comments
  The list of comments associated with the note.
• count: integer (int32)
  The number of comments associated with the note.
• domainId: integer (int32)
  The domain ID associated with the note.
• effectiveDate: string (date-time)
  The date and time the comment was posted.
• eventId: string
  The ID of the event associated with the note.
• extension: object extension
  The extended attributes.
• header: string
  The header associated with the note.
• id: string
  The ID.
• itemId: string
  The ID of the item associated with the note.
• reasonId: integer (int32)
  The reason ID associated with the note. Possible values are stored in /config/reason_code_scope objects. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the reasons.locale file.
• serviceId: string
  The service ID associated with the note.
• status: number
  The note's status: not set (100), resolved (101), or unresolved (102). The default value is 102.
• subType: integer (int32)
  The note's subtype. Possible values are stored in the /config/note_type object. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the note.locale file.
• type: integer (int32)
  The note's type. Possible values are stored in the /config/note_type object. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the note.locale file.

{
    "required":[
        "accountId"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "accountId":{
            "type":"string",
            "description":"The ID of the account associated with the note."
        },
        "amount":{
            "type":"number",
            "description":"The amount associated with the note. It can be a payment amount, adjustment amount, or so on."
        },
        "billUnitId":{
            "type":"string",
            "description":"The ID of the bill unit associated with the note."
        },
        "billId":{
            "type":"string",
            "description":"The ID of the bill associated with the note."
        },
        "closedDate":{
            "type":"string",
            "description":"The date and time the note was resolved.",
            "format":"date-time"
        },
        "count":{
            "type":"integer",
            "description":"The number of comments associated with the note.",
            "format":"int32"
        },
        "effectiveDate":{
            "type":"string",
            "description":"The date and time the comment was posted.",
            "format":"date-time"
        },
        "eventId":{
            "type":"string",
            "description":"The ID of the event associated with the note."
        },
        "header":{
            "type":"string",
            "description":"The header associated with the note."
        },
        "itemId":{
            "type":"string",
            "description":"The ID of the item associated with the note."
        },
        "subType":{
            "type":"integer",
            "description":"The note's subtype. Possible values are stored in the <b>/config/note_type</b> object. See <a href=\"http://docs.oracle.com/pls/topic/lookup?ctx=brm120&id=GUID-D733989B-5B0E-4643-B70A-77B62A73314D\">Localizing and Customizing Strings</a> in <i>BRM Developer's Guide</i> for information about how to customize these values using the <b>note.</b><i>locale</i> file.",
            "format":"int32"
        },
        "type":{
            "type":"integer",
            "description":"The note's type. Possible values are stored in the <b>/config/note_type</b> object. See <a href=\"http://docs.oracle.com/pls/topic/lookup?ctx=brm120&id=GUID-D733989B-5B0E-4643-B70A-77B62A73314D\">Localizing and Customizing Strings</a> in <i>BRM Developer's Guide</i> for information about how to customize these values using the <b>note.</b><i>locale</i> file.",
            "format":"int32"
        },
        "domainId":{
            "type":"integer",
            "description":"The domain ID associated with the note.",
            "format":"int32"
        },
        "reasonId":{
            "type":"integer",
            "description":"The reason ID associated with the note. Possible values are stored in <b>/config/reason_code_scope</b> objects. See <a href=\"http://docs.oracle.com/pls/topic/lookup?ctx=brm120&id=GUID-D733989B-5B0E-4643-B70A-77B62A73314D\">Localizing and Customizing Strings</a> in <i>BRM Developer's Guide</i> for information about how to customize these values using the <b>reasons.</b><i>locale</i> file.",
            "format":"int32"
        },
        "serviceId":{
            "type":"string",
            "description":"The service ID associated with the note."
        },
        "status":{
            "type":"number",
            "description":"The note's status: not set (<b>100</b>), resolved (<b>101</b>), or unresolved (<b>102</b>). The default value is <b>102</b>."
        },
        "comments":{
            "type":"array",
            "description":"The list of comments associated with the note.",
            "items":{
                "$ref":"#/components/schemas/Comments"
            }
        }
    }
}

Nested Schema : taxExemptDetails

Type: array

The details associated with a tax exemption.

Show Source

• Array of: object TaxExemptDetails
  The details associated with a tax exemption.

{
    "type":"array",
    "description":"The details associated with a tax exemption.",
    "items":{
        "$ref":"#/components/schemas/TaxExemptDetails"
    }
}

Nested Schema : comments

Type: array

The list of comments associated with the note.

Show Source

• Array of: object Comments
  The list of comments associated with the note.

{
    "type":"array",
    "description":"The list of comments associated with the note.",
    "items":{
        "$ref":"#/components/schemas/Comments"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : Comments

Type: object

The list of comments associated with the note.

Show Source

• comment(required): string
  The comment.
• csrAccountId: string
  The CSR's account ID.
• csrFirstName: string
  The CSR's first name.
• csrLastName: string
  The CSR's last name.
• csrLoginId: string
  The login ID associated with the CSR.
• entryDate: string (date-time)
  The date and time the comment was entered by the CSR.
• externalUser: string
  The external user.
• trackingId: string
  The tracking ID.

{
    "required":[
        "comment"
    ],
    "type":"object",
    "properties":{
        "csrLoginId":{
            "type":"string",
            "description":"The login ID associated with the CSR."
        },
        "csrFirstName":{
            "type":"string",
            "description":"The CSR's first name."
        },
        "csrLastName":{
            "type":"string",
            "description":"The CSR's last name."
        },
        "csrAccountId":{
            "type":"string",
            "description":"The CSR's account ID."
        },
        "externalUser":{
            "type":"string",
            "description":"The external user."
        },
        "comment":{
            "type":"string",
            "description":"The comment."
        },
        "trackingId":{
            "type":"string",
            "description":"The tracking ID."
        },
        "entryDate":{
            "type":"string",
            "description":"The date and time the comment was entered by the CSR.",
            "format":"date-time"
        }
    },
    "description":"The list of comments associated with the note."
}

Nested Schema : TaxExemptDetails

Type: object

The details associated with a tax exemption.

Show Source

• certificateNumber(required): string
  The tax exemption certificate number.
• ends: string (date-time)
  The date and time the tax exemption ends.
• percent(required): number
  The percentage of the tax that is exempt, such as 50 or 100.
• starts(required): string (date-time)
  The date and time the tax exemption starts.
• taxType: integer (int32)
  The exemption jurisdiction type. Can be one of the following:

  • 0: Federal
  • 1: State
  • 2: County
  • 3: City
  • 4: Secondary county
  • 5: Secondary city
  • 6: Territory
  • 7: Secondary state
  • 8: District
  • 9: Secondary federal
  • 10: County district
  • 11: City district
  • 12: Other

{
    "required":[
        "certificateNumber",
        "percent",
        "starts"
    ],
    "type":"object",
    "properties":{
        "taxType":{
            "type":"integer",
            "description":"The exemption jurisdiction type. Can be one of the following: <ul><li><b>0</b>: Federal</li><li><b>1</b>: State</li><li><b>2</b>: County</li><li><b>3</b>: City</li><li><b>4</b>: Secondary county</li><li><b>5</b>: Secondary city</li><li><b>6</b>: Territory</li><li><b>7</b>: Secondary state</li><li><b>8</b>: District</li><li><b>9</b>: Secondary federal</li><li><b>10</b>: County district</li><li><b>11</b>: City district</li><li><b>12</b>: Other</li></ul>",
            "format":"int32"
        },
        "certificateNumber":{
            "type":"string",
            "description":"The tax exemption certificate number."
        },
        "percent":{
            "type":"number",
            "description":"The percentage of the tax that is exempt, such as 50 or 100."
        },
        "starts":{
            "type":"string",
            "description":"The date and time the tax exemption starts.",
            "format":"date-time"
        },
        "ends":{
            "type":"string",
            "description":"The date and time the tax exemption ends.",
            "format":"date-time"
        }
    },
    "description":"The details associated with a tax exemption."
}

Back to Top

Examples

This example shows how to get the tax settings for a specified account by submitting a GET request on the REST resource using cURL. For more information about cURL, see "Use cURL".

cURL Command

curl -X GET 'http://hostname:port/bcws/webresources/version/accounts/taxinfo/0.0.0.1+-account+57615'

where:

• hostname is the URL for the Billing Care REST server.
• port is the port for the Billing Care REST server.
• version is the version of the API you're using, such as v1.0.

Example of Response Body

This example shows the contents of the response body in JSON format.

{
    "extension": null,
    "businessAccount": false,
    "insideIncorporatedArea": true,
    "notes": {
        "extension": null,
        "id": "0.0.0.1+-note+280028",
        "accountId": "0.0.0.1+-account+264746",
        "amount": 0,
        "billUnitId": "0.0.0.0++0",
        "billId": null,
        "closedDate": 1612942288000,
        "count": 1,
        "effectiveDate": 1612942288000,
        "eventId": "0.0.0.0++0",
        "header": "",
        "itemId": "0.0.0.0++0",
        "subType": 601,
        "type": 600,
        "domainId": 44,
        "reasonId": 0,
        "serviceId": "0.0.0.0++0",
        "status": 101,
        "comments": [
            {
                "csrLoginId": null,
                "csrFirstName": null,
                "csrLastName": null,
                "csrAccountId": null,
                "externalUser": "user",
                "comment": "Sample comment.",
                "trackingId": "",
                "entryDate": 1612942288000
            }
        ]
    },
    "taxExemptDetails": [
        {
            "taxType": 0,
            "certificateNumber": "56709",
            "percent": 1,
            "starts": 1612988039000,
            "ends": 1613374286000
        }
    ]
}

Back to Top