Allows you to create one or more quotes
PUT {{baseUrl}}/Quotes?summarizeErrors=false
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
summarizeErrors | boolean | If false return 200 OK and mix of successfully created objects and any with validation errors |
Request Body
{"Quotes"=>[{"QuoteID"=>"<uuid>", "QuoteNumber"=>"<string>", "Reference"=>"<string>", "Terms"=>"<string>", "Contact"=>{"ContactID"=>"<uuid>", "ContactNumber"=>"<string>", "AccountNumber"=>"<string>", "ContactStatus"=>"<string>", "Name"=>"<string>", "FirstName"=>"<string>", "LastName"=>"<string>", "EmailAddress"=>"<string>", "SkypeUserName"=>"<string>", "ContactPersons"=>[{"FirstName"=>"<string>", "LastName"=>"<string>", "EmailAddress"=>"<string>", "IncludeInEmails"=>"<boolean>"}, {"FirstName"=>"<string>", "LastName"=>"<string>", "EmailAddress"=>"<string>", "IncludeInEmails"=>"<boolean>"}], "BankAccountDetails"=>"<string>", "TaxNumber"=>"<string>", "AccountsReceivableTaxType"=>"<string>", "AccountsPayableTaxType"=>"<string>", "Addresses"=>[{"AddressType"=>"<string>", "AddressLine1"=>"<string>", "AddressLine2"=>"<string>", "AddressLine3"=>"<string>", "AddressLine4"=>"<string>", "City"=>"<string>", "Region"=>"<string>", "PostalCode"=>"<string>", "Country"=>"<string>", "AttentionTo"=>"<string>"}, {"AddressType"=>"<string>", "AddressLine1"=>"<string>", "AddressLine2"=>"<string>", "AddressLine3"=>"<string>", "AddressLine4"=>"<string>", "City"=>"<string>", "Region"=>"<string>", "PostalCode"=>"<string>", "Country"=>"<string>", "AttentionTo"=>"<string>"}], "Phones"=>[{"PhoneType"=>"<string>", "PhoneNumber"=>"<string>", "PhoneAreaCode"=>"<string>", "PhoneCountryCode"=>"<string>"}, {"PhoneType"=>"<string>", "PhoneNumber"=>"<string>", "PhoneAreaCode"=>"<string>", "PhoneCountryCode"=>"<string>"}], "IsSupplier"=>"<boolean>", "IsCustomer"=>"<boolean>", "DefaultCurrency"=>"<string>", "XeroNetworkKey"=>"<string>", "SalesDefaultAccountCode"=>"<string>", "PurchasesDefaultAccountCode"=>"<string>", "SalesTrackingCategories"=>[{"TrackingCategoryName"=>"<string>", "TrackingOptionName"=>"<string>"}, {"TrackingCategoryName"=>"<string>", "TrackingOptionName"=>"<string>"}], "PurchasesTrackingCategories"=>[{"TrackingCategoryName"=>"<string>", "TrackingOptionName"=>"<string>"}, {"TrackingCategoryName"=>"<string>", "TrackingOptionName"=>"<string>"}], "TrackingCategoryName"=>"<string>", "TrackingCategoryOption"=>"<string>", "PaymentTerms"=>{"Bills"=>{"Day"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Type"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "Sales"=>{"Day"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Type"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}}, "ContactGroups"=>[{"Name"=>"<string>", "Status"=>"<string>", "ContactGroupID"=>"<uuid>", "Contacts"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}]}, {"Name"=>"<string>", "Status"=>"<string>", "ContactGroupID"=>"<uuid>", "Contacts"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}]}], "BrandingTheme"=>{"BrandingThemeID"=>"<uuid>", "Name"=>"<string>", "LogoUrl"=>"<string>", "Type"=>"<string>", "SortOrder"=>"<integer>"}, "BatchPayments"=>{"BankAccountNumber"=>"<string>", "BankAccountName"=>"<string>", "Details"=>"<string>", "Code"=>"<string>", "Reference"=>"<string>"}, "Balances"=>{"AccountsReceivable"=>{"Outstanding"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Overdue"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "AccountsPayable"=>{"Outstanding"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Overdue"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}}, "Attachments"=>[{"AttachmentID"=>"<uuid>", "FileName"=>"<string>", "Url"=>"<string>", "MimeType"=>"<string>", "ContentLength"=>"<integer>", "IncludeOnline"=>"<boolean>"}, {"AttachmentID"=>"<uuid>", "FileName"=>"<string>", "Url"=>"<string>", "MimeType"=>"<string>", "ContentLength"=>"<integer>", "IncludeOnline"=>"<boolean>"}], "HasAttachments"=>"false", "ValidationErrors"=>[{"Message"=>"<string>"}, {"Message"=>"<string>"}], "HasValidationErrors"=>"false", "StatusAttributeString"=>"<string>"}, "LineItems"=>[{"LineItemID"=>"<uuid>", "Description"=>"<string>", "Quantity"=>"<double>", "UnitAmount"=>"<double>", "ItemCode"=>"<string>", "AccountCode"=>"<string>", "TaxType"=>"<string>", "TaxAmount"=>"<double>", "LineAmount"=>"<double>", "Tracking"=>[{"TrackingCategoryID"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "TrackingOptionID"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Name"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Option"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, {"TrackingCategoryID"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "TrackingOptionID"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Name"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Option"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}], "DiscountRate"=>"<double>", "DiscountAmount"=>"<double>", "RepeatingInvoiceID"=>"<uuid>"}, {"LineItemID"=>"<uuid>", "Description"=>"<string>", "Quantity"=>"<double>", "UnitAmount"=>"<double>", "ItemCode"=>"<string>", "AccountCode"=>"<string>", "TaxType"=>"<string>", "TaxAmount"=>"<double>", "LineAmount"=>"<double>", "Tracking"=>[{"TrackingCategoryID"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "TrackingOptionID"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Name"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Option"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, {"TrackingCategoryID"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "TrackingOptionID"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Name"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Option"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}], "DiscountRate"=>"<double>", "DiscountAmount"=>"<double>", "RepeatingInvoiceID"=>"<uuid>"}], "Date"=>"<string>", "DateString"=>"<string>", "ExpiryDate"=>"<string>", "ExpiryDateString"=>"<string>", "Status"=>"<string>", "CurrencyCode"=>"<string>", "CurrencyRate"=>"<double>", "Title"=>"<string>", "Summary"=>"<string>", "BrandingThemeID"=>"<uuid>", "LineAmountTypes"=>"<string>", "StatusAttributeString"=>"<string>", "ValidationErrors"=>[{"Message"=>"<string>"}, {"Message"=>"<string>"}]}, {"QuoteID"=>"<uuid>", "QuoteNumber"=>"<string>", "Reference"=>"<string>", "Terms"=>"<string>", "Contact"=>{"ContactID"=>"<uuid>", "ContactNumber"=>"<string>", "AccountNumber"=>"<string>", "ContactStatus"=>"<string>", "Name"=>"<string>", "FirstName"=>"<string>", "LastName"=>"<string>", "EmailAddress"=>"<string>", "SkypeUserName"=>"<string>", "ContactPersons"=>[{"FirstName"=>"<string>", "LastName"=>"<string>", "EmailAddress"=>"<string>", "IncludeInEmails"=>"<boolean>"}, {"FirstName"=>"<string>", "LastName"=>"<string>", "EmailAddress"=>"<string>", "IncludeInEmails"=>"<boolean>"}], "BankAccountDetails"=>"<string>", "TaxNumber"=>"<string>", "AccountsReceivableTaxType"=>"<string>", "AccountsPayableTaxType"=>"<string>", "Addresses"=>[{"AddressType"=>"<string>", "AddressLine1"=>"<string>", "AddressLine2"=>"<string>", "AddressLine3"=>"<string>", "AddressLine4"=>"<string>", "City"=>"<string>", "Region"=>"<string>", "PostalCode"=>"<string>", "Country"=>"<string>", "AttentionTo"=>"<string>"}, {"AddressType"=>"<string>", "AddressLine1"=>"<string>", "AddressLine2"=>"<string>", "AddressLine3"=>"<string>", "AddressLine4"=>"<string>", "City"=>"<string>", "Region"=>"<string>", "PostalCode"=>"<string>", "Country"=>"<string>", "AttentionTo"=>"<string>"}], "Phones"=>[{"PhoneType"=>"<string>", "PhoneNumber"=>"<string>", "PhoneAreaCode"=>"<string>", "PhoneCountryCode"=>"<string>"}, {"PhoneType"=>"<string>", "PhoneNumber"=>"<string>", "PhoneAreaCode"=>"<string>", "PhoneCountryCode"=>"<string>"}], "IsSupplier"=>"<boolean>", "IsCustomer"=>"<boolean>", "DefaultCurrency"=>"<string>", "XeroNetworkKey"=>"<string>", "SalesDefaultAccountCode"=>"<string>", "PurchasesDefaultAccountCode"=>"<string>", "SalesTrackingCategories"=>[{"TrackingCategoryName"=>"<string>", "TrackingOptionName"=>"<string>"}, {"TrackingCategoryName"=>"<string>", "TrackingOptionName"=>"<string>"}], "PurchasesTrackingCategories"=>[{"TrackingCategoryName"=>"<string>", "TrackingOptionName"=>"<string>"}, {"TrackingCategoryName"=>"<string>", "TrackingOptionName"=>"<string>"}], "TrackingCategoryName"=>"<string>", "TrackingCategoryOption"=>"<string>", "PaymentTerms"=>{"Bills"=>{"Day"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Type"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "Sales"=>{"Day"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Type"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}}, "ContactGroups"=>[{"Name"=>"<string>", "Status"=>"<string>", "ContactGroupID"=>"<uuid>", "Contacts"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}]}, {"Name"=>"<string>", "Status"=>"<string>", "ContactGroupID"=>"<uuid>", "Contacts"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}]}], "BrandingTheme"=>{"BrandingThemeID"=>"<uuid>", "Name"=>"<string>", "LogoUrl"=>"<string>", "Type"=>"<string>", "SortOrder"=>"<integer>"}, "BatchPayments"=>{"BankAccountNumber"=>"<string>", "BankAccountName"=>"<string>", "Details"=>"<string>", "Code"=>"<string>", "Reference"=>"<string>"}, "Balances"=>{"AccountsReceivable"=>{"Outstanding"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Overdue"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "AccountsPayable"=>{"Outstanding"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Overdue"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}}, "Attachments"=>[{"AttachmentID"=>"<uuid>", "FileName"=>"<string>", "Url"=>"<string>", "MimeType"=>"<string>", "ContentLength"=>"<integer>", "IncludeOnline"=>"<boolean>"}, {"AttachmentID"=>"<uuid>", "FileName"=>"<string>", "Url"=>"<string>", "MimeType"=>"<string>", "ContentLength"=>"<integer>", "IncludeOnline"=>"<boolean>"}], "HasAttachments"=>"false", "ValidationErrors"=>[{"Message"=>"<string>"}, {"Message"=>"<string>"}], "HasValidationErrors"=>"false", "StatusAttributeString"=>"<string>"}, "LineItems"=>[{"LineItemID"=>"<uuid>", "Description"=>"<string>", "Quantity"=>"<double>", "UnitAmount"=>"<double>", "ItemCode"=>"<string>", "AccountCode"=>"<string>", "TaxType"=>"<string>", "TaxAmount"=>"<double>", "LineAmount"=>"<double>", "Tracking"=>[{"TrackingCategoryID"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "TrackingOptionID"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Name"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Option"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, {"TrackingCategoryID"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "TrackingOptionID"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Name"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Option"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}], "DiscountRate"=>"<double>", "DiscountAmount"=>"<double>", "RepeatingInvoiceID"=>"<uuid>"}, {"LineItemID"=>"<uuid>", "Description"=>"<string>", "Quantity"=>"<double>", "UnitAmount"=>"<double>", "ItemCode"=>"<string>", "AccountCode"=>"<string>", "TaxType"=>"<string>", "TaxAmount"=>"<double>", "LineAmount"=>"<double>", "Tracking"=>[{"TrackingCategoryID"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "TrackingOptionID"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Name"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Option"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, {"TrackingCategoryID"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "TrackingOptionID"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Name"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "Option"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}], "DiscountRate"=>"<double>", "DiscountAmount"=>"<double>", "RepeatingInvoiceID"=>"<uuid>"}], "Date"=>"<string>", "DateString"=>"<string>", "ExpiryDate"=>"<string>", "ExpiryDateString"=>"<string>", "Status"=>"<string>", "CurrencyCode"=>"<string>", "CurrencyRate"=>"<double>", "Title"=>"<string>", "Summary"=>"<string>", "BrandingThemeID"=>"<uuid>", "LineAmountTypes"=>"<string>", "StatusAttributeString"=>"<string>", "ValidationErrors"=>[{"Message"=>"<string>"}, {"Message"=>"<string>"}]}]}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
xero-tenant-id | string | (Required) Xero identifier for Tenant | |
Content-Type | string |
RESPONSES
status: OK
{"SummarizeErrors":false,"Id":"29571f5a-bf73-4bb6-9de5-86be44e6bf2e","Status":"OK","ProviderName":"provider-name","DateTimeUTC":"/Date(1580607782916)/","Quotes":[{"QuoteID":"60031d53-6488-4321-9cbd-c1db6dbf9ba4","QuoteNumber":"QU-0008","Terms":"","Contact":{"ContactID":"6a65f055-b0e0-471a-a933-d1ffdd89393f","Name":"John Smith-82160","EmailAddress":""},"LineItems":[{"LineItemID":"26995857-0eea-45fb-b46c-f8ea896ec46e","AccountCode":"12775","Description":"Foobar","UnitAmount":20.0,"LineAmount":20.0,"ItemCode":"","Quantity":1.0,"TaxAmount":0.0,"Tracking":[]}],"Date":"/Date(1580515200000)/","DateString":"2020-02-01T00:00:00","Status":"DRAFT","CurrencyRate":1.0,"CurrencyCode":"USD","SubTotal":20.0,"TotalTax":0.0,"Total":20.0,"UpdatedDateUTC":"/Date(1580607782913)/","LineAmountTypes":"EXCLUSIVE","StatusAttributeString":"OK"}]}