Update a quote

PATCH

/v:version/quotes/:resourceId

PATCH

/v:version/quotes/:resourceId

$ curl -X PATCH https://test.api.solvimon.com/v1/quotes/ \
>      -H "X-API-KEY: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "contact_id": "cont_EwDegI0tt0diFEBEed12",
>   "owner_user_id": "user_EwDegI0tt0diFEBEed12"
> }'

1 {
2   "object_type": "string",
3   "id": "string",
4   "created_at": "string",
5   "updated_at": "string",
6   "status": "string",
7   "customer_id": "string",
8   "customer": {
9     "object_type": "string",
10     "id": "string",
11     "created_at": "string",
12     "parent_customer_id": "string",
13     "parent_customer_ids": [
14       "string"
15     ],
16     "reference": "string",
17     "status": "DRAFT",
18     "timezone": "string",
19     "type": "ORGANIZATION",
20     "email": "string",
21     "notification_preferences": [
22       {
23         "type": "INVOICE",
24         "channels": [
25           {
26             "type": "EMAIL",
27             "enabled": true
28           }
29         ]
30       }
31     ],
32     "locale": "string",
33     "individual": {
34       "name": {
35         "first_name": "string",
36         "last_name": "string",
37         "infix": "string"
38       },
39       "residential_address": {
40         "line1": "string",
41         "line2": "string",
42         "city": "string",
43         "postal_code": "string",
44         "state": "string",
45         "country": "AD"
46       }
47     },
48     "organization": {
49       "legal_name": "string",
50       "tax_id": "string",
51       "tax_ids": [
52         {
53           "id": "string",
54           "type": "GENERIC_TAX_ID",
55           "display_name": "string",
56           "tax_id_validation_result": {
57             "id": "string",
58             "validation_date": "string",
59             "source": "string",
60             "valid": "VALID",
61             "message": "string"
62           }
63         }
64       ],
65       "registration_number": "string",
66       "tax_exempt": true,
67       "tax_exempt_note": "string",
68       "registered_address": {
69         "line1": "string",
70         "line2": "string",
71         "city": "string",
72         "postal_code": "string",
73         "state": "string",
74         "country": "AD"
75       },
76       "tax_registrations": [
77         {
78           "id": "string",
79           "description": "string",
80           "tax_id": "string",
81           "tax_ids": [
82             {
83               "id": "string",
84               "type": "GENERIC_TAX_ID",
85               "display_name": "string",
86               "tax_id_validation_result": {
87                 "id": "string",
88                 "validation_date": "string",
89                 "source": "string",
90                 "valid": "VALID",
91                 "message": "string"
92               }
93             }
94           ],
95           "registration_number": "string",
96           "registered_address": {
97             "line1": "string",
98             "line2": "string",
99             "city": "string",
100             "postal_code": "string",
101             "state": "string",
102             "country": "AD"
103           }
104         }
105       ]
106     },
107     "custom_fields": [
108       {
109         "id": "string",
110         "reference": "string",
111         "value": "string",
112         "values": [
113           "string"
114         ],
115         "integration_details": {
116           "id": "string",
117           "reference": "string",
118           "payment_gateway_variant": "ADYEN",
119           "adyen": {
120             "recurring_detail_reference": "string"
121           },
122           "stripe": {
123             "payment_method_id": "string"
124           }
125         },
126         "integration_id": "string"
127       }
128     ],
129     "pricing_plan_subscription_selector": {
130       "data": [
131         {
132           "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
133           "value": "string"
134         }
135       ],
136       "rules": [
137         {
138           "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
139           "type": "EQUALS"
140         }
141       ],
142       "filters": [
143         {
144           "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
145           "type": "EQUALS",
146           "value": "string"
147         }
148       ],
149       "fallback": "LATEST"
150     },
151     "linked_integrations": [
152       {
153         "id": "string",
154         "link_details": [
155           {
156             "url": "string",
157             "custom_field_name": "string"
158           }
159         ]
160       }
161     ],
162     "roles": [
163       "DEFAULT"
164     ],
165     "seller_details": {
166       "default_billing_entity_id": "string"
167     },
168     "processing_only": true
169   },
170   "description": "string",
171   "contact_id": "string",
172   "owner_user_id": "string",
173   "owner_user": {
174     "object_type": "string",
175     "id": "string",
176     "entity_id": "string",
177     "created_at": "string",
178     "status": "INVITED",
179     "username": "string",
180     "password": "string",
181     "invite_expired": true,
182     "active": true,
183     "account_memberships": [
184       {
185         "object_type": "string",
186         "id": "string",
187         "account_id": "string",
188         "account": {
189           "id": "string",
190           "reference": "string",
191           "account_type_code": "string",
192           "environment": "string",
193           "account_group_id": "string",
194           "parent_id": "string",
195           "platform_id": "string"
196         },
197         "type": "ADMIN",
198         "role_ids": [
199           "string"
200         ],
201         "account_reference": "string",
202         "environment": "string",
203         "roles": [
204           {
205             "object_type": "string",
206             "id": "string",
207             "name": "string",
208             "description": "string",
209             "entity_id": "string",
210             "child_role_ids": [
211               "string"
212             ],
213             "child_roles": [
214               {}
215             ]
216           }
217         ]
218       }
219     ],
220     "team_memberships": [
221       {
222         "team_id": "string",
223         "start_at": "2024-01-15T09:30:00Z",
224         "end_at": "2024-01-15T09:30:00Z",
225         "account_memberships": [
226           {
227             "object_type": "string",
228             "id": "string",
229             "account_id": "string",
230             "account": {
231               "id": "string",
232               "reference": "string",
233               "account_type_code": "string",
234               "environment": "string",
235               "account_group_id": "string",
236               "parent_id": "string",
237               "platform_id": "string"
238             },
239             "type": "ADMIN",
240             "role_ids": [
241               "string"
242             ],
243             "account_reference": "string",
244             "environment": "string",
245             "roles": [
246               {
247                 "object_type": "string",
248                 "id": "string",
249                 "name": "string",
250                 "description": "string",
251                 "entity_id": "string",
252                 "child_role_ids": [
253                   "string"
254                 ],
255                 "child_roles": [
256                   {}
257                 ]
258               }
259             ]
260           }
261         ]
262       }
263     ]
264   },
265   "quote_version_infos": [
266     {
267       "version": 1,
268       "id": "string",
269       "status": "string",
270       "pricing_plan_subscription_id": "string"
271     }
272   ],
273   "custom_fields": [
274     {
275       "id": "string",
276       "reference": "string",
277       "value": "string",
278       "values": [
279         "string"
280       ],
281       "integration_details": {
282         "id": "string",
283         "reference": "string",
284         "payment_gateway_variant": "ADYEN",
285         "adyen": {
286           "recurring_detail_reference": "string"
287         },
288         "stripe": {
289           "payment_method_id": "string"
290         }
291       },
292       "integration_id": "string"
293     }
294   ],
295   "template_id": "string"
296 }

Requires the QUOTE.UPDATE 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

field_actionsmap from strings to stringsOptional

The list of actions for specific fields.

Request

This endpoint expects an object.

customer_idstringOptional

The ID of the customer.

customerobject or nullOptional

descriptionstringOptional

The description of the quote.

contact_idstringOptional

The contact details for the quote.

owner_user_idstringOptional

The ID of the user that is owning/ creating the quote.

owner_userobject or nullOptional

custom_fieldslist of objects or nullOptional

template_idstring or nullOptional

The ID of the template used to create this quote.

Response

object_typestring or nullRead-only

idstring or nullRead-only

created_atstring or nullRead-only

updated_atstring or nullRead-only

statusstring or nullRead-only

customer_idstring

The ID of the customer.

customerobject or null

descriptionstring

The description of the quote.

contact_idstring

The contact details for the quote.

owner_user_idstring

The ID of the user that is owning/ creating the quote.

owner_userobject or null

quote_version_infoslist of objects or nullRead-only

custom_fieldslist of objects or null

template_idstring or null

The ID of the template used to create this quote.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error