AvaTax for VAT

OverviewAPI
Version v2
APConfigSetting
Accounts
Addresses
AvaFileForms
Batches
CertExpressInvites
Certificates
Clerk
CommunicationCertificates
Companies
Compliance
Contacts
CostCenter
Customers
DataSources
Definitions
DistanceThresholds
DomainControlVerification
ECommerceToken
EcmEventNotifications
EcoNexusThreshold
FirmClientLinkages
FormTypeMapping
FundingRequests
GLAccount
Items
ItemsReverseSync
Jobs
JurisdictionOverrides
Locations
MultiDocument
Nexus
Notices
Notifications
Provisioning
Registrar
Reports
Settings
Subscriptions
TaxCodes
TaxContent
TaxRules
Transactions
Upcs
UserDefinedFields
Users
Utilities
VendorCertificates
Vendors

CertificateJobModel

A job associated with a certificate.

Used as both the input shape on certificate POST/PUT (only id and the nested Avalara.AvaTax.AccountServices.Models.v2.CertificateJobModel.phases ids are required to link existing jobs/phases/tasks to the certificate) and the response shape on certificate GET endpoints when jobs is requested via $include. Use $include=jobs.phases or $include=jobs.tasks on GET to additionally populate the nested Avalara.AvaTax.AccountServices.Models.v2.CertificateJobModel.phases collection and the tasks under each phase.

Parameters
isExplicitOptional
boolean

Indicates whether this job was explicitly linked to the certificate. Populated by CertCapture on GET responses; ignored on POST/PUT.

isDirectOptional
boolean

Indicates whether this is a direct association. Populated by CertCapture on GET responses; ignored on POST/PUT.

idOptional
integer

The unique ID of this job. Required on POST/PUT to link an existing job to the certificate.

nameOptional
string

The name of this job. Populated by CertCapture on GET responses; ignored on POST/PUT (the job is identified by Avalara.AvaTax.AccountServices.Models.v2.CertificateJobModel.id).

jobNumberOptional
string

The job number. Populated by CertCapture on GET responses; ignored on POST/PUT (the job is identified by Avalara.AvaTax.AccountServices.Models.v2.CertificateJobModel.id).

exposureZoneNameOptional
string

The name of the exposure zone associated with this job. Populated by CertCapture on GET responses; ignored on POST/PUT.

phasesOptional
array

The nested list of phases for this job (each phase containing its own tasks).

On GET, populated by CertCapture only when $include=jobs.phases or $include=jobs.tasks is requested; null otherwise. On POST/PUT, supply the phase / task id values to link them to the certificate alongside the job.