--- title: /payments/pricing/query/customer-quote slug: amberflo-api/paymentspricingquerycustomer-quote docTags: createdAt: 2024-11-07T15:10:16.976Z --- { "id": "LxJX00ifeueMWNaBDaoFC", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://app.amberflo.io/payments/pricing/query/customer-quote", "servers": [ { "url": "https://app.amberflo.io/payments/pricing/query/customer-quote" } ], "name": "", "description": "", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "description": "", "customType": "payment.pricing.customer.indexable.api.IndexableCustomerQuoteQuery.in", "schema": [ { "name": "filters", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "page", "kind": "optional", "type": "object", "description": "Query page.", "modelRef": "#/components/schemas/payment.common.Page.in", "customType": "payment.common.Page.in", "schema": [ { "name": "number", "kind": "optional", "type": "integer", "example": 0 }, { "name": "size", "kind": "optional", "type": "integer", "example": 0 }, { "name": "token", "kind": "optional", "type": "string", "example": "" } ] }, { "name": "take", "kind": "optional", "type": "object", "description": "Query limit expression.", "modelRef": "#/components/schemas/payment.common.Take.in", "customType": "payment.common.Take.in", "schema": [ { "name": "limit", "kind": "optional", "type": "integer", "example": 0 }, { "name": "isAscending", "kind": "optional", "type": "boolean", "example": "" } ] }, { "name": "search", "kind": "optional", "type": "string", "description": "Filter quotes by searching for the provided string in `customerName` or 'opportunity'.", "example": "" }, { "name": "sortField", "kind": "optional", "type": "string", "description": "Sort quotes by a sort field.", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.customer.indexable.api.IndexableCustomerQuoteQuery.in", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "apiKey", "name": "X-API-KEY", "kind": "optional", "type": "apiKey", "in": "header" } ] }, "responses": [ { "statusCode": "200", "description": "Successful request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "payment.pricing.customer.indexable.api.IndexableCustomerPricingQuoteResponse.out", "schema": [ { "name": "metadata", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.customer.indexable.api.IndexableCustomerQuoteQuery.out", "customType": "payment.pricing.customer.indexable.api.IndexableCustomerQuoteQuery.out", "schema": [ { "name": "filters", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "page", "kind": "optional", "type": "object", "description": "Query page.", "modelRef": "#/components/schemas/payment.common.Page.out", "customType": "payment.common.Page.out", "schema": [ { "name": "number", "kind": "optional", "type": "integer", "example": 0 }, { "name": "size", "kind": "optional", "type": "integer", "example": 0 }, { "name": "token", "kind": "optional", "type": "string", "example": "" } ] }, { "name": "take", "kind": "optional", "type": "object", "description": "Query limit expression.", "modelRef": "#/components/schemas/payment.common.Take.out", "customType": "payment.common.Take.out", "schema": [ { "name": "limit", "kind": "optional", "type": "integer", "example": 0 }, { "name": "isAscending", "kind": "optional", "type": "boolean", "example": "" } ] }, { "name": "search", "kind": "optional", "type": "string", "description": "Filter quotes by searching for the provided string in `customerName` or 'opportunity'.", "example": "" }, { "name": "sortField", "kind": "optional", "type": "string", "description": "Sort quotes by a sort field.", "example": "" } ] }, { "name": "pageInfo", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.common.PageInfo.out", "customType": "payment.common.PageInfo.out", "schema": [ { "name": "pageNumber", "kind": "optional", "type": "integer", "example": 0 }, { "name": "pageSize", "kind": "optional", "type": "integer", "example": 0 }, { "name": "pageToken", "kind": "optional", "type": "string", "example": "" }, { "name": "totalPages", "kind": "optional", "type": "integer", "example": 0 }, { "name": "totalResults", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "rows", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.pricing.customer.indexable.api.CustomerQuoteRow.out", "customType": "payment.pricing.customer.indexable.api.CustomerQuoteRow.out[]", "schema": [ { "name": "customerId", "kind": "optional", "type": "string", "example": "" }, { "name": "customerName", "kind": "optional", "type": "string", "example": "" }, { "name": "quoteId", "kind": "optional", "type": "string", "example": "" }, { "name": "opportunity", "kind": "optional", "type": "string", "example": "" }, { "name": "version", "kind": "optional", "type": "string", "example": "" }, { "name": "status", "kind": "optional", "type": "string", "example": "" }, { "name": "owners", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.pricing.customer.quote.CustomerQuoteOwner.out", "customType": "payment.pricing.customer.quote.CustomerQuoteOwner.out[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Owner id.", "example": "" }, { "name": "name", "kind": "required", "type": "string", "description": "Owner name.", "example": "" } ] }, { "name": "reviewers", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.pricing.customer.quote.CustomerQuoteReview.out", "customType": "payment.pricing.customer.quote.CustomerQuoteReview.out[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Reviewer id for the quote.", "example": "" }, { "name": "name", "kind": "required", "type": "string", "description": "Reviewer's display name for the quote.", "example": "" }, { "name": "approved", "kind": "optional", "type": "boolean", "example": "" } ] }, { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "quoteAmount", "kind": "optional", "type": "number", "example": "" }, { "name": "isLastVersion", "kind": "optional", "type": "boolean", "example": "" }, { "name": "rowCount", "kind": "optional", "type": "integer", "example": 0 } ] } ], "modelRef": "#/components/schemas/payment.pricing.customer.indexable.api.IndexableCustomerPricingQuoteResponse.out", "isExpanded": true } ] } ], "examples": { "languages": [ { "id": "eXl3_IzPgGnqJNTbAlMcd", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://app.amberflo.io/payments/pricing/query/customer-quote \\\n --header 'accept: application/json'" }, { "id": "nUUE6crl2Q0cY8EDe-pAn", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://app.amberflo.io/payments/pricing/query/customer-quote\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "YD1K9WVZnHnkleULH03YH", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://app.amberflo.io/payments/pricing/query/customer-quote\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "DKyd2hwRwbwMYOcyE7t2n", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://app.amberflo.io/payments/pricing/query/customer-quote\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "eXl3_IzPgGnqJNTbAlMcd" }, "results": { "languages": [ { "id": "5JNRbOevjUiVtW9F9WQ6I", "language": "200", "code": "// Successful request\n{\n \"metadata\": {\n \"filters\": \"\",\n \"page\": {\n \"number\": \"\",\n \"size\": \"\",\n \"token\": \"\"\n },\n \"take\": {\n \"limit\": \"\",\n \"isAscending\": false\n },\n \"search\": \"\",\n \"sortField\": \"\"\n },\n \"pageInfo\": {\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"pageToken\": \"\",\n \"totalPages\": \"\",\n \"totalResults\": \"\"\n },\n \"rows\": [\n {\n \"customerId\": \"\",\n \"customerName\": \"\",\n \"quoteId\": \"\",\n \"opportunity\": \"\",\n \"version\": \"\",\n \"status\": \"\",\n \"owners\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"reviewers\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"approved\": false\n }\n ],\n \"startTimeInSeconds\": \"\",\n \"endTimeInSeconds\": \"\",\n \"quoteAmount\": 0,\n \"isLastVersion\": false,\n \"rowCount\": \"\"\n }\n ]\n}" } ], "selectedLanguageId": "5JNRbOevjUiVtW9F9WQ6I" } }, "children": [ { "text": "" } ] }