Jump to

• Request
• Response
• Examples

Adjust an A/R Item's Currency Balance

post

/bcws/webresources/v1.0/adjustments/item/{id}

Adjusts the currency balance for the specified A/R item. For example, provide a $5 credit adjustment for a purchase fee.

Request

Path Parameters

• id(required): string
  The ID of the A/R item.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• actionAffectsRef: object ResourceRef
• amount(required): number
  The amount of the adjustment.
• amountIsCredit: boolean
  Default Value: true

  Whether the adjustment is a credit (true) or a debit (false).
• effective: string (date-time)
  The date and time the adjustment takes effect.
• extension: object extension
  The extended attributes.
• includeTax: boolean
  Default Value: true

  Whether to include the tax in the adjustment (true) or not (false).
• notes: object Notes
• resourceId: integer (int32)
  The ID of the resource to adjust.

{
    "required":[
        "amount"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "actionAffectsRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "effective":{
            "type":"string",
            "description":"The date and time the adjustment takes effect.",
            "format":"date-time"
        },
        "notes":{
            "$ref":"#/components/schemas/Notes"
        },
        "amount":{
            "type":"number",
            "description":"The amount of the adjustment."
        },
        "amountIsCredit":{
            "type":"boolean",
            "description":"Whether the adjustment is a credit (<b>true</b>) or a debit (<b>false</b>).",
            "default":true
        },
        "resourceId":{
            "type":"integer",
            "description":"The ID of the resource to adjust.",
            "format":"int32"
        },
        "includeTax":{
            "type":"boolean",
            "description":"Whether to include the tax in the adjustment (<b>true</b>) or not (<b>false</b>).",
            "default":true
        }
    },
    "xml":{
        "name":"adjustmentItem"
    }
}

Nested Schema : ResourceRef

Type: object

Show Source

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

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

Nested Schema : 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 : 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."
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• actionAffectsRef: object ResourceRef
• amount(required): number
  The amount of the adjustment.
• amountIsCredit: boolean
  Default Value: true

  Whether the adjustment is a credit (true) or a debit (false).
• effective: string (date-time)
  The date and time the adjustment takes effect.
• extension: object extension
  The extended attributes.
• includeTax: boolean
  Default Value: true

  Whether to include the tax in the adjustment (true) or not (false).
• notes: object Notes
• resourceId: integer (int32)
  The ID of the resource to adjust.

{
    "required":[
        "amount"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "actionAffectsRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "effective":{
            "type":"string",
            "description":"The date and time the adjustment takes effect.",
            "format":"date-time"
        },
        "notes":{
            "$ref":"#/components/schemas/Notes"
        },
        "amount":{
            "type":"number",
            "description":"The amount of the adjustment."
        },
        "amountIsCredit":{
            "type":"boolean",
            "description":"Whether the adjustment is a credit (<b>true</b>) or a debit (<b>false</b>).",
            "default":true
        },
        "resourceId":{
            "type":"integer",
            "description":"The ID of the resource to adjust.",
            "format":"int32"
        },
        "includeTax":{
            "type":"boolean",
            "description":"Whether to include the tax in the adjustment (<b>true</b>) or not (<b>false</b>).",
            "default":true
        }
    },
    "xml":{
        "name":"adjustmentItem"
    }
}

Nested Schema : ResourceRef

Type: object

Show Source

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

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

Nested Schema : 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 : 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."
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

201 Response

The A/R item's currency balance was adjusted successfully.

Body ()

Root Schema : adjustmentBill

Type: object

Show Source

• actionAffectsRef: object ResourceRef
• amount(required): number
  The amount of the adjustment.
• amountIsCredit: boolean
  Default Value: true

  Whether the adjustment is a credit (true) or a debit (false).
• billItem: array billItem
  The bill item details.
• effective: string (date-time)
  The date and time the adjustment takes effect.
• extension: object extension
  The extended attributes.
• includeTax: boolean
  Default Value: true

  Whether to include the tax in the adjustment (true) or not (false).
• notes: object Notes
• percent: number
  The amount of the adjustment, as a percentage. For example, enter 5 for 5%.
• resourceId: integer (int32)
  The ID of the resource to adjust.

{
    "required":[
        "amount"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "actionAffectsRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "effective":{
            "type":"string",
            "description":"The date and time the adjustment takes effect.",
            "format":"date-time"
        },
        "notes":{
            "$ref":"#/components/schemas/Notes"
        },
        "amount":{
            "type":"number",
            "description":"The amount of the adjustment."
        },
        "amountIsCredit":{
            "type":"boolean",
            "description":"Whether the adjustment is a credit (<b>true</b>) or a debit (<b>false</b>).",
            "default":true
        },
        "resourceId":{
            "type":"integer",
            "description":"The ID of the resource to adjust.",
            "format":"int32"
        },
        "includeTax":{
            "type":"boolean",
            "description":"Whether to include the tax in the adjustment (<b>true</b>) or not (<b>false</b>).",
            "default":true
        },
        "percent":{
            "type":"number",
            "description":"The amount of the adjustment, as a percentage. For example, enter <b>5</b> for 5%."
        },
        "billItem":{
            "type":"array",
            "description":"The bill item details.",
            "items":{
                "$ref":"#/components/schemas/BillItem"
            }
        }
    },
    "xml":{
        "name":"adjustmentBill"
    }
}

Nested Schema : ResourceRef

Type: object

Show Source

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

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

Nested Schema : billItem

Type: array

The bill item details.

Show Source

• Array of: object billItem
  The bill item details.

{
    "type":"array",
    "description":"The bill item details.",
    "items":{
        "$ref":"#/components/schemas/BillItem"
    }
}

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 : billItem

Type: object

The bill item details.

Show Source

• accountName: string
  The name of the account.
• accountNumber: string
  The account number associated with the bill item.
• accountRef: object ResourceRef
• adjusted: number
  The total amount from debit and credit adjustments made to the bill item.
• aliasList: array aliasList
  The list of aliases in the bill item.
• amount(required): number
  The amount of the bill item.
• arBillinfoRef: object ResourceRef
• arBillRef: object ResourceRef
• billInfoId: string
  The ID of the /billinfo object.
• billinfoRef: object ResourceRef
• billNo: string
  The bill number.
• billRef: object ResourceRef
• closedDate: string (date-time)
  The date and time the bill item was closed. If the bill item is reopened for an adjustment, this is reset until the bill item is closed again.
• creationDate: string (date-time)
  The date and time the bill item was created.
• currency: integer (int32)
  The currency for the bill item, copied from the currency of the associated account.
• deltaDue: number
  The delta amount due.
• discount: number
  The amount discounted for the bill item.
• disputed: number
  The total amount from disputes associated with the bill item.
• due: number
  The amount due for the bill item.
• dueDate: string (date-time)
  The date when the amount in the bill item is due.
• extension: object extension
  The extended attributes.
• firstName: string
  The first name of the account holder.
• id(required): string
  The ID.
• itemNo: string
  The bill item's number.
• lastName: string
  The last name of the account holder.
• login: string
  The username associated with the bill item.
• name: string
  The bill item's name.
• received: number
  The amount of payments or credits applied to the bill item.
• serviceRef: object ResourceRef
• serviceTypeName: string
  The name of the service type.
• status: string
  The status of the bill item: active (10100), inactive (10102), or closed (10103)
• transfered: number
  The amount transferred out of the bill item.
• transferInto: array transferInto
• transferOut: array transferOut
• type: string
  The bill item's type.
• writeoff: number
  The amount written off for the bill item.

{
    "required":[
        "amount",
        "id"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "name":{
            "type":"string",
            "description":"The bill item's name."
        },
        "type":{
            "type":"string",
            "description":"The bill item's type."
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "arBillinfoRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "arBillRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "billRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "billinfoRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the bill item was created.",
            "format":"date-time"
        },
        "closedDate":{
            "type":"string",
            "description":"The date and time the bill item was closed. If the bill item is reopened for an adjustment, this is reset until the bill item is closed again.",
            "format":"date-time"
        },
        "currency":{
            "type":"integer",
            "description":"The currency for the bill item, copied from the currency of the associated account.",
            "format":"int32"
        },
        "deltaDue":{
            "type":"number",
            "description":"The delta amount due."
        },
        "disputed":{
            "type":"number",
            "description":"The total amount from disputes associated with the bill item."
        },
        "adjusted":{
            "type":"number",
            "description":"The total amount from debit and credit adjustments made to the bill item."
        },
        "due":{
            "type":"number",
            "description":"The amount due for the bill item."
        },
        "dueDate":{
            "type":"string",
            "description":"The date when the amount in the bill item is due.",
            "format":"date-time"
        },
        "itemNo":{
            "type":"string",
            "description":"The bill item's number."
        },
        "login":{
            "type":"string",
            "description":"The username associated with the bill item."
        },
        "received":{
            "type":"number",
            "description":"The amount of payments or credits applied to the bill item."
        },
        "transfered":{
            "type":"number",
            "description":"The amount transferred out of the bill item."
        },
        "writeoff":{
            "type":"number",
            "description":"The amount written off for the bill item."
        },
        "amount":{
            "type":"number",
            "description":"The amount of the bill item."
        },
        "discount":{
            "type":"number",
            "description":"The amount discounted for the bill item."
        },
        "billNo":{
            "type":"string",
            "description":"The bill number."
        },
        "billInfoId":{
            "type":"string",
            "description":"The ID of the /billinfo object."
        },
        "accountName":{
            "type":"string",
            "description":"The name of the account."
        },
        "firstName":{
            "type":"string",
            "description":"The first name of the account holder."
        },
        "lastName":{
            "type":"string",
            "description":"The last name of the account holder."
        },
        "serviceTypeName":{
            "type":"string",
            "description":"The name of the service type."
        },
        "accountNumber":{
            "type":"string",
            "description":"The account number associated with the bill item."
        },
        "aliasList":{
            "type":"array",
            "description":"The list of aliases in the bill item.",
            "items":{
                "$ref":"#/components/schemas/AliasList"
            }
        },
        "status":{
            "type":"string",
            "description":"The status of the bill item: active (<b>10100</b>), inactive (<b>10102</b>), or closed (<b>10103</b>)"
        },
        "transferInto":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TransferInto"
            }
        },
        "transferOut":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TransferOut"
            }
        }
    },
    "description":"The bill item details.",
    "xml":{
        "name":"billItem"
    }
}

