Tax · FinBaze for Platforms

Reference

Queries#

hmrcVatReturn#

Requires: scope tax:read · feature hmrc_mtd.

hmrcVatReturn(profileId: ID!, periodKey: String!, fraudPrevention: HmrcFraudPreventionInput): HmrcVatReturnView!

Argument	Type
`profileId`	`ID!`
`periodKey`	`String!`
`fraudPrevention`	`HmrcFraudPreventionInput`

profileTaxObligationMeters#

Requires: scope tax:read · feature tax_filings.

profileTaxObligationMeters(profileId: ID!): TaxObligationMetersPayload!

Argument	Type
`profileId`	`ID!`

taxFilingAttachment#

Requires: scope tax:read · feature tax_filings.

taxFilingAttachment(id: ID!): TaxFilingAttachment!

Argument	Type
`id`	`ID!`

taxObligation#

Requires: scope tax:read · feature tax_filings.

taxObligation(id: ID!): TaxObligation!

Argument	Type
`id`	`ID!`	The id of the record to find.

taxObligations#

Requires: scope tax:read · feature tax_filings.

taxObligations(paging: CursorPaging!, filter: TaxObligationFilter!, sorting: [TaxObligationSort!]!): TaxObligationConnection!

Argument	Type
`paging`	`CursorPaging!`	Limit or page results.
`filter`	`TaxObligationFilter!`	Specify to filter the records returned.
`sorting`	`[TaxObligationSort!]!`	Specify to sort results.

nlWageTaxObligationSettings#

Requires: scope tax:read · feature payroll.

nlWageTaxObligationSettings(paging: CursorPaging!, filter: NlWageTaxObligationSettingsFilter!, sorting: [NlWageTaxObligationSettingsSort!]!): NlWageTaxObligationSettingsConnection!

Argument	Type
`paging`	`CursorPaging!`	Limit or page results.
`filter`	`NlWageTaxObligationSettingsFilter!`	Specify to filter the records returned.
`sorting`	`[NlWageTaxObligationSettingsSort!]!`	Specify to sort results.

taxFilingOverview#

Requires: scope tax:read · feature tax_filings.

taxFilingOverview(profileId: ID!, year: Int!): TaxFilingOverview!

Argument	Type
`profileId`	`ID!`
`year`	`Int!`

taxFilingMultiYearOverview#

Requires: scope tax:read · feature tax_filings.

taxFilingMultiYearOverview(profileId: ID!, fromYear: Int!, toYear: Int!): TaxFilingMultiYearOverview!

Argument	Type
`profileId`	`ID!`
`fromYear`	`Int!`
`toYear`	`Int!`

periodTaxFilingsDue#

Requires: scope tax:read · feature tax_filings.

periodTaxFilingsDue(periodId: ID!): [PeriodTaxFilingDue!]!

Argument	Type
`periodId`	`ID!`

taxFilingPaymentSummary#

Requires: scope tax:read · feature tax_filings.

taxFilingPaymentSummary(filingId: ID!): TaxFilingPaymentSummary!

Argument	Type
`filingId`	`ID!`

computedTaxFilingVatData#

Requires: scope tax:read · feature tax_filings.

computedTaxFilingVatData(filingId: ID!): String!

Argument	Type
`filingId`	`ID!`

taxFilingPdfData#

The filing rendered as a PDF, base64. The same document as the REST download, for callers (embedded components) that only speak GraphQL.

Requires: scope tax:read · feature tax_filings.

taxFilingPdfData(id: ID!): String!

Argument	Type
`id`	`ID!`

taxFilingSubmitPreview#

What would happen if this filing were submitted now, for the current actor.

Requires: scope tax:read · feature tax_filings.

taxFilingSubmitPreview(id: ID!): TaxFilingSubmitPreview!

Argument	Type
`id`	`ID!`

tAXFiling#

Requires: scope tax:read · feature tax_filings.

tAXFiling(id: ID!): TAXFiling!

Argument	Type
`id`	`ID!`	The id of the record to find.

tAXFilings#

Requires: scope tax:read · feature tax_filings.

