Create and send a quote

The full send quote operation, not a draft — the quote is rendered and emailed to the customer. userId must be a real user id: the API authenticates an App, so the caller supplies the acting user.

POST/ticket/{ticketId}/quote

Authorization

AuthorizationAPI key · headerrequired

The Incoming Secret value (<secretId>.<random>), with or without a Bearer prefix.

Path parameters

ticketIdstringrequired

Request body

application/json

customerIdintegerrequired

Id of the customer receiving the quote.

userIdintegerrequired

Id of the user the quote is sent on behalf of.

pdfTemplateNamestringrequired

Name of the PDF template used to render the quote document.

languageCodestringrequired

Language of the quote document, e.g. "en".

currencyCodestringrequired

Currency of the quote prices, e.g. "USD".

dueDateNamestringrequired

Name of the payment due date option configured in the app.

deliveryMethodNamestringrequired

Name of the delivery method; must exist for the shipping destination.

shippingAddressIdinteger

Id of an existing shipping address. Alternative to shippingAddress.

shippingAddressobject

A new shipping address to create and use for delivery pricing.

emailTostring[]

Extra recipient emails; the customer email is always included.

ccstring[]

CC recipient emails.

bccstring[]

BCC recipient emails.

messagestring

Free-text message included in the quote email.

contactDetailsstring

Contact details shown on the quote.

discountnumber

Discount amount applied to the quote.

discountTypestring

How the discount is interpreted, e.g. percentage or absolute.

vatRateIdinteger

Id of the VAT rate applied to the quote.

deliveryVatRateIdinteger

Id of the VAT rate applied to delivery.

isAutoUsVatDeliveryboolean

Automatically resolve US VAT for delivery.

isAutoUsVatServiceboolean

Automatically resolve US VAT for manual services.

manualRequestsobject[]

Manually priced line items added to the quote.

Show properties

Array of object

quantityintegerrequired

Quantity of the manual line item.

pricePerUnitnumberrequired

Price per unit of the manual line item.

descriptionstring

Line item description shown on the quote.

Responses

200

Created. Returns only the id — fetch the full Ticket quote with the corresponding GET.

idinteger | stringrequired

Id of the created Ticket quote.

Show properties

One of:

integer

integer

string

string

401

Authentication failed. All causes return this identical response.

codeinteger

messagestring

typestring

default

Downstream errors pass through verbatim; x-error-source names the failing service.

codeinteger

messagestring

typestring

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

ticketIdpath*

Bodyapplication/json

Request body

Request

curl -X POST 'https://next.amfg.ai/engine-service/public-api/v1/ticket/string/quote' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "customerId": 0,
  "userId": 0,
  "pdfTemplateName": "string",
  "languageCode": "string",
  "currencyCode": "string",
  "dueDateName": "string",
  "deliveryMethodName": "string",
  "shippingAddressId": 0,
  "shippingAddress": {},
  "emailTo": [
    "string"
  ],
  "cc": [
    "string"
  ],
  "bcc": [
    "string"
  ],
  "message": "string",
  "contactDetails": "string",
  "discount": 0,
  "discountType": "string",
  "vatRateId": 0,
  "deliveryVatRateId": 0,
  "isAutoUsVatDelivery": true,
  "isAutoUsVatService": true,
  "manualRequests": [
    {
      "quantity": 0,
      "pricePerUnit": 0,
      "description": "string"
    }
  ]
}'

const response = await fetch("https://next.amfg.ai/engine-service/public-api/v1/ticket/string/quote", {
  method: "POST",
  headers: {
    "Authorization": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: "{\n  \"customerId\": 0,\n  \"userId\": 0,\n  \"pdfTemplateName\": \"string\",\n  \"languageCode\": \"string\",\n  \"currencyCode\": \"string\",\n  \"dueDateName\": \"string\",\n  \"deliveryMethodName\": \"string\",\n  \"shippingAddressId\": 0,\n  \"shippingAddress\": {},\n  \"emailTo\": [\n    \"string\"\n  ],\n  \"cc\": [\n    \"string\"\n  ],\n  \"bcc\": [\n    \"string\"\n  ],\n  \"message\": \"string\",\n  \"contactDetails\": \"string\",\n  \"discount\": 0,\n  \"discountType\": \"string\",\n  \"vatRateId\": 0,\n  \"deliveryVatRateId\": 0,\n  \"isAutoUsVatDelivery\": true,\n  \"isAutoUsVatService\": true,\n  \"manualRequests\": [\n    {\n      \"quantity\": 0,\n      \"pricePerUnit\": 0,\n      \"description\": \"string\"\n    }\n  ]\n}"
});

import requests

response = requests.post(
    "https://next.amfg.ai/engine-service/public-api/v1/ticket/string/quote",
    headers={
        "Authorization": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    data="{\n  \"customerId\": 0,\n  \"userId\": 0,\n  \"pdfTemplateName\": \"string\",\n  \"languageCode\": \"string\",\n  \"currencyCode\": \"string\",\n  \"dueDateName\": \"string\",\n  \"deliveryMethodName\": \"string\",\n  \"shippingAddressId\": 0,\n  \"shippingAddress\": {},\n  \"emailTo\": [\n    \"string\"\n  ],\n  \"cc\": [\n    \"string\"\n  ],\n  \"bcc\": [\n    \"string\"\n  ],\n  \"message\": \"string\",\n  \"contactDetails\": \"string\",\n  \"discount\": 0,\n  \"discountType\": \"string\",\n  \"vatRateId\": 0,\n  \"deliveryVatRateId\": 0,\n  \"isAutoUsVatDelivery\": true,\n  \"isAutoUsVatService\": true,\n  \"manualRequests\": [\n    {\n      \"quantity\": 0,\n      \"pricePerUnit\": 0,\n      \"description\": \"string\"\n    }\n  ]\n}",
)

Response

{
  "id": 0
}

{
  "code": 401,
  "message": "Not Authorized"
}

{
  "code": 0,
  "message": "string",
  "type": "string"
}