Refresh the invoice and get it

POST

/v:version/invoices/:resourceId/refresh

POST

/v:version/invoices/:resourceId/refresh

1 curl -X POST https://api.solvimon.com/v1/invoices//refresh \
2      -H "X-API-KEY: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "types": [
6     "FULL"
7   ]
8 }'

1 {
2   "status": "OPEN",
3   "on_hold": false,
4   "type": "STANDARD",
5   "invoice_date": "2024-01-15T09:30:00Z",
6   "pricing_amount_type": "EXCLUDING_TAX",
7   "periods": [
8     {
9       "period_order": 1,
10       "start_at": "2024-01-01T00:00:00Z",
11       "end_at": "2024-01-31T23:59:59Z",
12       "tax_categories": [
13         {
14           "category": "VAT",
15           "percentage": "5.00",
16           "name": "State VAT",
17           "base_amount": {
18             "quantity": "1428.57",
19             "currency": "USD"
20           },
21           "tax_amount": {
22             "quantity": "71.43",
23             "currency": "USD"
24           },
25           "total_amount": {
26             "quantity": "1500.00",
27             "currency": "USD"
28           },
29           "local_amounts": {
30             "display": true,
31             "base_amount": {
32               "quantity": "1428.57",
33               "currency": "USD"
34             },
35             "tax_amount": {
36               "quantity": "71.43",
37               "currency": "USD"
38             },
39             "total_amount": {
40               "quantity": "1500.00",
41               "currency": "USD"
42             },
43             "used_exchange_rate": {
44               "currency": "USD",
45               "base_currency": "USD",
46               "rate_timestamp": "2024-01-01T00:00:00Z",
47               "rate": "1.0",
48               "source": "Internal"
49             }
50           },
51           "notes": [
52             "Standard VAT rate applied"
53           ],
54           "rates": [
55             {
56               "name": "Standard VAT",
57               "percentage": "5.00",
58               "tax_amount": {
59                 "quantity": "71.43",
60                 "currency": "USD"
61               }
62             }
63           ]
64         }
65       ],
66       "amount_excluding_tax": {
67         "quantity": "1428.57",
68         "currency": "USD"
69       },
70       "amount_including_tax": {
71         "quantity": "1500.00",
72         "currency": "USD"
73       },
74       "billing_period": {
75         "type": "MONTH",
76         "value": 1
77       },
78       "groups": []
79     }
80   ],
81   "payment_acceptor_ids": [
82     "payacc_001"
83   ],
84   "linked_invoices_ids": [],
85   "object_type": "invoice",
86   "id": "inv_1234567890abcdef",
87   "invoice_number": "INV-2024-0001",
88   "purchase_order_number": "PO-987654321",
89   "platform_id": "platform_001",
90   "sales_tax_percentage": "5.00",
91   "customer": {
92     "reference": "CUST-REF-001",
93     "type": "ORGANIZATION",
94     "email": "contact@acmecorp.com",
95     "roles": [
96       "DEFAULT"
97     ],
98     "object_type": "customer",
99     "id": "cust_abcdef1234567890",
100     "created_at": "2024-04-01T10:00:00Z",
101     "parent_customer_id": "cust_parent_001",
102     "parent_customer_ids": [
103       "cust_parent_001",
104       "cust_grandparent_001"
105     ],
106     "status": "DRAFT",
107     "timezone": "America/New_York",
108     "notification_preferences": [
109       {
110         "type": "INVOICE",
111         "channels": [
112           {
113             "type": "EMAIL",
114             "enabled": true
115           }
116         ]
117       }
118     ],
119     "locale": "en-US",
120     "individual": {
121       "name": {
122         "first_name": "John",
123         "last_name": "Doe",
124         "infix": ""
125       },
126       "residential_address": {
127         "line1": "123 Maple Street",
128         "line2": "Apt 4B",
129         "city": "Springfield",
130         "postal_code": "01103",
131         "state": "MA",
132         "country": "US"
133       }
134     },
135     "organization": {
136       "legal_name": "Acme Corporation",
137       "tax_id": "98-7654321",
138       "tax_ids": [
139         {
140           "id": "taxid_001",
141           "type": "GENERIC_TAX_ID",
142           "tax_id_validation_result": {
143             "id": "validation_001",
144             "validation_date": "2024-04-01T09:00:00Z",
145             "source": "IRS",
146             "valid": "VALID",
147             "message": "Tax ID validated successfully"
148           }
149         }
150       ],
151       "registration_number": "REG-123456",
152       "tax_exempt": false,
153       "tax_exempt_note": "",
154       "registered_address": {
155         "line1": "456 Oak Avenue",
156         "line2": "",
157         "city": "Springfield",
158         "postal_code": "01103",
159         "state": "MA",
160         "country": "US"
161       },
162       "tax_registrations": [
163         {
164           "id": "taxreg_001",
165           "description": "State VAT Registration",
166           "tax_id": "ST-987654321",
167           "tax_ids": [
168             {
169               "id": "taxid_002",
170               "type": "GENERIC_TAX_ID",
171               "tax_id_validation_result": {
172                 "id": "validation_002",
173                 "validation_date": "2024-04-01T09:30:00Z",
174                 "source": "State Tax Authority",
175                 "valid": "VALID",
176                 "message": "State tax ID validated"
177               }
178             }
179           ],
180           "registration_number": "ST-REG-987654",
181           "registered_address": {
182             "line1": "456 Oak Avenue",
183             "line2": "",
184             "city": "Springfield",
185             "postal_code": "01103",
186             "state": "MA",
187             "country": "US"
188           }
189         }
190       ]
191     },
192     "custom_fields": [
193       {
194         "id": "cf_001",
195         "reference": "preferred_contact_method",
196         "value": "email",
197         "values": [
198           "email"
199         ],
200         "integration_details": {
201           "payment_gateway_variant": "ADYEN",
202           "id": "int_001",
203           "reference": "adyen_payment",
204           "adyen": {
205             "recurring_detail_reference": "recurring_12345"
206           },
207           "stripe": {
208             "payment_method_id": "pm_1GqIC8Lz0qyl6XeW3Xq1"
209           }
210         }
211       }
212     ],
213     "processing_only": false,
214     "pricing_plan_subscription_selector": {
215       "data": [
216         {
217           "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
218           "value": "US"
219         }
220       ],
221       "rules": [
222         {
223           "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
224           "type": "EQUALS"
225         }
226       ],
227       "filters": [
228         {
229           "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
230           "type": "EQUALS",
231           "value": "US"
232         }
233       ],
234       "fallback": "LATEST"
235     },
236     "linked_integrations": [
237       {
238         "id": "link_001",
239         "link_details": [
240           {
241             "url": "https://crm.acmecorp.com/customer/cust_abcdef1234567890",
242             "custom_field_name": "CRM Profile"
243           }
244         ]
245       }
246     ]
247   },
248   "billing_entity": {
249     "reference": "BE-REF-001",
250     "default_customer_country_selector": [
251       "US"
252     ],
253     "default_billing_currency_selector": [
254       "USD"
255     ],
256     "object_type": "billing_entity",
257     "id": "be_001",
258     "created_at": "2023-12-01T08:00:00Z",
259     "status": "ACTIVE",
260     "timezone": "America/New_York",
261     "legal_name": "Acme Billing Services",
262     "tax_id": "12-3456789",
263     "tax_ids": [
264       {
265         "id": "taxid_be_001",
266         "type": "GENERIC_TAX_ID",
267         "tax_id_validation_result": {
268           "id": "validation_be_001",
269           "validation_date": "2024-01-01T08:00:00Z",
270           "source": "IRS",
271           "valid": "VALID",
272           "message": "Billing entity tax ID validated"
273         }
274       }
275     ],
276     "registration_number": "BE-REG-001",
277     "registered_address": {
278       "line1": "789 Birch Road",
279       "line2": "Suite 100",
280       "city": "Springfield",
281       "postal_code": "01103",
282       "state": "MA",
283       "country": "US"
284     },
285     "email": "billing@acmecorp.com",
286     "tax_settings": {
287       "apply_local_vat_for_missing_tax_id": false
288     },
289     "tax_registrations": [
290       {
291         "id": "taxreg_be_001",
292         "description": "Federal Tax Registration",
293         "tax_id": "FED-123456789",
294         "tax_ids": [
295           {
296             "id": "taxid_be_002",
297             "type": "GENERIC_TAX_ID",
298             "tax_id_validation_result": {
299               "id": "validation_be_002",
300               "validation_date": "2024-01-01T08:30:00Z",
301               "source": "Federal Tax Authority",
302               "valid": "VALID",
303               "message": "Federal tax ID validated"
304             }
305           }
306         ],
307         "registration_number": "FED-REG-123456",
308         "registered_address": {
309           "line1": "789 Birch Road",
310           "line2": "Suite 100",
311           "city": "Springfield",
312           "postal_code": "01103",
313           "state": "MA",
314           "country": "US"
315         }
316       }
317     ],
318     "custom_fields": [
319       {
320         "id": "cf_be_001",
321         "reference": "billing_contact",
322         "value": "billing@acmecorp.com",
323         "values": [
324           "billing@acmecorp.com"
325         ],
326         "integration_details": {
327           "payment_gateway_variant": "STRIPE",
328           "id": "int_be_001",
329           "reference": "stripe_billing",
330           "adyen": {
331             "recurring_detail_reference": ""
332           },
333           "stripe": {
334             "payment_method_id": "pm_1GqIC8Lz0qyl6XeW3Xq2"
335           }
336         }
337       }
338     ],
339     "linked_integrations": [
340       {
341         "id": "link_be_001",
342         "link_details": [
343           {
344             "url": "https://billing.acmecorp.com/entity/be_001",
345             "custom_field_name": "Billing Portal"
346           }
347         ]
348       }
349     ]
350   },
351   "paid": false,
352   "created_at": "2024-01-10T12:00:00Z",
353   "updated_at": "2024-01-12T15:00:00Z",
354   "delivery_date": "2024-01-16T09:30:00Z",
355   "due_date": "2024-02-15T09:30:00Z",
356   "billing_period_date": "2024-01-01T00:00:00Z",
357   "billing_currency": "USD",
358   "invoice_amount_including_tax": {
359     "quantity": "1500.00",
360     "currency": "USD"
361   },
362   "open_invoice_amount": {
363     "quantity": "1500.00",
364     "currency": "USD"
365   },
366   "closed_invoice_amount": {
367     "quantity": "0.00",
368     "currency": "USD"
369   },
370   "timezone": "America/New_York",
371   "billing_period": {
372     "type": "MONTH",
373     "value": 1
374   },
375   "pricing_plan_subscription_ids": [
376     "sub_001"
377   ],
378   "closed_periods": [],
379   "tax_categories": [
380     {
381       "category": "VAT",
382       "percentage": "5.00",
383       "name": "State VAT",
384       "base_amount": {
385         "quantity": "1428.57",
386         "currency": "USD"
387       },
388       "tax_amount": {
389         "quantity": "71.43",
390         "currency": "USD"
391       },
392       "total_amount": {
393         "quantity": "1500.00",
394         "currency": "USD"
395       },
396       "local_amounts": {
397         "display": true,
398         "base_amount": {
399           "quantity": "1428.57",
400           "currency": "USD"
401         },
402         "tax_amount": {
403           "quantity": "71.43",
404           "currency": "USD"
405         },
406         "total_amount": {
407           "quantity": "1500.00",
408           "currency": "USD"
409         },
410         "used_exchange_rate": {
411           "currency": "USD",
412           "base_currency": "USD",
413           "rate_timestamp": "2024-01-01T00:00:00Z",
414           "rate": "1.0",
415           "source": "Internal"
416         }
417       },
418       "notes": [
419         "Standard VAT rate applied"
420       ],
421       "rates": [
422         {
423           "name": "Standard VAT",
424           "percentage": "5.00",
425           "tax_amount": {
426             "quantity": "71.43",
427             "currency": "USD"
428           }
429         }
430       ]
431     }
432   ],
433   "tax_summary": {
434     "country_code": "US",
435     "base_amount": {
436       "quantity": "1428.57",
437       "currency": "USD"
438     },
439     "tax_amount": {
440       "quantity": "71.43",
441       "currency": "USD"
442     },
443     "total_amount": {
444       "quantity": "1500.00",
445       "currency": "USD"
446     },
447     "local_amounts": {
448       "display": true,
449       "base_amount": {
450         "quantity": "1428.57",
451         "currency": "USD"
452       },
453       "tax_amount": {
454         "quantity": "71.43",
455         "currency": "USD"
456       },
457       "total_amount": {
458         "quantity": "1500.00",
459         "currency": "USD"
460       },
461       "used_exchange_rate": {
462         "currency": "USD",
463         "base_currency": "USD",
464         "rate_timestamp": "2024-01-01T00:00:00Z",
465         "rate": "1.0",
466         "source": "Internal"
467       }
468     },
469     "notes": [
470       "Tax summary for invoice"
471     ]
472   },
473   "dunning_actions": [],
474   "payment_actions": [],
475   "pay_invoice_link": {
476     "expiry_period": {
477       "type": "DAY",
478       "value": 30
479     },
480     "portal_url_id": "portal_001",
481     "url": "https://pay.acmecorp.com/invoice/inv_1234567890abcdef"
482   },
483   "notes": [
484     "Invoice generated automatically"
485   ],
486   "linked_invoices": [],
487   "custom_fields": [],
488   "other_custom_fields": [],
489   "e_invoices": [],
490   "used_exchange_rates": [],
491   "processing_only_customers": [],
492   "meter_values": [],
493   "credit_types": [],
494   "display_invoice_sub_lines_per_processing_only_customer": false,
495   "forwarded_from_customers": [],
496   "validation_result": [
497     {
498       "status": "VALID",
499       "details": "Invoice data validated successfully"
500     }
501   ],
502   "footnote": "Thank you for your business.",
503   "approval_status": "PENDING_REVIEW",
504   "has_usage_based_pricing": false,
505   "coupons": [],
506   "promotion_codes": [],
507   "linked_integrations": [],
508   "billing_type": "DEFAULT",
509   "auto_rescues": [],
510   "to_be_reprocessed": false
511 }

Requires the INVOICE.REFRESH 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.

Request

This endpoint expects an object.

typeslist of enumsRequired

typeenum or nullOptional

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

500

Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors