Refund an instalment invoice

POST https://api.tamio.com/v2/invoices/instalments/refund/{uuid}

Processes a refund for a specific instalment payment within an instalment plan. Allows refunding individual instalments while keeping the rest of the payment plan intact.

Path Parameters

uuid string*

UUID of the main invoice containing the instalment plan

Body Parameters

instalment_invoice_id string*

Specific instalment invoice ID to refund

reason string*

Reason for the instalment refund

requested_by_customerduplicatefraudulentother

amount integer

Custom refund amount in smallest currency unit (full instalment amount if omitted)

Responses

200 Instalment invoice refunded successfully

Instalment invoice refunded successfully

status integer

invoice Invoice

400 Bad request. Possible `error_code` values:

Bad request. Possible error_code values:

Code	Description
`1002`	ResourceNotFound
`10117`	InvalidInvoice
`10340`	InvoiceAlreadyRefunded
`10341`	InvalidRefundAmount

status integer

error string

Human-readable error message

error_code integer

Machine-readable error code

401 Missing or invalid API key

Refund an invoice

Update affiliate commission

/invoices/instalments/refund/{uuid}

1 const response = await fetch("https://api.tamio.com/v2/invoices/instalments/refund/{uuid}", {
2   method: "POST",
3   headers: {
4     "Authorization": "Bearer YOUR_API_KEY",
5     "Content-Type": "application/json"
6   },
7   body: JSON.stringify({
8     // ... request body
9   })
10 });
11 const data = await response.json();

1 require "uri"
2 require "net/http"
3 
4 url = URI("https://api.tamio.com/v2/invoices/instalments/refund/{uuid}")
5 
6 https = Net::HTTP.new(url.host, url.port)
7 https.use_ssl = true
8 
9 request = Net::HTTP::Post.new(url)
10 request["Accept"] = "application/json"
11 request["Authorization"] = "Bearer YOUR_API_KEY"
12 request["Content-Type"] = "application/json"
13 request.body = %Q{
14   // ... request body
15 }
16 
17 response = https.request(request)
18 puts response.read_body

Responses

{
  "status": 200,
  "invoice": {
    "id": "string",
    "object": "invoice",
    "currency": "EUR",
    "paid": false,
    "processing_payment": false,
    "prefix": "INV-",
    "number": 1001,
    "total": 5000,
    "payment": "stripe_creditcard",
    "date": 1700000000,
    "status": "paid",
    "subscription": "string",
    "locale": "en",
    "payment_retried": false,
    "payment_charge_date": 0,
    "3d_secure_failure": false,
    "authorization_expiry": 0,
    "affiliate_program": "string",
    "affiliate": "string",
    "late_failure": false,
    "has_subscriptions": false,
    "is_instalment": false,
    "fortnox_submitted": false,
    "start_date": 0,
    "end_date": 0,
    "has_notes": false,
    "customer_information": {},
    "products": [],
    "shipping": {},
    "totals": {}
  }
}

1	const response = await fetch("https://api.tamio.com/v2/invoices/instalments/refund/{uuid}", {
2	method: "POST",
3	headers: {
4	"Authorization": "Bearer YOUR_API_KEY",
5	"Content-Type": "application/json"
6	},
7	body: JSON.stringify({
8	// ... request body
9	})
10	});
11	const data = await response.json();

1	require "uri"
2	require "net/http"
3
4	url = URI("https://api.tamio.com/v2/invoices/instalments/refund/{uuid}")
5
6	https = Net::HTTP.new(url.host, url.port)
7	https.use_ssl = true
8
9	request = Net::HTTP::Post.new(url)
10	request["Accept"] = "application/json"
11	request["Authorization"] = "Bearer YOUR_API_KEY"
12	request["Content-Type"] = "application/json"
13	request.body = %Q{
14	// ... request body
15	}
16
17	response = https.request(request)
18	puts response.read_body