Retrieve an Invoice

get/{invoice_id}

Request

  • Base URL
    https://api.tap.company/v2/invoices
  • URL
    https://api.tap.company/v2/invoices/{invoice_id}
  • Auth
    API key in header Authorization

Path parameters

invoice_idstring required

optional

Response

200

objectstring
live_modeboolean
api_versionstring
idstring
methodstring
statusstring
amountinteger
currencystring
createdinteger
updatedinteger
urlstring
draftboolean
dueinteger
expiryinteger
modestring
descriptionstring
description_idstring
invoice_numberstring
frequencystring
lang_codestring
payment_methodsstring[]
currenciesstring[]
savecardboolean
notestring
merchant_idstring

Example response

{
  "object": "invoice",
  "api_version": "V1.2",
  "id": "inv_9eaR1311012NSf3527897",
  "method": "GET",
  "status": "CREATED",
  "amount": 12,
  "currency": "KWD",
  "created": 1690184054897,
  "updated": 1690184064008,
  "url": "https://invoices.sandbox.tap.company/invoice/inv_9eaR1311012NSf3527897",
  "due": 1690268010000,
  "expiry": 1690268010000,
  "mode": "INVOICE",
  "description": "test invoice",
  "description_id": "desc_p5AR1311012lu2P527527",
  "invoice_number": "120230724073421624",
  "frequency": "SINGLE_INVOICE",
  "lang_code": "EN",
  "metadata": {
    "udf1": "1",
    "udf2": "2",
    "udf3": "3"
  },
  "notifications": {
    "dispatch": true,
    "channels": [
      "SMS"
    ]
  },
  "order": {
    "object": "order",
    "id": "ord_6H3l1311012pQ7p527357",
    "api_version": "V1.2",
    "currency": "KWD",
    "amount": 12,
    "status": "CREATED",
    "items": [
      {
        "id": "itm_Et0Y1311012mh2a527047",
        "product_id": "prd_ylcq1311012p4z3527357",
        "name": "test",
        "description": "test",
        "currency": "KWD",
        "amount": 10,
        "quantity": 1,
        "discount": {
          "type": "P"
        }
      }
    ],
    "tax": [
      {
        "id": "tax_3EXI1311012Q3K4527143",
        "name": "VAT",
        "description": "test",
        "rate": {
          "type": "F",
          "value": 1
        }
      }
    ],
    "shipping": {
      "id": "shp_uUtp1311012yoZh527240",
      "currency": "KWD",
      "amount": 1,
      "provider": "ARAMEX",
      "service": "test",
      "description": "test"
    },
    "itemAmount": 10,
    "created": 1690184059357,
    "merchant_id": "599424"
  },
  "reference": {
    "invoice": "INV_00001",
    "order": "ORD_00001"
  },
  "customer": {
    "id": "cus_TS03A1820231035i5FK2407026",
    "first_name": "test",
    "middle_name": "test",
    "last_name": "test",
    "email": "test@test.com",
    "phone": {
      "number": "51234567",
      "country_code": "965"
    }
  },
  "post": {
    "url": "http://your_website.com/post_url"
  },
  "redirect": {
    "url": "http://your_website.com/redirect_url"
  },
  "charge": {
    "receipt": {
      "email": true,
      "sms": true
    },
    "statement_descriptor": "test"
  },
  "track": {
    "id": "tck_x0AD1311012HAz0527527",
    "object": "track",
    "status": "DELIVERED",
    "updated": 1690184064008,
    "activity": [
      {
        "id": "act_ykJJ13110123Xmg527527",
        "object": "activity",
        "type": "CREATED",
        "created": 1690184061527
      }
    ]
  },
  "currencies": [
    "KWD"
  ],
  "note": "test note"
}

Changes

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