API / Task

Get Task Detail

get/v1/tasks/task/{id}

Path parameters

idstring uuid required

Response

Successful Response

idstring uuid required
status'TODO' | 'COMPLETED' | 'FAILED' | 'WAITING' required
task_type'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' required
invoice_idstring uuid nullable

Example response

{
  "payload": {
    "instance": {
      "date": "2022-01-01",
      "due_date": "2022-01-01",
      "booking_date": "2021-12-22",
      "currency": "EUR",
      "customer_reference_numbers": [
        "12345"
      ],
      "name": "Invoice-0001",
      "exchange_rate": {
        "rate_date": "2022-01-01",
        "rate": 1,
        "inverse_rate": 1
      },
      "total_excl_tax": "100",
      "total_incl_tax": "121",
      "total_tax": "21",
      "customer": {
        "currency": "EUR",
        "name": "John Doe",
        "legal_name": "John Doe",
        "vat_number": "BE1234.123.123",
        "accounting_code": "1234",
        "billing_location": {
          "code": "LOC123",
          "display_name": "Main Office",
          "address": "Gaston Crommenlaan 4",
          "city": "Ghent",
          "country": "BE",
          "postal_code": "9050",
          "name": "Qargo HQ"
        }
      },
      "line_items": [
        {
          "name": "Fuel charge",
          "amount": "100",
          "code": "FUEL",
          "description": "Charge description",
          "tax_rate": {
            "name": "21%",
            "percentage": 21,
            "code": "21% VAT"
          },
          "base_tax_rate": {
            "percentage": 21
          },
          "order_name": "Order-0001",
          "invoice_name": "Invoice-0001",
          "currency": "USD",
          "fraction": "0.5"
        }
      ],
      "billing_entity": {
        "legal_name": "Qargo BV",
        "vat_number": "NL123456789B01",
        "code": "QARGO",
        "company_registration_number": "12345678"
      }
    }
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.