Get a quote version by resource ID

GET

/v:version/quote-versions/:resourceId

GET

/v:version/quote-versions/:resourceId

$ curl https://test.api.solvimon.com/v1/quote-versions/ \
>      -H "X-API-KEY: <apiKey>"

1 {
2   "object_type": "string",
3   "id": "string",
4   "created_at": "string",
5   "updated_at": "string",
6   "expires_at": "2024-01-15T09:30:00Z",
7   "quote_id": "string",
8   "version": 1,
9   "pricing_plan_subscription_info": {
10     "id": "string",
11     "upgraded_from_pricing_plan_subscription_id": "string"
12   },
13   "content": {
14     "type": "DEFAULT",
15     "default": {
16       "header": "string",
17       "footer": "string"
18     },
19     "tiptap": "string"
20   },
21   "status": "DRAFT",
22   "actions": [
23     {
24       "created_at": "string",
25       "type": "string",
26       "status": "string",
27       "send": {
28         "to_email_addresses": [
29           "string"
30         ],
31         "overwrite_to": true,
32         "cc_email_addresses": [
33           "string"
34         ],
35         "bcc_email_addresses": [
36           "string"
37         ]
38       },
39       "accept": {
40         "name": {
41           "first_name": "string",
42           "last_name": "string",
43           "infix": "string"
44         },
45         "role": "string"
46       },
47       "reject": {
48         "name": {
49           "first_name": "string",
50           "last_name": "string",
51           "infix": "string"
52         },
53         "role": "string",
54         "reason": "string"
55       },
56       "create_subscription": {
57         "pricing_plan_subscription_id": "string"
58       },
59       "request_signature": {
60         "signature_request_id": "string",
61         "signature_request": {
62           "object_type": "string",
63           "id": "string",
64           "created_at": "string",
65           "updated_at": "string",
66           "status": "IN_PROGRESS",
67           "type": "QUOTE_VERSION",
68           "quote_version": {
69             "quote_version_id": "string"
70           },
71           "recipients": [
72             {
73               "id": "string",
74               "contact_id": "string",
75               "name": {
76                 "first_name": "string",
77                 "last_name": "string",
78                 "infix": "string"
79               },
80               "email": "string",
81               "role": "SIGNER",
82               "status": "PENDING"
83             }
84           ]
85         }
86       },
87       "sign": {
88         "signature_request_id": "string"
89       }
90     }
91   ],
92   "link": {
93     "expiry_period": {
94       "type": "DAY",
95       "value": 1
96     },
97     "portal_url_id": "string",
98     "url": "string"
99   },
100   "internal_notes": [
101     "string"
102   ],
103   "notes": [
104     "string"
105   ],
106   "approval_request_id": "string",
107   "recipients": [
108     {
109       "type": "CONTACT",
110       "contact": {
111         "contact_id": "string",
112         "contact": {
113           "object_type": "string",
114           "id": "string",
115           "reference": "string",
116           "customer_id": "string",
117           "name": {
118             "first_name": "string",
119             "last_name": "string",
120             "infix": "string"
121           },
122           "email": "string",
123           "notification_preferences": [
124             {
125               "type": "INVOICE",
126               "channels": [
127                 {
128                   "type": "EMAIL",
129                   "enabled": true
130                 }
131               ]
132             }
133           ],
134           "custom_fields": [
135             {
136               "id": "string",
137               "reference": "string",
138               "value": "string",
139               "values": [
140                 "string"
141               ],
142               "integration_details": {
143                 "id": "string",
144                 "reference": "string",
145                 "payment_gateway_variant": "ADYEN",
146                 "adyen": {
147                   "recurring_detail_reference": "string"
148                 },
149                 "stripe": {
150                   "payment_method_id": "string"
151                 }
152               },
153               "integration_id": "string"
154             }
155           ],
156           "linked_integrations": [
157             {
158               "id": "string",
159               "link_details": [
160                 {
161                   "url": "string",
162                   "custom_field_name": "string"
163                 }
164               ]
165             }
166           ]
167         }
168       },
169       "details": {
170         "name": {
171           "first_name": "string",
172           "last_name": "string",
173           "infix": "string"
174         },
175         "email": "string"
176       },
177       "role": "SIGNER"
178     }
179   ],
180   "invoices_info": {
181     "first_invoice_summary": {
182       "base_amount": {
183         "quantity": "string",
184         "currency": "AED"
185       },
186       "tax_amount": {
187         "quantity": "string",
188         "currency": "AED"
189       },
190       "total_amount": {
191         "quantity": "string",
192         "currency": "AED"
193       },
194       "local_amounts": {
195         "base_amount": {
196           "quantity": "string",
197           "currency": "AED"
198         },
199         "tax_amount": {
200           "quantity": "string",
201           "currency": "AED"
202         },
203         "total_amount": {
204           "quantity": "string",
205           "currency": "AED"
206         },
207         "used_exchange_rate": {
208           "currency": "string",
209           "base_currency": "string",
210           "rate_timestamp": "string",
211           "rate": "string",
212           "source": "string"
213         },
214         "display": true
215       },
216       "notes": [
217         "string"
218       ],
219       "country_code": "string"
220     }
221   }
222 }

Requires the QUOTE.VIEW 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 to be requested.

Query parameters

expand[]list of stringsOptional

The id fields of the resources that are going to be expanded.

Response

object_typestring or nullRead-only

idstring or nullRead-only

created_atstring or nullRead-only

updated_atstring or nullRead-only

expires_atdatetime or null

The expiration date of the quote version.

quote_idstring

The ID of the quote.

versioninteger

The value describing the version of the quote.

pricing_plan_subscription_infoobject or null

The info of the linked pricing plan subscription.

contentobject

Content of the body of the quote.

statusenum or null

actionslist of objects or nullRead-only

The history of all actions done.

linkobject or null

The public portal link of the quote.

internal_noteslist of strings or null

Internal notes on this quote versions.

noteslist of strings or null

Notes on this quote versions.

approval_request_idstring or nullRead-only

The ID of the Approval Request that was created for this Quote Version.

recipientslist of objects or null

The recipients for signature on this quote version.

invoices_infoobject or null

Information pertaining to the invoices generated by this quote version.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors