Skip to content

Get Task Detail

Request

Security
oAuth2ClientCredentials
Path
idstring, (uuid)(Id)required
GET
/v1/tasks/task/{id}
import requests

id = "YOUR_id_PARAMETER"
url = "https://api.qargo.com/v1/tasks/task/" + id

headers = {"Authorization": "Bearer <YOUR_TOKEN_HERE>"}

response = requests.get(url, headers=headers)

data = response.json()
print(data)

Responses

Successful Response

Bodyapplication/json
idstring, (uuid)(Id)required
statusstring(TaskStatus)required
Enum:"TODO""COMPLETED""FAILED""WAITING"
task_typestring(TaskType)required
Enum:"POST_INVOICE""POST_INVOICE_PURCHASE""POST_CREDIT_NOTE""POST_CREDIT_NOTE_PURCHASE""PAID_INVOICE""PAID_INVOICE_PURCHASE""REFUNDED_CREDIT_NOTE""REFUNDED_CREDIT_NOTE_PURCHASE""DISPATCH"
execution_metadataTaskInstanceExecutionMetadata (object) or null
Any of:
payloadTaskPayload (object) or null
Any of:

Task execution input data.

invoice_idstring or null(Invoice Id)
Any of:
string (uuid)
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "status": "TODO",
  "task_type": "POST_INVOICE",
  "execution_metadata": {
    "external_execution": { … }
  },
  "payload": {
    "subject_id": "80e197be-61ad-4068-b4ff-a483fb5c18f9",
    "subject_type": "SALES_INVOICE",
    "documents": [ … ],
    "instance": { … }
  },
  "invoice_id": "f4c4edb8-11e0-4b33-bcc1-482dc59ebb32"
}