Allows you to create one or more purchase orders

PUT {{baseUrl}}/PurchaseOrders?summarizeErrors=false

Request Params

KeyDatatypeRequiredDescription
summarizeErrorsbooleanIf false return 200 OK and mix of successfully created objects and any with validation errors

Request Body

{"PurchaseOrders"=>[{"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>", "DeliveryDate"=>"<string>", "LineAmountTypes"=>"<string>", "PurchaseOrderNumber"=>"<string>", "Reference"=>"<string>", "BrandingThemeID"=>"<uuid>", "CurrencyCode"=>"<string>", "Status"=>"<string>", "SentToContact"=>"<boolean>", "DeliveryAddress"=>"<string>", "AttentionTo"=>"<string>", "Telephone"=>"<string>", "DeliveryInstructions"=>"<string>", "ExpectedArrivalDate"=>"<string>", "PurchaseOrderID"=>"<uuid>", "CurrencyRate"=>"<double>", "StatusAttributeString"=>"<string>", "ValidationErrors"=>[{"Message"=>"<string>"}, {"Message"=>"<string>"}], "Warnings"=>[{"Message"=>"<string>"}, {"Message"=>"<string>"}], "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>"}]}, {"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>", "DeliveryDate"=>"<string>", "LineAmountTypes"=>"<string>", "PurchaseOrderNumber"=>"<string>", "Reference"=>"<string>", "BrandingThemeID"=>"<uuid>", "CurrencyCode"=>"<string>", "Status"=>"<string>", "SentToContact"=>"<boolean>", "DeliveryAddress"=>"<string>", "AttentionTo"=>"<string>", "Telephone"=>"<string>", "DeliveryInstructions"=>"<string>", "ExpectedArrivalDate"=>"<string>", "PurchaseOrderID"=>"<uuid>", "CurrencyRate"=>"<double>", "StatusAttributeString"=>"<string>", "ValidationErrors"=>[{"Message"=>"<string>"}, {"Message"=>"<string>"}], "Warnings"=>[{"Message"=>"<string>"}, {"Message"=>"<string>"}], "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>"}]}]}

HEADERS

KeyDatatypeRequiredDescription
xero-tenant-idstring(Required) Xero identifier for Tenant
Content-Typestring

RESPONSES

status: OK

{&quot;Id&quot;:&quot;aa2f9d23-fd76-4bee-9600-30c0f0f34036&quot;,&quot;Status&quot;:&quot;OK&quot;,&quot;ProviderName&quot;:&quot;Provider Name Example&quot;,&quot;DateTimeUTC&quot;:&quot;/Date(1552522946173)/&quot;,&quot;PurchaseOrders&quot;:[{&quot;PurchaseOrderID&quot;:&quot;56204648-8fbe-46f8-b09c-2125f7939533&quot;,&quot;PurchaseOrderNumber&quot;:&quot;PO-0004&quot;,&quot;DateString&quot;:&quot;2019-03-13T00:00:00&quot;,&quot;Date&quot;:&quot;/Date(1552435200000+0000)/&quot;,&quot;HasErrors&quot;:false,&quot;IsDiscounted&quot;:false,&quot;TotalDiscount&quot;:0.0,&quot;SentToContact&quot;:false,&quot;Type&quot;:&quot;PURCHASEORDER&quot;,&quot;CurrencyRate&quot;:1.0,&quot;CurrencyCode&quot;:&quot;NZD&quot;,&quot;Contact&quot;:{&quot;ContactID&quot;:&quot;430fa14a-f945-44d3-9f97-5df5e28441b8&quot;,&quot;ContactStatus&quot;:&quot;ACTIVE&quot;,&quot;Name&quot;:&quot;Liam Gallagher&quot;,&quot;FirstName&quot;:&quot;Liam&quot;,&quot;LastName&quot;:&quot;Gallagher&quot;,&quot;EmailAddress&quot;:&quot;liam@rockstar.com&quot;,&quot;BankAccountDetails&quot;:&quot;&quot;,&quot;Addresses&quot;:[null,{&quot;AddressType&quot;:&quot;POBOX&quot;,&quot;City&quot;:&quot;Anytown&quot;,&quot;Region&quot;:&quot;NY&quot;,&quot;PostalCode&quot;:&quot;10101&quot;,&quot;Country&quot;:&quot;USA&quot;,&quot;AttentionTo&quot;:&quot;&quot;}],&quot;Phones&quot;:[{&quot;PhoneType&quot;:&quot;DEFAULT&quot;,&quot;PhoneNumber&quot;:&quot;222-2222&quot;,&quot;PhoneAreaCode&quot;:&quot;212&quot;,&quot;PhoneCountryCode&quot;:&quot;&quot;},null,{&quot;PhoneType&quot;:&quot;FAX&quot;,&quot;PhoneNumber&quot;:&quot;333-2233&quot;,&quot;PhoneAreaCode&quot;:&quot;212&quot;,&quot;PhoneCountryCode&quot;:&quot;&quot;},{&quot;PhoneType&quot;:&quot;MOBILE&quot;,&quot;PhoneNumber&quot;:&quot;444-3433&quot;,&quot;PhoneAreaCode&quot;:&quot;212&quot;,&quot;PhoneCountryCode&quot;:&quot;&quot;}],&quot;UpdatedDateUTC&quot;:&quot;/Date(1551747281053+0000)/&quot;,&quot;ContactGroups&quot;:[{&quot;ContactGroupID&quot;:&quot;17b44ed7-4389-4162-91cb-3dd5766e4e22&quot;,&quot;Name&quot;:&quot;Oasis&quot;,&quot;Status&quot;:&quot;ACTIVE&quot;,&quot;Contacts&quot;:[],&quot;HasValidationErrors&quot;:false}],&quot;IsSupplier&quot;:true,&quot;IsCustomer&quot;:true,&quot;SalesTrackingCategories&quot;:[],&quot;PurchasesTrackingCategories&quot;:[],&quot;ContactPersons&quot;:[],&quot;HasValidationErrors&quot;:false},&quot;Status&quot;:&quot;DRAFT&quot;,&quot;LineAmountTypes&quot;:&quot;Exclusive&quot;,&quot;LineItems&quot;:[{&quot;Description&quot;:&quot;Foobar&quot;,&quot;UnitAmount&quot;:20.0,&quot;TaxType&quot;:&quot;INPUT2&quot;,&quot;TaxAmount&quot;:3.0,&quot;LineAmount&quot;:20.0,&quot;AccountCode&quot;:&quot;710&quot;,&quot;Tracking&quot;:[],&quot;Quantity&quot;:1.0,&quot;LineItemID&quot;:&quot;792b7e40-b9f2-47f0-8624-b09f4b0166dd&quot;}],&quot;SubTotal&quot;:20.0,&quot;TotalTax&quot;:3.0,&quot;Total&quot;:23.0,&quot;UpdatedDateUTC&quot;:&quot;/Date(1552522946077+0000)/&quot;,&quot;StatusAttributeString&quot;:&quot;ERROR&quot;,&quot;Warnings&quot;:[{&quot;Message&quot;:&quot;Only AUTHORISED and BILLED purchase orders may have SentToContact updated.&quot;}],&quot;ValidationErrors&quot;:[{&quot;Message&quot;:&quot;Order number must be unique&quot;}]}]}