GET
List VAT declarations (organization)
Organization space Accounting module For: Accountant · Permission: vat_declarations.list Conditions
  • The accounting module must be part of the organization’s plan.
  • In the organization space, the caller must have access to the book.
  • The book must have accounting set up (at least one journal).
  • fiscal_period_id, when sent, must be a fiscal period of the book.
  • sort_by accepts declared_at or created_at; per_page is 1 to 100.
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

book
string
required

Identifier of the accounting book (27-character KSUID string) whose records are worked on.

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.

data
VatDeclarationResource · object[]
required

Items of this page.

meta
object
required

Pagination details.