Nested Schema : aliasList

Type: array

The list of aliases in the bill item.

Show Source

• Array of: object AliasList
  The list of aliases associated with the service.

{
    "type":"array",
    "description":"The list of aliases in the bill item.",
    "items":{
        "$ref":"#/components/schemas/AliasList"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : transferInto

Type: array

Show Source

• Array of: object TransferInto

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

Nested Schema : transferOut

Type: array

Show Source

• Array of: object TransferOut

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

Nested Schema : AliasList

Type: object

The list of aliases associated with the service.

Show Source

• elem: integer (int32)
• name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "elem":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        }
    },
    "description":"The list of aliases associated with the service."
}

Nested Schema : TransferInto

Type: object

Show Source

• creationDate: string (date-time)
  The creation date for the bill item from which the balance was transferred.
• due: number
  The due date for the bill item from which the balance was transferred.
• itemNo: string
  The bill item number for the bill item from which the balance was transferred.
• itemRef: object ResourceRef
• name(required): string
  The name of the bill item from which the balance was transferred.
• transfered: number
  The amount transferred from the source bill item.

{
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "itemNo":{
            "type":"string",
            "description":"The bill item number for the bill item from which the balance was transferred."
        },
        "name":{
            "type":"string",
            "description":"The name of the bill item from which the balance was transferred."
        },
        "due":{
            "type":"number",
            "description":"The due date for the bill item from which the balance was transferred."
        },
        "creationDate":{
            "type":"string",
            "description":"The creation date for the bill item from which the balance was transferred.",
            "format":"date-time"
        },
        "itemRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "transfered":{
            "type":"number",
            "description":"The amount transferred from the source bill item."
        }
    }
}

Nested Schema : TransferOut

Type: object

Show Source

• creationDate: string (date-time)
  The creation date for the bill item to which the balance was transferred.
• due: number
  The due date for the bill item to which the balance was transferred.
• itemNo: string
  The bill item number for the bill item to which the balance was transferred.
• itemRef: object ResourceRef
• name(required): string
  The name of the bill item to which the balance was transferred.
• transfered: number
  The amount transferred to the target bill item.

{
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "itemNo":{
            "type":"string",
            "description":"The bill item number for the bill item to which the balance was transferred."
        },
        "name":{
            "type":"string",
            "description":"The name of the bill item to which the balance was transferred."
        },
        "due":{
            "type":"number",
            "description":"The due date for the bill item to which the balance was transferred."
        },
        "creationDate":{
            "type":"string",
            "description":"The creation date for the bill item to which the balance was transferred.",
            "format":"date-time"
        },
        "itemRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "transfered":{
            "type":"number",
            "description":"The amount transferred to the target bill item."
        }
    }
}

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

400 Response

The request isn't valid.

500 Response

An internal server error occurred.

Back to Top

Examples

This example shows how to adjust an A/R item's currency balance by submitting a POST request on the REST resource using cURL. For more information about cURL, see "Use cURL".

cURL Command

curl -X POST 'http://hostname:port/bcws/webresources/v1.0/adjustments/item/0.0.0.1+-item-adjustment+272577' -H 'content-type: application/json' -d @adjust.json

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.
• adjust.json is the JSON file that specifies the adjustment to make.

Example of Request Body

This example shows the contents of the adjust.json file sent as the request body.

{
    "amount": -1,
    "percent": -10.05,
    "notes": {
        "amount": 1,
        "type": 100
        "subtype": 105
        "domainId": 38,
        "accountId": "0.0.0.1+-account+81329",
        "billUnitId": "0.0.0.1+-billinfo+78769",
        "reasonId": 1,
        "status": 101,
        "comments": [
            {
                "comment": "Sample comment."
            }
        ]
    },
    "includeTax": false
}

Example of Response Body

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

{
    "extension": null,
    "actionAffectsRef": null,
    "effective": null,
    "notes": {
        "extension": null,
        "id": "0.0.0.1+-note+272065",
        "accountId": "0.0.0.1+-account+81329",
        "amount": 1,
        "billUnitId": "0.0.0.1+-billinfo+78769",
        "billId": null,
        "closedDate": null,
        "count": null,
        "effectiveDate": null,
        "eventId": null,
        "header": null,
        "itemId": "0.0.0.1+-item-adjustment+272577",
        "subType": 202,
        "type": 200,
        "domainId": 24,
        "reasonId": 1,
        "serviceId": null,
        "status": 101,
        "comments": [
            {
                "csrLoginId": null,
                "csrFirstName": "Joe",
                "csrLastName": "Miller",
                "csrAccountId": null,
                "externalUser": "Test Client",
                "comment": "A sample comment.",
                "trackingId": null,
                "entryDate": null
            }
        ]
    },
    "amount": -1,
    "amountIsCredit": null,
    "resourceId": null,
    "includeTax": false,
    "percent": null,
    "billItem": []
}

Back to Top