tAXFilings(paging: CursorPaging!, filter: TAXFilingFilter!, sorting: [TAXFilingSort!]!): TAXFilingConnection!

Argument	Type
`paging`	`CursorPaging!`	Limit or page results.
`filter`	`TAXFilingFilter!`	Specify to filter the records returned.
`sorting`	`[TAXFilingSort!]!`	Specify to sort results.

taxFilingPaymentRequests#

Requires: scope tax:read · feature tax_filings.

taxFilingPaymentRequests(profileId: ID!, taxFilingId: ID!): [PaymentRequest!]!

Argument	Type
`profileId`	`ID!`
`taxFilingId`	`ID!`

Mutations#

endTaxObligation#

Requires: scope tax:write · feature tax_filings.

endTaxObligation(id: ID!, endsAt: DateTime!): TaxObligation!

Argument	Type
`id`	`ID!`
`endsAt`	`DateTime!`

createOneTaxFilingAttachment#

Requires: scope tax:write · feature tax_filings.

createOneTaxFilingAttachment(taxFilingId: ID!, input: CreateTaxFilingAttachmentInput!): TaxFilingAttachment!

Argument	Type
`taxFilingId`	`ID!`
`input`	`CreateTaxFilingAttachmentInput!`

deleteOneTaxFilingAttachment#

Requires: scope tax:write · feature tax_filings.

deleteOneTaxFilingAttachment(input: DeleteOneTaxFilingAttachmentInput!): TaxFilingAttachment!

Argument	Type
`input`	`DeleteOneTaxFilingAttachmentInput!`

createOneTaxObligation#

Requires: scope tax:write · feature tax_filings.

createOneTaxObligation(profileId: ID!, input: CreateTaxObligationInput!): TaxObligation!

Argument	Type
`profileId`	`ID!`
`input`	`CreateTaxObligationInput!`

createManyTaxObligations#

Requires: scope tax:write · feature tax_filings.

createManyTaxObligations(profileId: ID!, input: [CreateTaxObligationInput!]!): [TaxObligation!]!

Argument	Type
`profileId`	`ID!`
`input`	`[CreateTaxObligationInput!]!`

updateOneTaxObligation#

Requires: scope tax:write · feature tax_filings.

updateOneTaxObligation(input: UpdateOneTaxObligationInput!): TaxObligation!

Argument	Type
`input`	`UpdateOneTaxObligationInput!`

updateManyTaxObligations#

Requires: scope tax:write · feature tax_filings.

updateManyTaxObligations(input: UpdateManyTaxObligationsInput!): UpdateManyResponse!

Argument	Type
`input`	`UpdateManyTaxObligationsInput!`

deleteOneTaxObligation#

Requires: scope tax:write · feature tax_filings.

deleteOneTaxObligation(input: DeleteOneTaxObligationInput!): TaxObligationDeleteResponse!

Argument	Type
`input`	`DeleteOneTaxObligationInput!`

deleteManyTaxObligations#

Requires: scope tax:write · feature tax_filings.

deleteManyTaxObligations(input: DeleteManyTaxObligationsInput!): DeleteManyResponse!

Argument	Type
`input`	`DeleteManyTaxObligationsInput!`

createOneNlWageTaxObligationSettings#

Requires: scope tax:write · feature payroll.

createOneNlWageTaxObligationSettings(profileId: ID!, input: CreateNlWageTaxObligationSettingsInput!): NlWageTaxObligationSettings!

Argument	Type
`profileId`	`ID!`
`input`	`CreateNlWageTaxObligationSettingsInput!`

createManyNlWageTaxObligationSettings#

Requires: scope tax:write · feature payroll.

createManyNlWageTaxObligationSettings(profileId: ID!, input: [CreateNlWageTaxObligationSettingsInput!]!): [NlWageTaxObligationSettings!]!

Argument	Type
`profileId`	`ID!`
`input`	`[CreateNlWageTaxObligationSettingsInput!]!`

updateOneNlWageTaxObligationSettings#

Requires: scope tax:write · feature payroll.

updateOneNlWageTaxObligationSettings(input: UpdateOneNlWageTaxObligationSettingsInput!): NlWageTaxObligationSettings!

