Avalara Managed Returns API
The guide provides an inventory of GraphQL APIs that orchestrate the end-to-end flow in Avalara’s Managed Returns API product.
Avalara Managed Returns API is a standardized GraphQL-based solution for automating sales tax preparation, filing, and remittance across U.S. jurisdictions. It enables you to embed a compliant, branded returns experience directly into your platform—leveraging Avalara’s infrastructure for accuracy, scale, and ease of integration.
API Endpoints
http://returns-api.sbx.avalara.com/graphqlDeveloper Documentation
Standard error response structure
This code sample shows the standard error response structure we use in Managed Returns API:
{
"data": {
"filingRequests": null
},
"errors": [
{
"message": "Authorization failed.",
"extensions": {
"code": 403,
"status": "Forbidden",
"type": "AuthorizationException",
"documentation": "Failed fetching filingRequests",
"timestamp": "2025-04-17T11:51:28.548Z",
"requestId": "3b48f1ce-2323-40d6-922e-c78fee021af4"
}
}
]
}
Error response structure has the following information:
message: This parameter shows a brief description of the error.extensions:code: Shows the HTTP error code. For example, 403.status: Shows the status of the error. For example, Forbidden, NotFound, InternalServerError and so on.type: Shows the type of error. For example, AuthorizationException, EntityNotFoundError, InvalidEntry, UnhandledException and so on.documentation: Shows the details explanation about the error.timestamp: Shows the exact time when the error occurred in ISO 8601 format.requestId: Shows the unique identifier of the request.
Queries
accountDetails
Description
Retrieves the details of a specific account using its unique identifier.
Response
Returns an AccountResult
Arguments
| Name | Description |
|---|---|
id - Int!
|
The unique ID of the account whose details are to be retrieved. |
Example
Query
query accountDetails($id: Int!) {
accountDetails(id: $id) {
id
crmid
name
effectiveDate
endDate
accountStatusId
accountTypeId
isSamlEnabled
isDeleted
}
}
Variables
{"id": 987}
Response
{
"data": {
"accountDetails": {
"id": 987,
"crmid": "abc123",
"name": "abc123",
"effectiveDate": "xyz789",
"endDate": "abc123",
"accountStatusId": "INACTIVE",
"accountTypeId": "REGULAR",
"isSamlEnabled": false,
"isDeleted": true
}
}
}
calcTransactionsErrors
Description
Retrieve the errors of the Calc transactions for the specified company.
Response
Returns a CalcTransactionsErrorsResult
Example
Query
query calcTransactionsErrors(
$companyId: Int!,
$transactionBatchId: Int!
) {
calcTransactionsErrors(
companyId: $companyId,
transactionBatchId: $transactionBatchId
) {
id
success
successfulCount
errorCount
message
errorMessages
fileName
contentBase64
}
}
Variables
{"companyId": 123, "transactionBatchId": 123}
Response
{
"data": {
"calcTransactionsErrors": {
"id": 987,
"success": false,
"successfulCount": 987,
"errorCount": 987,
"message": "xyz789",
"errorMessages": ["xyz789"],
"fileName": "abc123",
"contentBase64": "abc123"
}
}
}
canadaOnboardingQuestions
Description
Retrieves onboarding questions for Canadian companies. This endpoint provides the questions needed during the Canadian company onboarding process.
Response
Returns [CanadaOnboardingQuestion]
Arguments
| Name | Description |
|---|---|
companyId - Int!
|
The unique ID of the company for which to retrieve onboarding questions. |
Example
Query
query canadaOnboardingQuestions($companyId: Int!) {
canadaOnboardingQuestions(companyId: $companyId) {
questionCode
questionText
helpText
answers {
value
nextQuestionCode
helpText
}
}
}
Variables
{"companyId": 987}
Response
{
"data": {
"canadaOnboardingQuestions": [
{
"questionCode": "xyz789",
"questionText": "xyz789",
"helpText": "abc123",
"answers": [CanadaOnboardingAnswer]
}
]
}
}
companies
Description
Get company object. If you don’t specify an id, then all company objects in the account is fetched.
A company represents a single corporation or individual that is registered to handle transactional taxes.
Response
Returns a CompaniesResult
Arguments
| Name | Description |
|---|---|
id - Int
|
The unique ID for the company. This field is required if you want to get nexusDetails, bankInformation, suggestedReturns or fundingStatus else will return null. |
formCode - String
|
The unique ID for the form. This field is required if you want to get nexusDetails. |
accountId - Int
|
The unique ID for the account. This field is required if you want to retrieve only the companies linked to an account. |
input - CompaniesInput
|
Provide filter options to narrow down your results. For example, country. This will return results for the country you want to filter the results for. Note : The top and skip options will only be applied to the company response, orderBy will only work with fields from company result not from related details like bankInformation, nexus, and so on. |
Example
Query
query companies(
$id: Int,
$formCode: String,
$accountId: Int,
$input: CompaniesInput
) {
companies(
id: $id,
formCode: $formCode,
accountId: $accountId,
input: $input
) {
value {
accountId
businessIdentificationNo
companyCode
filingStatus
id
settings {
companyId
id
name
set
value
}
defaultCountry
isDeleted
isTest
locations {
addressCategoryId
addressTypeId
city
companyId
country
dbaName
description
endDate
effectiveDate
id
isDefault
isMarketplaceOutsideUsa
isRegistered
lastTransactionDate
line1
line2
line3
locationCode
outletName
postalCode
region
registeredDate
importedAddressCategoryId
importedAddressTypeId
settings {
questionId
questionName
value
}
}
mossCountry
mossId
name
parentCompanyId
bankInformation {
accountHolderName
accountNickname
accountType
bankAccountDescription
bankAccountNumber
bankAccountType
bankInformationId
bankName
bankRoutingNumber
country
financialInstitutionCode
firmId
institutionId
isDefault
region
}
nexus {
companyId
companyNexus {
companyId
country
effectiveDate
endDate
hasLocalNexus
hasPermanentEstablishment
id
isSstActive
isSellerImporterOfRecord
jurisCode
jurisName
jurisTypeId
jurisdictionTypeId
localNexusTypeId
nexusTaxTypeGroup
nexusTypeId
parameters {
id
name
nexusId
unit
value
}
region
shortName
signatureCode
sourcing
stateAssignedNo
streamlinedSalesTax
taxAuthorityId
taxId
taxName
taxTypeGroup
taxableNexus
}
formCode
nexusDefinitions {
companyId
country
effectiveDate
endDate
hasLocalNexus
hasPermanentEstablishment
id
isSstActive
isSellerImporterOfRecord
jurisCode
jurisName
jurisTypeId
jurisdictionTypeId
localNexusTypeId
nexusTaxTypeGroup
nexusTypeId
parameters {
id
name
nexusId
unit
value
}
region
shortName
signatureCode
sourcing
stateAssignedNo
streamlinedSalesTax
taxAuthorityId
taxId
taxName
taxTypeGroup
taxableNexus
}
}
taxpayerIdNumber
suggestedTaxForms {
answeredQuestions {
accountId
answerId
companyId
country
onboardingQuestionAnswerId
questionId
region
}
country
onboardingQuestions {
allowMultiSelect
answers {
answer
answerHelpText
leadingQuestionAnswerId
nextQuestionId
taxFormCode
}
country
dataType
helpText
question
questionId
region
sequence
standard
}
onboardingStatus {
nextQuestionId
completedTaxFormCodes
pendingTaxFormCodes
onboardingTaxFormCodes
}
region
suggestedReturns {
description
taxAuthorityId
taxAuthorityName
taxFormCode
taxFormName
taxTypes
}
}
fundingStatus {
agreementType
agreementVersion
businessUnit
companyId
companySource
currency
documentKey
documentName
documentType
domain
errorMessage
javaScript
lastActivated
lastPolled
lastSigned
methodReturn {
javaScript
javaScriptReady
method
}
recipient
requestId
sender
status
subledgerProfileId
subscriptionType
templateRequestId
widgetId
}
sstPid
isActive
hasProfile
isReportingEntity
roundingLevelId
taxDependencyLevelId
inProgress
contacts {
id
companyId
contactCode
firstName
middleName
lastName
title
line1
line2
line3
city
region
postalCode
country
email
phone
mobile
fax
}
regionStatus {
country
region
status
}
setupStatus {
companyId
companyName
returnsSetupComplete
poaStatus
submitForReviewStatus
completedRegions {
country
region
taxFormCode
effectiveDate
endDate
}
remainingRegions {
country
region
taxFormCode
effectiveDate
endDate
}
}
}
errors {
message
extensions {
type
code
status
documentation
timestamp
requestId
}
}
pageInfo {
totalRecords
top
skip
hasNextPage
hasPreviousPage
}
}
}
Variables
{
"id": 123,
"formCode": "xyz789",
"accountId": 123,
"input": CompaniesInput
}
Response
{
"data": {
"companies": {
"value": [CompanyModel],
"errors": [Error],
"pageInfo": PageInfo
}
}
}
countries
Description
Get a country. If you don't specify country code then all countries will be fetched.
Returns a list of all ISO 3166 country codes and their U.S. English-friendly names.
Response
Returns a ListCountriesResult
Arguments
| Name | Description |
|---|---|
top - Int
|
Specifies the maximum number of records to return. Think of it as the "page size." |
skip - Int
|
Specifies the number of records to skip before starting to return results. Use this to implement pagination by skipping previously retrieved records. |
input - ListCountriesInput
|
This contains additional params for filtering or sorting countries. |
Example
Query
query countries(
$top: Int,
$skip: Int,
$input: ListCountriesInput
) {
countries(
top: $top,
skip: $skip,
input: $input
) {
value {
code
alpha3Code
name
isEuropeanUnion
localizedNames {
languageAlpha2Code
languageAlpha3Code
name
}
addressesRequireRegion
regions {
countryCode
code
name
classification
streamlinedSalesTax
localizedNames {
languageAlpha2Code
languageAlpha3Code
name
}
isRegionTaxable
}
}
errors {
message
extensions {
type
code
status
documentation
timestamp
requestId
}
}
pageInfo {
totalRecords
top
skip
hasNextPage
hasPreviousPage
}
}
}
Variables
{"top": 987, "skip": 123, "input": ListCountriesInput}
Response
{
"data": {
"countries": {
"value": [ISOCountryModel],
"errors": [Error],
"pageInfo": PageInfo
}
}
}
creditPaymentsConfirmation
Use FilingAttachmentsByDownloadType with downloadType: 'Tracefiles' instead
Description
Retrieve the trace file for the specified company for a particular filing period.
Note: A filing period refers to the year and month of the most recent customer transaction that can be reported on a return, determined by the filing frequency.
Response
Returns [Byte]
Example
Query
query creditPaymentsConfirmation(
$companyId: Int!,
$year: Int!,
$month: Int!
) {
creditPaymentsConfirmation(
companyId: $companyId,
year: $year,
month: $month
)
}
Variables
{"companyId": 123, "year": 123, "month": 123}
Response
{"data": {"creditPaymentsConfirmation": [196, 189, 173, 171, 167, 163]}}
definitions
Description
Get definition for filingCalendar, taxTypes, taxForms and countries. If you don't specify code for country or taxFormCode for taxForms then all records are fetched.
Retrieves filingCalendarMetadata, taxTypes, taxForms and countries
Note:
top and skip will only be applicable for countries response.
Response
Returns a DefinitionsCombinedResult
Arguments
| Name | Description |
|---|---|
top - Int
|
Specifies the maximum number of records to return. Think of it as the "page size." |
skip - Int
|
Specifies the number of records to skip before starting to return results. Use this to implement pagination by skipping previously retrieved records. |
input - DefinitionInput
|
This contains additional params for filtering or sorting definitions. |
Example
Query
query definitions(
$top: Int,
$skip: Int,
$input: DefinitionInput
) {
definitions(
top: $top,
skip: $skip,
input: $input
) {
value {
countries {
code
alpha3Code
name
isEuropeanUnion
localizedNames {
languageAlpha2Code
languageAlpha3Code
name
}
addressesRequireRegion
regions {
countryCode
code
name
classification
streamlinedSalesTax
localizedNames {
languageAlpha2Code
languageAlpha3Code
name
}
isRegionTaxable
}
}
filingCalendarMetaData {
filingCalendarMetadata {
allowableAdjustments {
adjustmentCode
adjustmentName
adjustmentTypeId
customerEditable
decimalPlaces
effDate
endDate
formAdjustmentTypeId
isAccountsPayable
isAccountsReceivable
negativeAllowed
positiveAllowed
prompt
}
customQuestions {
id
country
dataType
defaultAnswer
destination
filingCalendarFieldName
filingCalendarsAffected
filingQuestionCode
filingQuestionId
helpText
hideForFilingMethod
hideForFilingMethodId
historical
internalOnly
jsonPath
maxLength
question
regex
regexTests
region
required
requiresClone
skyscraperFieldName
skyscraperValidationRequired
sortOrder
standard
}
formDependencies {
country
description
formDependencyId
formDependencyType
formDependencyTypeId
formMasterId
region
taxFormCode
taxFormName
}
formFilingFrequencies {
code
description
endDay
filingFrequency
filingFrequencyId
filingPeriodDates {
description
filingDueDate
transactionalPeriodEnd
transactionalPeriodStart
}
formMasterId
frequencyTrigger
legacyFilingFrequencyId
startDay
visibleToCustomer
}
formFilingMethods {
filingMethod
filingMethodId
}
formHeader {
allowFilingCalendarAutoApproval
amendedAddress1
amendedAddress2
amendedAddressCity
amendedAddressCountry
amendedAddressMailTo
amendedAddressPostalCode
amendedAddressRegion
amendedEmailAddress
amendedFaxNumber
amendedPhoneNumber
amendedWebsite
canValidateEfileCredentials
isTwoFactorAuthRequired
country
currencyCode
dorAddress1
dorAddress2
dorAddressCity
dorAddressCountry
dorAddressMailTo
dorAddressPostalCode
dorAddressRegion
dorEmailAddress
dorFaxNumber
dorPhoneNumber
dorWebsite
description
dueDay
fiscalYearStartMonth
formMasterId
formType
formTypeId
outletReportingMethod
outletReportingMethodId
paymentAddress1
paymentAddress2
paymentAddressCity
paymentAddressCountry
paymentAddressMailTo
paymentAddressPostalCode
paymentAddressRegion
paymentEmailAddress
paymentFaxNumber
paymentPhoneNumber
paymentWebsite
purpose
region
requiresOutletSetup
taxFormCode
taxFormName
zeroAddress1
zeroAddress2
zeroAddressCity
zeroAddressCountry
zeroAddressMailTo
zeroAddressPostalCode
zeroAddressRegion
zeroEmailAddress
zeroFaxNumber
zeroPhoneNumber
zeroWebsite
}
formImageUrls
formTaxAuthorities {
formMasterId
formMasterTaxAuthorityId
taxAuthority
taxAuthorityId
}
formTaxTypes {
taxType
taxTypeId
}
optionalSchedules {
description
formOptionalScheduleId
scheduleName
}
standardQuestions {
id
country
dataType
defaultAnswer
destination
filingCalendarFieldName
filingCalendarsAffected
filingQuestionCode
filingQuestionId
helpText
hideForFilingMethod
hideForFilingMethodId
historical
internalOnly
jsonPath
maxLength
question
regex
regexTests
region
required
requiresClone
skyscraperFieldName
skyscraperValidationRequired
sortOrder
standard
}
}
formDueDate {
dueDate
extensionOffset
filingFrequencyId
filingMethodId
formDueDateId
formMasterId
mailByDate
monthOffset
paymentMethodId
}
}
taxForms {
taxFormCode
taxFormName
description
country
region
authorityName
shortCode
dueDay
effDate
endDate
formMasterEffDate
formMasterEndDate
formVersionId
major
minor
revision
stackAggregationOption
formAggregationTypeId
formVersion
expiration
searchString
searchStringWithDescription
taxFormNameDescription
displayName
countryRegionFilter
taxTypes
purpose
taxAuthority
}
taxTypes {
id
description
}
adjustmentCodes
}
errors {
message
extensions {
type
code
status
documentation
timestamp
requestId
}
}
}
}
Variables
{"top": 987, "skip": 987, "input": DefinitionInput}
Response
{
"data": {
"definitions": {
"value": DefinitionsResult,
"errors": [Error]
}
}
}
filingAttachmentsByDownloadType
Description
Retrieve filing attachments by download type for the specified company and filing period.
This endpoint provides access to return confirmation PDFs, trace files, or both types of attachments based on the downloadType parameter. Designed for partner integrations that need consolidated access to different filing attachment types.
Supports the following download types:
- ReturnConfirmations: Filed return confirmation PDFs only
- Tracefiles: Transaction trace files only
- All: Both confirmation PDFs and trace files in a single download
Response
Returns [Byte]
Arguments
| Name | Description |
|---|---|
companyId - Int!
|
The unique ID of the company that owns the filings. |
year - Int!
|
The year of the filing period in YYYY format. |
month - Int!
|
The month of the filing period in MM format (1-12). |
downloadType - DownloadType!
|
The type of attachments to download. Can be ReturnConfirmations, Tracefiles, or All. |
Example
Query
query filingAttachmentsByDownloadType(
$companyId: Int!,
$year: Int!,
$month: Int!,
$downloadType: DownloadType!
) {
filingAttachmentsByDownloadType(
companyId: $companyId,
year: $year,
month: $month,
downloadType: $downloadType
)
}
Variables
{
"companyId": 987,
"year": 123,
"month": 123,
"downloadType": "RETURNCONFIRMATIONS"
}
Response
{"data": {"filingAttachmentsByDownloadType": [196, 189, 173, 171, 167, 163]}}
filingCalendarRequests
Description
The filingCalendarRequests endpoint provides detailed information about requests made to file tax returns. A filing calendar request represents an instruction to initiate or manage a tax return submission, including adjustments or special handling instructions.
Retrieves a list of filing calendar requests which are already created and a input model for creating a filing calendar.
Note:
-
In order to get filingCalendarRequestModel, taxFormCode should be passed in the input.
-
top and skip will only be applicable for filingRequests response.
Response
Returns a FilingCalendarRequestsResult
Arguments
| Name | Description |
|---|---|
top - Int
|
Specifies the maximum number of records to return. Think of it as the "page size." |
skip - Int
|
Specifies the number of records to skip before starting to return results. Use this to implement pagination by skipping previously retrieved records. |
input - FilingCalendarRequestsInput!
|
This contains additional params for filtering or sorting filing calendar requests. |
Example
Query
query filingCalendarRequests(
$top: Int,
$skip: Int,
$input: FilingCalendarRequestsInput!
) {
filingCalendarRequests(
top: $top,
skip: $skip,
input: $input
) {
value {
filingRequests {
value {
companyId
data {
answers {
answer
filingQuestionId
filingQuestionCode
}
autoLockOverrideDay
companyReturnId
country
effDate
endDate
filingFrequencyId
fiscalYearStartMonth
isClone
locationCode
region
registrationId
taxAuthorityId
taxAuthorityName
taxFormCode
taxTypeId
canValidateEfileCredentials
twoFactorAuthForwardEmail
twoFactorAlias
}
filingRequestStatusId
id
}
pageInfo {
totalRecords
top
skip
hasNextPage
hasPreviousPage
}
}
filingCalendarRequestModel {
id
companyId
filingRequestStatusId
data {
answers {
answer
filingQuestionId
filingQuestionCode
}
autoLockOverrideDay
companyReturnId
country
effDate
endDate
filingFrequencyId
fiscalYearStartMonth
isClone
locationCode
region
registrationId
taxAuthorityId
taxAuthorityName
taxFormCode
taxTypeId
canValidateEfileCredentials
formFilingFrequencies {
code
description
endDay
filingFrequency
filingFrequencyId
filingPeriodDates {
description
filingDueDate
transactionalPeriodEnd
transactionalPeriodStart
}
formMasterId
frequencyTrigger
legacyFilingFrequencyId
startDay
visibleToCustomer
}
questions {
dataType
destination
filingQuestionId
filingQuestionCode
helpText
maxLength
question
regex
required
sortOrder
defaultAnswer
}
filingMethods {
filingMethod
filingMethodId
}
expireOptions {
transactionalPeriodStart
transactionalPeriodEnd
filingDueDate
cycleName
}
twoFactorAuthForwardEmail
twoFactorAlias
outletReportingMethod
dorWebsite
isTwoFactorAuthRequired
}
}
}
errors {
message
extensions {
type
code
status
documentation
timestamp
requestId
}
}
}
}
Variables
{
"top": 123,
"skip": 123,
"input": FilingCalendarRequestsInput
}
Response
{
"data": {
"filingCalendarRequests": {
"value": FilingRequestCombinedResult,
"errors": [Error]
}
}
}
filingCalendars
Description
This endpoint retrieves a list of active filing calendars associated with a company’s tax jurisdictions. A filing calendar defines the schedule and frequency for filing returns and making tax payments.
Note:
-
If filingCalendarId is provided as input, it will return the specified filing calendar. If not provided, it will return all filing calendars for the company.
-
top and skip will only be applicable for filingCalendars response.
-
companyId is required if you are fetching filingCalendars or filingCalendarOptions.
Response
Returns a FilingCalendarsResult
Arguments
| Name | Description |
|---|---|
top - Int
|
Specifies the maximum number of records to return. Think of it as the "page size." |
skip - Int
|
Specifies the number of records to skip before starting to return results. Use this to implement pagination by skipping previously retrieved records. |
input - FilingCalendarsInput
|
This contains additional params for filtering and sorting filing calendars. |
Example
Query
query filingCalendars(
$top: Int,
$skip: Int,
$input: FilingCalendarsInput
) {
filingCalendars(
top: $top,
skip: $skip,
input: $input
) {
value {
filingCalendars {
value {
autoLockOverrideDay
bulkAccountId
bulkAccountValidationStatus
city
companyId
currency
eFilePassword
eFileUsername
effectiveDate
employerIdentificationNumber
endDate
filingFrequencyId
filingTypeId
fiscalYearStartMonth
fixedPrepaymentAmount
formCountry
formRegion
id
legalEntityName
localRegistrationId
locationCode
mailingAddressCity
mailingAddressCountry
mailingAddressLine1
mailingAddressLine2
mailingAddressPostalCode
mailingAddressRegion
months
phone
prePaymentRequired
prepayPercentage
settings {
companyReturnId
filingQuestionCode
filingQuestionId
id
value
}
siteCode
stateRegistrationId
taxAuthorityId
taxAuthorityName
taxAuthorityType
taxFormCode
taxTypes
}
pageInfo {
totalRecords
top
skip
hasNextPage
hasPreviousPage
}
}
filingCalendarOptions {
available
transactionalPeriodStart
transactionalPeriodEnd
filingDueDate
cycleName
frequencyName
filingFrequencyCode
filingFrequencyId
cycleUnavailableReason
availableLocationCodes
}
}
errors {
message
extensions {
type
code
status
documentation
timestamp
requestId
}
}
}
}
Variables
{"top": 987, "skip": 123, "input": FilingCalendarsInput}
Response
{
"data": {
"filingCalendars": {
"value": FilingCalendarCombinedResult,
"errors": [Error]
}
}
}
filingConfirmationAttachment
Description
Retrieve a filing confirmation attachment for the specified company by the unique identifier of the filing.
Response
Returns [Byte]
Example
Query
query filingConfirmationAttachment(
$companyId: Int!,
$filingReturnId: BigInt!
) {
filingConfirmationAttachment(
companyId: $companyId,
filingReturnId: $filingReturnId
)
}
Variables
{"companyId": 123, "filingReturnId": {}}
Response
{"data": {"filingConfirmationAttachment": [196, 189, 173, 171, 167, 163]}}
filingConfirmationAttachments
Use FilingAttachmentsByDownloadType with downloadType: 'ReturnConfirmations' instead
Description
Retrieve the filing confirmation attachments for the specified company in the year and month of a given filing period.
Note: A filing period refers to the year and month of the most recent customer transaction that can be reported on a return, determined by the filing frequency.
Response
Returns [Byte]
Example
Query
query filingConfirmationAttachments(
$companyId: Int!,
$year: Int!,
$month: Int!
) {
filingConfirmationAttachments(
companyId: $companyId,
year: $year,
month: $month
)
}
Variables
{"companyId": 123, "year": 987, "month": 987}
Response
{"data": {"filingConfirmationAttachments": [196, 189, 173, 171, 167, 163]}}
filingRequests
This endpoint is obsolete. Please use filingCalendarRequests instead.
Description
The filingRequests endpoint provides detailed information about requests made to file tax returns. A filing request represents an instruction to initiate or manage a tax return submission, including adjustments or special handling instructions.
Retrieves a list of filing requests which are already created and a input model for creating a filing calendar.
Note:
-
In order to get filingCalendarRequestModel, taxFormCode should be passed in the input.
-
top and skip will only be applicable for filingRequests response.
Response
Returns a FilingRequestsResult
Arguments
| Name | Description |
|---|---|
top - Int
|
Specifies the maximum number of records to return. Think of it as the "page size." |
skip - Int
|
Specifies the number of records to skip before starting to return results. Use this to implement pagination by skipping previously retrieved records. |
input - GetFilingRequestsInput!
|
This contains additional params for filtering or sorting filing requests. |
Example
Query
query filingRequests(
$top: Int,
$skip: Int,
$input: GetFilingRequestsInput!
) {
filingRequests(
top: $top,
skip: $skip,
input: $input
) {
value {
filingRequests {
value {
companyId
data {
answers {
answer
filingQuestionId
filingQuestionCode
}
autoLockOverrideDay
companyReturnId
country
effDate
endDate
filingFrequencyId
fiscalYearStartMonth
isClone
locationCode
region
registrationId
taxAuthorityId
taxAuthorityName
taxFormCode
taxTypeId
canValidateEfileCredentials
twoFactorAuthForwardEmail
twoFactorAlias
}
filingRequestStatusId
id
}
pageInfo {
totalRecords
top
skip
hasNextPage
hasPreviousPage
}
}
filingCalendarRequestModel {
id
companyId
filingRequestStatusId
data {
answers {
answer
filingQuestionId
filingQuestionCode
}
autoLockOverrideDay
companyReturnId
country
effDate
endDate
filingFrequencyId
fiscalYearStartMonth
isClone
locationCode
region
registrationId
taxAuthorityId
taxAuthorityName
taxFormCode
taxTypeId
canValidateEfileCredentials
formFilingFrequencies {
code
description
endDay
filingFrequency
filingFrequencyId
filingPeriodDates {
description
filingDueDate
transactionalPeriodEnd
transactionalPeriodStart
}
formMasterId
frequencyTrigger
legacyFilingFrequencyId
startDay
visibleToCustomer
}
questions {
dataType
destination
filingQuestionId
filingQuestionCode
helpText
maxLength
question
regex
required
sortOrder
defaultAnswer
}
filingMethods {
filingMethod
filingMethodId
}
expireOptions {
transactionalPeriodStart
transactionalPeriodEnd
filingDueDate
cycleName
}
twoFactorAuthForwardEmail
twoFactorAlias
outletReportingMethod
dorWebsite
isTwoFactorAuthRequired
}
}
}
errors {
message
extensions {
type
code
status
documentation
timestamp
requestId
}
}
}
}
Variables
{"top": 123, "skip": 123, "input": GetFilingRequestsInput}
Response
{
"data": {
"filingRequests": {
"value": FilingRequestCombinedResult,
"errors": [Error]
}
}
}
filings
Description
The filings endpoint retrieves detailed information about tax return filings that have been processed or are scheduled to be processed for a company. Each record represents a completed, in-progress, or scheduled tax filing, including jurisdiction, form, period, and status.
Retrieves a list of filings for a specific company.
Response
Returns a FilingsResult
Arguments
| Name | Description |
|---|---|
input - FilingsInput!
|
This contains additional params for filtering filings. |
Example
Query
query filings($input: FilingsInput!) {
filings(input: $input) {
recordsetCount
value {
companyId
filingRegions {
country
hasNexus
region
regionTaxDetails {
nonTaxableAmount
numberOfNights
salesAmount
taxAmount
taxType
}
regionTaxSummary {
collectAmount
nonTaxableAccrualAmount
nonTaxableAmount
remittanceAmount
reportableNonTaxableAmount
reportableSalesAmount
reportableTaxAmount
reportableTaxableAmount
salesAccrualAmount
salesAmount
taxAccrualAmount
taxAmount
taxableAccrualAmount
taxableAmount
}
returns {
accrualType
adjustments {
accountType
amount
filingId
id
isCalculated
period
reason
type
}
appliedCarryOverCredits {
totalExempt
totalSales
totalTax
totalTaxable
transactionDetails {
docCode
docDate
lines {
exemptAmount
lineAmount
lineNo
messages {
details
helpLink
name
refersTo
severity
source
summary
}
reportingDate
resultCode
taxAmount
taxableAmount
transactionId
}
messages {
details
helpLink
name
refersTo
severity
source
summary
}
resultCode
totalExempt
totalTax
totalTaxable
transactionId
}
}
attachments {
description
resourceFileId
}
augmentations {
fieldAmount
fieldName
filingId
id
}
description
endPeriod
excludedCarryOverCredits {
totalExempt
totalSales
totalTax
totalTaxable
transactionDetails {
docCode
docDate
lines {
exemptAmount
lineAmount
lineNo
messages {
details
helpLink
name
refersTo
severity
source
summary
}
reportingDate
resultCode
taxAmount
taxableAmount
transactionId
}
messages {
details
helpLink
name
refersTo
severity
source
summary
}
resultCode
totalExempt
totalTax
totalTaxable
transactionId
}
}
filedDate
filingCalendarId
filingFrequency
filingType
formName
taxFormCode
id
payments {
filingId
id
isCalculated
paymentAmount
type
}
registrationId
returnTaxDetails {
nonTaxableAmount
numberOfNights
salesAmount
taxAmount
taxType
}
returnTaxSummary {
collectAmount
nonTaxableAccrualAmount
nonTaxableAmount
remittanceAmount
reportableNonTaxableAmount
reportableSalesAmount
reportableTaxAmount
reportableTaxableAmount
salesAccrualAmount
salesAmount
taxAccrualAmount
taxAmount
taxableAccrualAmount
taxableAmount
}
startPeriod
status
taxAuthorityId
totalAdjustments
totalAugmentations
totalPayments
type
}
status
suggestReturns {
country
region
taxAuthorityId
taxFormCode
}
}
id
month
taxDetails {
nonTaxableAmount
numberOfNights
salesAmount
taxAmount
taxType
}
taxSummary {
collectAmount
nonTaxableAccrualAmount
nonTaxableAmount
remittanceAmount
reportableNonTaxableAmount
reportableSalesAmount
reportableTaxAmount
reportableTaxableAmount
salesAccrualAmount
salesAmount
taxAccrualAmount
taxAmount
taxableAccrualAmount
taxableAmount
}
type
year
}
}
}
Variables
{"input": FilingsInput}
Response
{
"data": {
"filings": {
"recordsetCount": 123,
"value": [MultiTaxFilingModel]
}
}
}
firmClientLinkDetails
Description
The firmClientLinkDetails endpoint retrieves the relationship details between a tax firm and its clients.
Retrieves the details for all linked client accounts in a firm.
Response
Returns a ListFirmClientLinkDetailsResult
Example
Query
query firmClientLinkDetails(
$id: Int,
$filter: String
) {
firmClientLinkDetails(
id: $id,
filter: $filter
) {
recordsetCount
value {
clientAccountId
clientAccountName
firmAccountId
firmAccountName
firmContactEmail
firmContactName
id
isDeleted
status
company {
companyId
accountId
name
isDefault
isActive
hasProfile
isReportingEntity
companyCode
isTest
}
licenseKey {
accountId
privateLicenseKey
}
}
}
}
Variables
{"id": 987, "filter": "xyz789"}
Response
{
"data": {
"firmClientLinkDetails": {
"recordsetCount": 123,
"value": [FirmClientLinkDetailsResult]
}
}
}
firmSupportCaseWithComments
Description
Retrieves detailed information about a specific firm support case by its ID. Returns complete case information including all associated comments and case history.
Response
Returns a PartnerSupportCaseDetail
Arguments
| Name | Description |
|---|---|
caseId - String!
|
The unique Salesforce case ID. |
Example
Query
query firmSupportCaseWithComments($caseId: String!) {
firmSupportCaseWithComments(caseId: $caseId) {
caseId
subject
description
status
caseOwnerName
createdDate
lastModifiedDate
firmAccountId
externalFirmCaseId
externalFirmCaseNumber
comments {
commentId
comment
commentedDate
}
}
}
Variables
{"caseId": "abc123"}
Response
{
"data": {
"firmSupportCaseWithComments": {
"caseId": "abc123",
"subject": "abc123",
"description": "abc123",
"status": "xyz789",
"caseOwnerName": "xyz789",
"createdDate": "xyz789",
"lastModifiedDate": "abc123",
"firmAccountId": "abc123",
"externalFirmCaseId": "xyz789",
"externalFirmCaseNumber": "abc123",
"comments": [PartnerSupportComment]
}
}
}
firmSupportCases
Description
Retrieves a list of firm support cases for a specific firm. Returns all cases for the specified firm.
Response
Returns a GetCasesResponse
Arguments
| Name | Description |
|---|---|
input - GetPartnerSupportCasesInput!
|
Filter options for retrieving firm support cases. |
Example
Query
query firmSupportCases($input: GetPartnerSupportCasesInput!) {
firmSupportCases(input: $input) {
totalCount
hasMore
cases {
caseId
subject
description
status
caseOwnerName
createdDate
lastModifiedDate
externalFirmCaseId
externalFirmCaseNumber
}
}
}
Variables
{"input": GetPartnerSupportCasesInput}
Response
{
"data": {
"firmSupportCases": {
"totalCount": 123,
"hasMore": true,
"cases": [PartnerSupportCase]
}
}
}
liabilityReports
Description
The liabilityReports endpoint retrieves detailed reports of a company’s tax liabilities across jurisdictions and time periods. These reports summarize the calculated or declared tax amounts owed to tax authorities before or after returns are filed.
Retrieves liability reports for a specified company.
This returns zipped liability reports, which include:
- Liability state summary report
- Liability summary return details report
Response
Returns a LiabilityReportsResult
Arguments
| Name | Description |
|---|---|
companyId - Int!
|
The unique ID of the company to retrieve the liability reports. |
month - Int!
|
The month to retrieve the liability reports. |
year - Int!
|
The year to retrieve the liability reports. |
liabilityType - LiabilityType!
|
The type of liability to filter and export the reports. |
country - String
|
The two-character ISO 3166 country code to filter country-specific liability reports. |
region - String
|
The region to filter country-specific liability reports. |
Example
Query
query liabilityReports(
$companyId: Int!,
$month: Int!,
$year: Int!,
$liabilityType: LiabilityType!,
$country: String,
$region: String
) {
liabilityReports(
companyId: $companyId,
month: $month,
year: $year,
liabilityType: $liabilityType,
country: $country,
region: $region
) {
value {
reports
}
errors {
message
extensions {
type
code
status
documentation
timestamp
requestId
}
}
}
}
Variables
{
"companyId": 123,
"month": 123,
"year": 123,
"liabilityType": "ALL",
"country": "xyz789",
"region": "xyz789"
}
Response
{
"data": {
"liabilityReports": {
"value": LiabilityReportsValue,
"errors": [Error]
}
}
}
licenseKey
Description
Retrieves an account license key.
Response
Returns [LicenseKey]
Arguments
| Name | Description |
|---|---|
accountId - Int!
|
The unique ID of the account. |
Example
Query
query licenseKey($accountId: Int!) {
licenseKey(accountId: $accountId) {
name
accountId
createdDate
modifiedDate
}
}
Variables
{"accountId": 123}
Response
{
"data": {
"licenseKey": [
{
"name": "xyz789",
"accountId": 987,
"createdDate": "xyz789",
"modifiedDate": "abc123"
}
]
}
}
noticePoa
Description
This allows users to retrieve a notice POA document for the specified notice and company.
Response
Returns [Byte]
Example
Query
query noticePoa(
$noticeId: Int!,
$companyId: Int!
) {
noticePoa(
noticeId: $noticeId,
companyId: $companyId
)
}
Variables
{"noticeId": 123, "companyId": 123}
Response
{"data": {"noticePoa": [196, 189, 173, 171, 167, 163]}}
notices
Description
The notices endpoint retrieves official tax notices issued by tax jurisdictions and tracked. These notices often contain requests for additional information, payment discrepancies, audit notifications, or filing issues.
Retrieves a list of notices.
Response
Returns a ListNoticesResult
Arguments
| Name | Description |
|---|---|
input - ListNoticesInput!
|
This contains additional params for filtering and sorting notices. |
Example
Query
query notices($input: ListNoticesInput!) {
notices(input: $input) {
recordsetCount
value {
id
createdDate
modifiedDate
status
region
taxPeriod
taxFormCode
filingFrequency
comments {
attachmentUploadRequest {
accountId
companyId
content
documentId
length
name
username
}
comment
commentLink
commentType
commentTypeId
commentUserId
commentUserName
date
documentId
id
modifiedDate
modifiedUserId
noticeId
taxNoticeFileName
}
finances {
attachmentUploadRequest {
accountId
companyId
content
documentId
length
name
username
}
createdDate
createdUserId
credits
cspFeeRefund
customerInterest
customerPenalty
documentId
dueDate
fileName
id
interest
modifiedDate
modifiedUserId
noticeDate
noticeId
noticeNumber
paymentMethod
penalty
taxAbated
taxDue
}
}
pageInfo {
totalRecords
top
skip
hasNextPage
hasPreviousPage
}
}
}
Variables
{"input": ListNoticesInput}
Response
{
"data": {
"notices": {
"recordsetCount": 123,
"value": [NoticesResult],
"pageInfo": PageInfo
}
}
}
noticesAttachment
Description
Retrieves attachment files from a notice.
Attachments are schedules, forms, receipts, or other documentation required by the IRS to verify income, deductions, credits, or other tax-related items.
Response
Returns [Byte]
Example
Query
query noticesAttachment(
$companyId: Int!,
$Id: Int!
) {
noticesAttachment(
companyId: $companyId,
Id: $Id
)
}
Variables
{"companyId": 987, "Id": 123}
Response
{"data": {"noticesAttachment": [196, 189, 173, 171, 167, 163]}}
taxForms
Description
Retrieve a list of available tax forms.
This query allows you to fetch information about available tax forms. You can optionally filter the results by providing a specific tax form code.
Response
Returns a TaxFormsResult
Arguments
| Name | Description |
|---|---|
taxFormCode - String
|
The unique ID for a specific tax form. |
country - String
|
The two-character ISO 3166 country code to filter country-specific tax form. |
region - String
|
The region to filter country-specific tax form. |
includeTaxTypes - Boolean
|
Boolean to include tax types in response. |
Example
Query
query taxForms(
$taxFormCode: String,
$country: String,
$region: String,
$includeTaxTypes: Boolean
) {
taxForms(
taxFormCode: $taxFormCode,
country: $country,
region: $region,
includeTaxTypes: $includeTaxTypes
) {
recordsetCount
value {
taxFormCode
taxFormName
description
country
region
authorityName
shortCode
dueDay
effDate
endDate
formMasterEffDate
formMasterEndDate
formVersionId
major
minor
revision
stackAggregationOption
formAggregationTypeId
formVersion
expiration
searchString
searchStringWithDescription
taxFormNameDescription
displayName
countryRegionFilter
taxTypes
purpose
taxAuthority
}
}
}
Variables
{
"taxFormCode": "abc123",
"country": "abc123",
"region": "abc123",
"includeTaxTypes": false
}
Response
{
"data": {
"taxForms": {
"recordsetCount": 123,
"value": [TaxFormModel]
}
}
}
transactionDetails
Description
The transactionDetails endpoint provides tax transaction data used in calculating tax liabilities and filing returns. These records include sales, purchases, credits, and other taxable activities reported.
Retrieves the list transaction details created for a company.
Response
Returns a TransactionDetailsResult
Arguments
| Name | Description |
|---|---|
input - TransactionDetailsInput
|
This contains additional params for filtering transaction details. |
companyId - Int!
|
The unique ID of the company to retrieve the transaction details. |
Example
Query
query transactionDetails(
$input: TransactionDetailsInput,
$companyId: Int!
) {
transactionDetails(
input: $input,
companyId: $companyId
) {
recordsetCount
value {
city
companyId
country
county
currencyCode
discount
exemptAmount
groupCode
jurisdiction
lines
locationCode
minutes
rateType
region
salesAmount
taxAmount
taxLevel
taxRate
taxSubType
taxType
taxableAmount
transactionDate
transactionCode
}
}
}
Variables
{"input": TransactionDetailsInput, "companyId": 123}
Response
{
"data": {
"transactionDetails": {
"recordsetCount": 987,
"value": [TransactionDetailModel]
}
}
}
transactionReportsCalc
Description
Generate the Calc transaction status report for the specified company.
Response
Returns [Byte]
Arguments
| Name | Description |
|---|---|
companyId - Int!
|
The unique ID of the company. |
input - TransactionsReportInput!
|
Request parameters for the Calc transaction status report. |
Example
Query
query transactionReportsCalc(
$companyId: Int!,
$input: TransactionsReportInput!
) {
transactionReportsCalc(
companyId: $companyId,
input: $input
)
}
Variables
{"companyId": 987, "input": TransactionsReportInput}
Response
{"data": {"transactionReportsCalc": [196, 189, 173, 171, 167, 163]}}
transactions
Description
The Transactions endpoint retrieves batch status, error details, and transaction history for a specified company.
Retrieves the following details:
-
Status of the specified batch.
-
An error breakdown for a batch of transactions that are created.
-
Transaction history of the specified company.
Response
Returns a TransactionQueryResult
Arguments
| Name | Description |
|---|---|
companyId - Int!
|
The unique ID of the company. |
batchId - Int
|
The unique ID of the batch of transaction. |
input - TransactionInput
|
This contains additional params for filtering transactions history. |
Example
Query
query transactions(
$companyId: Int!,
$batchId: Int,
$input: TransactionInput
) {
transactions(
companyId: $companyId,
batchId: $batchId,
input: $input
) {
value {
batchStatus {
transactionBatchId
status
errorMessages
hasErrorFile
fileName
importType
createdDate
}
batchErrors {
companyId
companyName
status
errors {
errorType
transaction {
transactionCode
transactionDate
country
region
addressLine1
county
city
postalCode
taxType
taxLevel
taxRate
grossAmount
exemptAmount
taxableAmount
taxAmount
}
}
}
importHistory {
value {
transactionBatchId
status
errorMessages
hasErrorFile
fileName
importType
createdDate
}
}
}
errors {
message
extensions {
type
code
status
documentation
timestamp
requestId
}
}
}
}
Variables
{
"companyId": 987,
"batchId": 123,
"input": TransactionInput
}
Response
{
"data": {
"transactions": {
"value": ImportResult,
"errors": [Error]
}
}
}
transactionsReport
Description
Retrieve the transactions report for the specified company.
Response
Returns [Byte]
Arguments
| Name | Description |
|---|---|
companyId - Int!
|
The unique ID of the company. |
input - TransactionsReportInput!
|
This contains additional params for filtering transactions report. |
Example
Query
query transactionsReport(
$companyId: Int!,
$input: TransactionsReportInput!
) {
transactionsReport(
companyId: $companyId,
input: $input
)
}
Variables
{"companyId": 987, "input": TransactionsReportInput}
Response
{"data": {"transactionsReport": [196, 189, 173, 171, 167, 163]}}
verifyEFileCredentialStatus
Description
Retrieve the status of the e-file credentials verification for the specified company.
Response
Returns a VerifyEFileCredentialResult
Example
Query
query verifyEFileCredentialStatus(
$companyId: Int!,
$jobId: BigInt!
) {
verifyEFileCredentialStatus(
companyId: $companyId,
jobId: $jobId
) {
jobId
status
loginSuccess
message
}
}
Variables
{"companyId": 123, "jobId": {}}
Response
{
"data": {
"verifyEFileCredentialStatus": {
"jobId": {},
"status": "xyz789",
"loginSuccess": false,
"message": "abc123"
}
}
}
Mutations
addFirmSupportCaseComment
Description
Adds a comment to an existing firm support case. This allows firms to provide additional information or updates on ongoing support cases.
Response
Returns an AddCommentResponse
Arguments
| Name | Description |
|---|---|
input - AddPartnerSupportCommentInput!
|
The details for adding a comment to a support case. |
Example
Query
mutation addFirmSupportCaseComment($input: AddPartnerSupportCommentInput!) {
addFirmSupportCaseComment(input: $input) {
success
message
externalFirmCaseId
externalFirmCaseNumber
caseId
error {
errorCode
errorMessage
}
}
}
Variables
{"input": AddPartnerSupportCommentInput}
Response
{
"data": {
"addFirmSupportCaseComment": {
"success": "abc123",
"message": "abc123",
"externalFirmCaseId": "abc123",
"externalFirmCaseNumber": "abc123",
"caseId": "abc123",
"error": PartnerSupportError
}
}
}
adjustFilings
Description
Creates an adjustment for an existing tax filing that hasn't been approved.
An adjustment is an increase or decrease to the customer funding to Avalara, such as the early filer discount amounts that are refunded to the customer, or efile fees from websites. An adjustment may be a manual change in tax liability, similar to an augmentation.
Response
Returns [FilingAdjustmentResult]
Arguments
| Name | Description |
|---|---|
input - CreateReturnAdjustmentInput!
|
The required input to create a return adjustment. |
Example
Query
mutation adjustFilings($input: CreateReturnAdjustmentInput!) {
adjustFilings(input: $input) {
accountType
amount
filingId
id
isCalculated
period
reason
type
}
}
Variables
{"input": CreateReturnAdjustmentInput}
Response
{
"data": {
"adjustFilings": [
{
"accountType": "NONE",
"amount": 123.45,
"filingId": {},
"id": {},
"isCalculated": false,
"period": "NONE",
"reason": "abc123",
"type": "abc123"
}
]
}
}
approveFilings
Description
This endpoint is used to approve one or more tax return filings. Approving a filing signals that the return has been reviewed and is ready for submission to the tax authority.
Customer approves the return from the Admin console or a return gets autoapproved the night before the filing cycle.
Filing period refers to the year and month of the most recent customer transaction that can be reported on a filing, determined by the filing frequency.
Response
Returns an ApproveFilingResult
Arguments
| Name | Description |
|---|---|
input - ApproveFilingsInput!
|
The input to specify approved filings data such as the filing month, country, region, and so on. |
Example
Query
mutation approveFilings($input: ApproveFilingsInput!) {
approveFilings(input: $input) {
recordsetCount
value {
companyId
filingRegions {
approveDate
collectAmount
consumerUseNonTaxableAmount
consumerUseTaxAmount
consumerUseTaxableAmount
country
endDate
filingId
hasNexus
id
nonTaxableAmount
region
returns {
accrualType
adjustments {
accountType
amount
filingId
id
isCalculated
period
reason
type
}
appliedCarryOverCredits {
totalExempt
totalSales
totalTax
totalTaxable
transactionDetails {
docCode
docDate
lines {
exemptAmount
lineAmount
lineNo
messages {
details
helpLink
name
refersTo
severity
source
summary
}
reportingDate
resultCode
taxAmount
taxableAmount
transactionId
}
messages {
details
helpLink
name
refersTo
severity
source
summary
}
resultCode
totalExempt
totalTax
totalTaxable
transactionId
}
}
attachments {
description
resourceFileId
}
augmentations {
fieldAmount
fieldName
filingId
id
}
carryOverConsumerUseTaxAmount
carryOverNonTaxableAmount
carryOverSalesAmount
carryOverTaxAmount
collectAmount
consumerUseNonTaxableAccrualAmount
consumerUseNonTaxableAmount
consumerUseTaxAccrualAmount
consumerUseTaxAmount
consumerUseTaxDueAmount
consumerUseTaxableAccrualAmount
consumerUseTaxableAmount
description
endPeriod
excludedCarryOverCredits {
totalExempt
totalSales
totalTax
totalTaxable
transactionDetails {
docCode
docDate
lines {
exemptAmount
lineAmount
lineNo
messages {
details
helpLink
name
refersTo
severity
source
summary
}
reportingDate
resultCode
taxAmount
taxableAmount
transactionId
}
messages {
details
helpLink
name
refersTo
severity
source
summary
}
resultCode
totalExempt
totalTax
totalTaxable
transactionId
}
}
excludedNonTaxableAmount
excludedSalesAmount
excludedTaxAmount
filedDate
filingCalendarCurrencyCode
filingCalendarId
filingFrequency
filingRegionId
filingType
formName
id
liabilityCurrencyCode
month
nonTaxableAccrualAmount
nonTaxableAmount
nonTaxableDueAmount
payments {
filingId
id
isCalculated
paymentAmount
type
}
registrationId
remitAmount
resourceFileId
salesAccrualAmount
salesAmount
salesTaxAccrualAmount
sellersUseTaxAccrualAmount
startPeriod
status
taxAccrualAmount
taxAmount
taxAuthorityId
taxDueAmount
taxableAccrualAmount
taxableAmount
totalAdjustments
totalAugmentations
totalPayments
type
year
}
salesAmount
startDate
status
suggestReturns {
country
region
taxAuthorityId
taxFormCode
}
taxAmount
taxDueAmount
taxableAmount
totalRemittanceAmount
}
id
month
type
year
}
}
}
Variables
{"input": ApproveFilingsInput}
Response
{
"data": {
"approveFilings": {
"recordsetCount": 987,
"value": [FilingModel]
}
}
}
askReturnsAgent
Description
Sends a prompt to the Returns Agent and returns the agent's response. Use this to ask natural language questions about returns, companies, filings, etc.
Response
Returns an AskReturnsAgentResult
Arguments
| Name | Description |
|---|---|
input - AskReturnsAgentInput!
|
Input containing the prompt and optional session identifiers. |
Example
Query
mutation askReturnsAgent($input: AskReturnsAgentInput!) {
askReturnsAgent(input: $input) {
result
success
requestId
sessionId
errors {
message
extensions {
type
code
status
documentation
timestamp
requestId
}
}
}
}
Variables
{"input": AskReturnsAgentInput}
Response
{
"data": {
"askReturnsAgent": {
"result": "abc123",
"success": true,
"requestId": "xyz789",
"sessionId": "abc123",
"errors": [Error]
}
}
}
cancelFilingCalendarRequest
Description
This allows users to cancel the existing filing requests.
Cancels an existing filing calendar request.
Response
Returns a FilingRequestModel
Example
Query
mutation cancelFilingCalendarRequest(
$id: Int!,
$companyId: Int!
) {
cancelFilingCalendarRequest(
id: $id,
companyId: $companyId
) {
companyId
data {
answers {
answer
filingQuestionId
filingQuestionCode
}
autoLockOverrideDay
companyReturnId
country
effDate
endDate
filingFrequencyId
fiscalYearStartMonth
isClone
locationCode
region
registrationId
taxAuthorityId
taxAuthorityName
taxFormCode
taxTypeId
canValidateEfileCredentials
twoFactorAuthForwardEmail
twoFactorAlias
}
filingRequestStatusId
id
}
}
Variables
{"id": 987, "companyId": 987}
Response
{
"data": {
"cancelFilingCalendarRequest": {
"companyId": 987,
"data": FilingRequestDataModel,
"filingRequestStatusId": "NEW",
"id": {}
}
}
}
createAndLinkAccount
Description
Creates a firm-client account with the specified product subscriptions.
And then links the created account to the firm so that they can manage their returns. Use this API call when a customer must be managed only by a firm.
The account created by this API will have the status set to Active.
This API will create a client for the firm and provides newly created client id and its license key. The client will use this credentials to setup filing calendar, create the transactions and prepare filings for the return.
Response
Returns a FirmClientLinkDetailsResult
Arguments
| Name | Description |
|---|---|
firmClientAccountInput - FirmClientAccountInput!
|
The input object containing the necessary information to create the firm-client account. |
Example
Query
mutation createAndLinkAccount($firmClientAccountInput: FirmClientAccountInput!) {
createAndLinkAccount(firmClientAccountInput: $firmClientAccountInput) {
clientAccountId
clientAccountName
firmAccountId
firmAccountName
firmContactEmail
firmContactName
id
isDeleted
status
company {
companyId
accountId
name
isDefault
isActive
hasProfile
isReportingEntity
companyCode
isTest
}
licenseKey {
accountId
privateLicenseKey
}
}
}
Variables
{"firmClientAccountInput": FirmClientAccountInput}
Response
{
"data": {
"createAndLinkAccount": {
"clientAccountId": 123,
"clientAccountName": "xyz789",
"firmAccountId": 987,
"firmAccountName": "xyz789",
"firmContactEmail": "abc123",
"firmContactName": "xyz789",
"id": 123,
"isDeleted": false,
"status": "REQUESTED",
"company": ClientCompanyResult,
"licenseKey": licenseKey
}
}
}
createCompanies
Description
Creates one or more company objects. You can include nested data objects such as, contacts, locations, and settings in the same CREATE call. These details will be included in the company profile.
Company represents a corporation or individual registered to handle transactional taxes.
Note: Ensure not to use the following blacklisted characters in company name and code: ; (semicolon), '' (double quotation marks), and | (vertical bar).
Response
Returns [CompanyResult]
Arguments
| Name | Description |
|---|---|
input - [CompanyModelInput]
|
This contains fields required for creating companies. |
Example
Query
mutation createCompanies($input: [CompanyModelInput]) {
createCompanies(input: $input) {
id
accountId
parentCompanyId
sstPid
companyCode
name
isActive
hasProfile
isReportingEntity
defaultCountry
roundingLevelId
isTest
taxDependencyLevelId
inProgress
businessIdentificationNo
locations {
addressCategoryId
addressTypeId
city
companyId
country
dbaName
description
endDate
effectiveDate
id
isDefault
isMarketplaceOutsideUsa
isRegistered
lastTransactionDate
line1
line2
line3
locationCode
outletName
postalCode
region
registeredDate
importedAddressCategoryId
importedAddressTypeId
settings {
questionId
questionName
value
}
}
settings {
companyId
id
name
set
value
}
contacts {
id
companyId
contactCode
firstName
middleName
lastName
title
line1
line2
line3
city
region
postalCode
country
email
phone
mobile
fax
}
mossCountry
mossId
isDeleted
taxpayerIdNumber
filingStatus
}
}
Variables
{"input": [CompanyModelInput]}
Response
{
"data": {
"createCompanies": [
{
"id": 987,
"accountId": 123,
"parentCompanyId": 123,
"sstPid": "xyz789",
"companyCode": "xyz789",
"name": "xyz789",
"isActive": false,
"hasProfile": false,
"isReportingEntity": false,
"defaultCountry": "abc123",
"roundingLevelId": "LINE",
"isTest": true,
"taxDependencyLevelId": "DOCUMENT",
"inProgress": true,
"businessIdentificationNo": "xyz789",
"locations": [LocationModel],
"settings": [CompanySettingModel],
"contacts": [ContactModel],
"mossCountry": "xyz789",
"mossId": "abc123",
"isDeleted": false,
"taxpayerIdNumber": "xyz789",
"filingStatus": "NOTCONFIGUREDFORCOMPLIANCE"
}
]
}
}
createContacts
Description
Creates one or more contacts for a company.
A contact is an individual associated with a company who can be contacted for tax-related inquiries. Each contact can have address, phone, and email information.
Response
Returns [ContactModel]
Arguments
| Name | Description |
|---|---|
input - CreateContactsInput!
|
The input containing the company ID and the list of contacts to create. |
Example
Query
mutation createContacts($input: CreateContactsInput!) {
createContacts(input: $input) {
id
companyId
contactCode
firstName
middleName
lastName
title
line1
line2
line3
city
region
postalCode
country
email
phone
mobile
fax
}
}
Variables
{"input": CreateContactsInput}
Response
{
"data": {
"createContacts": [
{
"id": 987,
"companyId": 987,
"contactCode": "abc123",
"firstName": "abc123",
"middleName": "xyz789",
"lastName": "xyz789",
"title": "xyz789",
"line1": "xyz789",
"line2": "abc123",
"line3": "abc123",
"city": "abc123",
"region": "xyz789",
"postalCode": "xyz789",
"country": "xyz789",
"email": "xyz789",
"phone": "xyz789",
"mobile": "xyz789",
"fax": "xyz789"
}
]
}
}
createFilingCalendarRequests
Description
This allows users to create new filing calendar requests by submitting necessary information about the proposed filing calendar. This request helps businesses automate and manage their filing schedules. The response includes details about the filing request such as the request ID, company ID, status, and associated data.
Creates filing calendar requests.
Response
Returns [FilingRequestModel]
Arguments
| Name | Description |
|---|---|
filingRequestInput - CreateFilingRequestInput
|
The information about the filing calendar you want to create. |
Example
Query
mutation createFilingCalendarRequests($filingRequestInput: CreateFilingRequestInput) {
createFilingCalendarRequests(filingRequestInput: $filingRequestInput) {
companyId
data {
answers {
answer
filingQuestionId
filingQuestionCode
}
autoLockOverrideDay
companyReturnId
country
effDate
endDate
filingFrequencyId
fiscalYearStartMonth
isClone
locationCode
region
registrationId
taxAuthorityId
taxAuthorityName
taxFormCode
taxTypeId
canValidateEfileCredentials
twoFactorAuthForwardEmail
twoFactorAlias
}
filingRequestStatusId
id
}
}
Variables
{"filingRequestInput": CreateFilingRequestInput}
Response
{
"data": {
"createFilingCalendarRequests": [
{
"companyId": 987,
"data": FilingRequestDataModel,
"filingRequestStatusId": "NEW",
"id": {}
}
]
}
}
createFirmClientLinkage
Description
This allows firms to establish a linkage between their firm account and a client's existing account.
Response
Returns a FirmClientLinkDetailsResult
Arguments
| Name | Description |
|---|---|
input - FirmClientLinkOptionsInput!
|
Details required to link the client account to the firm account. |
Example
Query
mutation createFirmClientLinkage($input: FirmClientLinkOptionsInput!) {
createFirmClientLinkage(input: $input) {
clientAccountId
clientAccountName
firmAccountId
firmAccountName
firmContactEmail
firmContactName
id
isDeleted
status
company {
companyId
accountId
name
isDefault
isActive
hasProfile
isReportingEntity
companyCode
isTest
}
licenseKey {
accountId
privateLicenseKey
}
}
}
Variables
{"input": FirmClientLinkOptionsInput}
Response
{
"data": {
"createFirmClientLinkage": {
"clientAccountId": 987,
"clientAccountName": "abc123",
"firmAccountId": 123,
"firmAccountName": "abc123",
"firmContactEmail": "xyz789",
"firmContactName": "abc123",
"id": 987,
"isDeleted": false,
"status": "REQUESTED",
"company": ClientCompanyResult,
"licenseKey": licenseKey
}
}
}
createFirmSupportCase
Description
Creates a new firm support case for tracking client issues and requests. This enables firms to submit support cases programmatically and track them through their lifecycle.
Response
Returns a CreateCaseResponse
Arguments
| Name | Description |
|---|---|
input - CreatePartnerSupportCaseInput!
|
The details for creating a new firm support case. |
Example
Query
mutation createFirmSupportCase($input: CreatePartnerSupportCaseInput!) {
createFirmSupportCase(input: $input) {
success
message
externalFirmCaseId
externalFirmCaseNumber
caseId
error {
errorCode
errorMessage
}
}
}
Variables
{"input": CreatePartnerSupportCaseInput}
Response
{
"data": {
"createFirmSupportCase": {
"success": "xyz789",
"message": "abc123",
"externalFirmCaseId": "abc123",
"externalFirmCaseNumber": "xyz789",
"caseId": "abc123",
"error": PartnerSupportError
}
}
}
createLocation
Description
Location specifies the address of the company and location data is used to determine taxing jurisdiction.
Creates bulk locations.
Response
Returns [LocationModel]
Arguments
| Name | Description |
|---|---|
companyId - Int!
|
Unique ID of the company for which location is to be created. |
input - [LocationModelInput]
|
Input containing location details like city, county, address and so on. |
Example
Query
mutation createLocation(
$companyId: Int!,
$input: [LocationModelInput]
) {
createLocation(
companyId: $companyId,
input: $input
) {
addressCategoryId
addressTypeId
city
companyId
country
dbaName
description
endDate
effectiveDate
id
isDefault
isMarketplaceOutsideUsa
isRegistered
lastTransactionDate
line1
line2
line3
locationCode
outletName
postalCode
region
registeredDate
importedAddressCategoryId
importedAddressTypeId
settings {
questionId
questionName
value
}
}
}
Variables
{"companyId": 123, "input": [LocationModelInput]}
Response
{
"data": {
"createLocation": [
{
"addressCategoryId": "STOREFRONT",
"addressTypeId": "LOCATION",
"city": "xyz789",
"companyId": 123,
"country": "xyz789",
"dbaName": "xyz789",
"description": "abc123",
"endDate": "abc123",
"effectiveDate": "xyz789",
"id": 987,
"isDefault": false,
"isMarketplaceOutsideUsa": false,
"isRegistered": true,
"lastTransactionDate": "abc123",
"line1": "xyz789",
"line2": "xyz789",
"line3": "abc123",
"locationCode": "xyz789",
"outletName": "xyz789",
"postalCode": "abc123",
"region": "xyz789",
"registeredDate": "abc123",
"importedAddressCategoryId": "xyz789",
"importedAddressTypeId": "xyz789",
"settings": [LocationSetting]
}
]
}
}
createNoticeComments
Description
Updates comments provided by a client for a notice specific to the clients company.
Response
Returns [CommentResult]
Arguments
| Name | Description |
|---|---|
input - NoticeCommentsInput
|
The details to be updated in the notice comment, such as company ID and comment description. |
Example
Query
mutation createNoticeComments($input: NoticeCommentsInput) {
createNoticeComments(input: $input) {
attachmentUploadRequest {
accountId
companyId
content
documentId
length
name
username
}
comment
commentLink
commentType
commentTypeId
commentUserId
commentUserName
date
documentId
id
modifiedDate
modifiedUserId
noticeId
taxNoticeFileName
}
}
Variables
{"input": NoticeCommentsInput}
Response
{
"data": {
"createNoticeComments": [
{
"attachmentUploadRequest": AttachmentUploadRequestModel,
"comment": "abc123",
"commentLink": "xyz789",
"commentType": "INTERNAL",
"commentTypeId": 123,
"commentUserId": 123,
"commentUserName": "xyz789",
"date": "xyz789",
"documentId": {},
"id": 123,
"modifiedDate": "abc123",
"modifiedUserId": 987,
"noticeId": 123,
"taxNoticeFileName": "xyz789"
}
]
}
}
createNoticeFinanceDetails
Description
Updates financial details for a notice specific to the clients company.
Response
Returns [FinanceResponseResult]
Arguments
| Name | Description |
|---|---|
input - NoticeFinanceDetailsInput
|
The financial details to be updated in the notice comment. |
Example
Query
mutation createNoticeFinanceDetails($input: NoticeFinanceDetailsInput) {
createNoticeFinanceDetails(input: $input) {
attachmentUploadRequest {
accountId
companyId
content
documentId
length
name
username
}
createdDate
createdUserId
credits
cspFeeRefund
customerInterest
customerPenalty
documentId
dueDate
fileName
id
interest
modifiedDate
modifiedUserId
noticeDate
noticeId
noticeNumber
paymentMethod
penalty
taxAbated
taxDue
}
}
Variables
{"input": NoticeFinanceDetailsInput}
Response
{
"data": {
"createNoticeFinanceDetails": [
{
"attachmentUploadRequest": AttachmentUploadRequestModel,
"createdDate": "abc123",
"createdUserId": 123,
"credits": 123.45,
"cspFeeRefund": 987.65,
"customerInterest": 987.65,
"customerPenalty": 987.65,
"documentId": {},
"dueDate": "xyz789",
"fileName": "xyz789",
"id": 987,
"interest": 123.45,
"modifiedDate": "abc123",
"modifiedUserId": 987,
"noticeDate": "abc123",
"noticeId": 987,
"noticeNumber": "xyz789",
"paymentMethod": "abc123",
"penalty": 123.45,
"taxAbated": 987.65,
"taxDue": 123.45
}
]
}
}
createNotices
Description
Creates notice and adds notice description specific to a company.
Response
Returns [NoticesResult]
Arguments
| Name | Description |
|---|---|
input - [CreateNoticesInput]
|
The details of the notice and description. |
Example
Query
mutation createNotices($input: [CreateNoticesInput]) {
createNotices(input: $input) {
id
createdDate
modifiedDate
status
region
taxPeriod
taxFormCode
filingFrequency
comments {
attachmentUploadRequest {
accountId
companyId
content
documentId
length
name
username
}
comment
commentLink
commentType
commentTypeId
commentUserId
commentUserName
date
documentId
id
modifiedDate
modifiedUserId
noticeId
taxNoticeFileName
}
finances {
attachmentUploadRequest {
accountId
companyId
content
documentId
length
name
username
}
createdDate
createdUserId
credits
cspFeeRefund
customerInterest
customerPenalty
documentId
dueDate
fileName
id
interest
modifiedDate
modifiedUserId
noticeDate
noticeId
noticeNumber
paymentMethod
penalty
taxAbated
taxDue
}
}
}
Variables
{"input": [CreateNoticesInput]}
Response
{
"data": {
"createNotices": [
{
"id": 987,
"createdDate": "abc123",
"modifiedDate": "xyz789",
"status": "xyz789",
"region": "abc123",
"taxPeriod": "xyz789",
"taxFormCode": "abc123",
"filingFrequency": "MONTHLY",
"comments": [CommentResult],
"finances": [FinanceResponseResult]
}
]
}
}
createOnboardingQuestionAnswer
Description
Creates the list of questions and their answers used in the onboarding survey.
Response
Returns an OnboardingQuestionAnswerResult
Arguments
| Name | Description |
|---|---|
companyId - Int!
|
Unique ID of the company for which onboarding question and their answer is to be created. |
input - OnboardingQuestionAnswerInput
|
Additional parameters for creation of onboarding question and their answer. |
Example
Query
mutation createOnboardingQuestionAnswer(
$companyId: Int!,
$input: OnboardingQuestionAnswerInput
) {
createOnboardingQuestionAnswer(
companyId: $companyId,
input: $input
) {
accountId
answerId
companyId
country
onboardingQuestionAnswerId
questionId
region
}
}
Variables
{"companyId": 123, "input": OnboardingQuestionAnswerInput}
Response
{
"data": {
"createOnboardingQuestionAnswer": {
"accountId": 123,
"answerId": {},
"companyId": 987,
"country": "abc123",
"onboardingQuestionAnswerId": {},
"questionId": {},
"region": "xyz789"
}
}
}
createTransaction
Description
Create a list of transactions done by the company.
A transaction is the record of a taxable event (sale, purchase, etc.) which contains details like amount, date, tax type used to calculate tax liabilities.
Response
Returns a CreateTransactionResult
Arguments
| Name | Description |
|---|---|
companyId - Int
|
The Unique ID of the company. |
input - [TransactionImportCreateInput]
|
The input details of the transactions to be created. |
Example
Query
mutation createTransaction(
$companyId: Int,
$input: [TransactionImportCreateInput]
) {
createTransaction(
companyId: $companyId,
input: $input
) {
status
transactionBatchId
errorMessage
}
}
Variables
{
"companyId": 987,
"input": [TransactionImportCreateInput]
}
Response
{
"data": {
"createTransaction": {
"status": "SUBMITTED",
"transactionBatchId": 123,
"errorMessage": "abc123"
}
}
}
createTransactionsSummary
Description
Create a list of transaction import summary for a company.
Response
Returns a CreateTransactionSummaryResult
Arguments
| Name | Description |
|---|---|
companyId - Int
|
The unique ID of the company. |
input - [TransactionImportSummaryInput]
|
The input details to update the transactions import summary. |
Example
Query
mutation createTransactionsSummary(
$companyId: Int,
$input: [TransactionImportSummaryInput]
) {
createTransactionsSummary(
companyId: $companyId,
input: $input
) {
status
transactionBatchId
errorMessage
}
}
Variables
{
"companyId": 987,
"input": [TransactionImportSummaryInput]
}
Response
{
"data": {
"createTransactionsSummary": {
"status": "SUBMITTED",
"transactionBatchId": 123,
"errorMessage": "xyz789"
}
}
}
createTransactionsUsingCalc
Description
Create a list of Calc transactions for a company.
Response
Returns a CreateTransactionSummaryResult
Arguments
| Name | Description |
|---|---|
companyId - Int!
|
The unique ID of the company. |
fileName - String!
|
The name of the file to create the Calc transaction. |
fileContents - String!
|
The content of the file in base64 format to create the Calc transaction. |
configurationId - Int
|
The unique ID of the transaction configuration. |
Example
Query
mutation createTransactionsUsingCalc(
$companyId: Int!,
$fileName: String!,
$fileContents: String!,
$configurationId: Int
) {
createTransactionsUsingCalc(
companyId: $companyId,
fileName: $fileName,
fileContents: $fileContents,
configurationId: $configurationId
) {
status
transactionBatchId
errorMessage
}
}
Variables
{
"companyId": 123,
"fileName": "abc123",
"fileContents": "xyz789",
"configurationId": 123
}
Response
{
"data": {
"createTransactionsUsingCalc": {
"status": "SUBMITTED",
"transactionBatchId": 123,
"errorMessage": "xyz789"
}
}
}
cycleSafeEditOptions
Description
Returns edit options when modifying a filing calendar.
This api will return the options available for updating the filing calendar.
Response
Returns a CycleSafeEditOptionsResult
Arguments
| Name | Description |
|---|---|
input - CycleSafeEditOptionsInput
|
The edit options for the filing calendar. |
Example
Query
mutation cycleSafeEditOptions($input: CycleSafeEditOptionsInput) {
cycleSafeEditOptions(input: $input) {
clonedCalendarEffDate
customerMustApprove
expiredCalendarEndDate
message
mustCloneFilingCalendar
success
}
}
Variables
{"input": CycleSafeEditOptionsInput}
Response
{
"data": {
"cycleSafeEditOptions": {
"clonedCalendarEffDate": "xyz789",
"customerMustApprove": true,
"expiredCalendarEndDate": "abc123",
"message": "abc123",
"mustCloneFilingCalendar": true,
"success": false
}
}
}
deleteContact
Description
Deletes an existing contact from a company.
This mutation allows you to remove a contact that was previously created for a company.
Response
Returns a DeleteResultModel
Example
Query
mutation deleteContact(
$companyId: Int!,
$contactId: Int!
) {
deleteContact(
companyId: $companyId,
contactId: $contactId
) {
success
message
}
}
Variables
{"companyId": 123, "contactId": 987}
Response
{
"data": {
"deleteContact": {
"success": false,
"message": "xyz789"
}
}
}
deleteFilingAdjustment
Description
Deletes an existing return adjustment.
This mutation allows you to remove a filing adjustment that was previously created.
Response
Returns a DeleteResultModel
Example
Query
mutation deleteFilingAdjustment(
$companyId: Int!,
$adjustmentId: Int!,
$type: String
) {
deleteFilingAdjustment(
companyId: $companyId,
adjustmentId: $adjustmentId,
type: $type
) {
success
message
}
}
Variables
{
"companyId": 987,
"adjustmentId": 123,
"type": "xyz789"
}
Response
{
"data": {
"deleteFilingAdjustment": {
"success": false,
"message": "xyz789"
}
}
}
deleteFirmClientLinkage
Description
This API allows the account user of the client account to remove the link to their current firm account.
Response
Returns a FirmClientLinkDetailsResult
Example
Query
mutation deleteFirmClientLinkage {
deleteFirmClientLinkage {
clientAccountId
clientAccountName
firmAccountId
firmAccountName
firmContactEmail
firmContactName
id
isDeleted
status
company {
companyId
accountId
name
isDefault
isActive
hasProfile
isReportingEntity
companyCode
isTest
}
licenseKey {
accountId
privateLicenseKey
}
}
}
Response
{
"data": {
"deleteFirmClientLinkage": {
"clientAccountId": 123,
"clientAccountName": "abc123",
"firmAccountId": 987,
"firmAccountName": "xyz789",
"firmContactEmail": "abc123",
"firmContactName": "abc123",
"id": 123,
"isDeleted": false,
"status": "REQUESTED",
"company": ClientCompanyResult,
"licenseKey": licenseKey
}
}
}
deleteLicenseKey
Description
Deletes a license key for an account.
Removes the specified license key from the account.
Response
Returns a DeleteResultModel
Arguments
| Name | Description |
|---|---|
accountId - Int!
|
The unique ID of the account. |
Example
Query
mutation deleteLicenseKey($accountId: Int!) {
deleteLicenseKey(accountId: $accountId) {
success
message
}
}
Variables
{"accountId": 987}
Response
{
"data": {
"deleteLicenseKey": {
"success": true,
"message": "abc123"
}
}
}
deleteLocation
Description
Deletes the specified location from a company.
Response
Returns a SaveResultModel
Example
Query
mutation deleteLocation(
$companyId: Int!,
$id: Int!
) {
deleteLocation(
companyId: $companyId,
id: $id
) {
id
success
successfulCount
errorCount
message
errorMessages
}
}
Variables
{"companyId": 123, "id": 987}
Response
{
"data": {
"deleteLocation": {
"id": 123,
"success": false,
"successfulCount": 987,
"errorCount": 123,
"message": "xyz789",
"errorMessages": ["abc123"]
}
}
}
deleteOnboardingQuestionAnswer
Description
Deletes an entry of onboarding question and their answer by an unique ID of the onboarding question and their answer.
Response
Returns a DeleteOnboardingQuestionAnswerResult
Example
Query
mutation deleteOnboardingQuestionAnswer(
$companyId: Int!,
$id: BigInt
) {
deleteOnboardingQuestionAnswer(
companyId: $companyId,
id: $id
) {
id
message
success
uuid
}
}
Variables
{"companyId": 123, "id": {}}
Response
{
"data": {
"deleteOnboardingQuestionAnswer": {
"id": {},
"message": "abc123",
"success": true,
"uuid": "4"
}
}
}
deleteTransaction
Description
Deletes the transactions created by using the unique ID of the batch used for creating the transactions.
Response
Returns a SaveResultModel
Example
Query
mutation deleteTransaction(
$companyId: Int!,
$transactionBatchId: Int!
) {
deleteTransaction(
companyId: $companyId,
transactionBatchId: $transactionBatchId
) {
id
success
successfulCount
errorCount
message
errorMessages
}
}
Variables
{"companyId": 987, "transactionBatchId": 123}
Response
{
"data": {
"deleteTransaction": {
"id": 987,
"success": true,
"successfulCount": 987,
"errorCount": 987,
"message": "xyz789",
"errorMessages": ["xyz789"]
}
}
}
deleteTransactionByCode
Description
Deletes a transaction import using the code of the transaction.
Response
Returns a SaveResultModel
Example
Query
mutation deleteTransactionByCode(
$companyId: Int!,
$transactionCode: String!
) {
deleteTransactionByCode(
companyId: $companyId,
transactionCode: $transactionCode
) {
id
success
successfulCount
errorCount
message
errorMessages
}
}
Variables
{
"companyId": 987,
"transactionCode": "xyz789"
}
Response
{
"data": {
"deleteTransactionByCode": {
"id": 987,
"success": false,
"successfulCount": 123,
"errorCount": 987,
"message": "xyz789",
"errorMessages": ["xyz789"]
}
}
}
fundingPoa
Description
Returns a list of funding setup requests and their current status.
Each object in the result is a request that was made to setup or adjust funding status for this company.
Response
Returns a FundingPOAResult
Arguments
| Name | Description |
|---|---|
input - FundingPOAInput!
|
Input used for setting funding poa. |
businessUnit - BusinessUnit
|
Specifies the type of the business of the company. |
companyId - Int!
|
The unique ID of the company. |
subscriptionType - SubscriptionType
|
The company's subscription type for which POA is to be created. |
bankingContact - BankingContactInput
|
Banking contact details used for NACHA compliance and banking inquiries. |
Example
Query
mutation fundingPoa(
$input: FundingPOAInput!,
$businessUnit: BusinessUnit,
$companyId: Int!,
$subscriptionType: SubscriptionType,
$bankingContact: BankingContactInput
) {
fundingPoa(
input: $input,
businessUnit: $businessUnit,
companyId: $companyId,
subscriptionType: $subscriptionType,
bankingContact: $bankingContact
) {
agreementType
agreementVersion
businessUnit
companyId
companySource
currency
documentKey
documentName
documentType
domain
errorMessage
javaScript
lastActivated
lastPolled
lastSigned
methodReturn {
javaScript
javaScriptReady
method
}
recipient
requestId
sender
status
subledgerProfileId
subscriptionType
templateRequestId
widgetId
}
}
Variables
{
"input": FundingPOAInput,
"businessUnit": "RETURNS",
"companyId": 123,
"subscriptionType": "MRS",
"bankingContact": BankingContactInput
}
Response
{
"data": {
"fundingPoa": {
"agreementType": "abc123",
"agreementVersion": 987,
"businessUnit": "abc123",
"companyId": "xyz789",
"companySource": "abc123",
"currency": "abc123",
"documentKey": "abc123",
"documentName": "xyz789",
"documentType": "xyz789",
"domain": "abc123",
"errorMessage": "abc123",
"javaScript": "xyz789",
"lastActivated": "abc123",
"lastPolled": "abc123",
"lastSigned": "abc123",
"methodReturn": FundingMethodReturn,
"recipient": "xyz789",
"requestId": {},
"sender": "abc123",
"status": "abc123",
"subledgerProfileId": 987,
"subscriptionType": "abc123",
"templateRequestId": {},
"widgetId": "xyz789"
}
}
}
resetLicenseKey
Description
Resets the license key for an account.
Represents a license key reset request. This license key reset function will only work when called using the credentials of the account administrator of this account.
Response
Returns a ResetLicenseKeyDetails
Arguments
| Name | Description |
|---|---|
accountId - Int!
|
The input containing account ID and confirmation flag. |
Example
Query
mutation resetLicenseKey($accountId: Int!) {
resetLicenseKey(accountId: $accountId) {
accountId
licenseKey
}
}
Variables
{"accountId": 123}
Response
{
"data": {
"resetLicenseKey": {
"accountId": 987,
"licenseKey": "xyz789"
}
}
}
reviewFilingCalendarRequests
Description
This endpoint is used to send request to compliance team to review the filing calendar requests for the specified company.
Response
Returns a SaveResultModel
Arguments
| Name | Description |
|---|---|
companyId - Int!
|
Unique ID of the company for which filing review is requested. |
Example
Query
mutation reviewFilingCalendarRequests($companyId: Int!) {
reviewFilingCalendarRequests(companyId: $companyId) {
id
success
successfulCount
errorCount
message
errorMessages
}
}
Variables
{"companyId": 987}
Response
{
"data": {
"reviewFilingCalendarRequests": {
"id": 123,
"success": true,
"successfulCount": 987,
"errorCount": 123,
"message": "xyz789",
"errorMessages": ["abc123"]
}
}
}
reviewFilingRequests
This endpoint is obsolete. Please use reviewFilingCalendarRequests instead.
Description
This endpoint is used to send request to compliance team to review the filing requests for the specified company.
Response
Returns a SaveResultModel
Arguments
| Name | Description |
|---|---|
companyId - Int!
|
Unique ID of the company for which filing review is requested. |
Example
Query
mutation reviewFilingRequests($companyId: Int!) {
reviewFilingRequests(companyId: $companyId) {
id
success
successfulCount
errorCount
message
errorMessages
}
}
Variables
{"companyId": 123}
Response
{
"data": {
"reviewFilingRequests": {
"id": 123,
"success": false,
"successfulCount": 123,
"errorCount": 123,
"message": "abc123",
"errorMessages": ["xyz789"]
}
}
}
submitCanadaOnboardingAnswer
Description
Submits an answer for a Canada onboarding question. This endpoint allows users to submit answers during the Canadian company onboarding process.
Response
Returns a CanadaOnboardingAnswerResult
Arguments
| Name | Description |
|---|---|
companyId - Int!
|
The unique ID of the company for which to submit the answer. |
input - CanadaOnboardingAnswerInput!
|
The answer input containing question code and answer value. |
Example
Query
mutation submitCanadaOnboardingAnswer(
$companyId: Int!,
$input: CanadaOnboardingAnswerInput!
) {
submitCanadaOnboardingAnswer(
companyId: $companyId,
input: $input
) {
nextQuestionCode
possibleAnswers
questionText
helpText
isOnboardingComplete
}
}
Variables
{"companyId": 987, "input": CanadaOnboardingAnswerInput}
Response
{
"data": {
"submitCanadaOnboardingAnswer": {
"nextQuestionCode": "xyz789",
"possibleAnswers": ["abc123"],
"questionText": "xyz789",
"helpText": "xyz789",
"isOnboardingComplete": true
}
}
}
submitNoticePoa
Description
This allows users to submit a filing notice POA, provided the notice is in the 'Open Waiting on Customer POA' status..
Submits the notice poa.
Response
Returns a SaveResultModel
Arguments
| Name | Description |
|---|---|
input - SubmitNoticeFilingInput
|
Input containing the filing POA details to be submitted. |
Example
Query
mutation submitNoticePoa($input: SubmitNoticeFilingInput) {
submitNoticePoa(input: $input) {
id
success
successfulCount
errorCount
message
errorMessages
}
}
Variables
{"input": SubmitNoticeFilingInput}
Response
{
"data": {
"submitNoticePoa": {
"id": 987,
"success": true,
"successfulCount": 123,
"errorCount": 987,
"message": "xyz789",
"errorMessages": ["abc123"]
}
}
}
updateAccount
Description
Updates the end date of the account that is due to expire.
If the account has active companies, then an exception is thrown.
Response
Returns an AccountResult
Arguments
| Name | Description |
|---|---|
accountId - Int!
|
Unique ID of the account which is to be updated. |
input - UpdateAccountRequestInput
|
Additional details used for updating the account. |
Example
Query
mutation updateAccount(
$accountId: Int!,
$input: UpdateAccountRequestInput
) {
updateAccount(
accountId: $accountId,
input: $input
) {
id
crmid
name
effectiveDate
endDate
accountStatusId
accountTypeId
isSamlEnabled
isDeleted
}
}
Variables
{"accountId": 123, "input": UpdateAccountRequestInput}
Response
{
"data": {
"updateAccount": {
"id": 987,
"crmid": "abc123",
"name": "xyz789",
"effectiveDate": "xyz789",
"endDate": "xyz789",
"accountStatusId": "INACTIVE",
"accountTypeId": "REGULAR",
"isSamlEnabled": false,
"isDeleted": true
}
}
}
updateCompany
Description
Updates company information including filing status and Taxpayer Identification Number (EIN/TIN).
When updating the EIN/TIN, note that this change only affects returns moving forward. Existing filing calendars will retain their current EIN and must be updated individually if needed.
Response
Returns a CompanyResult
Arguments
| Name | Description |
|---|---|
id - Int!
|
The unique ID of the company. |
input - UpdateCompanyRequestInput
|
Additional detail of the company for example, company name, status, and taxpayer identification number. |
Example
Query
mutation updateCompany(
$id: Int!,
$input: UpdateCompanyRequestInput
) {
updateCompany(
id: $id,
input: $input
) {
id
accountId
parentCompanyId
sstPid
companyCode
name
isActive
hasProfile
isReportingEntity
defaultCountry
roundingLevelId
isTest
taxDependencyLevelId
inProgress
businessIdentificationNo
locations {
addressCategoryId
addressTypeId
city
companyId
country
dbaName
description
endDate
effectiveDate
id
isDefault
isMarketplaceOutsideUsa
isRegistered
lastTransactionDate
line1
line2
line3
locationCode
outletName
postalCode
region
registeredDate
importedAddressCategoryId
importedAddressTypeId
settings {
questionId
questionName
value
}
}
settings {
companyId
id
name
set
value
}
contacts {
id
companyId
contactCode
firstName
middleName
lastName
title
line1
line2
line3
city
region
postalCode
country
email
phone
mobile
fax
}
mossCountry
mossId
isDeleted
taxpayerIdNumber
filingStatus
}
}
Variables
{"id": 123, "input": UpdateCompanyRequestInput}
Response
{
"data": {
"updateCompany": {
"id": 987,
"accountId": 123,
"parentCompanyId": 123,
"sstPid": "abc123",
"companyCode": "xyz789",
"name": "abc123",
"isActive": true,
"hasProfile": false,
"isReportingEntity": false,
"defaultCountry": "xyz789",
"roundingLevelId": "LINE",
"isTest": true,
"taxDependencyLevelId": "DOCUMENT",
"inProgress": true,
"businessIdentificationNo": "abc123",
"locations": [LocationModel],
"settings": [CompanySettingModel],
"contacts": [ContactModel],
"mossCountry": "abc123",
"mossId": "abc123",
"isDeleted": true,
"taxpayerIdNumber": "abc123",
"filingStatus": "NOTCONFIGUREDFORCOMPLIANCE"
}
}
}
updateContact
Description
Updates an existing contact for a company.
This mutation allows you to modify the details of an existing contact, such as name, address, phone, or email.
Response
Returns a ContactModel
Arguments
| Name | Description |
|---|---|
companyId - Int!
|
The unique ID of the company that owns the contact. |
contactId - Int!
|
The unique ID of the contact to update. |
input - ContactModelInput!
|
The updated contact data. |
Example
Query
mutation updateContact(
$companyId: Int!,
$contactId: Int!,
$input: ContactModelInput!
) {
updateContact(
companyId: $companyId,
contactId: $contactId,
input: $input
) {
id
companyId
contactCode
firstName
middleName
lastName
title
line1
line2
line3
city
region
postalCode
country
email
phone
mobile
fax
}
}
Variables
{
"companyId": 123,
"contactId": 123,
"input": ContactModelInput
}
Response
{
"data": {
"updateContact": {
"id": 123,
"companyId": 987,
"contactCode": "abc123",
"firstName": "abc123",
"middleName": "xyz789",
"lastName": "xyz789",
"title": "xyz789",
"line1": "abc123",
"line2": "xyz789",
"line3": "abc123",
"city": "xyz789",
"region": "abc123",
"postalCode": "abc123",
"country": "abc123",
"email": "xyz789",
"phone": "abc123",
"mobile": "abc123",
"fax": "abc123"
}
}
}
updateFilingAdjustment
Description
Updates an existing return adjustment.
This mutation allows you to modify the details of an existing filing adjustment, such as the amount, period, type, or account type.
Response
Returns a FilingAdjustmentResult
Arguments
| Name | Description |
|---|---|
companyId - Int!
|
The unique ID of the company that owns the filing adjustment. |
adjustmentId - Int!
|
The unique ID of the adjustment to update. |
input - FilingAdjustmentModelInput!
|
The updated adjustment data. |
Example
Query
mutation updateFilingAdjustment(
$companyId: Int!,
$adjustmentId: Int!,
$input: FilingAdjustmentModelInput!
) {
updateFilingAdjustment(
companyId: $companyId,
adjustmentId: $adjustmentId,
input: $input
) {
accountType
amount
filingId
id
isCalculated
period
reason
type
}
}
Variables
{
"companyId": 987,
"adjustmentId": 123,
"input": FilingAdjustmentModelInput
}
Response
{
"data": {
"updateFilingAdjustment": {
"accountType": "NONE",
"amount": 123.45,
"filingId": {},
"id": {},
"isCalculated": false,
"period": "NONE",
"reason": "abc123",
"type": "xyz789"
}
}
}
updateFilingCalendarRequest
Description
This allows users to update the existing filing calendar request by submitting necessary information about the filing calendar.
Updates filing calendar request.
Response
Returns a FilingRequestModel
Arguments
| Name | Description |
|---|---|
input - UpdateFilingRequestInputModel
|
The details required to update the existing filing calendar request. |
Example
Query
mutation updateFilingCalendarRequest($input: UpdateFilingRequestInputModel) {
updateFilingCalendarRequest(input: $input) {
companyId
data {
answers {
answer
filingQuestionId
filingQuestionCode
}
autoLockOverrideDay
companyReturnId
country
effDate
endDate
filingFrequencyId
fiscalYearStartMonth
isClone
locationCode
region
registrationId
taxAuthorityId
taxAuthorityName
taxFormCode
taxTypeId
canValidateEfileCredentials
twoFactorAuthForwardEmail
twoFactorAlias
}
filingRequestStatusId
id
}
}
Variables
{"input": UpdateFilingRequestInputModel}
Response
{
"data": {
"updateFilingCalendarRequest": {
"companyId": 987,
"data": FilingRequestDataModel,
"filingRequestStatusId": "NEW",
"id": {}
}
}
}
updateLocation
Description
Update specific location of the company using the unique ID.
Response
Returns a SaveResultModel
Arguments
| Name | Description |
|---|---|
companyId - Int!
|
Unique ID of the company for which location is to be updated. |
id - Int!
|
Unique ID of the location to be updated. |
input - LocationModelInput
|
Input containing location details like city, county, address and so on to be updated. |
Example
Query
mutation updateLocation(
$companyId: Int!,
$id: Int!,
$input: LocationModelInput
) {
updateLocation(
companyId: $companyId,
id: $id,
input: $input
) {
id
success
successfulCount
errorCount
message
errorMessages
}
}
Variables
{"companyId": 123, "id": 987, "input": LocationModelInput}
Response
{
"data": {
"updateLocation": {
"id": 123,
"success": true,
"successfulCount": 123,
"errorCount": 123,
"message": "xyz789",
"errorMessages": ["xyz789"]
}
}
}
updateOnboardingQuestionAnswer
Description
Updates the answer of the questions in the onboarding survey.
Response
Returns an OnboardingQuestionAnswerResult
Arguments
| Name | Description |
|---|---|
companyId - Int!
|
Unique ID of the company for which onboarding question and their answer is to be updated. |
input - OnboardingQuestionAnswerInput
|
Additional parameters for updating onboarding question and their answer. |
id - BigInt
|
Unique ID of the onboarding question answer to be updated. |
Example
Query
mutation updateOnboardingQuestionAnswer(
$companyId: Int!,
$input: OnboardingQuestionAnswerInput,
$id: BigInt
) {
updateOnboardingQuestionAnswer(
companyId: $companyId,
input: $input,
id: $id
) {
accountId
answerId
companyId
country
onboardingQuestionAnswerId
questionId
region
}
}
Variables
{
"companyId": 987,
"input": OnboardingQuestionAnswerInput,
"id": {}
}
Response
{
"data": {
"updateOnboardingQuestionAnswer": {
"accountId": 987,
"answerId": {},
"companyId": 123,
"country": "abc123",
"onboardingQuestionAnswerId": {},
"questionId": {},
"region": "xyz789"
}
}
}
updateRegionStatus
Description
Updates the status of the regions.
This endpoint will help in marking the status of the region to complete or in progress during onboarding.
Response
Returns [RegionStatusResult]
Arguments
| Name | Description |
|---|---|
companyId - Int!
|
Unique ID of the company for which region status is to be updated. |
input - [UpdateRegionStatusInput]
|
Properties for updating region status |
Example
Query
mutation updateRegionStatus(
$companyId: Int!,
$input: [UpdateRegionStatusInput]
) {
updateRegionStatus(
companyId: $companyId,
input: $input
) {
country
region
status
}
}
Variables
{"companyId": 123, "input": [UpdateRegionStatusInput]}
Response
{
"data": {
"updateRegionStatus": [
{
"country": "abc123",
"region": "xyz789",
"status": "NOTSTARTED"
}
]
}
}
uploadData
Description
Import transactions from a file, supporting multiple data sources.
Response
Returns a VatUploadDataResult
Arguments
| Name | Description |
|---|---|
companyId - Int!
|
The unique ID of the company. |
filingPeriod - String
|
The filing period for the transaction import. |
fileName - String!
|
The name of the file to import. |
fileContents - String!
|
The content of the file in base64 format. |
configurationId - Int
|
The unique ID of the transaction configuration. |
Example
Query
mutation uploadData(
$companyId: Int!,
$filingPeriod: String,
$fileName: String!,
$fileContents: String!,
$configurationId: Int
) {
uploadData(
companyId: $companyId,
filingPeriod: $filingPeriod,
fileName: $fileName,
fileContents: $fileContents,
configurationId: $configurationId
) {
id
errors {
message
extensions {
type
code
status
documentation
timestamp
requestId
}
}
}
}
Variables
{
"companyId": 123,
"filingPeriod": "abc123",
"fileName": "xyz789",
"fileContents": "xyz789",
"configurationId": 123
}
Response
{
"data": {
"uploadData": {
"id": "xyz789",
"errors": [Error]
}
}
}
verifyEFileCredential
Description
This allows users to verify the e-file credentials for the specified company.
Response
Returns a VerifyEFileCredentialResult
Arguments
| Name | Description |
|---|---|
companyId - Int!
|
The unique ID of the company. |
input - VerifyEFileCredentialInput!
|
The input details of the e-file credentials to be verified. |
Example
Query
mutation verifyEFileCredential(
$companyId: Int!,
$input: VerifyEFileCredentialInput!
) {
verifyEFileCredential(
companyId: $companyId,
input: $input
) {
jobId
status
loginSuccess
message
}
}
Variables
{"companyId": 987, "input": VerifyEFileCredentialInput}
Response
{
"data": {
"verifyEFileCredential": {
"jobId": {},
"status": "abc123",
"loginSuccess": false,
"message": "abc123"
}
}
}
Types
AccountResult
Fields
| Field Name | Description |
|---|---|
id - Int
|
The unique identifier for this account. |
crmid - String
|
The CRM identifier for this account. |
name - String
|
The display name of the account. |
effectiveDate - String
|
The date when this account becomes effective. |
endDate - String
|
The end date for this account's validity. |
accountStatusId - AccountStatus
|
The current status of this account. |
accountTypeId - AccountTypeId
|
The type classification of this account. |
isSamlEnabled - Boolean
|
Indicates whether SAML authentication is enabled for this account. |
isDeleted - Boolean
|
Indicates whether this account has been deleted. |
Example
{
"id": 123,
"crmid": "abc123",
"name": "xyz789",
"effectiveDate": "xyz789",
"endDate": "abc123",
"accountStatusId": "INACTIVE",
"accountTypeId": "REGULAR",
"isSamlEnabled": true,
"isDeleted": true
}
AccountStatus
Values
| Enum Value | Description |
|---|---|
|
|
The account is not currently active. |
|
|
The account is currently active and in use. |
|
|
The account is a test account. |
|
|
The account is newly created. |
Example
"INACTIVE"
AccountType
Values
| Enum Value | Description |
|---|---|
|
|
No specific account type |
|
|
Both accounts receivable and payable |
|
|
Accounts receivable only |
|
|
Accounts payable only |
Example
"NONE"
AccountTypeId
Values
| Enum Value | Description |
|---|---|
|
|
A regular user account. |
|
|
An account belonging to a tax firm. |
|
|
An account belonging to a client of a tax firm. |
Example
"REGULAR"
AccountValidationStatus
Values
| Enum Value | Description |
|---|---|
|
|
New account that hasn't been validated yet |
|
|
Account has been successfully added and validated |
|
|
Account validation process failed |
Example
"NEW"
AccrualType
Values
| Enum Value | Description |
|---|---|
|
|
Accrual based on filing |
|
|
General accrual |
Example
"FILING"
AddCommentResponse
Description
Response returned when adding a comment to a case
Fields
| Field Name | Description |
|---|---|
success - String!
|
Whether the comment creation was successful |
message - String
|
Response message |
externalFirmCaseId - String
|
External firm case ID |
externalFirmCaseNumber - String
|
External firm case number |
caseId - String
|
The case ID (15-18 characters) |
error - PartnerSupportError
|
Error details if operation failed |
Example
{
"success": "abc123",
"message": "abc123",
"externalFirmCaseId": "xyz789",
"externalFirmCaseNumber": "xyz789",
"caseId": "xyz789",
"error": PartnerSupportError
}
AddPartnerSupportCommentInput
Description
Input for adding a comment to an existing firm support case
Fields
| Input Field | Description |
|---|---|
caseId - String!
|
The Salesforce case ID to add the comment to |
externalFirmCaseId - String
|
External firm case ID |
externalFirmCaseNumber - String
|
External firm case number |
comment - String!
|
The comment text (max 4000 characters) |
commentedDate - String
|
Date when the comment was made (ISO 8601 format) |
Example
{
"caseId": "xyz789",
"externalFirmCaseId": "abc123",
"externalFirmCaseNumber": "xyz789",
"comment": "abc123",
"commentedDate": "abc123"
}
AddressCategory
Values
| Enum Value | Description |
|---|---|
|
|
Physical store location |
|
|
Main office location |
|
|
Warehouse location |
|
|
Salesperson location |
|
|
Other type of location |
|
|
Seller remits tax location |
|
|
Marketplace remits tax location |
|
|
Non-physical location |
|
|
Vendor location |
Example
"STOREFRONT"
AddressType
Values
| Enum Value | Description |
|---|---|
|
|
Physical location address |
|
|
Salesperson address |
|
|
Marketplace address |
Example
"LOCATION"
AllowableAdjustment
Fields
| Field Name | Description |
|---|---|
adjustmentCode - String
|
The adjustment code. |
adjustmentName - String
|
The name of the adjustment. |
adjustmentTypeId - BigInt
|
The type of adjustment. |
customerEditable - Boolean
|
A flag to indicate if the field is editable by the customer. |
decimalPlaces - Int
|
The number of decimal precision places for the amount field. |
effDate - String
|
The date when the adjustments becomes effective. |
endDate - String
|
The date when the adjustments end. |
formAdjustmentTypeId - BigInt
|
The type of form adjustment. |
isAccountsPayable - Boolean
|
A flag to indicate whether the adjustment is related to Accounts Payable. |
isAccountsReceivable - Boolean
|
A flag to indicate whether the adjustment is related to Accounts Receivable. |
negativeAllowed - Boolean
|
A flag to indicate whether a negative adjustment is allowed. |
positiveAllowed - Boolean
|
A flag to indicate whether a positive adjustment is allowed. |
prompt - String
|
Example
{
"adjustmentCode": "abc123",
"adjustmentName": "abc123",
"adjustmentTypeId": {},
"customerEditable": true,
"decimalPlaces": 123,
"effDate": "xyz789",
"endDate": "xyz789",
"formAdjustmentTypeId": {},
"isAccountsPayable": true,
"isAccountsReceivable": false,
"negativeAllowed": true,
"positiveAllowed": true,
"prompt": "xyz789"
}
ApprovalInput
Description
The input to decide whether to approve filings.
Fields
| Input Field | Description |
|---|---|
approve - Boolean!
|
The Boolean value to decide whether to approve filings. |
Example
{"approve": true}
ApproveFilingResult
Fields
| Field Name | Description |
|---|---|
recordsetCount - Int
|
The total number of records available. |
value - [FilingModel]
|
The list of filings. |
Example
{"recordsetCount": 987, "value": [FilingModel]}
ApproveFilingsInput
Fields
| Input Field | Description |
|---|---|
approvalInput - ApprovalInput
|
The input to decide whether to approve filings. |
companyId - Int!
|
The ID of the company that owns the filings. |
month - Int!
|
The month of the filing period to approve. |
year - Int!
|
The year of the filing period to approve. |
region - String
|
The two or three-character ISO 3166 code for the region. |
country - String
|
The two-character ISO 3166 country code. |
Example
{
"approvalInput": ApprovalInput,
"companyId": 123,
"month": 987,
"year": 123,
"region": "xyz789",
"country": "xyz789"
}
AskReturnsAgentInput
Description
Input for asking the Returns Agent a question
Example
{
"prompt": "abc123",
"sessionId": "xyz789"
}
AskReturnsAgentResult
Description
Result type for Returns Agent query
Fields
| Field Name | Description |
|---|---|
result - String
|
The agent's response text or result payload |
success - Boolean
|
Whether the request succeeded |
requestId - String
|
Request/correlation ID for the call |
sessionId - String
|
Session ID associated with the conversation |
errors - [Error]
|
Error details if the request failed. |
Example
{
"result": "xyz789",
"success": true,
"requestId": "xyz789",
"sessionId": "xyz789",
"errors": [Error]
}
AttachmentUploadRequestModel
Fields
| Field Name | Description |
|---|---|
accountId - Int
|
The identifier of the account associated with the upload. |
companyId - Int
|
The identifier of the company the attachment belongs to. |
content - String
|
The base64 encoded content of the attachment. |
documentId - Int
|
The unique identifier for the document. |
length - Float
|
The size of the attachment in bytes. |
name - String
|
The file name of the attachment. |
username - String
|
The username of the person uploading the attachment. |
Example
{
"accountId": 123,
"companyId": 987,
"content": "xyz789",
"documentId": 123,
"length": 987.65,
"name": "xyz789",
"username": "xyz789"
}
BankAccountType
Values
| Enum Value | Description |
|---|---|
|
|
Business checking account |
|
|
Business savings account |
|
|
Personal checking account |
|
|
Personal savings account |
Example
"BUSINESSCHECKING"
BankInformationModel
Fields
| Field Name | Description |
|---|---|
accountHolderName - String
|
The name of the account holder. |
accountNickname - String
|
The nickname for the account. |
accountType - String
|
The account type. |
bankAccountDescription - String
|
A short description of the account. |
bankAccountNumber - String
|
The bank account number. |
bankAccountType - BankAccountType
|
The type of bank account. |
bankInformationId - Int
|
The unique ID for the bank information. |
bankName - String
|
The name of the bank. |
bankRoutingNumber - String
|
The routing number of the bank account. |
country - String
|
The country where the bank is located. |
financialInstitutionCode - BigInt
|
The financial institution code. |
firmId - Int
|
The unique ID of the firm. |
institutionId - String
|
The unique ID of the institution. |
isDefault - Boolean
|
Set this flag to true to indicate that this is the default bank account for this company. |
region - String
|
The region of the return. |
Example
{
"accountHolderName": "xyz789",
"accountNickname": "abc123",
"accountType": "abc123",
"bankAccountDescription": "xyz789",
"bankAccountNumber": "xyz789",
"bankAccountType": "BUSINESSCHECKING",
"bankInformationId": 123,
"bankName": "abc123",
"bankRoutingNumber": "xyz789",
"country": "abc123",
"financialInstitutionCode": {},
"firmId": 987,
"institutionId": "xyz789",
"isDefault": false,
"region": "xyz789"
}
BankingContactInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
Banking contact name. |
email - String!
|
Banking contact email. Must be a valid email address. |
phone - String!
|
Banking contact phone. Must be a valid phone number. |
line1 - String!
|
Banking contact address line 1. |
line2 - String
|
Banking contact address line 2. |
city - String!
|
Banking contact city. |
region - String!
|
Banking contact region/state. |
postalCode - String!
|
Banking contact postal code. |
country - String!
|
Banking contact country (ISO code). |
Example
{
"name": "abc123",
"email": "xyz789",
"phone": "xyz789",
"line1": "xyz789",
"line2": "abc123",
"city": "abc123",
"region": "xyz789",
"postalCode": "abc123",
"country": "abc123"
}
BatchErrorResult
Fields
| Field Name | Description |
|---|---|
companyId - Int
|
Unique id of the company. |
companyName - String
|
Name of the company for which data is returned. |
status - TransactionBatchStatus
|
Status of the transaction import. |
errors - [TransactionImportError]
|
Collection of errors for the transaction import. |
Example
{
"companyId": 987,
"companyName": "xyz789",
"status": "SUBMITTED",
"errors": [TransactionImportError]
}
BatchStatusResult
Fields
| Field Name | Description |
|---|---|
transactionBatchId - Int
|
Unique id of the batch. |
status - TransactionBatchStatus
|
Indicates the status of the batch. |
errorMessages - [String]
|
Messages indicating any errors. |
hasErrorFile - Boolean
|
Indicates if there is any errorfile or not. |
fileName - String
|
Name of the file containing transactions. |
importType - ImportType
|
Type of the transaction import. |
createdDate - String
|
Date on which transaction is uploaded. |
Example
{
"transactionBatchId": 987,
"status": "SUBMITTED",
"errorMessages": ["xyz789"],
"hasErrorFile": true,
"fileName": "xyz789",
"importType": "A",
"createdDate": "abc123"
}
BigInt
Description
The BigInt scalar type represents non-fractional signed whole numeric values.
Example
{}
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
BusinessUnit
Values
| Enum Value | Description |
|---|---|
|
|
Returns business unit. |
|
|
Lodging business unit. |
|
|
Telecommunications business unit. |
Example
"RETURNS"
Byte
Description
The Byte scalar type represents an 8-bit unsigned integer with a range from 0 to 255. It is typically used to store binary data or small numeric values.
Example
[196, 189, 173, 171, 167, 163]
CalcTransactionsErrorsResult
Fields
| Field Name | Description |
|---|---|
id - Int
|
The unique ID of the record. |
success - Boolean
|
Indicates success or failure. |
successfulCount - Int
|
Count of the successful records saved. |
errorCount - Int
|
Count of the error records to be saved. |
message - String
|
Message of success or failure. |
errorMessages - [String]
|
List of messages specifying failures. |
fileName - String
|
The name of the error file (if error exists. If no error exists, this will be null). |
contentBase64 - String
|
The content of the error file in base64 format (if error exists. If no error exists, this will be null). |
Example
{
"id": 123,
"success": false,
"successfulCount": 987,
"errorCount": 987,
"message": "abc123",
"errorMessages": ["xyz789"],
"fileName": "xyz789",
"contentBase64": "abc123"
}
CanadaOnboardingAnswer
Description
A possible answer to a Canada onboarding question
Example
{
"value": "xyz789",
"nextQuestionCode": "abc123",
"helpText": "xyz789"
}
CanadaOnboardingAnswerInput
CanadaOnboardingAnswerResult
Description
Result type for Canada onboarding answer submission
Fields
| Field Name | Description |
|---|---|
nextQuestionCode - String
|
The code of the next question to display |
possibleAnswers - [String]
|
List of possible answers for the next question |
questionText - String
|
The text of the next question |
helpText - String
|
Help text providing additional context |
isOnboardingComplete - Boolean
|
Indicates whether the onboarding process is complete |
Example
{
"nextQuestionCode": "abc123",
"possibleAnswers": ["xyz789"],
"questionText": "abc123",
"helpText": "abc123",
"isOnboardingComplete": true
}
CanadaOnboardingQuestion
Description
A question in the Canada onboarding process
Fields
| Field Name | Description |
|---|---|
questionCode - String
|
The unique code identifier for the question |
questionText - String
|
The text of the question |
helpText - String
|
Help text providing additional context for the question |
answers - [CanadaOnboardingAnswer]
|
List of possible answers for this question |
Example
{
"questionCode": "abc123",
"questionText": "xyz789",
"helpText": "xyz789",
"answers": [CanadaOnboardingAnswer]
}
ClientCompanyResult
Fields
| Field Name | Description |
|---|---|
companyId - Int
|
The unique ID of the company. |
accountId - Int
|
Account ID. |
name - String
|
The name of the company. |
isDefault - Boolean
|
Specifies if the company is default. |
isActive - Boolean
|
Specifies if the company is default. |
hasProfile - Boolean
|
Specifies if the company has profile. |
isReportingEntity - Boolean
|
Specifies if the company is reporting entity. |
companyCode - String
|
The code of the company. |
isTest - Boolean
|
Specifies if the company is a test company. |
Example
{
"companyId": 123,
"accountId": 123,
"name": "abc123",
"isDefault": false,
"isActive": true,
"hasProfile": true,
"isReportingEntity": true,
"companyCode": "abc123",
"isTest": false
}
CommentInput
Fields
| Input Field | Description |
|---|---|
attachmentUploadRequest - DocumentUploadRequestModelInput
|
Details of the document to be uploaded. |
comment - String
|
Text of the comment. |
commentLink - String
|
Link of the comment. |
commentType - CommentType!
|
Type of the comment. |
commentTypeId - Int
|
Id of the type of comment. |
commentUserId - Int
|
UserId of the user added comment. |
commentUserName - String
|
Username of the user added comment. |
date - String
|
Date of the comment. |
documentId - BigInt
|
Id of attached document. |
noticeId - Int!
|
NoticeId for which comment is added. |
taxNoticeFileName - String
|
File name of the tax notice. |
Example
{
"attachmentUploadRequest": DocumentUploadRequestModelInput,
"comment": "xyz789",
"commentLink": "xyz789",
"commentType": "INTERNAL",
"commentTypeId": 987,
"commentUserId": 987,
"commentUserName": "abc123",
"date": "abc123",
"documentId": {},
"noticeId": 987,
"taxNoticeFileName": "abc123"
}
CommentResult
Fields
| Field Name | Description |
|---|---|
attachmentUploadRequest - AttachmentUploadRequestModel
|
The attachment upload request details. |
comment - String
|
The content of the comment. |
commentLink - String
|
The URL link associated with the comment. |
commentType - CommentType
|
The type of comment. |
commentTypeId - Int
|
The identifier for the comment type. |
commentUserId - Int
|
The user ID of the commenter. |
commentUserName - String
|
The username of the commenter. |
date - String
|
The date when the comment was made. |
documentId - BigInt
|
The identifier for associated document. |
id - Int
|
The unique identifier for the comment. |
modifiedDate - String
|
The last modification date. |
modifiedUserId - Int
|
The user ID of the last person to modify the comment. |
noticeId - Int
|
The reference to the associated notice. |
taxNoticeFileName - String
|
The name of the tax notice file. |
Example
{
"attachmentUploadRequest": AttachmentUploadRequestModel,
"comment": "xyz789",
"commentLink": "xyz789",
"commentType": "INTERNAL",
"commentTypeId": 987,
"commentUserId": 123,
"commentUserName": "abc123",
"date": "abc123",
"documentId": {},
"id": 987,
"modifiedDate": "abc123",
"modifiedUserId": 123,
"noticeId": 987,
"taxNoticeFileName": "abc123"
}
CommentType
Values
| Enum Value | Description |
|---|---|
|
|
Internal comment |
|
|
Customer comment |
|
|
POA attachment comment |
|
|
Notice voucher comment |
Example
"INTERNAL"
CompaniesInput
Fields
| Input Field | Description |
|---|---|
country - String
|
The two-character ISO 3166 country code to filter country-specific Suggested Returns. |
region - String
|
The region to filter region-specific Suggested Returns |
orderBy - String
|
A comma-separated list of sort statements. |
skip - Int
|
If nonzero, skip this number of records before returning results. |
top - Int
|
If nonzero, return no more than this number of results. |
Example
{
"country": "abc123",
"region": "xyz789",
"orderBy": "xyz789",
"skip": 123,
"top": 987
}
CompaniesResult
Fields
| Field Name | Description |
|---|---|
value - [CompanyModel]
|
A list of companies. |
errors - [Error]
|
List of errors. |
pageInfo - PageInfo
|
Pagination info. |
Example
{
"value": [CompanyModel],
"errors": [Error],
"pageInfo": PageInfo
}
CompanyAddressInput
Fields
| Input Field | Description |
|---|---|
city - String!
|
The city of the company's address. |
country - String!
|
The two character ISO-3166 code for the country of the company's address. |
line - String!
|
The line of the company's street address. |
postalCode - String!
|
The postal code of the company's address. |
region - String!
|
The two or three-character ISO-3166 code for region of the company's address. |
Example
{
"city": "xyz789",
"country": "abc123",
"line": "xyz789",
"postalCode": "abc123",
"region": "abc123"
}
CompanyFilingStatus
Values
| Enum Value | Description |
|---|---|
|
|
Company not set up for compliance |
|
|
Company not yet filing |
|
|
Filing has been requested |
|
|
First filing period |
|
|
Active filing status |
|
|
No reporting required |
|
|
Inactive filing status |
Example
"NOTCONFIGUREDFORCOMPLIANCE"
CompanyImportHistoryResult
Fields
| Field Name | Description |
|---|---|
value - [BatchStatusResult]
|
Specifies the batch status result. |
Example
{"value": [BatchStatusResult]}
CompanyLocationModelInput
Fields
| Input Field | Description |
|---|---|
addressCategoryId - AddressCategory!
|
The unique ID of the address category. |
addressTypeId - AddressType!
|
The unique ID of the address type. |
city - String
|
The city name. |
country - String
|
The country name. |
dbaName - String
|
The name of the dba. |
description - String
|
Description of the location. |
effectiveDate - String!
|
Date from which location is effective. |
endDate - String
|
End date of the location. |
id - Int
|
The unique ID of the location. |
importedAddressCategoryId - String
|
The unique ID of the imported address. |
importedAddressTypeId - String
|
The unique type ID of the imported address. |
isDefault - Boolean
|
A flag to indicate if this location is default. |
isMarketplaceOutsideUsa - Boolean
|
A flag to indicate if this marketplace location is outside the USA. |
isRegistered - Boolean
|
A flag to indicate if this location is registered. |
lastTransactionDate - String
|
Last transaction date for this location. |
line1 - String!
|
Address line 1. |
line2 - String
|
Address line 2. |
line3 - String
|
Address line 3. |
locationCode - String!
|
Unique code of the location. |
outletName - String
|
The name of the outlet. |
postalCode - String!
|
Postal code of the location. |
region - String!
|
Region of the location. |
registeredDate - String
|
Date of registration of the location. |
settings - [LocationSettingModelInput]
|
Settings details of the location. |
Example
{
"addressCategoryId": "STOREFRONT",
"addressTypeId": "LOCATION",
"city": "abc123",
"country": "xyz789",
"dbaName": "xyz789",
"description": "xyz789",
"effectiveDate": "abc123",
"endDate": "xyz789",
"id": 987,
"importedAddressCategoryId": "xyz789",
"importedAddressTypeId": "xyz789",
"isDefault": false,
"isMarketplaceOutsideUsa": true,
"isRegistered": false,
"lastTransactionDate": "xyz789",
"line1": "abc123",
"line2": "abc123",
"line3": "xyz789",
"locationCode": "xyz789",
"outletName": "xyz789",
"postalCode": "abc123",
"region": "xyz789",
"registeredDate": "xyz789",
"settings": [LocationSettingModelInput]
}
CompanyModel
Fields
| Field Name | Description |
|---|---|
accountId - Int
|
The unique ID number of the account this company belongs to. |
businessIdentificationNo - String
|
The ID number of the business. |
companyCode - String
|
A unique code that references this company within your account. |
filingStatus - CompanyFilingStatus
|
The company filing status. |
id - Int
|
The unique ID number of the company. |
settings - [CompanySettingModel]
|
A list of settings defined for this company. |
defaultCountry - String
|
The two-character ISO 3166 country code of the default country for this company. |
isDeleted - Boolean
|
A Boolean flag to identify if the company is deleted. |
isTest - Boolean
|
Set this flag to true to indicate that this company is a test company. If you have returns enabled, test companies will not file tax returns and can be used for validation purposes. |
locations - [LocationModel]
|
A list of locations defined for this company. |
mossCountry - String
|
The two-character ISO 3166 country code of the mini-one-stop-shop (MOSS) used for value-added tax (VAT) processing. |
mossId - String
|
The unique ID of the mini-one-stop-shop (MOSS) used for value-added tax (VAT) processing. |
name - String
|
The name of this company. |
parentCompanyId - Int
|
If this company is fully owned by another company, this is the unique identity of the parent company. |
bankInformation - [BankInformationModel]
|
A list of bank information for the company. |
nexus - NexusByTaxFormModel
|
The nexus details for a specific tax form code. |
taxpayerIdNumber - String
|
For United States companies, this field contains your Taxpayer Identification Number. |
suggestedTaxForms - [SuggestedReturnResponseModel]
|
List of suggested returns for the company. |
fundingStatus - [FundingStatusModel]
|
Retrieve the managed returns funding status for a specific company. This query provides information about the funding setup requests and their current status for managed returns associated with a given company. Each object in the result is a request that was made to set up or adjust funding status for this company. |
sstPid - String
|
|
isActive - Boolean
|
States whether it is active or not. |
hasProfile - Boolean
|
States whether it has profile or not. |
isReportingEntity - Boolean
|
States whether it is a reporting entity or not. |
roundingLevelId - RoundingLevelId
|
Rounding Level details. |
taxDependencyLevelId - TaxDependencyLevelId
|
Tax dependency level. |
inProgress - Boolean
|
States whether company is in progress or not. |
contacts - [ContactModel]
|
Contact details of the company. |
regionStatus - [RegionStatusResult]
|
Status of the regions. |
setupStatus - CompanySetupStatusResult
|
Retrieves funding status, setup status, completed regions and submit for review status for the specified company. |
Example
{
"accountId": 987,
"businessIdentificationNo": "abc123",
"companyCode": "abc123",
"filingStatus": "NOTCONFIGUREDFORCOMPLIANCE",
"id": 123,
"settings": [CompanySettingModel],
"defaultCountry": "xyz789",
"isDeleted": false,
"isTest": false,
"locations": [LocationModel],
"mossCountry": "abc123",
"mossId": "abc123",
"name": "abc123",
"parentCompanyId": 987,
"bankInformation": [BankInformationModel],
"nexus": NexusByTaxFormModel,
"taxpayerIdNumber": "xyz789",
"suggestedTaxForms": [SuggestedReturnResponseModel],
"fundingStatus": [FundingStatusModel],
"sstPid": "xyz789",
"isActive": false,
"hasProfile": true,
"isReportingEntity": true,
"roundingLevelId": "LINE",
"taxDependencyLevelId": "DOCUMENT",
"inProgress": false,
"contacts": [ContactModel],
"regionStatus": [RegionStatusResult],
"setupStatus": CompanySetupStatusResult
}
CompanyModelInput
Fields
| Input Field | Description |
|---|---|
id - Int
|
The unique ID number of the company. |
accountId - Int!
|
The unique ID number of the account this company belongs to. |
parentCompanyId - Int
|
If this company is fully owned by another company, this is the unique identity of the parent company. |
sstPid - String
|
If this company files Streamlined Sales Tax, this is the PID of this company as defined by the Streamlined Sales Tax governing board. |
companyCode - String
|
A unique code that references this company within your account. |
name - String!
|
The name of this company, as shown to customers. |
isActive - Boolean
|
This flag indicates whether tax activity can occur for this company. Set this flag to true to permit the company to process transactions. |
hasProfile - Boolean
|
Set this flag to true to give this company its own unique tax profile. If this flag is true, this company will have its own Nexus, TaxRule, TaxCode, and Item definitions. If this flag is false, this company will inherit all profile values from its parent. |
isReportingEntity - Boolean
|
Set this flag to true if this company must file its own tax returns. For users who have Returns enabled, this flag turns on monthly Worksheet generation for the company. |
defaultCountry - String!
|
The two character ISO-3166 country code of the default country for this company. |
roundingLevelId - RoundingLevelId
|
Indicates whether this company prefers to round amounts at the document level or line level. |
isTest - Boolean
|
Set this flag to true to indicate that this company is a test company. If you have Returns enabled, Test companies will not file tax returns and can be used for validation purposes. |
taxDependencyLevelId - TaxDependencyLevelId
|
Used to apply tax detail dependency at a jurisdiction level. |
inProgress - Boolean
|
Set this value to true to indicate that you are still working to finish configuring this company. While this value is true, no tax reporting will occur and the company will not be usable for transactions. |
businessIdentificationNo - String
|
The ID number of the business. |
locations - [CompanyLocationModelInput]
|
A list of locations defined for this company. |
settings - [CompanySettingInput]
|
A list of settings defined for this company. |
contacts - [ContactModelInput]
|
When calling CreateCompany, you may provide a list of objects in this element and they will be created alongside the company. |
mossCountry - String
|
The two-character ISO 3166 country code of the mini-one-stop-shop (MOSS) used for value-added tax (VAT) processing. |
mossId - String
|
The unique ID of the mini-one-stop-shop (MOSS) used for value-added tax (VAT) processing. |
isDeleted - Boolean
|
A Boolean flag to identify if the company is deleted. |
taxpayerIdNumber - String
|
For United States companies, this field contains your Taxpayer Identification Number. |
filingStatus - CompanyFilingStatus
|
The company filing status. |
Example
{
"id": 987,
"accountId": 123,
"parentCompanyId": 123,
"sstPid": "xyz789",
"companyCode": "xyz789",
"name": "abc123",
"isActive": false,
"hasProfile": true,
"isReportingEntity": true,
"defaultCountry": "abc123",
"roundingLevelId": "LINE",
"isTest": false,
"taxDependencyLevelId": "DOCUMENT",
"inProgress": true,
"businessIdentificationNo": "abc123",
"locations": [CompanyLocationModelInput],
"settings": [CompanySettingInput],
"contacts": [ContactModelInput],
"mossCountry": "abc123",
"mossId": "abc123",
"isDeleted": true,
"taxpayerIdNumber": "xyz789",
"filingStatus": "NOTCONFIGUREDFORCOMPLIANCE"
}
CompanyResult
Fields
| Field Name | Description |
|---|---|
id - Int
|
The unique ID number of the company. |
accountId - Int!
|
The unique ID number of the account this company belongs to. |
parentCompanyId - Int
|
If this company is fully owned by another company, this is the unique identity of the parent company. |
sstPid - String
|
If this company files Streamlined Sales Tax, this is the PID of this company as defined by the Streamlined Sales Tax governing board. |
companyCode - String
|
A unique code that references this company within your account. |
name - String!
|
The name of this company, as shown to customers. |
isActive - Boolean
|
This flag indicates whether tax activity can occur for this company. Set this flag to true to permit the company to process transactions. |
hasProfile - Boolean
|
Set this flag to true to give this company its own unique tax profile. If this flag is true, this company will have its own Nexus, TaxRule, TaxCode, and Item definitions. If this flag is false, this company will inherit all profile values from its parent. |
isReportingEntity - Boolean
|
Set this flag to true if this company must file its own tax returns. For users who have Returns enabled, this flag turns on monthly Worksheet generation for the company. |
defaultCountry - String!
|
The two character ISO-3166 country code of the default country for this company. |
roundingLevelId - RoundingLevelId
|
Indicates whether this company prefers to round amounts at the document level or line level. |
isTest - Boolean
|
Set this flag to true to indicate that this company is a test company. If you have Returns enabled, Test companies will not file tax returns and can be used for validation purposes. |
taxDependencyLevelId - TaxDependencyLevelId
|
Used to apply tax detail dependency at a jurisdiction level. |
inProgress - Boolean
|
Set this value to true to indicate that you are still working to finish configuring this company. While this value is true, no tax reporting will occur and the company will not be usable for transactions. |
businessIdentificationNo - String
|
The ID number of the business. |
locations - [LocationModel]
|
A list of locations defined for this company. |
settings - [CompanySettingModel]
|
A list of settings defined for this company. |
contacts - [ContactModel]
|
When calling CreateCompany, you may provide a list of objects in this element and they will be created alongside the company. |
mossCountry - String
|
The two-character ISO 3166 country code of the mini-one-stop-shop (MOSS) used for value-added tax (VAT) processing. |
mossId - String
|
The unique ID of the mini-one-stop-shop (MOSS) used for value-added tax (VAT) processing. |
isDeleted - Boolean
|
A Boolean flag to identify if the company is deleted. |
taxpayerIdNumber - String
|
For United States companies, this field contains your Taxpayer Identification Number. |
filingStatus - CompanyFilingStatus
|
The company filing status. |
Example
{
"id": 123,
"accountId": 987,
"parentCompanyId": 987,
"sstPid": "abc123",
"companyCode": "xyz789",
"name": "xyz789",
"isActive": true,
"hasProfile": false,
"isReportingEntity": false,
"defaultCountry": "xyz789",
"roundingLevelId": "LINE",
"isTest": false,
"taxDependencyLevelId": "DOCUMENT",
"inProgress": true,
"businessIdentificationNo": "xyz789",
"locations": [LocationModel],
"settings": [CompanySettingModel],
"contacts": [ContactModel],
"mossCountry": "abc123",
"mossId": "abc123",
"isDeleted": false,
"taxpayerIdNumber": "abc123",
"filingStatus": "NOTCONFIGUREDFORCOMPLIANCE"
}
CompanyReturnSettingModel
Fields
| Field Name | Description |
|---|---|
companyReturnId - BigInt!
|
The company return ID. |
filingQuestionCode - String
|
The filing question code for custom form fields. |
filingQuestionId - BigInt!
|
The filing question ID for custom form fields. |
id - BigInt
|
The unique ID of this CompanyReturnsSetting. |
value - String
|
The value of this setting. |
Example
{
"companyReturnId": {},
"filingQuestionCode": "xyz789",
"filingQuestionId": {},
"id": {},
"value": "xyz789"
}
CompanySettingInput
Example
{
"companyId": 123,
"id": 123,
"name": "xyz789",
"set": "abc123",
"value": "xyz789"
}
CompanySettingModel
Example
{
"companyId": 987,
"id": 123,
"name": "xyz789",
"set": "xyz789",
"value": "xyz789"
}
CompanySetupStatusResult
Fields
| Field Name | Description |
|---|---|
companyId - Int
|
The unique ID of the company. |
companyName - String
|
The name of the company. |
returnsSetupComplete - Boolean
|
Indicates if the returns setup is complete for the company. |
poaStatus - String
|
The status of the power of attorney (POA) for the company. |
submitForReviewStatus - String
|
The status of the 'submit for review' process. |
completedRegions - [RegionsModel]
|
A list of regions where the company has completed the returns setup. |
remainingRegions - [RegionsModel]
|
A list of regions where the company needs to complete the returns setup. |
Example
{
"companyId": 987,
"companyName": "xyz789",
"returnsSetupComplete": true,
"poaStatus": "xyz789",
"submitForReviewStatus": "xyz789",
"completedRegions": [RegionsModel],
"remainingRegions": [RegionsModel]
}
ContactModel
Fields
| Field Name | Description |
|---|---|
id - Int
|
Id of the contact |
companyId - Int
|
Unique id of the company. |
contactCode - String
|
Code of the contact. |
firstName - String
|
First name of the contact. |
middleName - String
|
Middle name of the contact. |
lastName - String
|
Last name of the contact. |
title - String
|
Title of the contact. |
line1 - String
|
Line 1 of the address. |
line2 - String
|
Line 2 of the address. |
line3 - String
|
Line 3 of the address. |
city - String
|
City of the contact. |
region - String
|
Region of the contact. |
postalCode - String
|
Postal code of the contact. |
country - String
|
Country of the contact. |
email - String
|
Email of the contact. |
phone - String
|
Phone of the contact. |
mobile - String
|
Mobile number of the contact. |
fax - String
|
Fax details of the contact. |
Example
{
"id": 123,
"companyId": 123,
"contactCode": "abc123",
"firstName": "abc123",
"middleName": "abc123",
"lastName": "abc123",
"title": "xyz789",
"line1": "abc123",
"line2": "xyz789",
"line3": "abc123",
"city": "xyz789",
"region": "abc123",
"postalCode": "abc123",
"country": "xyz789",
"email": "abc123",
"phone": "abc123",
"mobile": "xyz789",
"fax": "xyz789"
}
ContactModelInput
Fields
| Input Field | Description |
|---|---|
id - Int
|
The unique ID for this contact. |
companyId - Int
|
The unique ID of the company to which this contact belongs. |
contactCode - String
|
A unique code for this contact which is unique throughout company. |
firstName - String
|
The first or given name of this contact. |
middleName - String
|
The middle name of this contact. |
lastName - String
|
The last or family name of this contact. |
title - String
|
Professional title of this contact. |
line1 - String
|
The first line of the postal mailing address of this contact. |
line2 - String
|
The second line of the postal mailing address of this contact. |
line3 - String
|
The third line of the postal mailing address of this contact. |
city - String
|
The city of the postal mailing address of this contact. |
region - String
|
The two or three character ISO 3166 code of the region / state / province that issued the tax form for this filing calendar. |
postalCode - String
|
The postal code or zip code of the postal mailing address of this contact. |
country - String
|
The two character ISO 3166 country code of the country that issued the tax form for this filing calendar. |
email - String
|
The email address of this contact. |
phone - String
|
The main phone number for this contact. |
mobile - String
|
The mobile phone number for this contact. |
fax - String
|
The facsimile phone number for this contact. |
Example
{
"id": 123,
"companyId": 123,
"contactCode": "abc123",
"firstName": "xyz789",
"middleName": "abc123",
"lastName": "xyz789",
"title": "xyz789",
"line1": "xyz789",
"line2": "xyz789",
"line3": "xyz789",
"city": "abc123",
"region": "abc123",
"postalCode": "abc123",
"country": "abc123",
"email": "abc123",
"phone": "xyz789",
"mobile": "abc123",
"fax": "abc123"
}
CreateCaseResponse
Description
Response returned when creating a new firm support case
Fields
| Field Name | Description |
|---|---|
success - String!
|
Whether the case creation was successful |
message - String
|
Response message |
externalFirmCaseId - String
|
External firm case ID |
externalFirmCaseNumber - String
|
External firm case number |
caseId - String
|
The case ID (15-18 characters) |
error - PartnerSupportError
|
Error details if operation failed |
Example
{
"success": "xyz789",
"message": "abc123",
"externalFirmCaseId": "xyz789",
"externalFirmCaseNumber": "abc123",
"caseId": "abc123",
"error": PartnerSupportError
}
CreateContactsInput
Description
Input for creating contacts for a company.
Fields
| Input Field | Description |
|---|---|
companyId - Int!
|
The unique ID of the company to which these contacts belong. |
contacts - [ContactModelInput!]!
|
The list of contacts to create. |
Example
{"companyId": 987, "contacts": [ContactModelInput]}
CreateFilingRequestInput
Fields
| Input Field | Description |
|---|---|
companyId - Int
|
The unique ID of the company to which this filing request belongs. |
filingRequest - [FilingRequestInputModel]!
|
Input data model for filing request. |
Example
{
"companyId": 123,
"filingRequest": [FilingRequestInputModel]
}
CreateNoticesInput
Fields
| Input Field | Description |
|---|---|
companyId - Int!
|
Id of the company. |
country - String!
|
Unique id of country. |
filingFrequency - FilingFrequency!
|
Filing frequency of return. |
region - String!
|
Region of the notice. |
taxFormCode - String!
|
Tax for code. |
taxPeriod - String!
|
Tax period represented as a combination of year and month in YYYYMM format (e.g., 202503). The value must align with the filingFrequency. For example, if the filingFrequency is quarterly, the period must specify the first month of the quarter. |
Example
{
"companyId": 987,
"country": "xyz789",
"filingFrequency": "MONTHLY",
"region": "abc123",
"taxFormCode": "abc123",
"taxPeriod": "abc123"
}
CreatePartnerSupportCaseInput
Description
Input for creating a new firm support case
Fields
| Input Field | Description |
|---|---|
firmAccountName - String!
|
Firm account name |
firmCaseOwnerName - String!
|
Name of the firm case owner |
firmCaseOwnerEmail - String!
|
Email of the firm case owner |
firmCaseOwnerPhone - String
|
Phone number of the firm case owner |
subject - String!
|
Case subject/title (max 255 characters) |
description - String!
|
Detailed case description (max 32000 characters) |
externalFirmCrmId - String
|
External firm CRM ID |
firmAccountId - String
|
Firm account ID |
clientAccountId - String
|
Client account ID |
externalFirmCaseId - String
|
External firm case ID |
externalFirmCaseNumber - String
|
External firm case number |
Example
{
"firmAccountName": "abc123",
"firmCaseOwnerName": "abc123",
"firmCaseOwnerEmail": "xyz789",
"firmCaseOwnerPhone": "xyz789",
"subject": "xyz789",
"description": "abc123",
"externalFirmCrmId": "abc123",
"firmAccountId": "abc123",
"clientAccountId": "abc123",
"externalFirmCaseId": "abc123",
"externalFirmCaseNumber": "xyz789"
}
CreateReturnAdjustmentInput
Fields
| Input Field | Description |
|---|---|
companyFilingsAdjustInput - [FilingAdjustmentModelInput]!
|
The input to specify the company filing adjustment model. |
companyId - Int!
|
The unique ID of the company that owns the filing being adjusted. |
country - String!
|
The two-character ISO 3166 country code of the filing being adjusted. |
formCode - String!
|
The unique code of the form being adjusted. |
month - Int!
|
The month of the filing period being adjusted. |
region - String!
|
The two or three-character ISO 3166 code for region. |
year - Int!
|
The year of the filing period being adjusted. |
Example
{
"companyFilingsAdjustInput": [
FilingAdjustmentModelInput
],
"companyId": 123,
"country": "xyz789",
"formCode": "xyz789",
"month": 987,
"region": "xyz789",
"year": 123
}
CreateTransactionResult
Fields
| Field Name | Description |
|---|---|
status - TransactionBatchStatus
|
Indicates the status of the created transaction. |
transactionBatchId - Int
|
Unique batch id of the transaction. |
errorMessage - String
|
Message specifying any error occurred. |
Example
{
"status": "SUBMITTED",
"transactionBatchId": 987,
"errorMessage": "abc123"
}
CreateTransactionSummaryResult
Fields
| Field Name | Description |
|---|---|
status - TransactionImportStatus
|
Indicates the status of the created transaction summary. |
transactionBatchId - Int
|
Unique batch id of the transaction summary. |
errorMessage - String
|
Message specifying any error occurred. |
Example
{
"status": "SUBMITTED",
"transactionBatchId": 987,
"errorMessage": "abc123"
}
CycleAddOptionsResult
Fields
| Field Name | Description |
|---|---|
available - Boolean
|
True if this form can be added and filed for the current cycle. |
transactionalPeriodStart - String
|
The period start date for the customer's first transaction in the jurisdiction being added. |
transactionalPeriodEnd - String
|
The period end date for the customer's last transaction in the jurisdiction being added. |
filingDueDate - String
|
The jurisdiction-assigned due date for the form. |
cycleName - String
|
A descriptive name of the cycle and due date of form. |
frequencyName - String
|
The filing frequency of the form. |
filingFrequencyCode - String
|
A code assigned to the filing frequency. |
filingFrequencyId - FilingFrequency
|
The filing frequency of the request. |
cycleUnavailableReason - String
|
An explanation for why this form cannot be added for the current cycle. |
availableLocationCodes - [String]
|
A list of outlet codes that can be assigned to this form for the current cycle. |
Example
{
"available": false,
"transactionalPeriodStart": "xyz789",
"transactionalPeriodEnd": "xyz789",
"filingDueDate": "abc123",
"cycleName": "xyz789",
"frequencyName": "xyz789",
"filingFrequencyCode": "xyz789",
"filingFrequencyId": "MONTHLY",
"cycleUnavailableReason": "abc123",
"availableLocationCodes": ["xyz789"]
}
CycleSafeEditOptionsInput
Fields
| Input Field | Description |
|---|---|
companyId - Int
|
The unique ID of the company. |
edits - [FilingCalendarEditModelInput]
|
The input to specify the filing calendar edit model. |
filingCalendarId - Int
|
The unique ID number of the filing calendar associated with this return. |
Example
{
"companyId": 987,
"edits": [FilingCalendarEditModelInput],
"filingCalendarId": 987
}
CycleSafeEditOptionsResult
Fields
| Field Name | Description |
|---|---|
clonedCalendarEffDate - String
|
The cloned calendar effective date. |
customerMustApprove - Boolean
|
A flag to indicate whether or not the user should be warned of a change. Some changes have risks and may be done not in accordance with the jurisdiction rules. |
expiredCalendarEndDate - String
|
The expired calendar end date. |
message - String
|
A message to present to the user when the calendar is successfully or unsuccessfully changed. |
mustCloneFilingCalendar - Boolean
|
A flag to indicate if the filing calendar must be cloned. |
success - Boolean
|
A flag to indicate whether or not the changes can be made to the filing calendar. |
Example
{
"clonedCalendarEffDate": "xyz789",
"customerMustApprove": false,
"expiredCalendarEndDate": "abc123",
"message": "abc123",
"mustCloneFilingCalendar": true,
"success": true
}
CycleSafeExpireOption
Fields
| Field Name | Description |
|---|---|
transactionalPeriodStart - String
|
Start date of the transaction period. |
transactionalPeriodEnd - String
|
End date of the transaction period. |
filingDueDate - String
|
Filing deadline date. |
cycleName - String
|
Name of the filing cycle. Example: "Monthly filing for November 2024, due December 19 2024." |
Example
{
"transactionalPeriodStart": "xyz789",
"transactionalPeriodEnd": "abc123",
"filingDueDate": "xyz789",
"cycleName": "xyz789"
}
CycleSafeExpireOptionInput
Fields
| Input Field | Description |
|---|---|
transactionalPeriodStart - String
|
Start date of the transaction period |
transactionalPeriodEnd - String
|
End date of the transaction period |
filingDueDate - String
|
Filing deadline date |
cycleName - String
|
Name of the filing cycle. Example: "Monthly filing for November 2024, due December 19 2024." |
Example
{
"transactionalPeriodStart": "xyz789",
"transactionalPeriodEnd": "abc123",
"filingDueDate": "abc123",
"cycleName": "xyz789"
}
DateTimeISO
Description
A date-time string in ISO 8601 format, such as 2007-12-03T10:15:30Z, specifically serialized as an ISO string.
Example
"2007-12-03T10:15:30Z"
DefinitionInput
Fields
| Input Field | Description |
|---|---|
taxFormCode - String
|
The unique ID for a specific tax form. |
country - String
|
The two-character ISO 3166 country code to filter country-specific tax form. |
region - String
|
The region to filter country-specific tax form. |
orderBy - String
|
Field name on which data is to be order by. |
filter - String
|
Field name on which data is to be filtered. |
includeTaxTypes - Boolean
|
Boolean to include tax types in response. |
Example
{
"taxFormCode": "xyz789",
"country": "abc123",
"region": "abc123",
"orderBy": "xyz789",
"filter": "xyz789",
"includeTaxTypes": false
}
DefinitionsCombinedResult
Fields
| Field Name | Description |
|---|---|
value - DefinitionsResult
|
value specifying the details about filingCalendarMetadata, taxTypes, taxForms and countries |
errors - [Error]
|
List of errors. |
Example
{
"value": DefinitionsResult,
"errors": [Error]
}
DefinitionsResult
Fields
| Field Name | Description |
|---|---|
countries - [ISOCountryModel]
|
List of countries |
filingCalendarMetaData - FilingCalendarMetaDataResult
|
FilingCalendarMetadata model |
taxForms - [TaxFormModel]
|
A list of all available forms. |
taxTypes - [TaxTypeResult]
|
A list of all available tax types. |
adjustmentCodes - [String]
|
A list of adjustment codes |
Example
{
"countries": [ISOCountryModel],
"filingCalendarMetaData": FilingCalendarMetaDataResult,
"taxForms": [TaxFormModel],
"taxTypes": [TaxTypeResult],
"adjustmentCodes": ["xyz789"]
}
DeleteOnboardingQuestionAnswerResult
Example
{
"id": {},
"message": "abc123",
"success": true,
"uuid": "4"
}
DeleteResultModel
DocumentUploadRequestModelInput
Fields
| Input Field | Description |
|---|---|
accountId - Int
|
Account id of the document to be uploaded. |
companyId - Int
|
company id of the document to be uploaded. |
content - String!
|
Content of the document to be uploaded. |
documentId - Int
|
Id of the document to be uploaded. |
length - Float
|
length/size of the document to be uploaded. |
name - String!
|
Name of the document to be uploaded. |
username - String
|
Username of the document to be uploaded. |
Example
{
"accountId": 123,
"companyId": 123,
"content": "abc123",
"documentId": 987,
"length": 123.45,
"name": "xyz789",
"username": "abc123"
}
DownloadType
Values
| Enum Value | Description |
|---|---|
|
|
Download return confirmation PDFs only. |
|
|
Download trace files only. |
|
|
Download all attachment types (both confirmations and trace files). |
Example
"RETURNCONFIRMATIONS"
Error
Fields
| Field Name | Description |
|---|---|
message - String
|
The error message. |
extensions - ErrorExtensions
|
Additional details about the error. |
Example
{
"message": "xyz789",
"extensions": ErrorExtensions
}
ErrorExtensions
Fields
| Field Name | Description |
|---|---|
type - String
|
The type/category of the error (e.g. 'ValidationError', 'AuthenticationError'). |
code - Int
|
The numeric error code (e.g. 400, 401, 403, 404, 500). |
status - String
|
The HTTP status message associated with the error code (e.g. 'Bad Request', 'Unauthorized'). |
documentation - String
|
The API endpoint where the error occurred. |
timestamp - String
|
ISO 8601 formatted timestamp when the error occurred Example: 2024-01-15T10:30:15.123Z |
requestId - String
|
A unique identifier for tracking the request through the system. This ID is consistent across the entire request lifecycle and can be used for debugging and tracing. Example: 550e8400-e29b-41d4-a716-446655440000 |
Example
{
"type": "abc123",
"code": 123,
"status": "xyz789",
"documentation": "xyz789",
"timestamp": "xyz789",
"requestId": "xyz789"
}
FilingAdjustmentModelInput
Fields
| Input Field | Description |
|---|---|
accountType - AccountType!
|
The account type of the adjustment. |
amount - Float!
|
The adjustment amount. |
filingId - BigInt
|
The filing return ID that this adjustment applies to. |
id - BigInt
|
The unique ID number for the adjustment. |
isCalculated - Boolean
|
A flag to indicate whether or not the adjustment has been calculated. |
period - Period!
|
The filing period the adjustment is applied to. |
reason - String
|
A descriptive reason for creating this adjustment. |
type - String!
|
The type of the adjustment. |
Example
{
"accountType": "LIABILITY",
"amount": 1500.5,
"filingId": 789012,
"id": 45678,
"isCalculated": true,
"period": {"month": 12, "year": 2023},
"reason": "Sales tax adjustment",
"type": "AMENDMENT"
}
FilingAdjustmentResult
Description
A model for return adjustments.
Fields
| Field Name | Description |
|---|---|
accountType - AccountType
|
The account type of the adjustment. |
amount - Float
|
The adjustment amount. |
filingId - BigInt
|
The filing return ID that this adjustment applies to. |
id - BigInt
|
The unique ID number for the adjustment. |
isCalculated - Boolean
|
A flag to indicate whether or not the adjustment has been calculated. |
period - Period!
|
The filing period the adjustment is applied to. |
reason - String
|
A descriptive reason for creating this adjustment. |
type - String
|
The type of the adjustment. |
Example
{
"accountType": "NONE",
"amount": 123.45,
"filingId": {},
"id": {},
"isCalculated": false,
"period": "NONE",
"reason": "xyz789",
"type": "xyz789"
}
FilingAnswerModel
Example
{
"answer": {},
"filingQuestionId": {},
"filingQuestionCode": "xyz789"
}
FilingAnswerModelInput
Example
{
"answer": {},
"filingQuestionId": {},
"filingQuestionCode": "abc123"
}
FilingAttachmentModel
FilingAugmentationModel
Description
A model for return augmentations.
Example
{
"fieldAmount": 987.65,
"fieldName": "xyz789",
"filingId": {},
"id": {}
}
FilingCalendarCombinedResult
Fields
| Field Name | Description |
|---|---|
filingCalendars - FilingCalendars
|
The list of filing calendars. |
filingCalendarOptions - [CycleAddOptionsResult]
|
The filing calendar options. |
Example
{
"filingCalendars": FilingCalendars,
"filingCalendarOptions": [CycleAddOptionsResult]
}
FilingCalendarEditModelInput
Example
{
"fieldName": "abc123",
"newValue": {},
"oldValue": {},
"questionId": 987
}
FilingCalendarMetaDataResult
Fields
| Field Name | Description |
|---|---|
filingCalendarMetadata - FilingCalendarMetadata
|
The metadata of the filing calendar. |
formDueDate - FormDueDate
|
The due date of the form. |
Example
{
"filingCalendarMetadata": FilingCalendarMetadata,
"formDueDate": FormDueDate
}
FilingCalendarMetadata
Fields
| Field Name | Description |
|---|---|
allowableAdjustments - [AllowableAdjustment]
|
A list of adjustments allowed. |
customQuestions - [FilingCalendarQuestion]
|
A list of custom filing calendar questions. |
formDependencies - [FormDependency]
|
A list of form dependencies. |
formFilingFrequencies - [FormFilingFrequency]
|
A list of filing frequencies supported for the form. |
formFilingMethods - [FormFilingMethod]
|
A list of filing methods for the form. |
formHeader - FormHeader
|
The header of the form. |
formImageUrls - [String]
|
A list of form image URLs. |
formTaxAuthorities - [TaxAuthority]
|
A list of tax authorities. |
formTaxTypes - [FormTaxType]
|
A list of form tax types. |
optionalSchedules - [OptionalSchedule]
|
A list of optional schedules. |
standardQuestions - [FilingCalendarQuestion]
|
The standard filing calendar questions of the form. |
Example
{
"allowableAdjustments": [AllowableAdjustment],
"customQuestions": [FilingCalendarQuestion],
"formDependencies": [FormDependency],
"formFilingFrequencies": [FormFilingFrequency],
"formFilingMethods": [FormFilingMethod],
"formHeader": FormHeader,
"formImageUrls": ["xyz789"],
"formTaxAuthorities": [TaxAuthority],
"formTaxTypes": [FormTaxType],
"optionalSchedules": [OptionalSchedule],
"standardQuestions": [FilingCalendarQuestion]
}
FilingCalendarQuestion
Fields
| Field Name | Description |
|---|---|
id - Int
|
|
country - String
|
The two-character ISO 3166 code for the country. |
dataType - String
|
The data type of the answer (e.g., string, number, boolean). |
defaultAnswer - String
|
The default answer for the filing calendar question. |
destination - String
|
The destination or purpose of this question. |
filingCalendarFieldName - String
|
The filing calendar field name. |
filingCalendarsAffected - Int
|
The number of filing calendars affected by this question. |
filingQuestionCode - String
|
The filing question code as defined for the form. |
filingQuestionId - BigInt
|
The filing question ID as defined for the form. |
helpText - String
|
A short help tip for the filing calendar question. |
hideForFilingMethod - String
|
Hides this question for the specific filing method with ID. |
hideForFilingMethodId - BigInt
|
Hide this question for specific Filing method with Id. |
historical - Boolean
|
A flag to indicate if this question is for historical data. |
internalOnly - Boolean
|
A flag to indicate if this question is for internal use only. |
jsonPath - String
|
The JSON path for accessing this question's data. |
maxLength - Int
|
The maximum length allowed for the answer. |
question - String
|
Actual question text. |
regex - String
|
Regular expression pattern for answer validation. |
regexTests - String
|
Test cases for the regex pattern. |
region - String
|
The two or three-character ISO 3166 code for region. |
required - Boolean
|
A flag to indicate if this question is required. |
requiresClone - Boolean
|
A flag to indicate if this question requires cloning. |
skyscraperFieldName - String
|
The field name used in the Skyscraper system. |
skyscraperValidationRequired - Boolean
|
A flag to indicate if Skyscraper validation is required for this field. |
sortOrder - Int
|
The order in which this question should be presented. |
standard - Boolean
|
A flag to indicate if this is a standard question. |
Example
{
"id": 123,
"country": "abc123",
"dataType": "xyz789",
"defaultAnswer": "xyz789",
"destination": "xyz789",
"filingCalendarFieldName": "xyz789",
"filingCalendarsAffected": 987,
"filingQuestionCode": "xyz789",
"filingQuestionId": {},
"helpText": "xyz789",
"hideForFilingMethod": "xyz789",
"hideForFilingMethodId": {},
"historical": false,
"internalOnly": true,
"jsonPath": "xyz789",
"maxLength": 123,
"question": "abc123",
"regex": "xyz789",
"regexTests": "abc123",
"region": "abc123",
"required": false,
"requiresClone": false,
"skyscraperFieldName": "xyz789",
"skyscraperValidationRequired": true,
"sortOrder": 987,
"standard": false
}
FilingCalendarRequestModel
Fields
| Field Name | Description |
|---|---|
id - Int
|
The unique ID of this filing request. |
companyId - Int
|
The unique ID of the company to which this filing request belongs. |
filingRequestStatusId - FilingRequestStatus
|
The current status of this request. |
data - FilingRequestAddDataModel
|
The data model object of the filing request. |
Example
{
"id": 987,
"companyId": 987,
"filingRequestStatusId": "NEW",
"data": FilingRequestAddDataModel
}
FilingCalendarRequestsInput
Fields
| Input Field | Description |
|---|---|
companyId - Int!
|
The unique ID of the company. |
filingCalendarId - Int
|
The unique ID for the filing calendar. |
taxFormCode - String
|
The tax form code |
filter - String
|
A filter statement to select specific records to retrieve. |
orderBy - String
|
A comma-separated list of sort statements. |
Example
{
"companyId": 123,
"filingCalendarId": 987,
"taxFormCode": "abc123",
"filter": "abc123",
"orderBy": "xyz789"
}
FilingCalendarRequestsResult
Fields
| Field Name | Description |
|---|---|
value - FilingRequestCombinedResult
|
Consolidated result according to response requested |
errors - [Error]
|
List of errors. |
Example
{
"value": FilingRequestCombinedResult,
"errors": [Error]
}
FilingCalendarResponseModel
Fields
| Field Name | Description |
|---|---|
autoLockOverrideDay - Int
|
Auto Lock Override Day. |
bulkAccountId - String
|
The ID of the bulk account. |
bulkAccountValidationStatus - AccountValidationStatus
|
The validation status of the bulk account. |
city - String
|
The city name of the mailing address that will be used when filling out this tax return. |
companyId - Int!
|
The unique ID of the company for this filing calendar. |
currency - String
|
The three-character currency code according to country. |
eFilePassword - String
|
If you file electronically, this is the password or passcode you use to sign in to the tax authority’s website. |
eFileUsername - String
|
If you file electronically, this is the username you use to sign in to the tax authority’s website. |
effectiveDate - String!
|
The earliest date for the tax period when this return should be filed. This date specifies the earliest date for tax transactions that should be reported on this filing calendar. |
employerIdentificationNumber - String
|
The Employer Identification Number (EIN) or Taxpayer Identification Number (TIN) that is to be used when filing this return. |
endDate - String
|
The last date for the tax period when this return should be filed. This date specifies the last date for tax transactions that should be reported on this filing calendar. |
filingFrequencyId - FilingFrequency!
|
The frequency on which this tax form is filed. |
filingTypeId - FilingType
|
The method to be used when filing this return. |
fiscalYearStartMonth - Int
|
The start month of a fiscal year for this form or company. |
fixedPrepaymentAmount - Float
|
The fixed amount to be paid each period if the company is required to make a prepayment. |
formCountry - String
|
The two-character ISO 3166 code identifying the country that issued the tax form for this filing calendar. |
formRegion - String
|
The two or three-character ISO 3166 code identifying the region that issued the tax form for this filing calendar. |
id - BigInt
|
The unique ID of this filing calendar. |
legalEntityName - String
|
The legal entity name to be used when filing this return. |
localRegistrationId - String
|
The tax registration ID for the local jurisdiction, if any. |
locationCode - String
|
A code that identifies this location. |
mailingAddressCity - String
|
The city name of the mailing address that will be used when filling out this tax return. |
mailingAddressCountry - String
|
The ISO 3166 code identifying the country of the mailing address that will be used when filling out this tax return. |
mailingAddressLine1 - String
|
The first line of the mailing address that will be used when filling out this tax return. |
mailingAddressLine2 - String
|
The second line of the mailing address that will be used when filling out this tax return. |
mailingAddressPostalCode - String
|
The postal code or ZIP Code of the mailing address that will be used when filing out this tax return. |
mailingAddressRegion - String
|
The ISO 3166 code identifying the region of the mailing address that will be used when filling out this tax return. |
months - Int
|
A 16-bit bitmap containing a 1 for each month when the return should be filed. |
phone - String
|
The phone number to be used when filing this return. |
prePaymentRequired - Boolean
|
A flag to indicate if a prepayment is required for this filing calendar. |
prepayPercentage - Int
|
The percentage of taxes prepaid for future periods. |
settings - [CompanyReturnSettingModel]
|
A list of company return settings for the filing calendar. |
siteCode - String
|
The bulk account site code. |
stateRegistrationId - String
|
The tax registration ID for the state. |
taxAuthorityId - Int
|
The unique ID of the tax authority of this return. |
taxAuthorityName - String
|
The name of the tax authority of this return. |
taxAuthorityType - String
|
The type description of the tax authority of this return. |
taxFormCode - String
|
The code of the tax form for this filing calendar. |
taxTypes - [String]
|
The list of tax types to report on this return. |
Example
{
"autoLockOverrideDay": 123,
"bulkAccountId": "xyz789",
"bulkAccountValidationStatus": "NEW",
"city": "xyz789",
"companyId": 123,
"currency": "abc123",
"eFilePassword": "abc123",
"eFileUsername": "xyz789",
"effectiveDate": "xyz789",
"employerIdentificationNumber": "abc123",
"endDate": "abc123",
"filingFrequencyId": "MONTHLY",
"filingTypeId": "ELECTRONICRETURN",
"fiscalYearStartMonth": 123,
"fixedPrepaymentAmount": 123.45,
"formCountry": "xyz789",
"formRegion": "xyz789",
"id": {},
"legalEntityName": "xyz789",
"localRegistrationId": "xyz789",
"locationCode": "abc123",
"mailingAddressCity": "abc123",
"mailingAddressCountry": "xyz789",
"mailingAddressLine1": "abc123",
"mailingAddressLine2": "abc123",
"mailingAddressPostalCode": "xyz789",
"mailingAddressRegion": "xyz789",
"months": 123,
"phone": "xyz789",
"prePaymentRequired": false,
"prepayPercentage": 123,
"settings": [CompanyReturnSettingModel],
"siteCode": "xyz789",
"stateRegistrationId": "abc123",
"taxAuthorityId": 987,
"taxAuthorityName": "abc123",
"taxAuthorityType": "abc123",
"taxFormCode": "abc123",
"taxTypes": ["xyz789"]
}
FilingCalendars
Fields
| Field Name | Description |
|---|---|
value - [FilingCalendarResponseModel]
|
A list of filing calendars. |
pageInfo - PageInfo
|
Pagination info. |
Example
{
"value": [FilingCalendarResponseModel],
"pageInfo": PageInfo
}
FilingCalendarsInput
Fields
| Input Field | Description |
|---|---|
companyId - Int
|
The unique ID of the company. |
filingCalendarId - Int
|
The unique ID for the filing calendar. |
taxFormCode - String
|
The tax form code |
filter - String
|
A filter statement to select specific records to retrieve. |
orderBy - String
|
A comma-separated list of sort statements. |
returnCountry - String
|
The two-character ISO 3166 country code for the return. |
returnRegion - String
|
The two or three-character ISO 3166 code for the region. |
Example
{
"companyId": 123,
"filingCalendarId": 987,
"taxFormCode": "abc123",
"filter": "xyz789",
"orderBy": "xyz789",
"returnCountry": "xyz789",
"returnRegion": "xyz789"
}
FilingCalendarsResult
Fields
| Field Name | Description |
|---|---|
value - FilingCalendarCombinedResult
|
Consolidated result according to response requested |
errors - [Error]
|
List of errors. |
Example
{
"value": FilingCalendarCombinedResult,
"errors": [Error]
}
FilingFrequency
Values
| Enum Value | Description |
|---|---|
|
|
Filing occurs every month. |
|
|
Filing occurs every quarter (3 months). |
|
|
Filing occurs twice a year (every 6 months). |
|
|
Filing occurs once a year. |
|
|
Filing occurs every two months. |
|
|
Filing occurs on an irregular basis. |
|
|
Filing occurs on an inverse quarterly schedule. |
|
|
Filing occurs every week. |
|
|
Filing occurs an quarterly irregular basis. |
|
|
Filing occurs every six months. |
Example
"MONTHLY"
FilingModel
Fields
| Field Name | Description |
|---|---|
companyId - Int
|
The unique ID of the company. |
filingRegions - [FilingRegionModel]
|
A list of regional tax filings within this time period. |
id - BigInt
|
The unique ID of this filing. |
month - Int
|
The month of the filing period for this tax filing. |
type - WorkSheetType
|
Indicates whether this is an original or an amended filing. |
year - Int
|
The year of the filing period for this tax filing. |
Example
{
"companyId": 123,
"filingRegions": [FilingRegionModel],
"id": {},
"month": 987,
"type": "ORIGINAL",
"year": 987
}
FilingPaymentModel
Description
A model for return payments.
Fields
| Field Name | Description |
|---|---|
filingId - BigInt!
|
The filing return ID that this payment applies to. |
id - BigInt
|
The unique ID number for the payment. |
isCalculated - Boolean
|
A flag to indicate whether or not the payment has been calculated. |
paymentAmount - Float!
|
The payment amount. |
type - PaymentType!
|
The type of payment. |
Example
{
"filingId": {},
"id": {},
"isCalculated": true,
"paymentAmount": 987.65,
"type": "CURRENTPERIOD"
}
FilingPeriodDates
Example
{
"description": "xyz789",
"filingDueDate": "xyz789",
"transactionalPeriodEnd": "xyz789",
"transactionalPeriodStart": "xyz789"
}
FilingPeriodDatesInput
Example
{
"description": "abc123",
"filingDueDate": "abc123",
"transactionalPeriodEnd": "xyz789",
"transactionalPeriodStart": "abc123"
}
FilingRegionModel
Fields
| Field Name | Description |
|---|---|
approveDate - String
|
The date the filing region was approved. |
collectAmount - Float
|
The amount collected for this region. |
consumerUseNonTaxableAmount - Float
|
The amount of consumer use that is nontaxable. |
consumerUseTaxAmount - Float
|
The liability of the consumer use tax. |
consumerUseTaxableAmount - Float
|
The amount of consumer use that is taxable. |
country - String
|
The two-character ISO 3166 country code. |
endDate - String
|
The end date for the filing cycle. |
filingId - BigInt
|
The filing ID that this region belongs to. |
hasNexus - Boolean
|
A flag to indicate whether or not you have nexus in this region. |
id - BigInt
|
The unique ID number of this filing region. |
nonTaxableAmount - Float
|
The non-taxable amount. |
region - String
|
The two or three-character ISO 3166 code for the region. |
returns - [FilingReturnModel]
|
A list of tax returns in this region. |
salesAmount - Float
|
The sales amount. |
startDate - String
|
The start date for the filing cycle. |
status - Status
|
The current status of the filing region. |
suggestReturns - [FilingsCheckupSuggestedFormModel]
|
A list of tax returns in this region. |
taxAmount - Float
|
The tax amount. |
taxDueAmount - Float
|
The tax amount due. |
taxableAmount - Float
|
The taxable amount. |
totalRemittanceAmount - Float
|
The total remittance amount of all returns in this region. |
Example
{
"approveDate": "abc123",
"collectAmount": 987.65,
"consumerUseNonTaxableAmount": 123.45,
"consumerUseTaxAmount": 987.65,
"consumerUseTaxableAmount": 987.65,
"country": "xyz789",
"endDate": "xyz789",
"filingId": {},
"hasNexus": true,
"id": {},
"nonTaxableAmount": 123.45,
"region": "abc123",
"returns": [FilingReturnModel],
"salesAmount": 987.65,
"startDate": "xyz789",
"status": "READYFORREVIEW",
"suggestReturns": [FilingsCheckupSuggestedFormModel],
"taxAmount": 987.65,
"taxDueAmount": 987.65,
"taxableAmount": 987.65,
"totalRemittanceAmount": 987.65
}
FilingRequestAddDataModel
Fields
| Field Name | Description |
|---|---|
answers - [FilingAnswerModel]
|
The answers to the filing questions. |
autoLockOverrideDay - Int
|
Auto Lock Override Day. |
companyReturnId - BigInt
|
The company return ID if requesting an update. |
country - String
|
The two-character ISO 3166 country code of the country that issued the tax form for this filing calendar. |
effDate - String!
|
The filing cycle start date of the request. |
endDate - String
|
The filing cycle end date of the request. |
filingFrequencyId - FilingFrequency!
|
The filing frequency of the request. |
fiscalYearStartMonth - Int
|
The start period of a fiscal year for this form/company. |
isClone - Boolean
|
A flag to indicate if the request is a clone of a current filing calendar. |
locationCode - String
|
The location code of the filing request. |
region - String
|
The two or three-character ISO 3166 code of the region, state, or province that issued the tax form for this filing calendar. |
registrationId - String
|
The state registration ID of the company requesting the filing calendar. |
taxAuthorityId - Int
|
The tax authority ID of the return. |
taxAuthorityName - String
|
The tax authority name on the return. |
taxFormCode - String
|
The code of the tax form for this filing calendar. |
taxTypeId - MatchingTaxType
|
The type of tax to report on this return. |
canValidateEfileCredentials - Boolean
|
This value indicates whether eFile credentials can be validated or not. |
formFilingFrequencies - [FormFilingFrequency]
|
List of filing frequencies supported for the form. |
questions - [FilingRequestsQuestionModel]
|
List of filing request questions. |
filingMethods - [FormFilingMethodLite]
|
Filing methods. |
expireOptions - [CycleSafeExpireOption]
|
List of available filing cycle options with their respective dates and deadlines. |
twoFactorAuthForwardEmail - String
|
The email address to forward two-factor authentication codes to. |
twoFactorAlias - String
|
Alias for an email address to forward two-factor authentication codes to. |
outletReportingMethod - String
|
The outlet reporting method for the filing request. |
dorWebsite - String
|
The Department of Revenue website URL. |
isTwoFactorAuthRequired - Boolean
|
A flag to indicate if two-factor authentication is required. |
Example
{
"answers": [FilingAnswerModel],
"autoLockOverrideDay": 987,
"companyReturnId": {},
"country": "xyz789",
"effDate": "xyz789",
"endDate": "xyz789",
"filingFrequencyId": "MONTHLY",
"fiscalYearStartMonth": 987,
"isClone": true,
"locationCode": "xyz789",
"region": "abc123",
"registrationId": "xyz789",
"taxAuthorityId": 123,
"taxAuthorityName": "xyz789",
"taxFormCode": "abc123",
"taxTypeId": "E",
"canValidateEfileCredentials": false,
"formFilingFrequencies": [FormFilingFrequency],
"questions": [FilingRequestsQuestionModel],
"filingMethods": [FormFilingMethodLite],
"expireOptions": [CycleSafeExpireOption],
"twoFactorAuthForwardEmail": "abc123",
"twoFactorAlias": "abc123",
"outletReportingMethod": "xyz789",
"dorWebsite": "abc123",
"isTwoFactorAuthRequired": false
}
FilingRequestCombinedResult
Fields
| Field Name | Description |
|---|---|
filingRequests - FilingRequests
|
List of filing requests. |
filingCalendarRequestModel - FilingCalendarRequestModel
|
The filing calendar request Model of filing request. |
Example
{
"filingRequests": FilingRequests,
"filingCalendarRequestModel": FilingCalendarRequestModel
}
FilingRequestDataModel
Fields
| Field Name | Description |
|---|---|
answers - [FilingAnswerModel]
|
The answers to the filing questions. |
autoLockOverrideDay - Int
|
Auto Lock Override Day. |
companyReturnId - BigInt
|
The company return ID if requesting an update. |
country - String
|
The two-character ISO 3166 country code of the country that issued the tax form for this filing calendar. |
effDate - String!
|
The filing cycle start date of the request. |
endDate - String
|
The filing cycle end date of the request. |
filingFrequencyId - FilingFrequency!
|
The filing frequency of the request. |
fiscalYearStartMonth - Int
|
The start period of a fiscal year for this form/company. |
isClone - Boolean
|
A flag to indicate if the request is a clone of a current filing calendar. |
locationCode - String
|
The location code of the filing request. |
region - String
|
The two or three-character ISO 3166 code of the region, state, or province that issued the tax form for this filing calendar. |
registrationId - String
|
The state registration ID of the company requesting the filing calendar. |
taxAuthorityId - Int
|
The tax authority ID of the return. |
taxAuthorityName - String
|
The tax authority name on the return. |
taxFormCode - String
|
The code of the tax form for this filing calendar. |
taxTypeId - MatchingTaxType
|
The type of tax to report on this return. |
canValidateEfileCredentials - Boolean
|
This value indicates whether eFile credentials can be validated or not. |
twoFactorAuthForwardEmail - String
|
The email address to forward two-factor authentication codes to. |
twoFactorAlias - String
|
Alias for an email address to forward two-factor authentication codes to. |
Example
{
"answers": [FilingAnswerModel],
"autoLockOverrideDay": 123,
"companyReturnId": {},
"country": "abc123",
"effDate": "xyz789",
"endDate": "abc123",
"filingFrequencyId": "MONTHLY",
"fiscalYearStartMonth": 987,
"isClone": true,
"locationCode": "xyz789",
"region": "xyz789",
"registrationId": "abc123",
"taxAuthorityId": 987,
"taxAuthorityName": "abc123",
"taxFormCode": "xyz789",
"taxTypeId": "E",
"canValidateEfileCredentials": false,
"twoFactorAuthForwardEmail": "xyz789",
"twoFactorAlias": "abc123"
}
FilingRequestDataModelInput
Fields
| Input Field | Description |
|---|---|
answers - [FilingAnswerModelInput]
|
The answers to the filing questions. |
autoLockOverrideDay - Int
|
Auto Lock Override Day. |
companyReturnId - BigInt
|
The company return ID if requesting an update. |
country - String
|
The two-character ISO 3166 country code of the country that issued the tax form for this filing calendar. |
effDate - String!
|
The filing cycle start date of the request. |
endDate - String
|
The filing cycle end date of the request. |
filingFrequencyId - FilingFrequency!
|
The filing frequency of the request. |
fiscalYearStartMonth - Int
|
The start period of a fiscal year for this form/company. |
isClone - Boolean
|
A flag to indicate if the request is a clone of a current filing calendar. |
locationCode - String
|
The location code of the filing request. |
region - String
|
The two or three-character ISO 3166 code of the region, state, or province that issued the tax form for this filing calendar. |
registrationId - String
|
The state registration ID of the company requesting the filing calendar. |
taxAuthorityId - Int
|
The tax authority ID of the return. |
taxAuthorityName - String
|
The tax authority name on the return. |
taxFormCode - String!
|
The code of the tax form for this filing calendar. |
taxTypeId - MatchingTaxType
|
The type of tax to report on this return. |
canValidateEfileCredentials - Boolean
|
This value indicates whether eFile credentials can be validated or not. |
formFilingFrequencies - [FormFilingFrequencyInput]
|
List of filing frequencies supported for the form. |
questions - [FilingRequestsQuestionInputModel]
|
List of filing request questions. |
filingMethods - [FormFilingMethodInputLite]
|
Filing methods. |
expireOptions - [CycleSafeExpireOptionInput]
|
List of available filing cycle options with their respective dates and deadlines. |
twoFactorAuthForwardEmail - String
|
The email address to forward two-factor authentication codes to. |
twoFactorAlias - String
|
Alias for an email address to forward two-factor authentication codes to. |
outletReportingMethod - String
|
The outlet reporting method for the filing request. |
dorWebsite - String
|
The Department of Revenue website URL. |
isTwoFactorAuthRequired - Boolean
|
A flag to indicate if two-factor authentication is required. |
Example
{
"answers": [FilingAnswerModelInput],
"autoLockOverrideDay": 987,
"companyReturnId": {},
"country": "xyz789",
"effDate": "xyz789",
"endDate": "xyz789",
"filingFrequencyId": "MONTHLY",
"fiscalYearStartMonth": 123,
"isClone": true,
"locationCode": "abc123",
"region": "abc123",
"registrationId": "xyz789",
"taxAuthorityId": 123,
"taxAuthorityName": "xyz789",
"taxFormCode": "xyz789",
"taxTypeId": "E",
"canValidateEfileCredentials": false,
"formFilingFrequencies": [FormFilingFrequencyInput],
"questions": [FilingRequestsQuestionInputModel],
"filingMethods": [FormFilingMethodInputLite],
"expireOptions": [CycleSafeExpireOptionInput],
"twoFactorAuthForwardEmail": "xyz789",
"twoFactorAlias": "abc123",
"outletReportingMethod": "abc123",
"dorWebsite": "abc123",
"isTwoFactorAuthRequired": false
}
FilingRequestInputModel
Fields
| Input Field | Description |
|---|---|
companyId - Int!
|
The unique ID of the company to which this filing request belongs. |
data - FilingRequestDataModelInput!
|
The data model object of the request. |
filingRequestStatusId - FilingRequestStatus
|
The current status of this request. |
id - BigInt
|
The unique ID number of this filing request. |
Example
{
"companyId": 123,
"data": FilingRequestDataModelInput,
"filingRequestStatusId": "NEW",
"id": {}
}
FilingRequestModel
Fields
| Field Name | Description |
|---|---|
companyId - Int!
|
The unique ID of the company to which this filing request belongs. |
data - FilingRequestDataModel!
|
The data model object of the request. |
filingRequestStatusId - FilingRequestStatus
|
The current status of this request. |
id - BigInt
|
The unique ID number of this filing request. |
Example
{
"companyId": 123,
"data": FilingRequestDataModel,
"filingRequestStatusId": "NEW",
"id": {}
}
FilingRequestStatus
Values
| Enum Value | Description |
|---|---|
|
|
A new filing request has been created. |
|
|
The filing request has been validated. |
|
|
The filing request is pending review or processing. |
|
|
The filing request is active and in use. |
|
|
The filing request is pending deactivation. |
|
|
The filing request is no longer active. |
|
|
A change has been requested for the filing request. |
|
|
The requested change has been approved. |
|
|
The requested change has been denied. |
Example
"NEW"
FilingRequests
Fields
| Field Name | Description |
|---|---|
value - [FilingRequestModel]
|
A list of filing requests to file tax returns on a recurring basis. |
pageInfo - PageInfo
|
Pagination info. |
Example
{
"value": [FilingRequestModel],
"pageInfo": PageInfo
}
FilingRequestsQuestionInputModel
Fields
| Input Field | Description |
|---|---|
dataType - String
|
|
destination - String
|
|
filingQuestionId - BigInt
|
Filing question Id as defined for the form. |
filingQuestionCode - String
|
Filing question code as defined for the form. |
helpText - String
|
Short tip for the question. |
maxLength - Int
|
|
question - String
|
Actual question text. |
regex - String
|
Actual question text. |
required - Boolean
|
Flag to indicate if this question is required. |
sortOrder - Int
|
|
defaultAnswer - String
|
Default answer for the question. |
Example
{
"dataType": "xyz789",
"destination": "abc123",
"filingQuestionId": {},
"filingQuestionCode": "xyz789",
"helpText": "xyz789",
"maxLength": 987,
"question": "abc123",
"regex": "xyz789",
"required": false,
"sortOrder": 123,
"defaultAnswer": "xyz789"
}
FilingRequestsQuestionModel
Fields
| Field Name | Description |
|---|---|
dataType - String
|
The dataType of a filing question. |
destination - String
|
The destination for a filing question. |
filingQuestionId - BigInt
|
Filing question Id as defined for the form. |
filingQuestionCode - String
|
Filing question code as defined for the form. |
helpText - String
|
Short tip for the question. |
maxLength - Int
|
Max length of the answer |
question - String
|
Actual question text. |
regex - String
|
Actual question text. |
required - Boolean
|
Flag to indicate if this question is required. |
sortOrder - Int
|
|
defaultAnswer - String
|
Default answer for the question. |
Example
{
"dataType": "abc123",
"destination": "abc123",
"filingQuestionId": {},
"filingQuestionCode": "abc123",
"helpText": "abc123",
"maxLength": 123,
"question": "xyz789",
"regex": "abc123",
"required": false,
"sortOrder": 987,
"defaultAnswer": "abc123"
}
FilingRequestsResult
Fields
| Field Name | Description |
|---|---|
value - FilingRequestCombinedResult
|
Consolidated result according to response requested |
errors - [Error]
|
List of errors. |
Example
{
"value": FilingRequestCombinedResult,
"errors": [Error]
}
FilingReturnCreditModel
Description
Credit information for a filing return.
Fields
| Field Name | Description |
|---|---|
totalExempt - Float
|
The total amount of exempt sales. |
totalSales - Float
|
The total amount of sales. |
totalTax - Float
|
The total amount of tax. |
totalTaxable - Float
|
The total amount of taxable sales. |
transactionDetails - [WorksheetDocument]
|
The transaction details, represented as worksheet documents. |
Example
{
"totalExempt": 123.45,
"totalSales": 123.45,
"totalTax": 987.65,
"totalTaxable": 123.45,
"transactionDetails": [WorksheetDocument]
}
FilingReturnModel
Fields
| Field Name | Description |
|---|---|
accrualType - AccrualType
|
The accrual type for this return. |
adjustments - [FilingAdjustmentResult]
|
The adjustments for this return. |
appliedCarryOverCredits - FilingReturnCreditModel
|
The applied carry over credit documents. |
attachments - [FilingAttachmentModel]
|
The attachments for this return. |
augmentations - [FilingAugmentationModel]
|
The augmentations for this return. |
carryOverConsumerUseTaxAmount - Float
|
The amount of carry over consumer use tax applied to the liability calculation. |
carryOverNonTaxableAmount - Float
|
The amount of carry-over nontaxable sales applied applied to the liability calculation. |
carryOverSalesAmount - Float
|
The amount of carry over sales applied to the liability calculation. |
carryOverTaxAmount - Float
|
The amount of carry over sales tax applied to the liability calculation. |
collectAmount - Float
|
The amount collected for this return. |
consumerUseNonTaxableAccrualAmount - Float
|
The total amount of consumer use nontaxable sales accrued in the current active period. |
consumerUseNonTaxableAmount - Float
|
The nontaxable amount of consumer use. |
consumerUseTaxAccrualAmount - Float
|
The total amount of consumer use tax accrued in the current active period. |
consumerUseTaxAmount - Float
|
The tax liability of consumer use during the period. |
consumerUseTaxDueAmount - Float
|
The tax liability of consumer use during the period. |
consumerUseTaxableAccrualAmount - Float
|
The total amount of consumer use taxable sales accrued in the current active period. |
consumerUseTaxableAmount - Float
|
The taxable amount of consumer use. |
description - String
|
A description for the return. |
endPeriod - String
|
The end date of this return. |
excludedCarryOverCredits - FilingReturnCreditModel
|
The excluded carry over credit documents. |
excludedNonTaxableAmount - Float
|
The nontaxable amount of sales excluded from the liability calculation. |
excludedSalesAmount - Float
|
The amount of sales excluded from the liability calculation. |
excludedTaxAmount - Float
|
The amount of tax excluded from the liability calculation. |
filedDate - String
|
The date the return was filed. |
filingCalendarCurrencyCode - String
|
The three-character filing calendar currency code for this return. |
filingCalendarId - Int
|
The unique ID number of the filing calendar associated with this return. |
filingFrequency - FilingFrequency
|
The filing frequency of the return. |
filingRegionId - BigInt
|
The region ID that this return belongs to. |
filingType - FilingType
|
The filing type of the return. |
formName - String
|
The name of the form. |
id - BigInt
|
The unique ID number of this filing return. |
liabilityCurrencyCode - String
|
The three-character liability currency code. |
month - Int
|
The month of the filing period for this tax filing. |
nonTaxableAccrualAmount - Float
|
The total amount of nontaxable sales accrued in the current active period. |
nonTaxableAmount - Float
|
The nontaxable amount. |
nonTaxableDueAmount - Float
|
The nontaxable due amount. |
payments - [FilingPaymentModel]
|
The payments for this return. |
registrationId - String
|
The registration ID from the return's filing calendar. |
remitAmount - Float
|
The remittance amount of the return. |
resourceFileId - BigInt
|
The resourceFileId of the return. |
salesAccrualAmount - Float
|
The total amount of sales accrued in the current active period. |
salesAmount - Float
|
The sales amount. |
salesTaxAccrualAmount - Float
|
The total amount of sales tax accrued in the current active period. |
sellersUseTaxAccrualAmount - Float
|
The total amount of sellers use tax accrued in the current active period. |
startPeriod - String
|
The start period of this return. |
status - Status
|
The current status of the filing return. |
taxAccrualAmount - Float
|
The total amount of tax accrued in the current active period. |
taxAmount - Float
|
The tax amount. |
taxAuthorityId - Int
|
The tax authority ID of this return. |
taxDueAmount - Float
|
The tax due amount. |
taxableAccrualAmount - Float
|
The total amount of taxable sales accrued in the current active period. |
taxableAmount - Float
|
The taxable amount. |
totalAdjustments - Float
|
The total amount of adjustments on this return. |
totalAugmentations - Float
|
The total amount of augmentations on this return. |
totalPayments - Float
|
The total amount of payments on this return. |
type - String
|
The FilingTaskType for this return. |
year - Int
|
The year of the filing period for this tax filing. |
Example
{
"accrualType": "FILING",
"adjustments": [FilingAdjustmentResult],
"appliedCarryOverCredits": FilingReturnCreditModel,
"attachments": [FilingAttachmentModel],
"augmentations": [FilingAugmentationModel],
"carryOverConsumerUseTaxAmount": 987.65,
"carryOverNonTaxableAmount": 987.65,
"carryOverSalesAmount": 123.45,
"carryOverTaxAmount": 123.45,
"collectAmount": 123.45,
"consumerUseNonTaxableAccrualAmount": 987.65,
"consumerUseNonTaxableAmount": 987.65,
"consumerUseTaxAccrualAmount": 123.45,
"consumerUseTaxAmount": 123.45,
"consumerUseTaxDueAmount": 123.45,
"consumerUseTaxableAccrualAmount": 987.65,
"consumerUseTaxableAmount": 987.65,
"description": "abc123",
"endPeriod": "abc123",
"excludedCarryOverCredits": FilingReturnCreditModel,
"excludedNonTaxableAmount": 123.45,
"excludedSalesAmount": 123.45,
"excludedTaxAmount": 987.65,
"filedDate": "abc123",
"filingCalendarCurrencyCode": "xyz789",
"filingCalendarId": 123,
"filingFrequency": "MONTHLY",
"filingRegionId": {},
"filingType": "ELECTRONICRETURN",
"formName": "abc123",
"id": {},
"liabilityCurrencyCode": "xyz789",
"month": 987,
"nonTaxableAccrualAmount": 123.45,
"nonTaxableAmount": 987.65,
"nonTaxableDueAmount": 123.45,
"payments": [FilingPaymentModel],
"registrationId": "abc123",
"remitAmount": 987.65,
"resourceFileId": {},
"salesAccrualAmount": 123.45,
"salesAmount": 987.65,
"salesTaxAccrualAmount": 987.65,
"sellersUseTaxAccrualAmount": 987.65,
"startPeriod": "xyz789",
"status": "READYFORREVIEW",
"taxAccrualAmount": 987.65,
"taxAmount": 123.45,
"taxAuthorityId": 987,
"taxDueAmount": 987.65,
"taxableAccrualAmount": 987.65,
"taxableAmount": 123.45,
"totalAdjustments": 123.45,
"totalAugmentations": 987.65,
"totalPayments": 123.45,
"type": "abc123",
"year": 987
}
FilingType
Values
| Enum Value | Description |
|---|---|
|
|
Electronic return filing |
|
|
Paper return filing |
|
|
Return not filed |
|
|
Electronic funds transfer with paper return |
|
|
State electronic return |
|
|
Trust file EDI |
|
|
Upload file return |
|
|
Manual paper return |
|
|
Certificate capture |
|
|
Signature ready return |
|
|
Phone paper return |
|
|
E-file check return |
Example
"ELECTRONICRETURN"
FilingsCheckupSuggestedFormModel
Fields
| Field Name | Description |
|---|---|
country - String
|
The two-character ISO 3166 code of the suggested form returned. |
region - String
|
The two or three-character ISO 3166 code for the region of the suggested form returned. |
taxAuthorityId - Int
|
The tax authority ID of the suggested form returned. |
taxFormCode - String
|
The name of the suggested form returned. |
Example
{
"country": "abc123",
"region": "abc123",
"taxAuthorityId": 123,
"taxFormCode": "abc123"
}
FilingsInput
Fields
| Input Field | Description |
|---|---|
companyId - Int!
|
The unique ID of the company that owns the filings. |
country - String
|
The two-character ISO 3166 country code. |
creditdetails - Boolean
|
A flag to indicate whether credit details are needed or not. |
filingReturnId - Int
|
The ID of the return filing. |
formCode - String
|
The unique code of the form. |
month - Int
|
The two-digit month of the filing period. |
region - String
|
The two or three-character ISO 3166 code for region. |
year - Int
|
The year of the filing period. |
Example
{
"companyId": 123456,
"country": "US",
"creditdetails": true,
"filingReturnId": 789012,
"formCode": "SALES-TX-2023",
"month": 3,
"region": "TX",
"year": 2025
}
FilingsResult
Fields
| Field Name | Description |
|---|---|
recordsetCount - Int
|
The total number of records available. |
value - [MultiTaxFilingModel]
|
A list of multitax filings. |
Example
{"recordsetCount": 123, "value": [MultiTaxFilingModel]}
FilingsTaxDetailsModel
Example
{
"nonTaxableAmount": 123.45,
"numberOfNights": {},
"salesAmount": 987.65,
"taxAmount": 123.45,
"taxType": "xyz789"
}
FilingsTaxSummaryModel
Fields
| Field Name | Description |
|---|---|
collectAmount - Float
|
The collect amount. |
nonTaxableAccrualAmount - Float
|
The nontaxable accrual amount. |
nonTaxableAmount - Float
|
The nontaxable amount. |
remittanceAmount - Float
|
The remittance amount. |
reportableNonTaxableAmount - Float
|
The reportable nontaxable amount. |
reportableSalesAmount - Float
|
The reportable sales amount. |
reportableTaxAmount - Float
|
The reportable tax amount. |
reportableTaxableAmount - Float
|
The reportable taxable amount. |
salesAccrualAmount - Float
|
The sales accrual amount. |
salesAmount - Float
|
The total sales amount. |
taxAccrualAmount - Float
|
The tax accrual amount. |
taxAmount - Float
|
The tax amount. |
taxableAccrualAmount - Float
|
The taxable sales accrual amount. |
taxableAmount - Float
|
The taxable amount. |
Example
{
"collectAmount": 123.45,
"nonTaxableAccrualAmount": 123.45,
"nonTaxableAmount": 987.65,
"remittanceAmount": 123.45,
"reportableNonTaxableAmount": 987.65,
"reportableSalesAmount": 123.45,
"reportableTaxAmount": 987.65,
"reportableTaxableAmount": 987.65,
"salesAccrualAmount": 987.65,
"salesAmount": 123.45,
"taxAccrualAmount": 123.45,
"taxAmount": 123.45,
"taxableAccrualAmount": 987.65,
"taxableAmount": 123.45
}
FinanceDetailsInput
Fields
| Input Field | Description |
|---|---|
attachmentUploadRequest - DocumentUploadRequestModelInput
|
Details of the document. |
credits - Float
|
Credits of the notice finance details. |
cspFeeRefund - Float
|
Refund amount of csp for the notice finance details. |
customerInterest - Float
|
Customer interest amount of the notice finance details. |
customerPenalty - Float
|
Customer penalty amount for the notice finance details. |
documentId - BigInt
|
Id of the document for notice finance details. |
dueDate - String
|
Due date of the notice finance details. |
fileName - String
|
File name of the notice finance details. |
interest - Float
|
interest of the notice finance. |
noticeDate - String
|
Date of the notice finance details. |
noticeId - Int!
|
Id of the notice for finance details. |
noticeNumber - String
|
Number of the notice for finance details. |
paymentMethod - String
|
Payment method of the notice finance details. |
penalty - Float
|
Penalty amount if any for the notice finance details. |
taxAbated - Float
|
Tax abated of the notice finance details. |
taxDue - Float
|
Tax due for notice finance details. |
Example
{
"attachmentUploadRequest": DocumentUploadRequestModelInput,
"credits": 123.45,
"cspFeeRefund": 987.65,
"customerInterest": 987.65,
"customerPenalty": 987.65,
"documentId": {},
"dueDate": "xyz789",
"fileName": "xyz789",
"interest": 123.45,
"noticeDate": "abc123",
"noticeId": 123,
"noticeNumber": "abc123",
"paymentMethod": "xyz789",
"penalty": 987.65,
"taxAbated": 987.65,
"taxDue": 123.45
}
FinanceResponseResult
Fields
| Field Name | Description |
|---|---|
attachmentUploadRequest - AttachmentUploadRequestModel
|
The attachment upload request details. |
createdDate - String
|
The date when the finance record was created. |
createdUserId - Int
|
The user ID of the creator. |
credits - Float
|
The amount of credits. |
cspFeeRefund - Float
|
The amount of CSP fee refund. |
customerInterest - Float
|
The interest amount charged to customer. |
customerPenalty - Float
|
The penalty amount charged to customer. |
documentId - BigInt
|
The identifier for associated document. |
dueDate - String
|
The due date for the payment. |
fileName - String
|
The name of the associated file. |
id - Int
|
The unique identifier for the finance record. |
interest - Float
|
The interest amount. |
modifiedDate - String
|
The last modification date. |
modifiedUserId - Int
|
The user ID of the last person to modify. |
noticeDate - String
|
The date of the notice. |
noticeId - Int
|
The reference to the associated notice. |
noticeNumber - String
|
The notice reference number. |
paymentMethod - String
|
The method of payment. |
penalty - Float
|
The penalty amount. |
taxAbated - Float
|
The amount of tax abated. |
taxDue - Float
|
The amount of tax due. |
Example
{
"attachmentUploadRequest": AttachmentUploadRequestModel,
"createdDate": "abc123",
"createdUserId": 987,
"credits": 987.65,
"cspFeeRefund": 987.65,
"customerInterest": 987.65,
"customerPenalty": 987.65,
"documentId": {},
"dueDate": "abc123",
"fileName": "xyz789",
"id": 123,
"interest": 123.45,
"modifiedDate": "xyz789",
"modifiedUserId": 987,
"noticeDate": "abc123",
"noticeId": 987,
"noticeNumber": "abc123",
"paymentMethod": "abc123",
"penalty": 987.65,
"taxAbated": 987.65,
"taxDue": 987.65
}
FirmClientAccountInput
Fields
| Input Field | Description |
|---|---|
accountName - String!
|
The account name of the client to be linked to the firm. |
companyAddress - CompanyAddressInput!
|
The address of the client to be linked to the firm. |
email - String!
|
The email of the client to be linked to the firm. |
firstName - String!
|
The first name of the client to be linked to the firm. |
lastName - String!
|
The last name of the client to be linked to the firm. |
phoneNumber - String
|
The phone number of the client to be linked to the firm. |
title - String
|
The title of the client's name. |
taxPayerIdNumber - String
|
The taxpayer number of the client to be linked to the firm. |
companyCode - String
|
The code of the company. |
Example
{
"accountName": "abc123",
"companyAddress": CompanyAddressInput,
"email": "xyz789",
"firstName": "xyz789",
"lastName": "abc123",
"phoneNumber": "abc123",
"title": "abc123",
"taxPayerIdNumber": "xyz789",
"companyCode": "xyz789"
}
FirmClientLinkDetailsResult
Fields
| Field Name | Description |
|---|---|
clientAccountId - Int
|
The client account to be linked with the firm. |
clientAccountName - String
|
The account name of the client. |
firmAccountId - Int
|
The firm account to be linked with the client. |
firmAccountName - String
|
The account name of the firm. |
firmContactEmail - String
|
The email of the firm's point of contact person for the client. |
firmContactName - String
|
The name of the firm's point of contact person for the client. |
id - Int
|
The unique ID number of firm-client linkage. |
isDeleted - Boolean
|
A flag to indicate if the firm client linkage is deleted. |
status - FirmClientLinkageStatus
|
The status of the account linkage. |
company - ClientCompanyResult
|
The compny details. |
licenseKey - licenseKey
|
The license details. |
Example
{
"clientAccountId": 123,
"clientAccountName": "abc123",
"firmAccountId": 987,
"firmAccountName": "abc123",
"firmContactEmail": "xyz789",
"firmContactName": "abc123",
"id": 987,
"isDeleted": false,
"status": "REQUESTED",
"company": ClientCompanyResult,
"licenseKey": licenseKey
}
FirmClientLinkOptionsInput
FirmClientLinkageStatus
Values
| Enum Value | Description |
|---|---|
|
|
The firm-client linkage request has been submitted but not yet approved. |
|
|
The firm-client linkage has been approved and is active. |
|
|
The firm-client linkage request has been rejected. |
|
|
The firm-client linkage has been revoked. |
Example
"REQUESTED"
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
123.45
FormDependency
Fields
| Field Name | Description |
|---|---|
country - String
|
The two-character ISO 3166 code for the country associated with this form dependency. |
description - String
|
A detailed description of the form dependency. |
formDependencyId - BigInt
|
A unique ID for this form dependency. |
formDependencyType - String
|
The type of dependency relationship between the forms. |
formDependencyTypeId - BigInt
|
A unique ID for the type of form dependency. |
formMasterId - BigInt
|
The ID of the tax form. |
region - String
|
The two or three-character ISO 3166 code for region where this form dependency applies. |
taxFormCode - String
|
A unique code identifying the tax form associated with this dependency. |
taxFormName - String
|
The name of the tax form associated with the dependency. |
Example
{
"country": "abc123",
"description": "xyz789",
"formDependencyId": {},
"formDependencyType": "xyz789",
"formDependencyTypeId": {},
"formMasterId": {},
"region": "abc123",
"taxFormCode": "xyz789",
"taxFormName": "abc123"
}
FormDueDate
Fields
| Field Name | Description |
|---|---|
dueDate - String
|
The due date for filing the form. |
extensionOffset - Int
|
|
filingFrequencyId - Int
|
The filing frequency ID for the form. |
filingMethodId - Int
|
The filing method ID. |
formDueDateId - Int
|
The ID for the form’s due date. |
formMasterId - BigInt
|
The ID of the tax form. |
mailByDate - String
|
|
monthOffset - Int
|
The filing month. |
paymentMethodId - Int
|
The unique ID for the payment method. |
Example
{
"dueDate": "abc123",
"extensionOffset": 123,
"filingFrequencyId": 123,
"filingMethodId": 987,
"formDueDateId": 123,
"formMasterId": {},
"mailByDate": "xyz789",
"monthOffset": 987,
"paymentMethodId": 987
}
FormFilingFrequency
Fields
| Field Name | Description |
|---|---|
code - String
|
The code for the filing frequency. |
description - String
|
A short description for the filing frequency. |
endDay - Int
|
The last day of the filing frequency. |
filingFrequency - String
|
Filing frequency for the form. |
filingFrequencyId - BigInt
|
The ID of the filing frequency. |
filingPeriodDates - [FilingPeriodDates]
|
A list of filing period dates. |
formMasterId - BigInt
|
The ID of the tax form. |
frequencyTrigger - String
|
The trigger for the filing frequency. |
legacyFilingFrequencyId - Int
|
The ID of the legacy filing frequency. |
startDay - Int
|
The start day of the filing frequency. |
visibleToCustomer - Boolean
|
A flag to indicate if the filing frequency is visible to the customer. |
Example
{
"code": "abc123",
"description": "abc123",
"endDay": 987,
"filingFrequency": "xyz789",
"filingFrequencyId": {},
"filingPeriodDates": [FilingPeriodDates],
"formMasterId": {},
"frequencyTrigger": "xyz789",
"legacyFilingFrequencyId": 987,
"startDay": 987,
"visibleToCustomer": true
}
FormFilingFrequencyInput
Fields
| Input Field | Description |
|---|---|
code - String
|
The code for the filing frequency. |
description - String
|
A short description for the filing frequency. |
endDay - Int
|
The last day of the filing frequency. |
filingFrequency - String
|
Filing frequency for the form. |
filingFrequencyId - BigInt
|
The ID of the filing frequency. |
filingPeriodDates - [FilingPeriodDatesInput]
|
A list of filing period dates. |
formMasterId - BigInt
|
The ID of the tax form. |
frequencyTrigger - String
|
The trigger for the filing frequency. |
legacyFilingFrequencyId - Int
|
The ID of the legacy filing frequency. |
startDay - Int
|
The start day of the filing frequency. |
visibleToCustomer - Boolean
|
A flag to indicate if the filing frequency is visible to the customer. |
Example
{
"code": "xyz789",
"description": "xyz789",
"endDay": 987,
"filingFrequency": "xyz789",
"filingFrequencyId": {},
"filingPeriodDates": [FilingPeriodDatesInput],
"formMasterId": {},
"frequencyTrigger": "xyz789",
"legacyFilingFrequencyId": 123,
"startDay": 123,
"visibleToCustomer": false
}
FormFilingMethod
FormFilingMethodInputLite
FormFilingMethodLite
FormHeader
Fields
| Field Name | Description |
|---|---|
allowFilingCalendarAutoApproval - Boolean
|
A flag to indicate whether the filing calendar can be automatically approved. |
amendedAddress1 - String
|
The first line of the amended address. |
amendedAddress2 - String
|
The second line of the amended address.. |
amendedAddressCity - String
|
The city of the amended address. |
amendedAddressCountry - String
|
The country of the amended address. |
amendedAddressMailTo - String
|
The mail-to name for the amdended address. |
amendedAddressPostalCode - String
|
The postal code of the amended address. |
amendedAddressRegion - String
|
The region or state of the amended address. |
amendedEmailAddress - String
|
The amended email address. |
amendedFaxNumber - String
|
The amended fax number. |
amendedPhoneNumber - String
|
The amended phone number. |
amendedWebsite - String
|
The amended website URL. |
canValidateEfileCredentials - Boolean
|
A flag to indicate if e-file credentials can be validated. |
isTwoFactorAuthRequired - Boolean
|
A flag to indicate if two-factor authentication is required. |
country - String
|
The two-character ISO 3166 code for the country associated with the form. |
currencyCode - String
|
The currency code used for the form. |
dorAddress1 - String
|
The first line of the Department of Revenue (DOR) address. |
dorAddress2 - String
|
The second line of the Department of Revenue (DOR) address. |
dorAddressCity - String
|
The city of the Department of Revenue (DOR) address. |
dorAddressCountry - String
|
The country of the Department of Revenue (DOR) address. |
dorAddressMailTo - String
|
The mail-to name for the Department of Revenue (DOR) address. |
dorAddressPostalCode - String
|
The postal code of the Department of Revenue (DOR) address. |
dorAddressRegion - String
|
The region or state of the Department of Revenue (DOR) address. |
dorEmailAddress - String
|
The email address of the Department of Revenue (DOR). |
dorFaxNumber - String
|
The fax number of the Department of Revenue (DOR). |
dorPhoneNumber - String
|
The phone number of the Department of Revenue (DOR). |
dorWebsite - String
|
The website URL of the Department of Revenue (DOR). |
description - String
|
A short description of the form. |
dueDay - Int
|
The day of the month when the form is due. |
fiscalYearStartMonth - Int
|
The start month of the fiscal year as an integer. |
formMasterId - BigInt
|
The unique ID for the tax form. |
formType - String
|
The type of form. |
formTypeId - BigInt
|
The ID of the form type. |
outletReportingMethod - String
|
The method used for outlet reporting. |
outletReportingMethodId - BigInt
|
The ID used for the outlet reporting method. |
paymentAddress1 - String
|
The first line of the payment address. |
paymentAddress2 - String
|
The second line of the payment address. |
paymentAddressCity - String
|
The city of the payment address. |
paymentAddressCountry - String
|
The country of the payment address. |
paymentAddressMailTo - String
|
The mail-to name for the payment address. |
paymentAddressPostalCode - String
|
The postal code of the payment address. |
paymentAddressRegion - String
|
The region or state of the payment address. |
paymentEmailAddress - String
|
The email address for payment-related communications. |
paymentFaxNumber - String
|
The fax number for payment-related communications. |
paymentPhoneNumber - String
|
The phone number for payment-related communications. |
paymentWebsite - String
|
The website URL for payment-related information. |
purpose - String
|
The purpose or intent of the form. |
region - String
|
The region or state associated with the form. |
requiresOutletSetup - Boolean
|
A flag to indicate whether an outlet setup is required. |
taxFormCode - String
|
A code identifying the tax form. |
taxFormName - String
|
The name of the tax form. |
zeroAddress1 - String
|
The first line of the zero-tax liability address. |
zeroAddress2 - String
|
The second line of the zero-tax liability address. |
zeroAddressCity - String
|
The city of the zero-tax liability address. |
zeroAddressCountry - String
|
The country of the zero-tax liability address. |
zeroAddressMailTo - String
|
The mail-to name for the zero-tax liability address. |
zeroAddressPostalCode - String
|
The postal code of the zero-tax liability address. |
zeroAddressRegion - String
|
The region or state of the zero tax liability address. |
zeroEmailAddress - String
|
The email address for zero-tax liability communications. |
zeroFaxNumber - String
|
The fax number for zero-tax liability communications. |
zeroPhoneNumber - String
|
The phone number for zero-tax liability communications. |
zeroWebsite - String
|
The website URL for zero-tax liability information. |
Example
{
"allowFilingCalendarAutoApproval": false,
"amendedAddress1": "xyz789",
"amendedAddress2": "xyz789",
"amendedAddressCity": "xyz789",
"amendedAddressCountry": "xyz789",
"amendedAddressMailTo": "xyz789",
"amendedAddressPostalCode": "abc123",
"amendedAddressRegion": "abc123",
"amendedEmailAddress": "abc123",
"amendedFaxNumber": "xyz789",
"amendedPhoneNumber": "abc123",
"amendedWebsite": "xyz789",
"canValidateEfileCredentials": true,
"isTwoFactorAuthRequired": false,
"country": "abc123",
"currencyCode": "abc123",
"dorAddress1": "abc123",
"dorAddress2": "xyz789",
"dorAddressCity": "xyz789",
"dorAddressCountry": "abc123",
"dorAddressMailTo": "xyz789",
"dorAddressPostalCode": "abc123",
"dorAddressRegion": "abc123",
"dorEmailAddress": "xyz789",
"dorFaxNumber": "xyz789",
"dorPhoneNumber": "xyz789",
"dorWebsite": "xyz789",
"description": "abc123",
"dueDay": 987,
"fiscalYearStartMonth": 123,
"formMasterId": {},
"formType": "abc123",
"formTypeId": {},
"outletReportingMethod": "abc123",
"outletReportingMethodId": {},
"paymentAddress1": "abc123",
"paymentAddress2": "xyz789",
"paymentAddressCity": "xyz789",
"paymentAddressCountry": "xyz789",
"paymentAddressMailTo": "abc123",
"paymentAddressPostalCode": "xyz789",
"paymentAddressRegion": "xyz789",
"paymentEmailAddress": "xyz789",
"paymentFaxNumber": "abc123",
"paymentPhoneNumber": "xyz789",
"paymentWebsite": "xyz789",
"purpose": "xyz789",
"region": "xyz789",
"requiresOutletSetup": true,
"taxFormCode": "abc123",
"taxFormName": "xyz789",
"zeroAddress1": "abc123",
"zeroAddress2": "xyz789",
"zeroAddressCity": "xyz789",
"zeroAddressCountry": "abc123",
"zeroAddressMailTo": "abc123",
"zeroAddressPostalCode": "abc123",
"zeroAddressRegion": "xyz789",
"zeroEmailAddress": "xyz789",
"zeroFaxNumber": "abc123",
"zeroPhoneNumber": "abc123",
"zeroWebsite": "xyz789"
}
FormTaxType
FundingESignMethodReturn
FundingMethodReturn
FundingPOAInput
Fields
| Input Field | Description |
|---|---|
agreementType - String!
|
Agreement type of the Funding POA. Example: ACHDebit |
currency - String!
|
Currency of the Funding POA. Example: USD |
fundingEmailRecipient - String!
|
Email address of the recipient who will receive and sign the Funding POA document. Must be a valid email address. |
requestEmail - Boolean!
|
Whether or not an email is to be requested. Example: true |
requestWidget - Boolean!
|
Whether or not a widget is to be requested. Example: true |
Example
{
"agreementType": "abc123",
"currency": "xyz789",
"fundingEmailRecipient": "xyz789",
"requestEmail": false,
"requestWidget": true
}
FundingPOAResult
Fields
| Field Name | Description |
|---|---|
agreementType - String
|
Type of agreement for the funding POA. |
agreementVersion - Int
|
Version number of the agreement. |
businessUnit - String
|
Business unit associated with the funding POA. |
companyId - String
|
Unique identifier for the company. |
companySource - String
|
Source system or platform of the company. |
currency - String
|
Currency code for the funding POA. |
documentKey - String
|
Unique key identifier for the document. |
documentName - String
|
Name of the document. |
documentType - String
|
Type/category of the document. |
domain - String
|
Domain associated with the funding POA. |
errorMessage - String
|
Error message if any operation fails. |
javaScript - String
|
JavaScript code associated with the funding POA. |
lastActivated - String
|
Timestamp when the document was last activated. |
lastPolled - String
|
Timestamp of the last polling operation. |
lastSigned - String
|
Timestamp when the document was last signed. |
methodReturn - FundingMethodReturn
|
Method return object containing JavaScript and method details. |
recipient - String
|
Email address or identifier of the document recipient. |
requestId - BigInt
|
Unique identifier for the request. |
sender - String
|
Email address or identifier of the document sender. |
status - String
|
Current status of the funding POA. |
subledgerProfileId - Int
|
Identifier for the subledger profile. |
subscriptionType - String
|
Type of subscription associated with the funding POA. |
templateRequestId - BigInt
|
Unique identifier for the template request. |
widgetId - String
|
Identifier for the widget associated with the funding POA. |
Example
{
"agreementType": "xyz789",
"agreementVersion": 987,
"businessUnit": "xyz789",
"companyId": "xyz789",
"companySource": "xyz789",
"currency": "abc123",
"documentKey": "abc123",
"documentName": "xyz789",
"documentType": "xyz789",
"domain": "abc123",
"errorMessage": "xyz789",
"javaScript": "xyz789",
"lastActivated": "abc123",
"lastPolled": "xyz789",
"lastSigned": "xyz789",
"methodReturn": FundingMethodReturn,
"recipient": "xyz789",
"requestId": {},
"sender": "abc123",
"status": "xyz789",
"subledgerProfileId": 987,
"subscriptionType": "abc123",
"templateRequestId": {},
"widgetId": "abc123"
}
FundingStatusModel
Fields
| Field Name | Description |
|---|---|
agreementType - String
|
Type of agreement for the funding POA. |
agreementVersion - Int
|
Version number of the agreement. |
businessUnit - String
|
Business unit associated with the funding POA. |
companyId - String
|
Unique identifier for the company. |
companySource - String
|
Source system or platform of the company. |
currency - String
|
Currency code for the funding POA. |
documentKey - String
|
Unique key identifier for the document. |
documentName - String
|
Name of the document. |
documentType - String
|
Type/category of the document. |
domain - String
|
Domain associated with the funding POA. |
errorMessage - String
|
Error message if any operation fails. |
javaScript - String
|
JavaScript code associated with the funding POA. |
lastActivated - String
|
Timestamp when the document was last activated. |
lastPolled - String
|
Timestamp of the last polling operation. |
lastSigned - String
|
Timestamp when the document was last signed. |
methodReturn - FundingESignMethodReturn
|
Method return object containing JavaScript and method details. |
recipient - String
|
Email address or identifier of the document recipient. |
requestId - BigInt
|
Unique identifier for the request. |
sender - String
|
Email address or identifier of the document sender. |
status - String
|
Current status of the funding POA. |
subledgerProfileId - Int
|
Identifier for the subledger profile. |
subscriptionType - String
|
Type of subscription associated with the funding POA. |
templateRequestId - BigInt
|
Unique identifier for the template request. |
widgetId - String
|
Identifier for the widget associated with the funding POA. |
Example
{
"agreementType": "abc123",
"agreementVersion": 987,
"businessUnit": "xyz789",
"companyId": "xyz789",
"companySource": "abc123",
"currency": "abc123",
"documentKey": "abc123",
"documentName": "xyz789",
"documentType": "xyz789",
"domain": "abc123",
"errorMessage": "abc123",
"javaScript": "xyz789",
"lastActivated": "abc123",
"lastPolled": "abc123",
"lastSigned": "abc123",
"methodReturn": FundingESignMethodReturn,
"recipient": "xyz789",
"requestId": {},
"sender": "xyz789",
"status": "abc123",
"subledgerProfileId": 987,
"subscriptionType": "xyz789",
"templateRequestId": {},
"widgetId": "xyz789"
}
GetCasesResponse
Description
Response returned when getting firm support cases. Can contain either a single case (when queried by caseId) or multiple cases (when queried by firmId).
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
Total number of cases available |
hasMore - Boolean!
|
Whether there are more cases available |
cases - [PartnerSupportCase!]!
|
List of firm support cases |
Example
{
"totalCount": 123,
"hasMore": false,
"cases": [PartnerSupportCase]
}
GetFilingRequestsInput
Fields
| Input Field | Description |
|---|---|
companyId - Int!
|
The unique ID of the company. |
filingCalendarId - Int
|
The unique ID for the filing calendar. |
taxFormCode - String
|
The tax form code |
filter - String
|
A filter statement to select specific records to retrieve. |
orderBy - String
|
A comma-separated list of sort statements. |
Example
{
"companyId": 123,
"filingCalendarId": 987,
"taxFormCode": "xyz789",
"filter": "abc123",
"orderBy": "abc123"
}
GetPartnerSupportCasesInput
Description
Input for querying firm support cases
Fields
| Input Field | Description |
|---|---|
firmAccountId - String!
|
Firm account ID to filter cases |
Example
{"firmAccountId": "abc123"}
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
"4"
ISOCountryModel
Description
Represents an ISO 3166 recognized country.
Fields
| Field Name | Description |
|---|---|
code - String
|
The two-character ISO 3166 country code. |
alpha3Code - String
|
The three-character ISO 3166 country code. |
name - String
|
The full name of this country in uppercase. |
isEuropeanUnion - String
|
A flag to indicate if this country is a member of the European Union. |
localizedNames - [ISOLocalizedNameModel]
|
A list of localized names in a variety of languages. |
addressesRequireRegion - Boolean
|
A flag to indicate whether or not this country requires a region in postal addresses. |
regions - [ISORegionModel]
|
A list of regions. |
Example
{
"code": "abc123",
"alpha3Code": "abc123",
"name": "abc123",
"isEuropeanUnion": "abc123",
"localizedNames": [ISOLocalizedNameModel],
"addressesRequireRegion": true,
"regions": [ISORegionModel]
}
ISOLocalizedNameModel
Description
Represents a language-specific localized name of a particular geographic entity such as a country or a region.
Fields
| Field Name | Description |
|---|---|
languageAlpha2Code - String
|
The two-character alphanumeric code identifying the language in which this name is used. |
languageAlpha3Code - String
|
The three-character alphanumeric code identifying the language in which this name is used. |
name - String
|
The name of this geographic entity as known in this language. |
Example
{
"languageAlpha2Code": "abc123",
"languageAlpha3Code": "abc123",
"name": "xyz789"
}
ISORegionModel
Description
Represents a region, province, or state within a country.
Fields
| Field Name | Description |
|---|---|
countryCode - String
|
The two-character ISO 3166 country code this region belongs to. |
code - String
|
The three-character ISO 3166 region code. |
name - String
|
The full name, using localized characters, for this region, in uppercase. |
classification - String
|
The word in the local language that classifies what type of a region this represents. |
streamlinedSalesTax - Boolean
|
For the United States, this flag indicates whether a U.S. State participates in the Streamlined Sales Tax program. |
localizedNames - [ISOLocalizedNameModel]
|
A list of localized names in a variety of languages. |
isRegionTaxable - Boolean
|
A flag to indicate whether or not the region collects tax. |
Example
{
"countryCode": "abc123",
"code": "xyz789",
"name": "abc123",
"classification": "xyz789",
"streamlinedSalesTax": true,
"localizedNames": [ISOLocalizedNameModel],
"isRegionTaxable": true
}
ImportResult
Fields
| Field Name | Description |
|---|---|
batchStatus - BatchStatusResult
|
Result of the batch status. |
batchErrors - BatchErrorResult
|
Result of the batch errors. |
importHistory - CompanyImportHistoryResult
|
Result of the company import history. |
Example
{
"batchStatus": BatchStatusResult,
"batchErrors": BatchErrorResult,
"importHistory": CompanyImportHistoryResult
}
ImportType
Values
| Enum Value | Description |
|---|---|
|
|
Add import type |
|
|
Delete import type |
Example
"A"
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
987
JSON
Description
The JSON scalar type represents JSON values as specified by ECMA-404.
Example
{}
JurisTypeId
Values
| Enum Value | Description |
|---|---|
|
|
State jurisdiction |
|
|
County jurisdiction |
|
|
City jurisdiction |
|
|
Special jurisdiction |
|
|
Country jurisdiction |
Example
"STA"
JurisdictionType
Values
| Enum Value | Description |
|---|---|
|
|
National level jurisdiction |
|
|
State or province level jurisdiction |
|
|
County level jurisdiction |
|
|
City or municipality level jurisdiction |
|
|
Special tax district jurisdiction |
Example
"COUNTRY"
LiabilityReportsResult
Fields
| Field Name | Description |
|---|---|
value - LiabilityReportsValue
|
Contains the liability reports result |
errors - [Error]
|
List of errors. |
Example
{
"value": LiabilityReportsValue,
"errors": [Error]
}
LiabilityReportsValue
Fields
| Field Name | Description |
|---|---|
reports - [Byte]
|
The byte array representing the zipped liability state summary and liability summary return details xlsx reports. |
Example
{"reports": [196, 189, 173, 171, 167, 163]}
LiabilityType
Values
| Enum Value | Description |
|---|---|
|
|
All liability types |
|
|
Original liability |
|
|
Amended liability |
Example
"ALL"
LicenseKey
Description
An account user who is permitted to use AvaTax.
Example
{
"name": "abc123",
"accountId": 123,
"createdDate": "abc123",
"modifiedDate": "xyz789"
}
ListCountriesInput
ListCountriesResult
Fields
| Field Name | Description |
|---|---|
value - [ISOCountryModel]
|
A list of ISO 3166 countries. |
errors - [Error]
|
List of errors. |
pageInfo - PageInfo
|
Pagination info. |
Example
{
"value": [ISOCountryModel],
"errors": [Error],
"pageInfo": PageInfo
}
ListFirmClientLinkDetailsResult
Fields
| Field Name | Description |
|---|---|
recordsetCount - Int
|
The total number of records available. |
value - [FirmClientLinkDetailsResult]
|
A list of firm-client link details. |
Example
{
"recordsetCount": 987,
"value": [FirmClientLinkDetailsResult]
}
ListNoticesInput
Fields
| Input Field | Description |
|---|---|
id - Int
|
The unique ID of the notice |
companyId - Int!
|
The ID of the company that owns these notices. |
filter - String
|
A filter statement to select specific records to retrieve. |
include - String
|
A comma separated list of additional data to retrieve. |
orderBy - String
|
A comma separated list of sort statements. |
skip - Int
|
If nonzero, skip this number of records before returning results. |
top - Int
|
If nonzero, return no more than this number of results. |
Example
{
"id": 123,
"companyId": 123,
"filter": "abc123",
"include": "xyz789",
"orderBy": "abc123",
"skip": 123,
"top": 987
}
ListNoticesResult
Fields
| Field Name | Description |
|---|---|
recordsetCount - Int
|
The total count of records in the result set. |
value - [NoticesResult]
|
The array of notice response objects. |
pageInfo - PageInfo
|
Pagination info. |
Example
{
"recordsetCount": 123,
"value": [NoticesResult],
"pageInfo": PageInfo
}
LocalNexusTypeId
Values
| Enum Value | Description |
|---|---|
|
|
Only selected jurisdictions |
|
|
State-administered jurisdictions |
|
|
All jurisdictions |
Example
"SELECTED"
LocationModel
Fields
| Field Name | Description |
|---|---|
addressCategoryId - AddressCategory
|
Indicates the type of place of business represented by this location. |
addressTypeId - AddressType
|
Indicates whether this location is a physical place of business or a temporary salesperson location. |
city - String
|
The city of the physical address of this location. |
companyId - Int
|
The unique ID number of the company. |
country - String
|
The two-character ISO 3166 country code. |
dbaName - String
|
If this location has a different business name from its legal entity name, specify the "Doing Business As" name for this location. |
description - String
|
A friendly name for this location. |
endDate - String
|
If this place of business has closed, the date when this location closed business. |
effectiveDate - String
|
Date from which location is effective. |
id - Int
|
The unique ID number of this location. |
isDefault - Boolean
|
Set this flag to true to indicate that this is the default location for this company. |
isMarketplaceOutsideUsa - Boolean
|
A flag to indicate whether the marketplace is outside or inside the U.S. |
isRegistered - Boolean
|
Set this flag to true to indicate that this location has been registered with a tax authority. |
lastTransactionDate - String
|
The most recent date when a transaction was processed for this location. |
line1 - String
|
The first line of the physical address of this location. |
line2 - String
|
Address line 2. |
line3 - String
|
Address line 3. |
locationCode - String
|
A code that identifies this location. |
outletName - String
|
A friendly name for this location. |
postalCode - String
|
The postal code or ZIP Code of the physical address of this location. |
region - String
|
The two or three-character ISO 3166 code for region. |
registeredDate - String
|
The date when this location was registered with a tax authority. |
importedAddressCategoryId - String
|
The unique ID of the imported address. |
importedAddressTypeId - String
|
The unique type ID of the imported address. |
settings - [LocationSetting]
|
Settings details of the location. |
Example
{
"addressCategoryId": "STOREFRONT",
"addressTypeId": "LOCATION",
"city": "xyz789",
"companyId": 123,
"country": "abc123",
"dbaName": "xyz789",
"description": "xyz789",
"endDate": "abc123",
"effectiveDate": "abc123",
"id": 123,
"isDefault": false,
"isMarketplaceOutsideUsa": true,
"isRegistered": false,
"lastTransactionDate": "xyz789",
"line1": "abc123",
"line2": "xyz789",
"line3": "abc123",
"locationCode": "abc123",
"outletName": "xyz789",
"postalCode": "xyz789",
"region": "xyz789",
"registeredDate": "abc123",
"importedAddressCategoryId": "abc123",
"importedAddressTypeId": "abc123",
"settings": [LocationSetting]
}
LocationModelInput
Fields
| Input Field | Description |
|---|---|
addressCategoryId - AddressCategory!
|
The unique ID of the address category. |
addressTypeId - AddressType!
|
The unique ID of the address type. |
city - String!
|
The city name. |
companyId - Int!
|
The unique ID of the company. |
country - String!
|
The country name. |
dbaName - String
|
The name of the dba. |
description - String
|
Description of the location. |
effectiveDate - String!
|
Date from which location is effective. |
endDate - String
|
End date of the location. |
id - Int
|
The unique ID of the location. |
importedAddressCategoryId - String
|
The unique ID of the imported address. |
importedAddressTypeId - String
|
The unique type ID of the imported address. |
isDefault - Boolean
|
A flag to indicate if this location is default. |
isMarketplaceOutsideUsa - Boolean
|
A flag to indicate if this marketplace location is outside the USA. |
isRegistered - Boolean
|
A flag to indicate if this location is registered. |
lastTransactionDate - String
|
Last transaction date for this location. |
line1 - String!
|
Address line 1. |
line2 - String
|
Address line 2. |
line3 - String
|
Address line 3. |
locationCode - String!
|
Unique code of the location. |
outletName - String
|
The name of the outlet. |
postalCode - String!
|
Postal code of the location. |
region - String!
|
Region of the location. |
registeredDate - String
|
Date of registration of the location. |
settings - [LocationSettingModelInput]
|
Settings details of the location. |
Example
{
"addressCategoryId": "STOREFRONT",
"addressTypeId": "LOCATION",
"city": "abc123",
"companyId": 123,
"country": "abc123",
"dbaName": "xyz789",
"description": "abc123",
"effectiveDate": "xyz789",
"endDate": "xyz789",
"id": 123,
"importedAddressCategoryId": "xyz789",
"importedAddressTypeId": "xyz789",
"isDefault": true,
"isMarketplaceOutsideUsa": true,
"isRegistered": false,
"lastTransactionDate": "xyz789",
"line1": "abc123",
"line2": "xyz789",
"line3": "xyz789",
"locationCode": "xyz789",
"outletName": "abc123",
"postalCode": "abc123",
"region": "xyz789",
"registeredDate": "abc123",
"settings": [LocationSettingModelInput]
}
LocationSetting
LocationSettingModelInput
MatchingTaxType
Values
| Enum Value | Description |
|---|---|
|
|
E-commerce tax type. |
|
|
Lodging tax type. |
|
|
Bottle deposit tax type. |
|
|
Rent-to-own tax type. |
|
|
Bicycle tax type. |
|
|
Landed cost tax type. |
|
|
Checkout bag tax type. |
|
|
Alcohol tax type. |
|
|
Amusement tax type. |
|
|
Hospitality tax type. |
|
|
Rental and leasing tax type. |
|
|
Gross receipts tax type. |
|
|
Mattress tax type. |
|
|
Lumber tax type. |
|
|
Paint tax type. |
|
|
Tires tax type. |
|
|
Environmental impact tax type. |
|
|
All tax types. |
|
|
Both sales and use tax types. |
|
|
Consumer use tax type. |
|
|
Consumers use and sellers use tax type. |
|
|
Consumer use and sales tax type. |
|
|
Fee tax type. |
|
|
VAT input tax type. |
|
|
Light bulbs tax type. |
|
|
Meals tax type. |
|
|
VAT non-recoverable input tax type. |
|
|
VAT output tax type. |
|
|
Public improvement fee tax type. |
|
|
Rental tax type. |
|
|
Sales tax type. |
|
|
Use tax type. |
|
|
Electronic waste tax type. |
|
|
Batteries tax type. |
Example
"E"
Message
Fields
| Field Name | Description |
|---|---|
details - String
|
A message of the transaction details. |
helpLink - String
|
A URL to the transaction error documentation. |
name - String
|
|
refersTo - String
|
The information about what object in your request this message refers to. |
severity - Severity
|
The severity of the message. |
source - String
|
The source of the message. |
summary - String
|
The summary of the message. |
Example
{
"details": "abc123",
"helpLink": "xyz789",
"name": "abc123",
"refersTo": "xyz789",
"severity": "SUCCESS",
"source": "xyz789",
"summary": "xyz789"
}
MultiTaxFilingModel
Fields
| Field Name | Description |
|---|---|
companyId - Int
|
The unique ID number of the company for this filing. |
filingRegions - [MultiTaxFilingRegionModel]
|
A list of regional tax filings within this time period. |
id - BigInt
|
The unique ID number of this filing. |
month - Int
|
The month of the filing period for this tax filing. The filing period represents the year and month of the last day of taxes being reported on this filing. For example, an annual tax filing for Jan-Dec 2015 would have a filing period of Dec 2015. |
taxDetails - [FilingsTaxDetailsModel]
|
A detailed breakdown of the taxes in this filing. |
taxSummary - FilingsTaxSummaryModel
|
Represents a summary of all tax calculation data for filings and for accruing to future filings. |
type - WorkSheetType
|
Indicates whether this tax filing is an original or an amended filing. |
year - Int
|
The year of the filing period for this tax filing. The filing period represents the year and month of the last day of taxes being reported on this filing. For example, an annual tax filing for Jan-Dec 2015 would have a filing period of Dec 2015. |
Example
{
"companyId": 123,
"filingRegions": [MultiTaxFilingRegionModel],
"id": {},
"month": 123,
"taxDetails": [FilingsTaxDetailsModel],
"taxSummary": FilingsTaxSummaryModel,
"type": "ORIGINAL",
"year": 123
}
MultiTaxFilingRegionModel
Fields
| Field Name | Description |
|---|---|
country - String
|
The two-character ISO 3166 code for the country. |
hasNexus - Boolean
|
A flag to indicate whether or not you have nexus in this region. |
region - String
|
The two or three-character region code for the region. |
regionTaxDetails - [FilingsTaxDetailsModel]
|
A detailed breakdown of the taxes in this filing. |
regionTaxSummary - FilingsTaxSummaryModel
|
Represents a summary of all tax calculation data for filings and for accruing to future filings. |
returns - [MultiTaxFilingReturnModel]
|
A list of tax returns in this region. |
status - Status
|
The current status of the filing region. |
suggestReturns - [FilingsCheckupSuggestedFormModel]
|
A list of tax returns in this region. |
Example
{
"country": "abc123",
"hasNexus": false,
"region": "xyz789",
"regionTaxDetails": [FilingsTaxDetailsModel],
"regionTaxSummary": FilingsTaxSummaryModel,
"returns": [MultiTaxFilingReturnModel],
"status": "READYFORREVIEW",
"suggestReturns": [FilingsCheckupSuggestedFormModel]
}
MultiTaxFilingReturnModel
Description
A model of multitax filing returns.
Fields
| Field Name | Description |
|---|---|
accrualType - AccrualType
|
Indicates whether this return is an accrual type or filing type. |
adjustments - [FilingAdjustmentResult]
|
A list of adjustments for this return. |
appliedCarryOverCredits - FilingReturnCreditModel
|
An attachment associated with a filing return. |
attachments - [FilingAttachmentModel]
|
A list of attachments for this return. |
augmentations - [FilingAugmentationModel]
|
A list of augmentations for this return. |
description - String
|
A description for the return. |
endPeriod - String
|
The end date of this return. |
excludedCarryOverCredits - FilingReturnCreditModel
|
An attachment associated with a filing return. |
filedDate - String
|
The date the return was filed. |
filingCalendarId - Int
|
The unique ID number of the filing calendar associated with this return. |
filingFrequency - FilingFrequency
|
The filing frequency of the return. |
filingType - FilingType
|
The filing type of the return. |
formName - String
|
The name of the form. |
taxFormCode - String
|
The code of the tax form. |
id - BigInt
|
The unique ID number of this filing return. |
payments - [FilingPaymentModel]
|
The payments for this return. |
registrationId - String
|
The registration ID from the return's filing calendar. |
returnTaxDetails - [FilingsTaxDetailsModel]
|
A detailed breakdown of the taxes in this filing. |
returnTaxSummary - FilingsTaxSummaryModel
|
Represents a summary of all tax calculation data for filings and for accruing to future filings. |
startPeriod - String
|
The start date of this return. |
status - Status
|
The current status of the filing return. |
taxAuthorityId - Int
|
The tax authority ID of this return. |
totalAdjustments - Float
|
The total amount of adjustments on this return. |
totalAugmentations - Float
|
The total amount of augmentations on this return. |
totalPayments - Float
|
The total amount of payments on this return. |
type - String
|
The FilingTaskType for this return. |
Example
{
"accrualType": "FILING",
"adjustments": [FilingAdjustmentResult],
"appliedCarryOverCredits": FilingReturnCreditModel,
"attachments": [FilingAttachmentModel],
"augmentations": [FilingAugmentationModel],
"description": "abc123",
"endPeriod": "abc123",
"excludedCarryOverCredits": FilingReturnCreditModel,
"filedDate": "xyz789",
"filingCalendarId": 987,
"filingFrequency": "MONTHLY",
"filingType": "ELECTRONICRETURN",
"formName": "abc123",
"taxFormCode": "xyz789",
"id": {},
"payments": [FilingPaymentModel],
"registrationId": "xyz789",
"returnTaxDetails": [FilingsTaxDetailsModel],
"returnTaxSummary": FilingsTaxSummaryModel,
"startPeriod": "xyz789",
"status": "READYFORREVIEW",
"taxAuthorityId": 987,
"totalAdjustments": 123.45,
"totalAugmentations": 123.45,
"totalPayments": 123.45,
"type": "xyz789"
}
NexusByTaxFormModel
Fields
| Field Name | Description |
|---|---|
companyId - Int
|
The unique ID number of the company. |
companyNexus - [NexusModel]
|
The list of nexus relevant to the form. |
formCode - String
|
The form code to look up the nexus. |
nexusDefinitions - [NexusModel]
|
The list of nexus definitions relevant to the form. |
Example
{
"companyId": 123,
"companyNexus": [NexusModel],
"formCode": "abc123",
"nexusDefinitions": [NexusModel]
}
NexusModel
Fields
| Field Name | Description |
|---|---|
companyId - Int
|
The unique ID number of the company that declared nexus. |
country - String!
|
The two-character ISO 3166 country code that declared the nexus. |
effectiveDate - String
|
The date when this nexus began. |
endDate - String
|
If this nexus will end or has ended on a specific date, set this to the date when this nexus ends. |
hasLocalNexus - Boolean
|
A flag to indicate if you are also declaring local nexus within this jurisdiction. |
hasPermanentEstablishment - Boolean
|
A flag to indicate that the company has a permanent establishment within this jurisdiction. |
id - Int
|
The unique ID number of this declaration of nexus. |
isSstActive - Boolean
|
For the United States, this flag indicates whether this particular nexus falls within a U.S. State that participates in the Streamlined Sales Tax (SST) program. |
isSellerImporterOfRecord - Boolean
|
A flag to indicate whether this company is considered the importer of record in this nexus region. |
jurisCode - String!
|
The code identifying the jurisdiction in which this company declared nexus. |
jurisName - String!
|
The common name of the jurisdiction in which this company declared nexus. |
jurisTypeId - JurisTypeId
|
The jurisdiction type of jurisdiction in which this company declared nexus. |
jurisdictionTypeId - JurisdictionType
|
The type of jurisdiction in which this company decalred nexus. |
localNexusTypeId - LocalNexusTypeId
|
The type of local nexus declaration. |
nexusTaxTypeGroup - String
|
The type of nexus that this company is declaring. |
nexusTypeId - NexusTypeId
|
The type of nexus that this company is declaring. |
parameters - [NexusParameterDetailModel]
|
A list of nexus parameters. |
region - String!
|
The two or three-character ISO 3166 code for the region. |
shortName - String
|
A short name of the jurisdiction. |
signatureCode - String
|
The signature code. |
sourcing - Sourcing
|
A flag to indicate whether this nexus is defined as an origin or destination nexus. |
stateAssignedNo - String
|
The state assigned number of the jurisdiction. |
streamlinedSalesTax - Boolean
|
A flag to indicate whether this particular nexus falls within a U.S. state that participates in the Streamlined Sales Tax (SST) program. |
taxAuthorityId - BigInt
|
A unique ID number of the tax authority that is associated with this nexus. |
taxId - String
|
The tax identification number under which you declared nexus. |
taxName - String
|
A description of corresponding tax type applied to the nexus. |
taxTypeGroup - String
|
The type group of nexus that this company is declaring. |
taxableNexus - Boolean
|
A flag to indicate if the system nexus records are associated with tax collection. |
Example
{
"companyId": 987,
"country": "abc123",
"effectiveDate": "abc123",
"endDate": "abc123",
"hasLocalNexus": true,
"hasPermanentEstablishment": false,
"id": 123,
"isSstActive": true,
"isSellerImporterOfRecord": false,
"jurisCode": "abc123",
"jurisName": "abc123",
"jurisTypeId": "STA",
"jurisdictionTypeId": "COUNTRY",
"localNexusTypeId": "SELECTED",
"nexusTaxTypeGroup": "abc123",
"nexusTypeId": "NONE",
"parameters": [NexusParameterDetailModel],
"region": "xyz789",
"shortName": "abc123",
"signatureCode": "xyz789",
"sourcing": "MIXED",
"stateAssignedNo": "xyz789",
"streamlinedSalesTax": false,
"taxAuthorityId": {},
"taxId": "abc123",
"taxName": "xyz789",
"taxTypeGroup": "xyz789",
"taxableNexus": false
}
NexusParameterDetailModel
Description
Represents a parameter associated with a nexus.
Example
{
"id": {},
"name": "xyz789",
"nexusId": 987,
"unit": "xyz789",
"value": "xyz789"
}
NexusTypeId
Values
| Enum Value | Description |
|---|---|
|
|
No nexus established |
|
|
Sales or sellers use tax nexus |
|
|
Sales tax nexus only |
|
|
SST volunteer nexus |
|
|
SST non-volunteer nexus |
Example
"NONE"
NoticeCommentsInput
Fields
| Input Field | Description |
|---|---|
companyId - Int!
|
The unique ID of the company. |
comments - [CommentInput]
|
Comments for the Notice. |
Example
{"companyId": 123, "comments": [CommentInput]}
NoticeFinanceDetailsInput
Fields
| Input Field | Description |
|---|---|
companyId - Int!
|
The unique ID of the company. |
financeDetails - [FinanceDetailsInput]
|
Finance Details for the Notice. |
Example
{
"companyId": 123,
"financeDetails": [FinanceDetailsInput]
}
NoticesResult
Fields
| Field Name | Description |
|---|---|
id - Int
|
The unique identifier for the notice. |
createdDate - String
|
The date when the notice was created. |
modifiedDate - String
|
The last modification date. |
status - String
|
The current status of the notice. |
region - String
|
The geographic region. |
taxPeriod - String
|
Tax period represented as a combination of year and month in YYYYMM format (e.g., 202503). The value must align with the filingFrequency. For example, if the filingFrequency is quarterly, the period must specify the first month of the quarter. |
taxFormCode - String
|
The tax form code. |
filingFrequency - FilingFrequency
|
The frequency of filing. |
comments - [CommentResult]
|
The list of comments associated with the notice. |
finances - [FinanceResponseResult]
|
The list of financial details associated with the notice. |
Example
{
"id": 987,
"createdDate": "abc123",
"modifiedDate": "xyz789",
"status": "abc123",
"region": "abc123",
"taxPeriod": "xyz789",
"taxFormCode": "xyz789",
"filingFrequency": "MONTHLY",
"comments": [CommentResult],
"finances": [FinanceResponseResult]
}
OnboardingQuestionAnswerInput
Fields
| Input Field | Description |
|---|---|
accountId - Int
|
The unique ID of the account. |
answerId - BigInt
|
The unique ID of the answer. |
companyId - Int
|
The unique ID of the company. |
country - String
|
The unique ID of the country. |
onboardingQuestionAnswerId - BigInt
|
The ID of the onboarding question answer. |
questionId - BigInt
|
The unique ID of the question. |
region - String
|
The unique ID of the region. |
Example
{
"accountId": 987,
"answerId": {},
"companyId": 123,
"country": "abc123",
"onboardingQuestionAnswerId": {},
"questionId": {},
"region": "xyz789"
}
OnboardingQuestionAnswerResult
Fields
| Field Name | Description |
|---|---|
accountId - Int
|
The unique ID of the account. |
answerId - BigInt
|
The unique ID of the answer. |
companyId - Int
|
The unique ID of the company. |
country - String
|
The unique ID of the country. |
onboardingQuestionAnswerId - BigInt
|
The ID of the onboarding question answer. |
questionId - BigInt
|
The unique ID of the question. |
region - String
|
The unique ID of the region. |
Example
{
"accountId": 987,
"answerId": {},
"companyId": 987,
"country": "xyz789",
"onboardingQuestionAnswerId": {},
"questionId": {},
"region": "abc123"
}
OnboardingRegionStatus
Values
| Enum Value | Description |
|---|---|
|
|
Onboarding process not started |
|
|
Onboarding process in progress |
|
|
Onboarding process completed |
Example
"NOTSTARTED"
OnboardingStatus
Fields
| Field Name | Description |
|---|---|
nextQuestionId - BigInt
|
The ID of the next question in the onboarding flow. |
completedTaxFormCodes - [String]
|
A list of tax form codes that have been completed during onboarding. |
pendingTaxFormCodes - [String]
|
A list of tax form codes that are pending completion during onboarding. |
onboardingTaxFormCodes - [String]
|
A list of tax form codes that are part of the onboarding process. |
Example
{
"nextQuestionId": {},
"completedTaxFormCodes": ["xyz789"],
"pendingTaxFormCodes": ["xyz789"],
"onboardingTaxFormCodes": ["xyz789"]
}
OptionalSchedule
Example
{
"description": "xyz789",
"formOptionalScheduleId": {},
"scheduleName": "abc123"
}
PageInfo
Example
{
"totalRecords": 987,
"top": 987,
"skip": 987,
"hasNextPage": false,
"hasPreviousPage": true
}
PartnerSupportCase
Description
A firm support case containing basic case information. Used when retrieving a list of cases for a firm.
Fields
| Field Name | Description |
|---|---|
caseId - String!
|
The unique Salesforce case ID |
subject - String!
|
Case subject/title |
description - String!
|
Detailed case description |
status - String!
|
Current case status |
caseOwnerName - String
|
Name of the case owner |
createdDate - String!
|
Date when the case was created |
lastModifiedDate - String!
|
Date when the case was last modified |
externalFirmCaseId - String
|
External firm case ID |
externalFirmCaseNumber - String
|
External firm case number |
Example
{
"caseId": "xyz789",
"subject": "abc123",
"description": "xyz789",
"status": "abc123",
"caseOwnerName": "xyz789",
"createdDate": "xyz789",
"lastModifiedDate": "abc123",
"externalFirmCaseId": "xyz789",
"externalFirmCaseNumber": "xyz789"
}
PartnerSupportCaseDetail
Description
A detailed firm support case containing all case information and associated comments.
Used when retrieving a single case by ID with full details.
Fields
| Field Name | Description |
|---|---|
caseId - String!
|
The unique Salesforce case ID |
subject - String!
|
Case subject/title |
description - String!
|
Detailed case description |
status - String!
|
Current case status |
caseOwnerName - String
|
Name of the case owner |
createdDate - String!
|
Date when the case was created |
lastModifiedDate - String!
|
Date when the case was last modified |
firmAccountId - String!
|
Firm account ID associated with the case |
externalFirmCaseId - String
|
External firm case ID |
externalFirmCaseNumber - String
|
External firm case number |
comments - [PartnerSupportComment!]
|
List of comments associated with this case |
Example
{
"caseId": "abc123",
"subject": "abc123",
"description": "abc123",
"status": "abc123",
"caseOwnerName": "xyz789",
"createdDate": "xyz789",
"lastModifiedDate": "xyz789",
"firmAccountId": "xyz789",
"externalFirmCaseId": "xyz789",
"externalFirmCaseNumber": "xyz789",
"comments": [PartnerSupportComment]
}
PartnerSupportComment
PartnerSupportError
PaymentType
Values
| Enum Value | Description |
|---|---|
|
|
Payment for current period |
|
|
Advance payment |
|
|
Payment for prior period |
|
|
Prior CSP fee payment |
Example
"CURRENTPERIOD"
Period
Values
| Enum Value | Description |
|---|---|
|
|
No specific period |
|
|
Current reporting period |
|
|
Next reporting period |
Example
"NONE"
RegionStatusResult
Fields
| Field Name | Description |
|---|---|
country - String
|
The two character ISO-3166 country code. |
region - String
|
The state, region, or province related to the country. |
status - OnboardingRegionStatus
|
The status of the region. |
Example
{
"country": "abc123",
"region": "xyz789",
"status": "NOTSTARTED"
}
RegionsModel
Fields
| Field Name | Description |
|---|---|
country - String
|
The two-character ISO 3166 country code of the region. |
region - String
|
The state or province code of the region. |
taxFormCode - String
|
The unique ID of the tax form code. |
effectiveDate - String
|
The effective date of the region's tax form. |
endDate - String
|
The end date of the region's tax form. |
Example
{
"country": "abc123",
"region": "xyz789",
"taxFormCode": "xyz789",
"effectiveDate": "xyz789",
"endDate": "xyz789"
}
ResetLicenseKeyDetails
ResultCode
Values
| Enum Value | Description |
|---|---|
|
|
Operation completed successfully |
|
|
Operation completed with warnings |
|
|
Operation failed with errors |
|
|
Operation failed with exceptions |
Example
"SUCCESS"
RoundingLevelId
Values
| Enum Value | Description |
|---|---|
|
|
Round at line item level |
|
|
Round at document level |
Example
"LINE"
SaveResultModel
Fields
| Field Name | Description |
|---|---|
id - Int
|
The unique ID of the record. |
success - Boolean
|
Indicates success or failure. |
successfulCount - Int
|
Count of the successful records saved. |
errorCount - Int
|
Count of the error records to be saved. |
message - String
|
Message of success or failure. |
errorMessages - [String]
|
List of messages specifying failures. |
Example
{
"id": 123,
"success": true,
"successfulCount": 123,
"errorCount": 123,
"message": "abc123",
"errorMessages": ["abc123"]
}
Severity
Values
| Enum Value | Description |
|---|---|
|
|
Success level severity |
|
|
Warning level severity |
|
|
Error level severity |
|
|
Exception level severity |
Example
"SUCCESS"
Sourcing
Values
| Enum Value | Description |
|---|---|
|
|
Mixed sourcing rules |
|
|
Destination-based sourcing |
|
|
Origin-based sourcing |
Example
"MIXED"
Status
Values
| Enum Value | Description |
|---|---|
|
|
Ready for review by compliance team |
|
|
Currently refreshing tax numbers |
|
|
In process of preparing to file |
|
|
Return has been filed |
|
|
Return has been voided |
|
|
Return marked as do not file |
Example
"READYFORREVIEW"
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"abc123"
SubmitNoticeFilingInput
Example
{
"noticeId": 123,
"companyId": 123,
"filingPoa": "xyz789"
}
SubscriptionType
Values
| Enum Value | Description |
|---|---|
|
|
Monthly Returns Subscription. |
|
|
Ava Communications Subscription. |
|
|
Ava Hospitality Subscription. |
|
|
Ava Lodging Subscription. |
|
|
MRS Compliance Manager Subscription. |
|
|
AMRA Subscription. |
|
|
MRS Premium Subscription. |
|
|
MRS Premier Subscription. |
Example
"MRS"
SuggestedReturnOnboardingQuestionModel
Fields
| Field Name | Description |
|---|---|
allowMultiSelect - Boolean
|
Specifies whether to select multiple or not. |
answers - [SuggestedReturnsAnswersModel]
|
The list of answers for the suggested return. |
country - String
|
The value of the country. |
dataType - String
|
The type of the data. |
helpText - String
|
Help text. |
question - String
|
Specifies the question. |
questionId - BigInt
|
The unique ID of the question. |
region - String
|
The value of the region. |
sequence - Int
|
The value of the sequence. |
standard - Boolean
|
Specifies if it is standard or not. |
Example
{
"allowMultiSelect": true,
"answers": [SuggestedReturnsAnswersModel],
"country": "abc123",
"dataType": "abc123",
"helpText": "abc123",
"question": "abc123",
"questionId": {},
"region": "xyz789",
"sequence": 123,
"standard": false
}
SuggestedReturnResponseModel
Fields
| Field Name | Description |
|---|---|
answeredQuestions - [OnboardingQuestionAnswerResult]
|
The list of the responses of the question answers. |
country - String
|
The value of the country. |
onboardingQuestions - [SuggestedReturnOnboardingQuestionModel]
|
The list of the onboarding question. |
onboardingStatus - OnboardingStatus
|
The onboarding status information. |
region - String
|
The value of the region. |
suggestedReturns - [SuggestedReturnsResult]
|
The list specifying the suggested returns. |
Example
{
"answeredQuestions": [OnboardingQuestionAnswerResult],
"country": "xyz789",
"onboardingQuestions": [
SuggestedReturnOnboardingQuestionModel
],
"onboardingStatus": OnboardingStatus,
"region": "xyz789",
"suggestedReturns": [SuggestedReturnsResult]
}
SuggestedReturnsAnswersModel
Fields
| Field Name | Description |
|---|---|
answer - String
|
The answer specified for the suggested returns. |
answerHelpText - String
|
The help text for the specified answer of the suggested returns. |
leadingQuestionAnswerId - BigInt
|
Question answer id for the suggested returns. |
nextQuestionId - BigInt
|
The next question id of the suggested returns. |
taxFormCode - String
|
The unique ID of the tax form code. |
Example
{
"answer": "abc123",
"answerHelpText": "abc123",
"leadingQuestionAnswerId": {},
"nextQuestionId": {},
"taxFormCode": "xyz789"
}
SuggestedReturnsResult
Fields
| Field Name | Description |
|---|---|
description - String
|
The description of the returns. |
taxAuthorityId - Int
|
The unique ID of the tax authority. |
taxAuthorityName - String
|
The name of the tax authority. |
taxFormCode - String
|
The unique ID of the tax form code. |
taxFormName - String
|
The name of the tax form code. |
taxTypes - [String]
|
List specifying the tax types. |
Example
{
"description": "abc123",
"taxAuthorityId": 123,
"taxAuthorityName": "xyz789",
"taxFormCode": "xyz789",
"taxFormName": "abc123",
"taxTypes": ["abc123"]
}
TaxAuthority
Example
{
"formMasterId": {},
"formMasterTaxAuthorityId": {},
"taxAuthority": "abc123",
"taxAuthorityId": {}
}
TaxDependencyLevelId
Values
| Enum Value | Description |
|---|---|
|
|
Tax dependency at document level |
|
|
Tax dependency at state level |
|
|
Tax dependency at tax region level |
|
|
Tax dependency at address level |
Example
"DOCUMENT"
TaxFormModel
Fields
| Field Name | Description |
|---|---|
taxFormCode - String
|
The tax form code |
taxFormName - String
|
The name of the submitted form. |
description - String
|
A short description of the submitted form. |
country - String
|
The two-character ISO 3166 country code for which the form is submitted for. |
region - String
|
The state, province, or region where this form is submitted for. |
authorityName - String
|
The tax authority that issued the form. |
shortCode - String
|
A short code for the form. |
dueDay - Int
|
The due date of the form. |
effDate - String
|
The effective start date of the form. |
endDate - String
|
The effective end date of the form. |
formMasterEffDate - String
|
The effective start date of the form. |
formMasterEndDate - String
|
The effective end date of the form. |
formVersionId - Int
|
The version of the tax form. |
major - Int
|
The major version of the tax form. |
minor - Int
|
The minor version of the tax form. |
revision - Int
|
The revised version of the tax form. |
stackAggregationOption - String
|
The option that defines how a stack rate is determined for a specific country and region. |
formAggregationTypeId - Int
|
The aggregation type of the form. |
formVersion - String
|
The version of the tax form. |
expiration - String
|
Expiration of the form. |
searchString - String
|
Search string for the form. |
searchStringWithDescription - String
|
Search string with description for the form. |
taxFormNameDescription - String
|
Tax form name description. |
displayName - String
|
The display name for the form. |
countryRegionFilter - String
|
Country region filter for the form. |
taxTypes - [String]
|
List specifying the tax types. |
purpose - String
|
The purpose or intent of the form. |
taxAuthority - String
|
The name of the tax authority of this return. |
Example
{
"taxFormCode": "abc123",
"taxFormName": "xyz789",
"description": "abc123",
"country": "xyz789",
"region": "abc123",
"authorityName": "xyz789",
"shortCode": "xyz789",
"dueDay": 123,
"effDate": "abc123",
"endDate": "xyz789",
"formMasterEffDate": "xyz789",
"formMasterEndDate": "xyz789",
"formVersionId": 123,
"major": 123,
"minor": 987,
"revision": 987,
"stackAggregationOption": "abc123",
"formAggregationTypeId": 987,
"formVersion": "abc123",
"expiration": "abc123",
"searchString": "abc123",
"searchStringWithDescription": "abc123",
"taxFormNameDescription": "xyz789",
"displayName": "abc123",
"countryRegionFilter": "abc123",
"taxTypes": ["abc123"],
"purpose": "xyz789",
"taxAuthority": "abc123"
}
TaxFormsResult
Fields
| Field Name | Description |
|---|---|
recordsetCount - Int
|
The total number of records available. |
value - [TaxFormModel]
|
A list of all available forms. |
Example
{"recordsetCount": 123, "value": [TaxFormModel]}
TaxTypeResult
Transaction
Fields
| Field Name | Description |
|---|---|
transactionCode - String
|
Unique id of the transaction |
transactionDate - String
|
Date of the transaction. |
country - String
|
country of the transaction. |
region - String
|
region of the transaction. |
addressLine1 - String
|
address line of the transaction. |
county - String
|
county of the transaction. |
city - String
|
city of the transaction. |
postalCode - String
|
postal code of the transaction. |
taxType - String
|
tax type of the transaction. |
taxLevel - String
|
tax level of the transaction. |
taxRate - Float
|
tax rate of the transaction. |
grossAmount - Float
|
gross amount of the transaction. |
exemptAmount - Float
|
exempt amount of the transaction. |
taxableAmount - Float
|
taxable amount of the transaction. |
taxAmount - Float
|
tax amount of the transaction. |
Example
{
"transactionCode": "xyz789",
"transactionDate": "abc123",
"country": "xyz789",
"region": "abc123",
"addressLine1": "xyz789",
"county": "abc123",
"city": "xyz789",
"postalCode": "abc123",
"taxType": "abc123",
"taxLevel": "xyz789",
"taxRate": 987.65,
"grossAmount": 123.45,
"exemptAmount": 987.65,
"taxableAmount": 987.65,
"taxAmount": 987.65
}
TransactionBatchStatus
Values
| Enum Value | Description |
|---|---|
|
|
Batch has been submitted |
|
|
Batch is being processed |
|
|
Batch processing completed |
|
|
Batch processing failed |
|
|
Batch has been deleted |
|
|
Batch is a duplicate |
|
|
Batch is blocked |
Example
"SUBMITTED"
TransactionDetailModel
Fields
| Field Name | Description |
|---|---|
city - String
|
The city for this transaction. |
companyId - Int
|
The unique ID number of the company for this transaction. |
country - String
|
The ISO 3166 country code for this transaction. |
county - String
|
The county for this transaction. |
currencyCode - String
|
The currency code for this transaction. |
discount - Float
|
The discount on the transaction. |
exemptAmount - Float
|
The exempt amount for this transaction. |
groupCode - String
|
The group code for this transaction. |
jurisdiction - String
|
The jurisdiction for this transaction. |
lines - Int
|
The lines of this transaction. |
locationCode - String
|
A code that identifies this location. |
minutes - Float
|
|
rateType - String
|
The rate type for this transaction. |
region - String
|
The two or three-character ISO 3166 code of the region for this transaction. |
salesAmount - Float
|
The sales amount for this transaction. |
taxAmount - Float
|
The tax amount for this transaction. |
taxLevel - String
|
The tax level for this transaction. |
taxRate - Float
|
The tax rate for this transaction. |
taxSubType - String
|
The tax subtype for this transaction. |
taxType - String
|
The type of tax for this transaction. |
taxableAmount - Float
|
The taxable amount for this transaction. |
transactionDate - String
|
The date of this transaction. |
transactionCode - String
|
Unique id of the transaction. |
Example
{
"city": "abc123",
"companyId": 987,
"country": "abc123",
"county": "abc123",
"currencyCode": "abc123",
"discount": 123.45,
"exemptAmount": 987.65,
"groupCode": "abc123",
"jurisdiction": "xyz789",
"lines": 123,
"locationCode": "abc123",
"minutes": 123.45,
"rateType": "abc123",
"region": "abc123",
"salesAmount": 987.65,
"taxAmount": 123.45,
"taxLevel": "xyz789",
"taxRate": 123.45,
"taxSubType": "xyz789",
"taxType": "xyz789",
"taxableAmount": 987.65,
"transactionDate": "abc123",
"transactionCode": "abc123"
}
TransactionDetailsInput
Fields
| Input Field | Description |
|---|---|
companyId - Int!
|
The unique company ID to retrieve the transactions. |
country - String
|
An optional field to filter transactions specific to a country. |
endPeriod - String!
|
The end date to filter transactions. |
region - String
|
An optional field to filter transactions specific to a region. |
skip - Int
|
If nonzero, skip this number of records before returning results. |
startPeriod - String!
|
The start date to filter transactions. |
take - Int
|
If nonzero, return no more than this number of results. |
Example
{
"companyId": 987,
"country": "xyz789",
"endPeriod": "xyz789",
"region": "abc123",
"skip": 987,
"startPeriod": "abc123",
"take": 123
}
TransactionDetailsResult
Fields
| Field Name | Description |
|---|---|
recordsetCount - Int
|
The total number of records available. |
value - [TransactionDetailModel]
|
A list of transaction details. |
Example
{"recordsetCount": 123, "value": [TransactionDetailModel]}
TransactionImportCreateInput
Fields
| Input Field | Description |
|---|---|
transactionCode - String!
|
Unique id of the transaction |
transactionDate - String
|
Date of the transaction. |
country - String
|
country of the transaction. |
region - String
|
region of the transaction. |
addressLine1 - String
|
address line of the transaction. |
county - String
|
county of the transaction. |
city - String
|
city of the transaction. |
postalCode - String
|
postal code of the transaction. |
taxType - String
|
tax type of the transaction. |
taxLevel - String
|
tax level of the transaction. |
taxRate - Float
|
tax rate of the transaction. |
grossAmount - Float
|
gross amount of the transaction. |
exemptAmount - Float
|
exempt amount of the transaction. |
taxableAmount - Float
|
taxable amount of the transaction. |
taxAmount - Float
|
tax amount of the transaction. |
Example
{
"transactionCode": "xyz789",
"transactionDate": "abc123",
"country": "xyz789",
"region": "xyz789",
"addressLine1": "abc123",
"county": "xyz789",
"city": "xyz789",
"postalCode": "abc123",
"taxType": "abc123",
"taxLevel": "xyz789",
"taxRate": 987.65,
"grossAmount": 987.65,
"exemptAmount": 987.65,
"taxableAmount": 987.65,
"taxAmount": 987.65
}
TransactionImportError
Fields
| Field Name | Description |
|---|---|
errorType - TransactionImportErrorType
|
Indicates the type of the error. |
transaction - Transaction
|
Details of the transaction with error. |
Example
{
"errorType": "INVALIDLOCATION",
"transaction": Transaction
}
TransactionImportErrorType
Values
| Enum Value | Description |
|---|---|
|
|
Indicates error in transaction with invalid location |
|
|
Indicates error in transaction with invalid type of the tax |
|
|
Indicates tax rate is missing in the transaction |
Example
"INVALIDLOCATION"
TransactionImportStatus
Values
| Enum Value | Description |
|---|---|
|
|
Transaction batch is submitted. |
|
|
Transaction batch is processing. |
|
|
Transaction batch is completed. |
|
|
Transaction batch is failed. |
|
|
Transaction batch is sent for processing. |
|
|
Transaction batch is completed with warning. |
Example
"SUBMITTED"
TransactionImportSummaryInput
Fields
| Input Field | Description |
|---|---|
year - Int!
|
The year of the transaction. |
month - Int!
|
The month of the transaction. |
country - String!
|
The country code of the transaction. |
region - String!
|
The region/state code of the transaction. |
city - String!
|
The city of the transaction. |
postalCode - String!
|
The postal code of the transaction. |
taxType - String!
|
The type of tax for the transaction. |
grossAmount - Float
|
The gross amount of the transaction. |
exemptAmount - Float
|
The exempt amount of the transaction. |
taxableAmount - Float
|
The taxable amount of the transaction. |
taxAmount - Float
|
The tax amount of the transaction. |
Example
{
"year": 123,
"month": 987,
"country": "xyz789",
"region": "xyz789",
"city": "xyz789",
"postalCode": "abc123",
"taxType": "abc123",
"grossAmount": 987.65,
"exemptAmount": 987.65,
"taxableAmount": 987.65,
"taxAmount": 123.45
}
TransactionInput
Fields
| Input Field | Description |
|---|---|
fileNameSearch - String
|
Name of the import file to search. |
importType - ImportType
|
Type of the import. |
transactionBatchStatus - TransactionBatchStatus
|
Status of the batch of the transaction. |
Example
{
"fileNameSearch": "xyz789",
"importType": "A",
"transactionBatchStatus": "SUBMITTED"
}
TransactionQueryResult
Fields
| Field Name | Description |
|---|---|
value - ImportResult
|
Specifies the expected result. |
errors - [Error]
|
Collection of errors if any. |
Example
{
"value": ImportResult,
"errors": [Error]
}
TransactionsReportInput
Fields
| Input Field | Description |
|---|---|
startDate - DateTimeISO!
|
The start date of the transactions. |
endDate - DateTimeISO!
|
The end date of the transactions. |
country - String
|
The country code of the transactions. |
region - String
|
The region/state code of the transactions. |
Example
{
"startDate": "2007-12-03T10:15:30Z",
"endDate": "2007-12-03T10:15:30Z",
"country": "xyz789",
"region": "abc123"
}
TransportOptions
Example
TransportOptions
UpdateAccountRequestInput
UpdateCompanyRequestInput
Fields
| Input Field | Description |
|---|---|
id - Int!
|
Unique id of the company to update. |
name - String!
|
Name of the company to update. |
status - CompanyFilingStatus
|
Status of the company to update. |
taxpayerIdNumber - String
|
Taxpayer Identification Number (EIN/TIN) for the company. |
Example
{
"id": 123,
"name": "abc123",
"status": "NOTCONFIGUREDFORCOMPLIANCE",
"taxpayerIdNumber": "abc123"
}
UpdateFilingRequestDataModelInput
Fields
| Input Field | Description |
|---|---|
answers - [FilingAnswerModelInput]
|
The answers to the filing questions. |
autoLockOverrideDay - Int
|
Auto Lock Override Day. |
companyReturnId - BigInt
|
The company return ID if requesting an update. |
country - String!
|
The two-character ISO 3166 country code of the country that issued the tax form for this filing calendar. |
effDate - String!
|
The filing cycle start date of the request. |
endDate - String
|
The filing cycle end date of the request. |
filingFrequencyId - FilingFrequency!
|
The filing frequency of the request. |
fiscalYearStartMonth - Int
|
The start period of a fiscal year for this form/company. |
isClone - Boolean
|
A flag to indicate if the request is a clone of a current filing calendar. |
locationCode - String
|
The location code of the filing request. |
region - String!
|
The two or three-character ISO 3166 code of the region, state, or province that issued the tax form for this filing calendar. |
registrationId - String
|
The state registration ID of the company requesting the filing calendar. |
taxAuthorityId - Int
|
The tax authority ID of the return. |
taxAuthorityName - String!
|
The tax authority name on the return. |
taxFormCode - String!
|
The code of the tax form for this filing calendar. |
canValidateEfileCredentials - Boolean
|
This value indicates whether eFile credentials can be validated or not. |
twoFactorAuthForwardEmail - String
|
The email address to forward two-factor authentication codes to. |
Example
{
"answers": [FilingAnswerModelInput],
"autoLockOverrideDay": 123,
"companyReturnId": {},
"country": "xyz789",
"effDate": "xyz789",
"endDate": "abc123",
"filingFrequencyId": "MONTHLY",
"fiscalYearStartMonth": 987,
"isClone": false,
"locationCode": "xyz789",
"region": "xyz789",
"registrationId": "abc123",
"taxAuthorityId": 123,
"taxAuthorityName": "xyz789",
"taxFormCode": "xyz789",
"canValidateEfileCredentials": true,
"twoFactorAuthForwardEmail": "abc123"
}
UpdateFilingRequestInputModel
Fields
| Input Field | Description |
|---|---|
companyId - Int!
|
The unique ID of the company to which this filing request belongs. |
data - UpdateFilingRequestDataModelInput!
|
The data model object of the request. |
filingRequestStatusId - FilingRequestStatus
|
The current status of this request. |
id - BigInt
|
The unique ID number of this filing request. |
Example
{
"companyId": 987,
"data": UpdateFilingRequestDataModelInput,
"filingRequestStatusId": "NEW",
"id": {}
}
UpdateRegionStatusInput
Fields
| Input Field | Description |
|---|---|
country - String
|
The two character ISO-3166 country code. |
region - String
|
The state, region, or province related to the country. |
status - OnboardingRegionStatus
|
The status of the region. |
Example
{
"country": "abc123",
"region": "xyz789",
"status": "NOTSTARTED"
}
VatUploadDataResult
Description
Result returned after initiating a VAT data upload.
Contains the upload identifier for tracking progress and any validation or processing errors. Use the upload ID to poll or subscribe for upload status and outcome.
Usage: This result is returned by the vatUploadData mutation after accepting a file upload.
Example
{
"id": "abc123",
"errors": [Error]
}
VerifyEFileCredentialInput
VerifyEFileCredentialResult
Example
{
"jobId": {},
"status": "abc123",
"loginSuccess": true,
"message": "abc123"
}
WorkSheetType
Values
| Enum Value | Description |
|---|---|
|
|
Original worksheet |
|
|
Amended worksheet |
|
|
Test worksheet |
Example
"ORIGINAL"
WorksheetDocument
Fields
| Field Name | Description |
|---|---|
docCode - String
|
The code of the document. |
docDate - String
|
The date of the document. |
lines - [WorksheetDocumentLine]
|
The transaction detail lines of the document. |
messages - [Message]
|
A list of messages for this transaction. |
resultCode - ResultCode
|
The status code of this transaction. |
totalExempt - Float
|
The total amount exempt for this transaction. |
totalTax - Float
|
The total tax amount for this transaction. |
totalTaxable - Float
|
The total taxable amount for this transaction. |
transactionId - String
|
The ID for this transaction. |
Example
{
"docCode": "xyz789",
"docDate": "xyz789",
"lines": [WorksheetDocumentLine],
"messages": [Message],
"resultCode": "SUCCESS",
"totalExempt": 123.45,
"totalTax": 123.45,
"totalTaxable": 123.45,
"transactionId": "xyz789"
}
WorksheetDocumentLine
Fields
| Field Name | Description |
|---|---|
exemptAmount - Float
|
The exempt amount on the transaction line. |
lineAmount - Float
|
The amount for this transaction line. |
lineNo - String
|
The transaction line number. |
messages - [Message]
|
A list of messages for this transaction line. |
reportingDate - String
|
The reporting date for this transaction line. |
resultCode - ResultCode
|
The status code for this transaction line. |
taxAmount - Float
|
The tax amount for this transaction line. |
taxableAmount - Float
|
The taxable amount for this transaction line. |
transactionId - String
|
The ID for this transaction line. |
Example
{
"exemptAmount": 987.65,
"lineAmount": 123.45,
"lineNo": "xyz789",
"messages": [Message],
"reportingDate": "abc123",
"resultCode": "SUCCESS",
"taxAmount": 987.65,
"taxableAmount": 987.65,
"transactionId": "xyz789"
}
_DirectiveExtensions
Example
_DirectiveExtensions