Create a job
curl --request PUT \
--url https://api.invopop.com/transform/v1/jobs/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json'
{
"attachments": [
{
"desc": "My file description.",
"hash": "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad",
"id": "b564ff94-7823-4f54-975e-280feb38df3f",
"meta": "object",
"mime": "application/pdf",
"name": "my-file.pdf",
"size": "12345",
"url": "string"
}
],
"completed_at": "string",
"created_at": "string",
"id": "5b45453c-cdd0-11ed-afa1-0242ac120002",
"intents": [
{
"completed": "boolean",
"created_at": "string",
"events": [
{
"at": "2021-09-15T15:04:05.999Z",
"code": "string",
"index": "integer",
"message": "string",
"status": "ERR"
}
],
"id": "b564ff94-7823-4f54-975e-280feb38df3f",
"name": "PDF Generation",
"provider": "pdf",
"step_id": "8d49556b-ff63-477b-9cd3-32c986c1c77b",
"updated_at": "string"
}
],
"silo_entry_id": "75fa764a-cdd0-11ed-afa1-0242ac120002",
"status": "string",
"tags": [
"string"
],
"updated_at": "string",
"workflow_id": "186522a6-e697-4e34-8498-eee961bcb845"
}
Path Parameters
The UUIDv1 (other versions not supported) of the job to create.
Query Parameters
WorkflowID description
ID for the entry in the silo as an alternative for the raw data object.
Raw JSON data of the complete GOBL Envelope or Document when the Silo Entry ID.
Tags to associate with the job.
Number of seconds to wait for the job to complete and provide a response.
Body
Raw JSON data of the complete GOBL Envelope or Document when the Silo Entry ID.
ID for the entry in the silo as an alternative for the raw data object.
Tags to associate with the job.
WorkflowID description
Response
Any attachments that have been generated while processing the job in the workflow will be here.
When this job was completed, will be nil if still ongoing.
When the job was created.
Raw JSON data of the complete GOBL Envelope.
The UUIDv1 (other versions not supported) of the job
Array of intent objects following the execution of each of the steps of the associated workflow.
Last known status text for this job.
Any tags that may be useful to be associated with the job.
When the job was last updated.
curl --request PUT \
--url https://api.invopop.com/transform/v1/jobs/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json'
{
"attachments": [
{
"desc": "My file description.",
"hash": "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad",
"id": "b564ff94-7823-4f54-975e-280feb38df3f",
"meta": "object",
"mime": "application/pdf",
"name": "my-file.pdf",
"size": "12345",
"url": "string"
}
],
"completed_at": "string",
"created_at": "string",
"id": "5b45453c-cdd0-11ed-afa1-0242ac120002",
"intents": [
{
"completed": "boolean",
"created_at": "string",
"events": [
{
"at": "2021-09-15T15:04:05.999Z",
"code": "string",
"index": "integer",
"message": "string",
"status": "ERR"
}
],
"id": "b564ff94-7823-4f54-975e-280feb38df3f",
"name": "PDF Generation",
"provider": "pdf",
"step_id": "8d49556b-ff63-477b-9cd3-32c986c1c77b",
"updated_at": "string"
}
],
"silo_entry_id": "75fa764a-cdd0-11ed-afa1-0242ac120002",
"status": "string",
"tags": [
"string"
],
"updated_at": "string",
"workflow_id": "186522a6-e697-4e34-8498-eee961bcb845"
}