POST
Declare VAT for a period (client account)
Client space Accounting module For: Accountant · Permission: vat_declarations.create Conditions
  • The accounting module must be part of the organization’s plan.
  • The book must have accounting set up (at least one journal).
  • fiscal_period_id is required and must be a fiscal period of the book.
  • The fiscal year of the period must be open.
  • The period must have ended.
  • The period must not already be declared (one declaration per book and period).
  • Declarations run oldest first: an earlier undeclared period of the book, counted from the book’s first declared period or the start of the period’s own year if earlier, or an already declared later period, refuses the call.
What else happens
  • Creates the declaration with the totals computed from the 443 (output) and 445 (input) accounts over the period.
  • When the period has VAT movements, posts a miscellaneous-operations journal entry dated at the end of the period that clears the 443 and 445 balances; the net amount due goes to the VAT payable account (4441 in the default chart) and a net credit to the VAT credit carry-forward account (4449 in the default chart), and any credit carried from earlier periods is consumed. The entry is linked to the declaration (journal_entry_id).
  • When the period has no VAT movement, no entry is posted, journal_entry_id stays null and any earlier credit stays on 4449.
Part of Declare VAT.

Authorizations

Authorization
string
header
required

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

Query Parameters

response
enum<string>
default:none

Response mode. Default none; none answers 204 No Content.

Available options:
none,
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, owner_type, fiscal_period_id, output_vat_total, input_vat_total, prior_credit_applied, net_due, net_credit, journal_entry_id, currency_code, currency_exponent, declared_at, declared_by, declared_by_type, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: fiscalPeriod, journalEntry, journalEntry.lines, journalEntry.attachments.

Body

application/json

Shared by preview and store.

fiscal_period_id
string
required

Identifier of the fiscal period the VAT declaration covers (27-character KSUID string), a period of the selected book. Required. Used both for the preview and for creating the declaration.

Response

Resource (only with response=resource).

id

Identifier of the declaration (27-character KSUID string).

owner_type

Kind of owner of the book (for example organization or client account); set by the server.

fiscal_period_id

Identifier of the declared fiscal period (27-character KSUID string); one declaration per period.

fiscal_period
object

The fiscal period, present only when requested with ?include=fiscalPeriod and the caller has fiscal_periods.retrieve.

output_vat_total
integer

Output VAT of the period, integer in minor units (divide by 10 to the power currency_exponent).

input_vat_total
integer

Input VAT of the period, integer in minor units.

prior_credit_applied
integer

VAT credit carried from earlier periods (the VAT credit carry-forward account, 4449 in the default chart) before the period starts, integer in minor units. It is used against this period's VAT; when the period has no VAT movement it stays on that account and net_credit repeats it.

net_due
integer

VAT to pay for the period, integer in minor units; 0 when there is none.

net_credit
integer

VAT credit carried forward to the next period, integer in minor units; 0 when there is none.

journal_entry_id

Identifier of the VAT settlement journal entry; null when the period had no VAT movement to settle.

journal_entry
object

The settlement journal entry, present only when requested with ?include=journalEntry and the caller has journal_entries.retrieve.

currency_code

ISO 4217 currency code of the fiscal year, for example XOF.

currency_exponent
integer

Number of decimal places of the currency (0 for XOF). An amount in minor units divided by 10 to this power gives the amount in the currency.

declared_at

When the declaration was recorded, ISO 8601; set by the server.

declared_by

Identifier of the member or agent account that declared; null when the actor could not be validated.

declared_by_type

Kind of actor in declared_by; null when declared_by is null.

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).