Argument	Type
`input`	`UpdateOneNlWageTaxObligationSettingsInput!`

updateManyNlWageTaxObligationSettings#

Requires: scope tax:write · feature payroll.

updateManyNlWageTaxObligationSettings(input: UpdateManyNlWageTaxObligationSettingsInput!): UpdateManyResponse!

Argument	Type
`input`	`UpdateManyNlWageTaxObligationSettingsInput!`

deleteOneNlWageTaxObligationSettings#

Requires: scope tax:write · feature payroll.

deleteOneNlWageTaxObligationSettings(input: DeleteOneNlWageTaxObligationSettingsInput!): NlWageTaxObligationSettingsDeleteResponse!

Argument	Type
`input`	`DeleteOneNlWageTaxObligationSettingsInput!`

deleteManyNlWageTaxObligationSettings#

Requires: scope tax:write · feature payroll.

deleteManyNlWageTaxObligationSettings(input: DeleteManyNlWageTaxObligationSettingsInput!): DeleteManyResponse!

Argument	Type
`input`	`DeleteManyNlWageTaxObligationSettingsInput!`

createTaxFilingDraft#

Requires: scope tax:write · feature tax_filings.

createTaxFilingDraft(obligationId: ID!, from: DateTime!, to: DateTime!, manual: Boolean, asReturn: Boolean): TAXFiling!

Argument	Type
`obligationId`	`ID!`
`from`	`DateTime!`
`to`	`DateTime!`
`manual`	`Boolean`
`asReturn`	`Boolean`

updateTaxFilingCitData#

Requires: scope tax:write · feature tax_filings.

updateTaxFilingCitData(id: ID!, data: String!): TAXFiling!

Argument	Type
`id`	`ID!`
`data`	`String!`

updateTaxFilingUsCitData#

Requires: scope tax:write · feature tax_filings.

updateTaxFilingUsCitData(id: ID!, data: String!): TAXFiling!

Argument	Type
`id`	`ID!`
`data`	`String!`

refreshTaxFilingUsCitFromLedger#

Requires: scope tax:write · feature tax_filings.

refreshTaxFilingUsCitFromLedger(id: ID!): TAXFiling!

Argument	Type
`id`	`ID!`

refreshTaxFilingCitFromLedger#

Requires: scope tax:write · feature tax_filings.

refreshTaxFilingCitFromLedger(id: ID!): TAXFiling!

Argument	Type
`id`	`ID!`

updateTaxFilingKvkData#

Requires: scope tax:write · feature tax_filings.

updateTaxFilingKvkData(id: ID!, data: String!): TAXFiling!

Argument	Type
`id`	`ID!`
`data`	`String!`

refreshTaxFilingKvkFromLedger#

Requires: scope tax:write · feature tax_filings.

refreshTaxFilingKvkFromLedger(id: ID!): TAXFiling!

Argument	Type
`id`	`ID!`

updateTaxFilingVatData#

Requires: scope tax:write · feature tax_filings.

updateTaxFilingVatData(id: ID!, data: String!): TAXFiling!

Argument	Type
`id`	`ID!`
`data`	`String!`

updateTaxFilingIcpData#

Save hand-typed ICP supplies on a manual ICP draft (filings-only clients).

Requires: scope tax:write · feature tax_filings.

updateTaxFilingIcpData(id: ID!, data: String!): TAXFiling!

Argument	Type
`id`	`ID!`
`data`	`String!`

updateTaxFilingOssData#

Save hand-typed OSS lines on a manual OSS draft (filings-only clients).

Requires: scope tax:write · feature tax_filings.

updateTaxFilingOssData(id: ID!, data: String!): TAXFiling!

Argument	Type
`id`	`ID!`
`data`	`String!`

updateTaxFilingLateInvoices#

Re-check late invoices from filed periods on a draft VAT return and include the given ones (all within the correction threshold when omitted).

Requires: scope tax:write · feature tax_filings.

updateTaxFilingLateInvoices(id: ID!, invoiceIds: [String!]): TAXFiling!

Argument	Type
`id`	`ID!`
`invoiceIds`	`[String!]`

