PUT
/
transform
/
v1
/
jobs
/
{id}

Use UUID versions 7 or 1 to create jobs idempotently.

Path Parameters

id
string
required

ID of the job to create.

Query Parameters

wait
integer

Number of seconds to wait for the job to complete and provide a response.

Body

application/json
workflow_id
string
required

WorkflowID description

data
object | null

Raw JSON data of the GOBL Envelope or Object when the Silo Entry ID is empty.

silo_entry_id
string

ID for the entry in the silo as an alternative for the raw data object.

tags
string[]

Tags to associate with the job.

Response

200 - application/json
attachments
object[]

Any attachments that have been generated while processing the job in the workflow will be here.

completed_at
string

When this job was completed, will be nil if still ongoing.

created_at
string

When the job was created.

envelope
object

Raw JSON data of the complete GOBL Envelope.

faults
object[]

Array of fault objects that represent errors that occurred during the processing of the job.

id
string

The UUID v7 or v1 of the job

intents
object[]

Array of intent objects following the execution of each of the steps of the associated workflow.

silo_entry_id
string
status
string

Last known status text for this job.

tags
string[]

Any tags that may be useful to be associated with the job.

updated_at
string

When the job was last updated.

workflow_id
string