Update a Filer

patch

https://api.multi1.enterprise.taxbit.com/v1/filers/{id}

Update an existing Filer by its unique identifier. All fields are optional on update. Additional fields may be required to generate specific form types. See our Filer Data Model for details on required fields based on form type.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

required

The unique identifier (UUID) for the Filer.

Body Params

All fields are optional. Omitted fields are left unchanged. Fields that accept null can be set to null to clear their current value.

name

string

The legal name of the Filer.

address

object

tin

string | null

The Taxpayer Identification Number (TIN) of the Filer. Used for international reporting regimes. Format is validated in tandem with tax_country_code and the error response will indicate the expected format if validation fails.

ein

string | null

The Employer Identification Number (EIN) of the Filer. Primarily used for US tax reporting. Must match format XX-XXXXXXX, XXX-XX-XXXX, or 9 digits. Dashes are stripped on storage and the returned value will always be 9 digits.

tax_country_code

string

The two-character ISO 3166-1 alpha-2 country code of the country the Filer is subject to taxes in.

vat_id

string | null

The Value Added Tax (VAT) identification number of the Filer. Format is validated in tandem with vat_country and the error response will indicate the expected format if validation fails. Once stored, the masked value can be retrieved via vat_id_masked.

vat_country

string | null

The two-character ISO 3166-1 alpha-2 country code of the country the Filer's VAT is registered in. Set to null to clear.

contact_name

string | null

The name of the Filer's contact person. Set to null to clear.

contact_title

string | null

The job title of the Filer's contact person. Set to null to clear.

contact_email

string | null

The email address of the Filer's contact person. Set to null to clear.

contact_phone

string | null

The phone number of the Filer's contact person, in E.164 format. Set to null to clear.

giin

string | null

The Global Intermediary Identification Number (GIIN) of the Filer. Set to null to clear.

arn

string | null

The ATO Reference Number (ARN) of the Filer. Used for Australia SERR reporting. Must be exactly 12 numeric digits.

rtn

string | null

The Routing Transit Number (RTN) of the Filer. Set to null to clear.

form_1099_k_filer_type

string | null

enum

The filer type classification for Form 1099-K.

Allowed:

form_1099_k_transaction_type

string | null

enum

The transaction type for Form 1099-K.

Allowed:

form_1042_s_chapter_3_status

string | null

enum

The Chapter 3 withholding status for Form 1042-S.

form_1042_s_chapter_4_status

string | null

enum

The Chapter 4 (FATCA) status for Form 1042-S.

cesop_psp_ids

array of objects | null

An array of CESOP Payment Service Provider (PSP) identifiers associated with the Filer. Set to null to clear.

cesop_psp_ids

cra_account_number

string | null

The Canada Revenue Agency (CRA) account number of the Filer. Used for Canadian MRDP reporting.

cra_account_number_type

string | null

enum

The type of Canada Revenue Agency (CRA) account number.

Allowed:

cra_representative_identifier

string | null

The CRA representative identifier of the Filer. Used for Canadian MRDP reporting. Must be exactly 7 alphanumeric characters.

pse_name

string | null

The name of the Payment Settlement Entity (PSE) associated with the Filer for Form 1099-K. Set to null to clear.

pse_telephone_number

string | null

The telephone number of the Payment Settlement Entity (PSE) associated with the Filer for Form 1099-K. Set to null to clear.

dac7_receiving_member_state

string | null

enum

The EU member state designated to receive the DAC7 report.

Responses

200Filer updated successfully.

400Bad Request

401Unauthorized Error.

403Forbidden

404Not Found

429Too Many Requests - Throttling.