Skip to main content
POST
Create WithholdingTaxRemittance record

Authorizations

X-API-KEY
string
header
required

Headers

Idempotency-Key
string

Optional. A unique value (a UUID works well) identifying this operation. If the request is repeated with the same key, the original response is replayed instead of the operation running again, so a retry cannot create a duplicate record. Results are replayable for 48 hours. Reusing a key with a different request body returns 422.

Maximum string length: 255

Query Parameters

apply_default_classifications
boolean
default:true

When false, store submitted line classifications, including an empty list. When omitted, organization defaults apply to new lines with omitted or empty classifications only when the organization setting is enabled.

Body

application/json
date
string<date>
required
company_id
integer
required
tax_agency_id
integer
required

The ID of a vendor whose vendor_type is tax_agency.

bank_account_id
integer
required

The ID of the bank or credit card account that paid the tax agency.

liability_account_id
integer
required

The ID of the withholding tax payable account that the withheld amounts are on.

lines
PublicWithholdingTaxRemittanceLineIn · object[]
required
reference_number
string | null
Required string length: 1 - 128

Response

OK

internal_id
integer
required
number
integer
required
date
string<date>
required
company_id
integer
required
company_name
string
required
currency_iso_4217_code
string
required
tax_agency_id
integer
required
tax_agency_name
string
required
bank_account_id
integer
required
liability_account_id
integer
required
record_status
enum<string>
required
Available options:
draft,
posted,
archived
total
string
required

Sum of the line amounts, in the company currency

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
lines
WithholdingTaxRemittanceLineOut · object[]
required
created_at
string<date-time>
required

Date and time the record was created

updated_at
string<date-time>
required

Date and time the record was last updated

code
string | null
reference_number
string | null