Tax IDs
You can add one or multiple tax IDs to a customer or account. Customer and account tax IDs get displayed on related invoices and credit notes.
Related guides: Customer tax identification numbers, Account tax IDs
The Tax ID object
Attributes
- idstring
Unique identifier for the object.
- countrynullable string
Two-letter ISO code representing the country of the tax ID.
- customernullable stringExpandable
ID of the customer.
- typeenum
Type of the tax ID, one of
ad_nrt,ae_trn,ar_cuit,au_abn,au_arn,bg_uic,bh_vat,bo_tin,br_cnpj,br_cpf,ca_bn,ca_gst_hst,ca_pst_bc,ca_pst_mb,ca_pst_sk,ca_qst,ch_vat,cl_tin,cn_tin,co_nit,cr_tin,do_rcn,ec_ruc,eg_tin,es_cif,eu_oss_vat,eu_vat,gb_vat,ge_vat,hk_br,hu_tin,id_npwp,il_vat,in_gst,is_vat,jp_cn,jp_rn,jp_trn,ke_pin,kr_brn,kz_bin,li_uid,mx_rfc,my_frp,my_itn,my_sst,ng_tin,no_vat,no_voec,nz_gst,om_vat,pe_ruc,ph_tin,ro_tin,rs_pib,ru_inn,ru_kpp,sa_vat,sg_gst,sg_uen,si_tin,sv_nit,th_vat,tr_tin,tw_vat,ua_vat,us_ein,uy_ruc,ve_rif,vn_tin, orza_vat. Note that some legacy tax IDs have typeunknown - valuestring
Value of the tax ID.
More attributes
- objectstring
- createdtimestamp
- livemodeboolean
- ownernullable object
- verificationnullable object
Create a Customer tax ID
Creates a new tax_id object for a customer.
Parameters
- typestringRequired
Type of the tax ID, one of
ad_nrt,ae_trn,ar_cuit,au_abn,au_arn,bg_uic,bh_vat,bo_tin,br_cnpj,br_cpf,ca_bn,ca_gst_hst,ca_pst_bc,ca_pst_mb,ca_pst_sk,ca_qst,ch_vat,cl_tin,cn_tin,co_nit,cr_tin,do_rcn,ec_ruc,eg_tin,es_cif,eu_oss_vat,eu_vat,gb_vat,ge_vat,hk_br,hu_tin,id_npwp,il_vat,in_gst,is_vat,jp_cn,jp_rn,jp_trn,ke_pin,kr_brn,kz_bin,li_uid,mx_rfc,my_frp,my_itn,my_sst,ng_tin,no_vat,no_voec,nz_gst,om_vat,pe_ruc,ph_tin,ro_tin,rs_pib,ru_inn,ru_kpp,sa_vat,sg_gst,sg_uen,si_tin,sv_nit,th_vat,tr_tin,tw_vat,ua_vat,us_ein,uy_ruc,ve_rif,vn_tin, orza_vat - valuestringRequired
Value of the tax ID.
Returns
The created tax_id object.
Create a tax ID
Creates a new account or customer tax_id object.
Parameters
- typestringRequired
Type of the tax ID, one of
ad_nrt,ae_trn,ar_cuit,au_abn,au_arn,bg_uic,bh_vat,bo_tin,br_cnpj,br_cpf,ca_bn,ca_gst_hst,ca_pst_bc,ca_pst_mb,ca_pst_sk,ca_qst,ch_vat,cl_tin,cn_tin,co_nit,cr_tin,do_rcn,ec_ruc,eg_tin,es_cif,eu_oss_vat,eu_vat,gb_vat,ge_vat,hk_br,hu_tin,id_npwp,il_vat,in_gst,is_vat,jp_cn,jp_rn,jp_trn,ke_pin,kr_brn,kz_bin,li_uid,mx_rfc,my_frp,my_itn,my_sst,ng_tin,no_vat,no_voec,nz_gst,om_vat,pe_ruc,ph_tin,ro_tin,rs_pib,ru_inn,ru_kpp,sa_vat,sg_gst,sg_uen,si_tin,sv_nit,th_vat,tr_tin,tw_vat,ua_vat,us_ein,uy_ruc,ve_rif,vn_tin, orza_vat - valuestringRequired
Value of the tax ID.
More parameters
- ownerobject
Returns
The created tax_id object.
Retrieve a Customer tax ID
Retrieves the tax_id object with the given identifier.
Parameters
No parameters.
Returns
Returns a tax_id object if a valid identifier was provided.