updateTaxFilingWageTaxData#

Requires: scope tax:write · feature tax_filings.

updateTaxFilingWageTaxData(id: ID!, data: String!): TAXFiling!

Argument	Type
`id`	`ID!`
`data`	`String!`

recordTaxFilingManually#

Requires: scope tax:write · feature tax_filings.

recordTaxFilingManually(id: ID!, data: String, bookedAt: DateTime): TAXFiling!

Argument	Type
`id`	`ID!`
`data`	`String`
`bookedAt`	`DateTime`

updateTaxFilingBookedAt#

Requires: scope tax:write · feature tax_filings.

updateTaxFilingBookedAt(id: ID!, bookedAt: DateTime!): TAXFiling!

Argument	Type
`id`	`ID!`
`bookedAt`	`DateTime!`

createTaxFilingSuppletieDraft#

Requires: scope tax:write · feature tax_filings.

createTaxFilingSuppletieDraft(correctsFilingId: ID!): TAXFiling!

Argument	Type
`correctsFilingId`	`ID!`

createTaxFilingSuppletieForPeriod#

Requires: scope tax:write · feature tax_filings.

createTaxFilingSuppletieForPeriod(obligationId: ID!, from: DateTime!, to: DateTime!): TAXFiling!

Argument	Type
`obligationId`	`ID!`
`from`	`DateTime!`
`to`	`DateTime!`

createTaxFilingUitstelDraft#

Requires: scope tax:write · feature tax_filings.

createTaxFilingUitstelDraft(obligationId: ID!, from: DateTime!, to: DateTime!, data: String): TAXFiling!

Argument	Type
`obligationId`	`ID!`
`from`	`DateTime!`
`to`	`DateTime!`
`data`	`String`

createTaxFilingBezwaarDraft#

Requires: scope tax:write · feature tax_filings.

createTaxFilingBezwaarDraft(obligationId: ID!, data: String): TAXFiling!

Argument	Type
`obligationId`	`ID!`
`data`	`String`

createTaxFilingEuVatRefundDraft#

Requires: scope tax:write · feature tax_filings.

createTaxFilingEuVatRefundDraft(obligationId: ID!, data: String): TAXFiling!

Argument	Type
`obligationId`	`ID!`
`data`	`String`

createTaxFilingVoorlopigeAanslagDraft#

Requires: scope tax:write · feature tax_filings.

createTaxFilingVoorlopigeAanslagDraft(obligationId: ID!, from: DateTime!, to: DateTime!, data: String!): TAXFiling!

Argument	Type
`obligationId`	`ID!`
`from`	`DateTime!`
`to`	`DateTime!`
`data`	`String!`

updateTaxFilingVoorlopigeAanslagData#

Requires: scope tax:write · feature tax_filings.

updateTaxFilingVoorlopigeAanslagData(id: ID!, data: String!): TAXFiling!

Argument	Type
`id`	`ID!`
`data`	`String!`

updateTaxFilingUitstelData#

Requires: scope tax:write · feature tax_filings.

updateTaxFilingUitstelData(id: ID!, data: String!): TAXFiling!

Argument	Type
`id`	`ID!`
`data`	`String!`

updateTaxFilingBezwaarData#

Requires: scope tax:write · feature tax_filings.

updateTaxFilingBezwaarData(id: ID!, data: String!): TAXFiling!

Argument	Type
`id`	`ID!`
`data`	`String!`

updateTaxFilingEuVatRefundData#

Requires: scope tax:write · feature tax_filings.

updateTaxFilingEuVatRefundData(id: ID!, data: String!): TAXFiling!

Argument	Type
`id`	`ID!`
`data`	`String!`

markTaxFilingReady#

Requires: scope tax:write · feature tax_filings.

markTaxFilingReady(id: ID!): TAXFiling!

Argument	Type
`id`	`ID!`

approveTaxFiling#

Requires: scope tax:write · feature tax_filings.

approveTaxFiling(id: ID!): TAXFiling!

Argument	Type
`id`	`ID!`

markTaxFilingDraft#

Requires: scope tax:write · feature tax_filings.

