Allows you to create draft expense claim receipts for any user
PUT {{baseUrl}}/Receipts?unitdp=<integer>
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
unitdp | string | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts |
Request Body
{"Receipts"=>[{"Date"=>"<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>"}], "User"=>{"UserID"=>"<uuid>", "EmailAddress"=>"<string>", "FirstName"=>"<string>", "LastName"=>"<string>", "IsSubscriber"=>"<boolean>", "OrganisationRole"=>"<string>"}, "Reference"=>"<string>", "LineAmountTypes"=>"<string>", "SubTotal"=>"<double>", "TotalTax"=>"<double>", "Total"=>"<double>", "ReceiptID"=>"<uuid>", "Status"=>"<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>"}]}, {"Date"=>"<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>"}], "User"=>{"UserID"=>"<uuid>", "EmailAddress"=>"<string>", "FirstName"=>"<string>", "LastName"=>"<string>", "IsSubscriber"=>"<boolean>", "OrganisationRole"=>"<string>"}, "Reference"=>"<string>", "LineAmountTypes"=>"<string>", "SubTotal"=>"<double>", "TotalTax"=>"<double>", "Total"=>"<double>", "ReceiptID"=>"<uuid>", "Status"=>"<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
Key | Datatype | Required | Description |
---|---|---|---|
xero-tenant-id | string | (Required) Xero identifier for Tenant | |
Content-Type | string |
RESPONSES
status: OK
{"Id":"35898898-5361-4b42-b6ca-9d2c584fc53d","Status":"OK","ProviderName":"Provider Name Example","DateTimeUTC":"/Date(1552524583429)/","Receipts":[{"ReceiptID":"a44fd147-af4e-4fe8-a09a-55332df74162","ReceiptNumber":1,"Status":"DRAFT","User":{"UserID":"d1164823-0ac1-41ad-987b-b4e30fe0b273","EmailAddress":"api@xero.com","FirstName":"API ","LastName":"Team","UpdatedDateUTC":"/Date(1511957179217+0000)/","IsSubscriber":true,"OrganisationRole":"FINANCIALADVISER"},"Contact":{"ContactID":"430fa14a-f945-44d3-9f97-5df5e28441b8","ContactStatus":"ACTIVE","Name":"Liam Gallagher","FirstName":"Liam","LastName":"Gallagher","EmailAddress":"liam@rockstar.com","BankAccountDetails":"","Addresses":[{"AddressType":"STREET","City":"","Region":"","PostalCode":"","Country":"","AttentionTo":""},{"AddressType":"POBOX","City":"Anytown","Region":"NY","PostalCode":"10101","Country":"USA","AttentionTo":""}],"Phones":[{"PhoneType":"DEFAULT","PhoneNumber":"222-2222","PhoneAreaCode":"212","PhoneCountryCode":""},{"PhoneType":"DDI","PhoneNumber":"","PhoneAreaCode":"","PhoneCountryCode":""},{"PhoneType":"FAX","PhoneNumber":"333-2233","PhoneAreaCode":"212","PhoneCountryCode":""},{"PhoneType":"MOBILE","PhoneNumber":"444-3433","PhoneAreaCode":"212","PhoneCountryCode":""}],"UpdatedDateUTC":"/Date(1551747281053+0000)/","ContactGroups":[],"ContactPersons":[],"HasValidationErrors":false},"Date":"/Date(1552521600000+0000)/","UpdatedDateUTC":"/Date(1552524583367+0000)/","Reference":"","LineAmountTypes":"NoTax","LineItems":[{"Description":"Foobar","UnitAmount":20.0,"TaxType":"NONE","TaxAmount":0.0,"LineAmount":40.0,"AccountCode":"400","Tracking":[],"Quantity":2.0}],"SubTotal":40.0,"TotalTax":0.0,"Total":40.0,"ID":"a44fd147-af4e-4fe8-a09a-55332df74162","HasAttachments":false,"ValidationErrors":[{"Message":"A valid user should be identified using the UserID."}]}]}