Refund a credit invoice via the original payment

POST

/v:version/invoices/:resourceId/refund

POST

/v:version/invoices/:resourceId/refund

1 curl -X POST https://api.solvimon.com/v1/invoices//refund \
2      -H "X-API-KEY: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

1 {
2   "status": "PAID",
3   "on_hold": false,
4   "type": "STANDARD",
5   "invoice_date": "2024-01-15T09:30:00Z",
6   "pricing_amount_type": "EXCLUDING_TAX",
7   "periods": [],
8   "payment_acceptor_ids": [
9     "payacc_001"
10   ],
11   "linked_invoices_ids": [],
12   "object_type": "invoice",
13   "id": "inv_1234567890abcdef",
14   "invoice_number": "INV-2024-0001",
15   "purchase_order_number": "PO-987654321",
16   "platform_id": "platform_001",
17   "sales_tax_percentage": "5.00",
18   "customer": {
19     "reference": "CUST-REF-001",
20     "type": "ORGANIZATION",
21     "email": "contact@customerexample.com",
22     "roles": [
23       "DEFAULT"
24     ],
25     "object_type": "customer",
26     "id": "cust_001",
27     "created_at": "2024-01-10T08:00:00Z",
28     "parent_customer_id": "cust_parent_001",
29     "parent_customer_ids": [
30       "cust_parent_001",
31       "cust_grandparent_001"
32     ],
33     "status": "DRAFT",
34     "timezone": "Asia/Dubai",
35     "notification_preferences": [
36       {
37         "type": "INVOICE",
38         "channels": [
39           {
40             "type": "EMAIL",
41             "enabled": true
42           }
43         ]
44       }
45     ],
46     "locale": "en_AE",
47     "individual": {
48       "name": {
49         "first_name": "John",
50         "last_name": "Doe",
51         "infix": ""
52       },
53       "residential_address": {
54         "line1": "123 Palm Street",
55         "line2": "Suite 4B",
56         "city": "Dubai",
57         "postal_code": "00000",
58         "state": "Dubai",
59         "country": "AE"
60       }
61     },
62     "organization": {
63       "legal_name": "Customer Example LLC",
64       "tax_id": "AE123456789",
65       "tax_ids": [
66         {
67           "id": "AE123456789",
68           "type": "VAT"
69         }
70       ],
71       "registration_number": "REG-987654321",
72       "tax_exempt": false,
73       "tax_exempt_note": "",
74       "registered_address": {
75         "line1": "123 Palm Street",
76         "line2": "Suite 4B",
77         "city": "Dubai",
78         "postal_code": "00000",
79         "state": "Dubai",
80         "country": "AE"
81       }
82     },
83     "custom_fields": [
84       {
85         "id": "cf_001",
86         "reference": "customer_custom_field_1",
87         "value": "Preferred Customer",
88         "values": [
89           "Preferred Customer"
90         ],
91         "integration_details": {
92           "payment_gateway_variant": "ADYEN",
93           "id": "int_001",
94           "reference": "int_ref_001",
95           "adyen": {
96             "recurring_detail_reference": "recurring_123"
97           },
98           "stripe": {
99             "payment_method_id": "pm_123456789"
100           }
101         }
102       }
103     ],
104     "processing_only": false,
105     "pricing_plan_subscription_selector": {
106       "data": [
107         {
108           "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
109           "value": "AE"
110         }
111       ],
112       "rules": [
113         {
114           "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
115           "type": "EQUALS"
116         }
117       ],
118       "filters": [
119         {
120           "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
121           "type": "EQUALS",
122           "value": "AE"
123         }
124       ],
125       "fallback": "LATEST"
126     },
127     "linked_integrations": [
128       {
129         "id": "link_001",
130         "link_details": [
131           {
132             "url": "https://integration.example.com/customer/cust_001",
133             "custom_field_name": "external_customer_id"
134           }
135         ]
136       }
137     ]
138   },
139   "billing_entity": {
140     "reference": "BE-REF-001",
141     "default_customer_country_selector": [
142       "AE"
143     ],
144     "default_billing_currency_selector": [
145       "AED"
146     ],
147     "object_type": "billing_entity",
148     "id": "be_001",
149     "created_at": "2023-12-01T09:00:00Z",
150     "status": "ACTIVE",
151     "timezone": "Asia/Dubai",
152     "legal_name": "Billing Entity LLC",
153     "tax_id": "AE987654321",
154     "tax_ids": [
155       {
156         "id": "AE987654321",
157         "type": "VAT"
158       }
159     ],
160     "registration_number": "REG-123456789",
161     "registered_address": {
162       "line1": "456 Business Bay",
163       "line2": "Floor 10",
164       "city": "Dubai",
165       "postal_code": "00001",
166       "state": "Dubai",
167       "country": "AE"
168     },
169     "email": "billing@billingentity.com",
170     "tax_settings": {
171       "apply_local_vat_for_missing_tax_id": true
172     },
173     "tax_registrations": [
174       {
175         "id": "taxreg_001",
176         "description": "VAT Registration UAE",
177         "tax_id": "AE987654321",
178         "tax_ids": [
179           {
180             "id": "AE987654321",
181             "type": "VAT"
182           }
183         ],
184         "registration_number": "REG-123456789",
185         "registered_address": {
186           "line1": "456 Business Bay",
187           "line2": "Floor 10",
188           "city": "Dubai",
189           "postal_code": "00001",
190           "state": "Dubai",
191           "country": "AE"
192         }
193       }
194     ],
195     "custom_fields": [
196       {
197         "id": "cf_be_001",
198         "reference": "billing_entity_custom_field_1",
199         "value": "Priority Billing",
200         "values": [
201           "Priority Billing"
202         ],
203         "integration_details": {
204           "payment_gateway_variant": "ADYEN",
205           "id": "int_be_001",
206           "reference": "int_ref_be_001",
207           "adyen": {
208             "recurring_detail_reference": "recurring_be_123"
209           },
210           "stripe": {
211             "payment_method_id": "pm_be_123456789"
212           }
213         }
214       }
215     ],
216     "linked_integrations": [
217       {
218         "id": "link_be_001",
219         "link_details": [
220           {
221             "url": "https://integration.example.com/billing_entity/be_001",
222             "custom_field_name": "external_billing_entity_id"
223           }
224         ]
225       }
226     ]
227   },
228   "paid": true,
229   "created_at": "2024-01-15T09:30:00Z",
230   "updated_at": "2024-01-20T10:00:00Z",
231   "delivery_date": "2024-01-16T09:30:00Z",
232   "due_date": "2024-02-15T09:30:00Z",
233   "billing_period_date": "2024-01-01T00:00:00Z",
234   "billing_currency": "AED",
235   "invoice_amount_including_tax": {
236     "quantity": "1050.00",
237     "currency": "AED"
238   },
239   "open_invoice_amount": {
240     "quantity": "0.00",
241     "currency": "AED"
242   },
243   "closed_invoice_amount": {
244     "quantity": "1050.00",
245     "currency": "AED"
246   },
247   "timezone": "Asia/Dubai",
248   "billing_period": {
249     "type": "MONTH",
250     "value": 1
251   },
252   "pricing_plan_subscription_ids": [
253     "sub_001"
254   ],
255   "closed_periods": [],
256   "tax_categories": [
257     {
258       "category": "STANDARD",
259       "percentage": "5.00",
260       "name": "VAT",
261       "base_amount": {
262         "quantity": "1000.00",
263         "currency": "AED"
264       },
265       "tax_amount": {
266         "quantity": "50.00",
267         "currency": "AED"
268       },
269       "total_amount": {
270         "quantity": "1050.00",
271         "currency": "AED"
272       },
273       "local_amounts": {
274         "display": true,
275         "base_amount": {
276           "quantity": "1000.00",
277           "currency": "AED"
278         },
279         "tax_amount": {
280           "quantity": "50.00",
281           "currency": "AED"
282         },
283         "total_amount": {
284           "quantity": "1050.00",
285           "currency": "AED"
286         },
287         "used_exchange_rate": {
288           "currency": "AED",
289           "base_currency": "AED",
290           "rate_timestamp": "2024-01-15T00:00:00Z",
291           "rate": "1.0",
292           "source": "Internal"
293         }
294       },
295       "notes": [
296         "Standard VAT rate applied"
297       ],
298       "rates": [
299         {
300           "name": "VAT Standard Rate",
301           "percentage": "5.00",
302           "tax_amount": {
303             "quantity": "50.00",
304             "currency": "AED"
305           }
306         }
307       ]
308     }
309   ],
310   "tax_summary": {
311     "country_code": "AE",
312     "base_amount": {
313       "quantity": "1000.00",
314       "currency": "AED"
315     },
316     "tax_amount": {
317       "quantity": "50.00",
318       "currency": "AED"
319     },
320     "total_amount": {
321       "quantity": "1050.00",
322       "currency": "AED"
323     },
324     "local_amounts": {
325       "display": true,
326       "base_amount": {
327         "quantity": "1000.00",
328         "currency": "AED"
329       },
330       "tax_amount": {
331         "quantity": "50.00",
332         "currency": "AED"
333       },
334       "total_amount": {
335         "quantity": "1050.00",
336         "currency": "AED"
337       },
338       "used_exchange_rate": {
339         "currency": "AED",
340         "base_currency": "AED",
341         "rate_timestamp": "2024-01-15T00:00:00Z",
342         "rate": "1.0",
343         "source": "Internal"
344       }
345     },
346     "notes": [
347       "Summary of VAT applied"
348     ]
349   },
350   "dunning_actions": [],
351   "payment_actions": [],
352   "pay_invoice_link": {
353     "expiry_period": {
354       "type": "DAY",
355       "value": 30
356     },
357     "portal_url_id": "portal_001",
358     "url": "https://pay.example.com/invoice/inv_1234567890abcdef"
359   },
360   "notes": [
361     "Invoice paid in full on 2024-01-20"
362   ],
363   "linked_invoices": [],
364   "custom_fields": [],
365   "other_custom_fields": [],
366   "credit": {
367     "note": "Refund issued for overpayment",
368     "original_invoice_id": "inv_0000000000000001",
369     "original_invoice_info": {
370       "id": "inv_0000000000000001",
371       "invoice_number": "INV-2023-0999"
372     }
373   },
374   "e_invoices": [],
375   "used_exchange_rates": [
376     {
377       "currency": "AED",
378       "base_currency": "AED",
379       "rate_timestamp": "2024-01-15T00:00:00Z",
380       "rate": "1.0",
381       "source": "Internal"
382     }
383   ],
384   "processing_only_customers": [],
385   "meter_values": [],
386   "credit_types": [],
387   "display_invoice_sub_lines_per_processing_only_customer": false,
388   "forwarded_from_customers": [],
389   "validation_result": [
390     {
391       "status": "VALID",
392       "details": "Invoice data validated successfully"
393     }
394   ],
395   "used_tax_registration": {
396     "id": "taxreg_001",
397     "description": "VAT Registration UAE",
398     "tax_id": "AE987654321",
399     "tax_ids": [
400       {
401         "id": "AE987654321",
402         "type": "VAT"
403       }
404     ],
405     "registration_number": "REG-123456789",
406     "registered_address": {
407       "line1": "456 Business Bay",
408       "line2": "Floor 10",
409       "city": "Dubai",
410       "postal_code": "00001",
411       "state": "Dubai",
412       "country": "AE"
413     }
414   },
415   "footnote": "Thank you for your business.",
416   "approval_status": "APPROVED",
417   "updated_to_final_at": "2024-01-20T10:00:00Z",
418   "has_usage_based_pricing": false,
419   "coupons": [],
420   "promotion_codes": [],
421   "linked_integrations": [],
422   "auto_rescues": [],
423   "to_be_reprocessed": false
424 }

Requires the INVOICE.REFUND permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1

version

resourceIdstringRequiredDefaults to

The ID of the resource for which the action is posted.

Response

statusstring

on_holdboolean

typeenum

Allowed values:

invoice_datedatetime

pricing_amount_typeenum

Indicates whether the amounts provided, e.g. from the pricing plan, are including or excluding tax.

Allowed values:

periodslist of objects

Periods that are applicable for this invoice, use either periods or groups for summation, groups will be removed in later version

payment_acceptor_idslist of strings

linked_invoices_idslist of stringsDeprecated

Can currently only be used for ‘ONE_OFF_CREDIT’ invoices, indicates original invoices that this invoice links to

object_typestring or nullRead-only

idstring or nullRead-only

invoice_numberstring or nullRead-only

purchase_order_numberstring or null

platform_idstring or nullRead-only

sales_tax_percentagestring or null

Sales tax percentage. Needs to be present if both customer and billing entity are US-based. Optional if one of them is US-based

customerobject or null

billing_entityobject or null

paidboolean or null

created_atstring or nullRead-only

updated_atstring or nullRead-only

delivery_datestring or nullRead-only

due_datedatetime or null

billing_period_datestring or nullRead-only

billing_currencystring or nullRead-only

invoice_amount_including_taxobject or null

Amount value of the meter value, will be set when type == AMOUNT

open_invoice_amountobject or null

Amount value of the meter value, will be set when type == AMOUNT

closed_invoice_amountobject or null

Amount value of the meter value, will be set when type == AMOUNT

timezonestring or nullRead-only

billing_periodobject or null

Optional delivery window configuration that limits when outbound emails may be sent.

pricing_plan_subscription_idslist of strings or nullRead-only

closed_periodslist of objects or nullRead-only

tax_categorieslist of objects or nullRead-only

tax_summaryobject or null

dunning_actionslist of objects or nullRead-only

payment_actionslist of objects or nullRead-only

pay_invoice_linkobject or null

noteslist of strings or null

linked_invoiceslist of objects or nullRead-only

custom_fieldslist of objects or null

other_custom_fieldslist of objects or nullRead-only

creditobject or null

e_invoiceslist of objects or nullRead-only

used_exchange_rateslist of objects or nullRead-only

processing_only_customerslist of objects or nullRead-only

meter_valueslist of objects or nullRead-only

credit_typeslist of objects or nullRead-only

display_invoice_sub_lines_per_processing_only_customerboolean or nullRead-only

forwarded_from_customerslist of objects or nullRead-only

validation_resultlist of objects or nullRead-only

reprocessobject

used_tax_registrationobject or null

The tax registrations that are used to calculate the tax for this invoice. If empty, the billing entity was used

footnotestring or nullRead-only

Footnote to be shown on the invoice

approval_statusenum or nullRead-only

Approval status for invoices that are associated with an approval request

Allowed values:

updated_to_final_atstring or nullRead-only

The invoice finalization date

has_usage_based_pricingboolean or nullRead-only

couponslist of objects or nullRead-only

Coupons applied to this invoice

promotion_codeslist of objects or nullRead-only

Promotion codes applied to this invoice

linked_integrationslist of objects or null

billing_typeenum or null

Allowed values:

auto_rescueslist of objects or nullRead-onlyDeprecated

to_be_reprocessedboolean or nullRead-onlyDeprecated

to_be_reprocessed_atstring or nullRead-onlyDeprecated

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

Authentication

Path parameters

Headers

Response

Errors