markTaxFilingDraft(id: ID!): TAXFiling!

Argument	Type
`id`	`ID!`

reopenRejectedTaxFiling#

Move a rejected or failed filing back to draft so it can be corrected and submitted again. The previous delivery is kept.

Requires: scope tax:write · feature tax_filings.

reopenRejectedTaxFiling(id: ID!): TAXFiling!

Argument	Type
`id`	`ID!`

submitTaxFiling#

Requires: scope tax:write · feature tax_filings.

submitTaxFiling(id: ID!, finalised: Boolean, fraudPrevention: HmrcFraudPreventionInput): TAXFiling!

Argument	Type
`id`	`ID!`
`finalised`	`Boolean`
`fraudPrevention`	`HmrcFraudPreventionInput`

deleteTaxFilingDraft#

Requires: scope tax:write · feature tax_filings.

deleteTaxFilingDraft(id: ID!): TAXFiling!

Argument	Type
`id`	`ID!`

initiateTaxFilingPayment#

Requires: scope tax:write · feature tax_filings.

initiateTaxFilingPayment(id: ID!, returnPath: String, returnTarget: TaxPaymentReturnTarget): TaxFilingPaymentInitiation!

Argument	Type
`id`	`ID!`
`returnPath`	`String`
`returnTarget`	`TaxPaymentReturnTarget`	`embed`: the payment page returns to the embedded components (popup callback on the embed origin); returnPath is ignored.

refreshTaxFilingPayment#

Requires: scope tax:write · feature tax_filings.

refreshTaxFilingPayment(id: ID!): TaxAuthorityPayment!

Argument	Type
`id`	`ID!`

refreshTaxFilingPaymentByKenmerk#

Requires: scope tax:write · feature tax_filings.

refreshTaxFilingPaymentByKenmerk(kenmerk: String): TaxAuthorityPayment!

Argument	Type
`kenmerk`	`String`

createOneTAXFiling#

Requires: scope tax:write · feature tax_filings.

createOneTAXFiling(profileId: ID!, input: CreateTAXFilingInput!): TAXFiling!

Argument	Type
`profileId`	`ID!`
`input`	`CreateTAXFilingInput!`

createManyTAXFilings#

Requires: scope tax:write · feature tax_filings.

createManyTAXFilings(profileId: ID!, input: [CreateTAXFilingInput!]!): [TAXFiling!]!

Argument	Type
`profileId`	`ID!`
`input`	`[CreateTAXFilingInput!]!`

updateOneTAXFiling#

Requires: scope tax:write · feature tax_filings.

updateOneTAXFiling(input: UpdateOneTAXFilingInput!): TAXFiling!

Argument	Type
`input`	`UpdateOneTAXFilingInput!`

updateManyTAXFilings#

Requires: scope tax:write · feature tax_filings.

updateManyTAXFilings(input: UpdateManyTAXFilingsInput!): UpdateManyResponse!

Argument	Type
`input`	`UpdateManyTAXFilingsInput!`

deleteOneTAXFiling#

Requires: scope tax:write · feature tax_filings.

deleteOneTAXFiling(input: DeleteOneTAXFilingInput!): TAXFilingDeleteResponse!

Argument	Type
`input`	`DeleteOneTAXFilingInput!`

deleteManyTAXFilings#

Requires: scope tax:write · feature tax_filings.

deleteManyTAXFilings(input: DeleteManyTAXFilingsInput!): DeleteManyResponse!

Argument	Type
`input`	`DeleteManyTAXFilingsInput!`

createTaxFilingPaymentRequest#

Requires: scope tax:write · feature tax_filings.

createTaxFilingPaymentRequest(profileId: ID!, taxFilingId: ID!): PaymentRequest!

Argument	Type
`profileId`	`ID!`
`taxFilingId`	`ID!`

reportTaxFilingPaymentRequestStatus#

Requires: scope tax:write · feature tax_filings.

reportTaxFilingPaymentRequestStatus(profileId: ID!, input: ReportPaymentRequestStatusInput!): PaymentRequest!

Argument	Type
`profileId`	`ID!`
`input`	`ReportPaymentRequestStatusInput!`