GET
View a VAT declaration (client account)
Client space Accounting module For: Accountant · Permission: vat_declarations.retrieve Conditions
  • The accounting module must be part of the organization’s plan.
Part of Declare VAT.

Authorizations

Authorization
string
header
required

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

Path Parameters

vatDeclaration
string
required

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

Query Parameters

response
enum<string>
default:resource

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

Available options:
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.

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).