1. REST API Reference for Billing Care
  2. Tasks
  3. Accounts

Update an Account's Tax Settings

put

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

Adds or updates the specified account's tax settings. You can add or update the following:
  • The VAT certificate
  • The tax exemptions
  • The tax incorporation information
  • Whether the tax is for a business account

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
The tax settings to add or update. All parameters are optional.
Root Schema : schema
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : Notes
Type: object
Show Source
Nested Schema : taxExemptDetails
Type: array
The details associated with a tax exemption.
Show Source
Nested Schema : comments
Type: array
The list of comments associated with the note.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : Comments
Type: object
The list of comments associated with the note.
Show Source
Nested Schema : TaxExemptDetails
Type: object
The details associated with a tax exemption.
Show Source
Request Body - application/xml ()
The tax settings to add or update. All parameters are optional.
Root Schema : schema
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : Notes
Type: object
Show Source
Nested Schema : taxExemptDetails
Type: array
The details associated with a tax exemption.
Show Source
Nested Schema : comments
Type: array
The list of comments associated with the note.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : Comments
Type: object
The list of comments associated with the note.
Show Source
Nested Schema : TaxExemptDetails
Type: object
The details associated with a tax exemption.
Show Source
Back to Top

Response

200 Response

The tax information was saved successfully.

500 Response

An internal server error occurred.
Back to Top

Examples

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

cURL Command

curl -X PUT 'http://hostname:port/bcws/webresources/version/accounts/taxinfo/0.0.0.1+-account+57615' -H 'content-type: application/json' -d @updateTaxInfo.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.
  • updateTaxInfo.json is the JSON file that specifies the tax details to save.

Example of Request Body

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

{
   "extension": null,
   "businessAccount": false,
   "insideIncorporatedArea": true,
   "notes": null,
   "taxExemptDetails": [ 
      {
         "starts": "2021-02-23T12:53:26.000Z",
         "ends": "2021-02-25T12:53:26.000Z",
         "percent": 10,
         "taxType": "1",
         "certificateNumber": "908735376"
      }
   ],
}

Example of Response

If successful, the response code 200 is returned with no response body.

Back to Top