Create Tax Profile | Papertracc Docs

Creates a tax profile. Input and output account IDs are required. Set kind to WHT to create a withholding tax profile. For a WHT profile, output_account_id is the withholding tax payable account (a liability account, used when you withhold from a vendor) and input_account_id is the withholding tax receivable account (an asset account, used when a customer withholds from you). withholding_basis sets whether the rate applies to the VAT-exclusive or the full amount being settled. Withholding tax profiles are not available as line taxes on invoices, bills, expenses or journals, and are excluded from the VAT return.

Requires the can_create_tax_profile permission on the key owner’s role.

Keys: secret key only.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

identitystring

The identity for the active workspace.

Request

This endpoint expects an object.

namestringRequired

ratedoubleRequired

input_account_idstringRequiredformat: "uuid"

output_account_idstringRequiredformat: "uuid"

codestringOptional3-10 characters

is_compoundbooleanOptional

is_recoverablebooleanOptional

kindenumOptionalDefaults to VAT

VAT for sales and purchase tax. WHT for withholding tax, which is deducted from a payment. Fixed once the profile is created. Profiles created before this field existed are VAT.

Allowed values:

deduct_onenumOptionalDefaults to PAYMENT

When withholding tax is deducted. Only applies to WHT profiles. PAYMENT deducts it when the vendor is paid or the customer pays. BILL is reserved and not yet supported for posting.

Allowed values:

withholding_basisenumOptionalDefaults to EXCL_VAT

What the withholding rate applies to when a payment or receipt does not state its own base. EXCL_VAT uses the VAT-exclusive share of the amount being settled. INCL_VAT uses the full amount being settled. Only applies to WHT profiles.

Allowed values:

Response

Created

dataobject

statusboolean

messagestring

Errors

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error