Remind an Invoice
post/{invoice_id}/remind
Request
- Base URLhttps://api.tap.company/v2/invoices
- URLhttps://api.tap.company/v2/invoices/{invoice_id}/remind
- AuthAPI key in header Authorization
Path parameters
invoice_idstring required
optional
Response
200
Example response
{
"object": "invoice",
"api_version": "V1.2",
"id": "inv_N0U21311012qNz6527513",
"method": "CREATE",
"status": "CREATED",
"amount": 12,
"currency": "KWD",
"created": 1690186245513,
"updated": 1690186280312,
"url": "https://invoices.sandbox.tap.company/invoice/inv_N0U21311012qNz6527513",
"due": 1690268010000,
"expiry": 1690268010000,
"mode": "INVOICE",
"description": "test invoice",
"description_id": "desc_aYBg1311012OxJ3527458",
"invoice_number": "120230724081049553",
"frequency": "SINGLE_INVOICE",
"lang_code": "EN",
"metadata": {
"udf1": "1",
"udf2": "2",
"udf3": "3"
},
"notifications": {
"dispatch": true,
"channels": [
"SMS"
]
},
"order": {
"object": "order",
"id": "ord_msFD1311012NoUk527371",
"api_version": "V1.2",
"currency": "KWD",
"amount": 12,
"status": "CREATED",
"items": [
{
"id": "itm_0F3A1311012jLBA527059",
"product_id": "prd_m8lW1311012kMEm527371",
"name": "test",
"description": "test",
"currency": "KWD",
"amount": 10,
"quantity": 1,
"discount": {
"type": "P"
}
}
],
"tax": [
{
"id": "tax_yUR21311012HLm6527155",
"name": "VAT",
"description": "test",
"rate": {
"type": "F",
"value": 1
}
}
],
"shipping": {
"id": "shp_h9Y913110129MSh527251",
"currency": "KWD",
"amount": 1,
"provider": "ARAMEX",
"service": "test",
"description": "test"
},
"itemAmount": 10,
"created": 1690186247371,
"merchant_id": "599424"
},
"reference": {
"invoice": "INV_00001",
"order": "ORD_00001"
},
"customer": {
"id": "cus_TS06A4520231111Zb4q2407927",
"first_name": "test 2",
"middle_name": "test 2",
"last_name": "test 2",
"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_gSDm1311012DT4s527458",
"object": "track",
"status": "DELIVERED",
"updated": 1690186280312,
"activity": [
{
"id": "act_yl1k1311012zYmc527458",
"object": "activity",
"type": "CREATED",
"created": 1690186249458
}
]
},
"currencies": [
"KWD"
],
"note": "test note"
}Changes
No recorded changes to this operation across all 1 revision of this API.