Settings
API Version
Product Catalog
Library

Tax withheld

Tax regulations in many countries allow taxes to be deducted by the buyer while making payments for products and services. The buyer then pays this tax to the taxation authority. The tax_withheld resource captures the details of such tax deductions.

Note:

  • This resource is available as the linked_taxes_withheld sub-resource under invoices.
  • Whenever refunds are provided against this resource, they are available as linked_tax_withheld_refunds sub-resource under credit_notes.

Sample tax withheld [ JSON ]

{ "amount": 100, "description": "Contractor payments TDS", "date": 1585050579, "id": "tax_wh_16BdDXSlbu4uV1Ee6", "reference_number": "GAPN11000100" }

API Index URL GET

https://{site}.chargebee.com/api/v2/tax_withheld

Model Class

 

      Tax withheld attributes
      
 
id
 

      string, max chars=40
 An auto-generated unique identifier for the tax withheld. The value starts with the prefix tax_wh_. For example, tax_wh_16BdDXSlbu4uV1Ee6. 
 
 
reference_number
 

      optional, string, max chars=100
 A unique external reference number for the tax withheld. Typically, this is the reference number used by the system you are integrating the API with. Depending on your integration, this could be the reference number issued by the taxation authority to identify the customer or the specific tax transaction.  
 
 
description
 

      optional, string, max chars=65k
 The description for this tax withheld. 
 
 
date
 

      optional, timestamp(UTC) in seconds
 Date or time associated with the tax withheld. 
 
 
amount
 

      optional, in cents, min=1
 The amount withheld by the customer as tax from the invoice. The unit depends on the type of currency. 
 
 
resource_version
 

      optional, long
  
 
 
updated_at
 

      optional, timestamp(UTC) in seconds
  
 
 
 
Event types
 

      This is a list of the event types we currently support. We will continue
      to add more events moving forward. All events follow a uniform pattern -
      <resource>_<event_name>. The resources that will be
      present in the event content are provided beneath each event type's
      description.
    
 
Note: If consolidated invoicing is enabled, the
      attributes invoice.subscription_id and
      credit_note.subscription_id should not be used
      (as it will not be present if the invoice / credit note has lines from
      multiple subscriptions). Instead to know the related subscriptions,
      their line_items' subscription_id attribute should be referred.
    
 
 
id id
 

          string, max chars=40
 An auto-generated unique identifier for the tax withheld. The value starts with the prefix tax_wh_. For example, tax_wh_16BdDXSlbu4uV1Ee6. 
 
reference_number reference_number
 

          optional, string, max chars=100
 A unique external reference number for the tax withheld. Typically, this is the reference number used by the system you are integrating the API with. Depending on your integration, this could be the reference number issued by the taxation authority to identify the customer or the specific tax transaction.  
 
description description
 

          optional, string, max chars=65k
 The description for this tax withheld. 
 
date date
 

          optional, timestamp(UTC) in seconds
 Date or time associated with the tax withheld. 
 
amount amount
 

          optional, in cents, min=1
 The amount withheld by the customer as tax from the invoice. The unit depends on the type of currency. 
 
resource_version resource_version
 

          optional, long
  
 
updated_at updated_at
 

          optional, timestamp(UTC) in seconds
  
 
 
 
Consent Fields for Tax withheld
 
 
Custom Fields for Tax withheld