openapi-directory/api/xero.com.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"contact":{"name":"Xero Developer Team","url":"https://developer.xero.com","x-twitter":"XeroAPI"},"description":"# Introduction\nThe Xero Accounting API is a RESTful web service and uses the OAuth (v1.0a) protocol to authenticate 3rd party applications. The Accounting API exposes accounting and related functions of the main Xero application and can be used for a variety of purposes such as creating transactions like invoices and credit notes, right through to extracting accounting data via our reports endpoint.\n","title":"Accounting","version":"2.0","x-apisguru-categories":["financial"],"x-logo":{"url":"https://lh3.googleusercontent.com/-_IQ9BNy118c/AAAAAAAAAAI/AAAAAAAAAB0/yvA2ZQSg_pk/s500-c-no/photo.jpg"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/XeroAPI/Xero-OpenAPI/master/spec/accounting2.yaml","version":"2.0"}],"x-providerName":"xero.com"},"tags":[{"externalDocs":{"description":"Accounts","url":"https://developer.xero.com/documentation/api/accounts/"},"name":"Accounts"},{"externalDocs":{"description":"BankTransactions","url":"https://developer.xero.com/documentation/api/banktransactions/"},"name":"BankTransactions"},{"externalDocs":{"description":"BankTransfers","url":"https://developer.xero.com/documentation/api/banktransfers/"},"name":"BankTransfers"},{"externalDocs":{"description":"BrandingThemes","url":"https://developer.xero.com/documentation/api/brandingthemes/"},"name":"BrandingThemes"},{"externalDocs":{"description":"Contacts","url":"https://developer.xero.com/documentation/api/contacts/"},"name":"Contacts"},{"externalDocs":{"description":"ContactGroups","url":"https://developer.xero.com/documentation/api/contactgroups/"},"name":"ContactGroups"},{"externalDocs":{"description":"CreditNotes","url":"https://developer.xero.com/documentation/api/creditnotes/"},"name":"CreditNotes"},{"externalDocs":{"description":"Currencies","url":"https://developer.xero.com/documentation/api/currencies/"},"name":"Currencies"},{"externalDocs":{"description":"Employees","url":"https://developer.xero.com/documentation/api/employees/"},"name":"Employees"},{"externalDocs":{"description":"ExpenseClaims","url":"https://developer.xero.com/documentation/api/expenseclaims/"},"name":"ExpenseClaims"},{"externalDocs":{"description":"Invoices","url":"https://developer.xero.com/documentation/api/invoices/"},"name":"Invoices"},{"externalDocs":{"description":"Items","url":"https://developer.xero.com/documentation/api/items/"},"name":"Items"},{"externalDocs":{"description":"Journals","url":"https://developer.xero.com/documentation/api/journals/"},"name":"Journals"},{"externalDocs":{"description":"LinkedTransactions","url":"https://developer.xero.com/documentation/api/Linked-Transactions/"},"name":"LinkedTransactions"},{"externalDocs":{"description":"ManualJournals","url":"https://developer.xero.com/documentation/api/manual-journals/"},"name":"ManualJournals"},{"externalDocs":{"description":"Organsiations","url":"https://developer.xero.com/documentation/api/organisation/"},"name":"Organisations"},{"externalDocs":{"description":"Overpayments","url":"https://developer.xero.com/documentation/api/overpayments/"},"name":"Overpayments"},{"externalDocs":{"description":"Payments","url":"https://developer.xero.com/documentation/api/payments/"},"name":"Payments"},{"externalDocs":{"description":"Prepayments","url":"https://developer.xero.com/documentation/api/prepayments/"},"name":"Prepayments"},{"externalDocs":{"description":"PurchaseOrders","url":"https://developer.xero.com/documentation/api/purchase-orders/"},"name":"PurchaseOrders"},{"externalDocs":{"description":"Receipts","url":"https://developer.xero.com/documentation/api/receipts/"},"name":"Receipts"},{"externalDocs":{"description":"RepeatingInvoices","url":"https://developer.xero.com/documentation/api/repeating-invoices/"},"name":"RepeatingInvoices"},{"externalDocs":{"description":"Reports","url":"https://developer.xero.com/documentation/api/reports/"},"name":"Reports"},{"externalDocs":{"description":"TaxRates","url":"https://developer.xero.com/documentation/api/tax-rates/"},"name":"TaxRates"},{"externalDocs":{"description":"TrackingCategories","url":"https://developer.xero.com/documentation/api/tracking-categories/"},"name":"TrackingCategories"},{"externalDocs":{"description":"Users","url":"https://developer.xero.com/documentation/api/users/"},"name":"Users"}],"paths":{"/Accounts":{"get":{"description":"Retrieve the chart of accounts","parameters":[{"$ref":"#/components/parameters/If-Modified-Since"},{"$ref":"#/components/parameters/where"},{"$ref":"#/components/parameters/order"}],"responses":{"200":{"$ref":"#/components/responses/AccountsResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Retrieve the full chart of accounts","tags":["Accounts"]},"post":{"requestBody":{"$ref":"#/components/requestBodies/Account"},"responses":{"200":{"$ref":"#/components/responses/AccountsResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"}},"summary":"Create or update accounts","tags":["Accounts"]},"put":{"requestBody":{"$ref":"#/components/requestBodies/Account"},"responses":{"200":{"$ref":"#/components/responses/AccountsResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"}},"summary":"Create new accounts","tags":["Accounts"]},"x-related-model":"Account"},"/Accounts/{AccountID}":{"delete":{"parameters":[{"in":"path","name":"AccountID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"A successful request"},"404":{"$ref":"#/components/responses/404ErrorResponse"}},"summary":"Delete an account","tags":["Accounts"]},"get":{"parameters":[{"in":"path","name":"AccountID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"$ref":"#/components/responses/AccountsResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"}},"summary":"Retrieve a single account","tags":["Accounts"]},"post":{"parameters":[{"in":"path","name":"AccountID","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"$ref":"#/components/requestBodies/Account"},"responses":{"200":{"$ref":"#/components/responses/AccountsResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"}},"summary":"Update an account","tags":["Accounts"]},"x-related-model":"Account"},"/Accounts/{AccountID}/Attachments":{"get":{"description":"Retrieve Attachments","parameters":[{"description":"The Xero generated unique identifier for an account","in":"path","name":"AccountID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/If-Modified-Since"}],"responses":{"200":{"$ref":"#/components/responses/AttachmentsResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Retrieve Attachments","tags":["Accounts"]}},"/Accounts/{AccountID}/Attachments/{FileName}":{"get":{"description":"Download an Attachment","parameters":[{"description":"The filename of the attachment to be downloaded","in":"path","name":"FileName","required":true,"schema":{"type":"string"}},{"description":"The Xero generated unique identifier for an account","in":"path","name":"AccountID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/If-Modified-Since"}],"responses":{"200":{"description":"Successful response. The response message will contain the raw file content that was originally uploaded. The response won’t contain any xml or json encoded information"},"404":{"description":"Attachment does not exist"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Download an Attachment","tags":["Accounts"]},"post":{"description":"Upload an Attachment","parameters":[{"description":"The filename of the attachment being uploaded","in":"path","name":"FileName","required":true,"schema":{"type":"string"}},{"description":"The Xero generated unique identifier for an account","in":"path","name":"AccountID","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/Content"},"responses":{"200":{"$ref":"#/components/responses/AttachmentsResponse"},"400":{"description":"Attachment couldn't be created."},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Upload an Attachment","tags":["Accounts"]}},"/BankTransactions":{"get":{"parameters":[{"$ref":"#/components/parameters/If-Modified-Since"},{"$ref":"#/components/parameters/where"},{"$ref":"#/components/parameters/order"},{"$ref":"#/components/parameters/unitdp"}],"responses":{"200":{"$ref":"#/components/responses/BankTransactionsResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Retrieve any spend or receive money transactions (inc. prepayments and overpayments)","tags":["BankTransactions"]},"post":{"parameters":[{"$ref":"#/components/parameters/unitdp"},{"$ref":"#/components/parameters/summarizeErrors"}],"requestBody":{"$ref":"#/components/requestBodies/BankTransaction"},"responses":{"200":{"$ref":"#/components/responses/BankTransactionsResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Create a new spend or receive money (inc. prepayments and overpayments)","tags":["BankTransactions"]},"put":{"parameters":[{"$ref":"#/components/parameters/summarizeErrors"}],"requestBody":{"$ref":"#/components/requestBodies/BankTransaction"},"responses":{"200":{"$ref":"#/components/responses/BankTransactionsResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Create a new spend or receive money (inc. prepayments and overpayments)","tags":["BankTransactions"]},"x-related-model":"BankTransaction"},"/BankTransactions/{BankTransactionID}":{"get":{"parameters":[{"in":"path","name":"BankTransactionID","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/unitdp"}],"responses":{"200":{"$ref":"#/components/responses/BankTransactionsResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Retrieve a spend or receive money (inc. prepayments and overpayments)","tags":["BankTransactions"]},"post":{"parameters":[{"in":"path","name":"BankTransactionID","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/unitdp"}],"requestBody":{"$ref":"#/components/requestBodies/BankTransaction"},"responses":{"200":{"$ref":"#/components/responses/BankTransactionsResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Update a spend or receive money","tags":["BankTransactions"]},"x-related-model":"BankTransaction"},"/BankTransactions/{BankTransactionID}/Attachments":{"get":{"description":"Retrieve Attachments","parameters":[{"description":"The Xero generated unique identifier for an bank transaction","in":"path","name":"BankTransactionID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/If-Modified-Since"}],"responses":{"200":{"$ref":"#/components/responses/AttachmentsResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Retrieve Attachments","tags":["BankTransactions"]}},"/BankTransactions/{BankTransactionID}/Attachments/{FileName}":{"get":{"description":"Download an Attachment","parameters":[{"description":"The filename of the attachment to be downloaded","in":"path","name":"FileName","required":true,"schema":{"type":"string"}},{"description":"The Xero generated unique identifier for an bank transaction","in":"path","name":"BankTransactionID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/If-Modified-Since"}],"responses":{"200":{"description":"Successful response. The response message will contain the raw file content that was originally uploaded. The response won’t contain any xml or json encoded information"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Download an Attachment","tags":["BankTransactions"]},"post":{"description":"Upload an Attachment","parameters":[{"description":"The filename of the attachment being uploaded","in":"path","name":"FileName","required":true,"schema":{"type":"string"}},{"description":"The Xero generated unique identifier for an bank transaction","in":"path","name":"BankTransactionID","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/Content"},"responses":{"200":{"$ref":"#/components/responses/AttachmentsResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Upload an Attachment","tags":["BankTransactions"]}},"/BankTransfers":{"get":{"parameters":[{"$ref":"#/components/parameters/If-Modified-Since"},{"$ref":"#/components/parameters/where"},{"$ref":"#/components/parameters/order"}],"responses":{"200":{"$ref":"#/components/responses/BankTransfersResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Retrieve a colection of bank transfers","tags":["BankTransfers"]},"put":{"parameters":[{"$ref":"#/components/parameters/summarizeErrors"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankTransfer"}},"application/xml":{"schema":{"$ref":"#/components/schemas/BankTransfer"}}},"required":true},"responses":{"200":{"$ref":"#/components/responses/BankTransfersResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Create a bank transfer","tags":["BankTransfers"]},"x-related-model":"BankTransfer"},"/BankTransfers/{BankTransferID}":{"get":{"parameters":[{"in":"path","name":"BankTransferID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"$ref":"#/components/responses/BankTransfersResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Retrieve an individual bank transfer","tags":["BankTransfers"]},"x-related-model":"BankTransfer"},"/BankTransfers/{BankTransferID}/Attachments/{FileName}":{"get":{"description":"Download an Attachment","parameters":[{"description":"The filename of the attachment to be downloaded","in":"path","name":"FileName","required":true,"schema":{"type":"string"}},{"description":"The Xero generated unique identifier for an BankTransfer","in":"path","name":"BankTransferID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/If-Modified-Since"}],"responses":{"200":{"description":"Successful response. The response message will contain the raw file content that was originally uploaded. The response won’t contain any xml or json encoded information"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Download an Attachment","tags":["BankTransfers"]},"post":{"description":"Upload an Attachment","parameters":[{"description":"The filename of the attachment being uploaded","in":"path","name":"FileName","required":true,"schema":{"type":"string"}},{"description":"The Xero generated unique identifier for a BankTransfer","in":"path","name":"BankTransferID","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/Content"},"responses":{"200":{"$ref":"#/components/responses/AttachmentsResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Upload an Attachment","tags":["BankTransfers"]}},"/BrandingThemes":{"get":{"responses":{"200":{"$ref":"#/components/responses/BrandingThemesResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Retrieve a collection of BrandingThemes","tags":["BrandingThemes"]},"x-related-model":"BrandingTheme"},"/BrandingThemes/{BrandingThemeID}":{"get":{"parameters":[{"in":"path","name":"BrandingThemeID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"$ref":"#/components/responses/BrandingThemesResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Retrieve an individual BrandingTheme","tags":["BrandingThemes"]},"x-related-model":"BrandingTheme"},"/ContactGroups":{"get":{"parameters":[{"$ref":"#/components/parameters/If-Modified-Since"},{"$ref":"#/components/parameters/where"},{"$ref":"#/components/parameters/order"}],"responses":{"200":{"$ref":"#/components/responses/ContactGroupsResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Retrieve a collection of contact groups","tags":["ContactGroups"]},"post":{"parameters":[{"$ref":"#/components/parameters/summarizeErrors"}],"requestBody":{"$ref":"#/components/requestBodies/ContactGroup"},"responses":{"200":{"$ref":"#/components/responses/ContactGroupsResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Create or update a contact group","tags":["ContactGroups"]},"put":{"parameters":[{"$ref":"#/components/parameters/summarizeErrors"}],"requestBody":{"$ref":"#/components/requestBodies/ContactGroup"},"responses":{"200":{"$ref":"#/components/responses/ContactGroupsResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Create a new contact group","tags":["ContactGroups"]},"x-related-model":"ContactGroup"},"/ContactGroups/{ContactGroupID}":{"delete":{"parameters":[{"in":"path","name":"ContactGroupID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"A successful request"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Delete a contact group","tags":["ContactGroups"]},"get":{"parameters":[{"in":"path","name":"ContactGroupID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"$ref":"#/components/responses/ContactGroupsResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Retrieve the ContactID and Name of all the contacts in a contact group","tags":["ContactGroups"]},"post":{"parameters":[{"in":"path","name":"ContactGroupID","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"$ref":"#/components/requestBodies/ContactGroup"},"responses":{"200":{"$ref":"#/components/responses/ContactGroupsResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Update a contact group","tags":["ContactGroups"]},"x-related-model":"ContactGroup"},"/ContactGroups/{ContactGroupID}/Contacts":{"delete":{"parameters":[{"in":"path","name":"ContactGroupID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"A successful request"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Remove all contacts from a contact group","tags":["ContactGroups"]},"put":{"parameters":[{"in":"path","name":"ContactGroupID","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"$ref":"#/components/requestBodies/Contact"},"responses":{"200":{"$ref":"#/components/responses/ContactGroupsResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Add contacts to a contact group","tags":["ContactGroups"]},"x-related-model":"ContactGroup"},"/ContactGroups/{ContactGroupID}/Contacts/{ContactID}":{"delete":{"parameters":[{"in":"path","name":"ContactGroupID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"ContactID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"A successful request"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Remove a contact from a contact group","tags":["ContactGroups"]},"x-related-model":"ContactGroup"},"/Contacts":{"get":{"parameters":[{"$ref":"#/components/parameters/If-Modified-Since"},{"$ref":"#/components/parameters/where"},{"$ref":"#/components/parameters/order"},{"$ref":"#/components/parameters/includeArchived"},{"description":"Filter by a comma-separated list of ContactIDs","in":"query","name":"IDs","required":false,"schema":{"type":"string","default":""}}],"responses":{"200":{"$ref":"#/components/responses/ContactsResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Retrieve a collection of contacts","tags":["Contacts"]},"post":{"parameters":[{"$ref":"#/components/parameters/summarizeErrors"}],"requestBody":{"$ref":"#/components/requestBodies/Contact"},"responses":{"200":{"$ref":"#/components/responses/ContactsResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Create or update a contact","tags":["Contacts"]},"put":{"requestBody":{"$ref":"#/components/requestBodies/Contact"},"responses":{"200":{"$ref":"#/components/responses/ContactsResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Create a contact","tags":["Contacts"]},"x-related-model":"Contact"},"/Contacts/{ContactID}":{"get":{"parameters":[{"in":"path","name":"ContactID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"$ref":"#/components/responses/ContactsResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Retrieve an individual contact","tags":["Contacts"]},"post":{"parameters":[{"in":"path","name":"ContactID","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"$ref":"#/components/requestBodies/Contact"},"responses":{"200":{"$ref":"#/components/responses/ContactsResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Update a contact","tags":["Contacts"]},"x-related-model":"Contact"},"/Contacts/{ContactID}/Attachments":{"get":{"description":"Retrieve Attachments","parameters":[{"description":"The Xero generated unique identifier for a Contact","in":"path","name":"ContactID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/If-Modified-Since"}],"responses":{"200":{"$ref":"#/components/responses/AttachmentsResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Retrieve Attachments","tags":["Contacts"]}},"/Contacts/{ContactID}/Attachments/{FileName}":{"get":{"description":"Download an Attachment","parameters":[{"description":"The filename of the attachment to be downloaded","in":"path","name":"FileName","required":true,"schema":{"type":"string"}},{"description":"The Xero generated unique identifier for a Contact","in":"path","name":"ContactID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/If-Modified-Since"}],"responses":{"200":{"description":"Successful response. The response message will contain the raw file content that was originally uploaded. The response won’t contain any xml or json encoded information"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Download an Attachment","tags":["Contacts"]},"post":{"description":"Upload an Attachment","parameters":[{"description":"The filename of the attachment being uploaded","in":"path","name":"FileName","required":true,"schema":{"type":"string"}},{"description":"The Xero generated unique identifier for a Contact","in":"path","name":"ContactID","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/Content"},"responses":{"200":{"$ref":"#/components/responses/AttachmentsResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Upload an Attachment","tags":["Contacts"]}},"/CreditNotes":{"get":{"parameters":[{"$ref":"#/components/parameters/If-Modified-Since"},{"$ref":"#/components/parameters/where"},{"$ref":"#/components/parameters/order"},{"$ref":"#/components/parameters/unitdp"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"$ref":"#/components/responses/CreditNotesResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Retrieve a collection of credit notes","tags":["CreditNotes"]},"post":{"parameters":[{"$ref":"#/components/parameters/unitdp"},{"$ref":"#/components/parameters/summarizeErrors"}],"requestBody":{"$ref":"#/components/requestBodies/CreditNote"},"responses":{"200":{"$ref":"#/components/responses/CreditNotesResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Create or update a credit note","tags":["CreditNotes"]},"put":{"parameters":[{"$ref":"#/components/parameters/unitdp"},{"$ref":"#/components/parameters/summarizeErrors"}],"requestBody":{"$ref":"#/components/requestBodies/CreditNote"},"responses":{"200":{"$ref":"#/components/responses/CreditNotesResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Create a credit note","tags":["CreditNotes"]},"x-related-model":"CreditNote"},"/CreditNotes/{CreditNoteID}":{"get":{"parameters":[{"in":"path","name":"CreditNoteID","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/unitdp"}],"responses":{"200":{"$ref":"#/components/responses/CreditNotesResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Retrieve an individual credit note","tags":["CreditNotes"]},"post":{"parameters":[{"in":"path","name":"CreditNoteID","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/unitdp"}],"requestBody":{"$ref":"#/components/requestBodies/CreditNote"},"responses":{"200":{"$ref":"#/components/responses/CreditNotesResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Update a credit note","tags":["CreditNotes"]},"x-related-model":"CreditNote"},"/CreditNotes/{CreditNoteID}/Allocations":{"put":{"parameters":[{"in":"path","name":"CreditNoteID","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"$ref":"#/components/requestBodies/Allocation"},"responses":{"200":{"$ref":"#/components/responses/CreditNotesResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Allocate a credit note","tags":["CreditNotes"]},"x-related-model":"CreditNote"},"/CreditNotes/{CreditNoteID}/Attachments":{"get":{"description":"Retrieve Attachments","parameters":[{"description":"The Xero generated unique identifier for a CreditNote","in":"path","name":"CreditNoteID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/If-Modified-Since"}],"responses":{"200":{"$ref":"#/components/responses/AttachmentsResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Retrieve Attachments","tags":["CreditNotes"]}},"/CreditNotes/{CreditNoteID}/Attachments/{FileName}":{"get":{"description":"Download an Attachment","parameters":[{"description":"The filename of the attachment to be downloaded","in":"path","name":"FileName","required":true,"schema":{"type":"string"}},{"description":"The Xero generated unique identifier for a CreditNote","in":"path","name":"CreditNoteID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/If-Modified-Since"}],"responses":{"200":{"description":"Successful response. The response message will contain the raw file content that was originally uploaded. The response won’t contain any xml or json encoded information"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Download an Attachment","tags":["CreditNotes"]},"post":{"description":"Upload an Attachment","parameters":[{"description":"The filename of the attachment being uploaded","in":"path","name":"FileName","required":true,"schema":{"type":"string"}},{"description":"The Xero generated unique identifier for a CreditNote","in":"path","name":"CreditNoteID","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/Content"},"responses":{"200":{"$ref":"#/components/responses/AttachmentsResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Upload an Attachment","tags":["CreditNotes"]}},"/Currencies":{"get":{"parameters":[{"$ref":"#/components/parameters/If-Modified-Since"},{"$ref":"#/components/parameters/where"},{"$ref":"#/components/parameters/order"}],"responses":{"200":{"$ref":"#/components/responses/CurrenciesResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Retrieve the currencies the organisation is subscribed to","tags":["Currencies"]},"put":{"parameters":[{"$ref":"#/components/parameters/summarizeErrors"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Currency"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Currency"}}},"required":true},"responses":{"200":{"$ref":"#/components/responses/CurrenciesResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Add currencies to the organisation","tags":["Currencies"]},"x-related-model":"Currency"},"/Employees":{"get":{"parameters":[{"$ref":"#/components/parameters/If-Modified-Since"},{"$ref":"#/components/parameters/where"},{"$ref":"#/components/parameters/order"}],"responses":{"200":{"$ref":"#/components/responses/EmployeesResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Retrieve a collection of employees","tags":["Employees"]},"post":{"parameters":[{"$ref":"#/components/parameters/summarizeErrors"}],"requestBody":{"$ref":"#/components/requestBodies/Employee"},"responses":{"200":{"$ref":"#/components/responses/EmployeesResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Create or update employees","tags":["Employees"]},"put":{"parameters":[{"$ref":"#/components/parameters/summarizeErrors"}],"requestBody":{"$ref":"#/components/requestBodies/Employee"},"responses":{"200":{"$ref":"#/components/responses/EmployeesResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Create employees","tags":["Employees"]},"x-related-model":"Employee"},"/Employees/{EmployeeID}":{"get":{"parameters":[{"in":"path","name":"EmployeeID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"$ref":"#/components/responses/EmployeesResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Retrieve an individual employee","tags":["Employees"]},"post":{"parameters":[{"in":"path","name":"EmployeeID","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"$ref":"#/components/requestBodies/Employee"},"responses":{"200":{"$ref":"#/components/responses/EmployeesResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Update an employee","tags":["Employees"]},"x-related-model":"Employee"},"/ExpenseClaims":{"get":{"parameters":[{"$ref":"#/components/parameters/If-Modified-Since"},{"$ref":"#/components/parameters/where"},{"$ref":"#/components/parameters/order"}],"responses":{"200":{"$ref":"#/components/responses/ExpenseClaimsResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Retrieve a collection of expense claims","tags":["ExpenseClaims"]},"post":{"parameters":[{"$ref":"#/components/parameters/summarizeErrors"}],"requestBody":{"$ref":"#/components/requestBodies/ExpenseClaim"},"responses":{"200":{"$ref":"#/components/responses/ExpenseClaimsResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Create or update an expense claim","tags":["ExpenseClaims"]},"put":{"parameters":[{"$ref":"#/components/parameters/summarizeErrors"}],"requestBody":{"$ref":"#/components/requestBodies/ExpenseClaim"},"responses":{"200":{"$ref":"#/components/responses/ExpenseClaimsResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Create an expense claim","tags":["ExpenseClaims"]},"x-related-model":"ExpenseClaim"},"/ExpenseClaims/{ExpenseClaimID}":{"get":{"parameters":[{"in":"path","name":"ExpenseClaimID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"$ref":"#/components/responses/ExpenseClaimsResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Retrieve an individual expense claim","tags":["ExpenseClaims"]},"post":{"parameters":[{"in":"path","name":"ExpenseClaimID","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"$ref":"#/components/requestBodies/ExpenseClaim"},"responses":{"200":{"$ref":"#/components/responses/ExpenseClaimsResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Update an expense claim","tags":["ExpenseClaims"]},"x-related-model":"ExpenseClaim"},"/Invoices":{"get":{"parameters":[{"$ref":"#/components/parameters/If-Modified-Since"},{"$ref":"#/components/parameters/where"},{"$ref":"#/components/parameters/order"},{"$ref":"#/components/parameters/unitdp"},{"description":"Filter by a comma-separated list of InvoiceIDs","in":"query","name":"IDs","required":false,"schema":{"type":"string","default":""}},{"description":"Filter by a comma-separated list of ContactIDs","in":"query","name":"ContactIDs","required":false,"schema":{"type":"string","default":""}},{"description":"Filter by a comma-separated list of Statuses","in":"query","name":"Statuses","required":false,"schema":{"type":"string","default":""}},{"description":"Filter by a comma-separated list of InvoiceNumbers","in":"query","name":"InvoiceNumbers","required":false,"schema":{"type":"string","default":""}}],"responses":{"200":{"$ref":"#/components/responses/InvoicesResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Retrieve a collection of invoices (sales invoices and bills)","tags":["Invoices"]},"post":{"parameters":[{"$ref":"#/components/parameters/unitdp"},{"$ref":"#/components/parameters/summarizeErrors"}],"requestBody":{"$ref":"#/components/requestBodies/Invoice"},"responses":{"200":{"$ref":"#/components/responses/InvoicesResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Create or update an Invoice (sales invoices or bills)","tags":["Invoices"]},"put":{"parameters":[{"$ref":"#/components/parameters/unitdp"},{"$ref":"#/components/parameters/summarizeErrors"}],"requestBody":{"$ref":"#/components/requestBodies/Invoice"},"responses":{"200":{"$ref":"#/components/responses/InvoicesResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Create an Invoice (sales invoices or bills)","tags":["Invoices"]},"x-related-model":"Invoice"},"/Invoices/{InvoiceID}":{"get":{"parameters":[{"in":"path","name":"InvoiceID","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/unitdp"}],"responses":{"200":{"$ref":"#/components/responses/InvoicesResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Retrieve an Invoice (sales invoice or bill)","tags":["Invoices"]},"post":{"parameters":[{"in":"path","name":"InvoiceID","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/unitdp"}],"requestBody":{"$ref":"#/components/requestBodies/Invoice"},"responses":{"200":{"$ref":"#/components/responses/InvoicesResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Update an Invoice (sales invoice or bill)","tags":["Invoices"]},"x-related-model":"Invoice"},"/Invoices/{InvoiceID}/Attachments":{"get":{"description":"Retrieve Attachments","parameters":[{"description":"The Xero generated unique identifier for an Invoice","in":"path","name":"InvoiceID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/If-Modified-Since"}],"responses":{"200":{"$ref":"#/components/responses/AttachmentsResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Retrieve Attachments","tags":["Invoices"]}},"/Invoices/{InvoiceID}/Attachments/{FileName}":{"get":{"description":"Download an Attachment","parameters":[{"description":"The filename of the attachment to be downloaded","in":"path","name":"FileName","required":true,"schema":{"type":"string"}},{"description":"The Xero generated unique identifier for an Invoice","in":"path","name":"InvoiceID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/If-Modified-Since"}],"responses":{"200":{"description":"Successful response. The response message will contain the raw file content that was originally uploaded. The response won’t contain any xml or json encoded information"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Download an Attachment","tags":["Invoices"]},"post":{"description":"Upload an Attachment","parameters":[{"description":"The filename of the attachment being uploaded","in":"path","name":"FileName","required":true,"schema":{"type":"string"}},{"description":"The Xero generated unique identifier for an Invoice","in":"path","name":"InvoiceID","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/Content"},"responses":{"200":{"$ref":"#/components/responses/AttachmentsResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Upload an Attachment","tags":["Invoices"]}},"/Invoices/{InvoiceID}/OnlineInvoice":{"get":{"parameters":[{"in":"path","name":"InvoiceID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"$ref":"#/components/responses/OnlineInvoicesResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Retrieve the URL to view the online invoice","tags":["Invoices"]},"x-related-model":"OnlineInvoice"},"/Items":{"get":{"parameters":[{"$ref":"#/components/parameters/If-Modified-Since"},{"$ref":"#/components/parameters/where"},{"$ref":"#/components/parameters/order"},{"$ref":"#/components/parameters/unitdp"}],"responses":{"200":{"$ref":"#/components/responses/ItemsResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Retrieve a collection of items","tags":["Items"]},"post":{"parameters":[{"$ref":"#/components/parameters/unitdp"},{"$ref":"#/components/parameters/summarizeErrors"}],"requestBody":{"$ref":"#/components/requestBodies/Item"},"responses":{"200":{"$ref":"#/components/responses/ItemsResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Create or update an item","tags":["Items"]},"put":{"parameters":[{"$ref":"#/components/parameters/unitdp"},{"$ref":"#/components/parameters/summarizeErrors"}],"requestBody":{"$ref":"#/components/requestBodies/Item"},"responses":{"200":{"$ref":"#/components/responses/ItemsResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Create an item","tags":["Items"]},"x-related-model":"Item"},"/Items/{ItemID}":{"delete":{"parameters":[{"in":"path","name":"ItemID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"A successful request"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Delete an item","tags":["Items"]},"get":{"parameters":[{"in":"path","name":"ItemID","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/unitdp"}],"responses":{"200":{"$ref":"#/components/responses/ItemsResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Retrieve an item","tags":["Items"]},"post":{"parameters":[{"in":"path","name":"ItemID","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/unitdp"}],"requestBody":{"$ref":"#/components/requestBodies/Item"},"responses":{"200":{"$ref":"#/components/responses/ItemsResponse"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Update an item","tags":["Items"]},"x-related-model":"Item"},"/Journals":{"get":{"parameters":[{"$ref":"#/components/parameters/If-Modified-Since"},{"$ref":"#/components/parameters/paymentsOnly"},{"$ref":"#/components/parameters/offset"}],"responses":{"200":{"$ref":"#/components/responses/JournalsResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Retrieve a collection of journals.","tags":["Journals"]},"x-related-model":"Journal"},"/Journals/{JournalID}":{"get":{"parameters":[{"in":"path","name":"JournalID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"$ref":"#/components/responses/JournalsResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Retrieve an individual journal.","tags":["Journals"]},"x-related-model":"Journal"},"/LinkedTransactions":{"get":{"parameters":[{"$ref":"#/components/parameters/page"},{"description":"Filter by the SourceTransactionID. Get all the linked transactions created from a particular ACCPAY invoice","in":"query","name":"SourceTransactionID","schema":{"type":"string","format":"uuid"}},{"description":"Filter by the ContactID. Get all the linked transactions that have been assigned to a particular customer.","in":"query","name":"ContactID","schema":{"type":"string","format":"uuid"}},{"description":"Filter by the combination of ContactID and Status. Get all the linked transactions that have been assigned to a particular customer and have a particular status e.g. GET /LinkedTransactions?ContactID=4bb34b03-3378-4bb2-a0ed-6345abf3224e&Status=APPROVED.","in":"query","name":"Status","schema":{"type":"string","format":"uuid"}},{"description":"Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice.","in":"query","name":"TargetTransactionID","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"$ref":"#/components/responses/LinkedTransactionsResponse"}},"summary":"Retrieve a collection of linked transactions (billable expenses)","tags":["LinkedTransactions"]},"post":{"requestBody":{"$ref":"#/components/requestBodies/LinkedTransaction"},"responses":{"200":{"$ref":"#/components/responses/LinkedTransactionsResponse"}},"summary":"Create or update a linked transaction (billable expense)","tags":["LinkedTransactions"]},"put":{"requestBody":{"$ref":"#/components/requestBodies/LinkedTransaction"},"responses":{"200":{"$ref":"#/components/responses/LinkedTransactionsResponse"}},"summary":"Create a linked transaction (billable expense)","tags":["LinkedTransactions"]},"x-related-model":"LinkedTransaction"},"/LinkedTransactions/{LinkedTransactionID}":{"delete":{"parameters":[{"in":"path","name":"LinkedTransactionID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"A successful request"}},"summary":"Delete a linked transaction (billable expense)","tags":["LinkedTransactions"]},"get":{"parameters":[{"in":"path","name":"LinkedTransactionID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"$ref":"#/components/responses/LinkedTransactionsResponse"}},"summary":"Retrieve a linked transaction (billable expense)","tags":["LinkedTransactions"]},"post":{"parameters":[{"in":"path","name":"LinkedTransactionID","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"$ref":"#/components/requestBodies/LinkedTransaction"},"responses":{"200":{"$ref":"#/components/responses/LinkedTransactionsResponse"}},"summary":"Update a linked transaction (billable expense)","tags":["LinkedTransactions"]},"x-related-model":"LinkedTransaction"},"/ManualJournals":{"get":{"parameters":[{"$ref":"#/components/parameters/If-Modified-Since"},{"$ref":"#/components/parameters/where"},{"$ref":"#/components/parameters/order"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"$ref":"#/components/responses/ManualJournalsResponse"}},"summary":"Retrieve a collection of manual journals","tags":["ManualJournals"]},"post":{"parameters":[{"$ref":"#/components/parameters/summarizeErrors"}],"requestBody":{"$ref":"#/components/requestBodies/ManualJournal"},"responses":{"200":{"$ref":"#/components/responses/ManualJournalsResponse"}},"summary":"Create or update a manual journal","tags":["ManualJournals"]},"put":{"parameters":[{"$ref":"#/components/parameters/summarizeErrors"}],"requestBody":{"$ref":"#/components/requestBodies/ManualJournal"},"responses":{"200":{"$ref":"#/components/responses/ManualJournalsResponse"}},"summary":"Create a manual journal","tags":["ManualJournals"]},"x-related-model":"ManualJournal"},"/ManualJournals/{ManualJournalID}":{"get":{"parameters":[{"in":"path","name":"ManualJournalID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"$ref":"#/components/responses/ManualJournalsResponse"}},"summary":"Retrieve an individual manual journal","tags":["ManualJournals"]},"post":{"parameters":[{"in":"path","name":"ManualJournalID","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"$ref":"#/components/requestBodies/ManualJournal"},"responses":{"200":{"$ref":"#/components/responses/ManualJournalsResponse"}},"summary":"Update a manual journal","tags":["ManualJournals"]},"x-related-model":"ManualJournal"},"/ManualJournals/{ManualJournalID}/Attachments":{"get":{"description":"Retrieve Attachments","parameters":[{"description":"The Xero generated unique identifier for a Manual Journal","in":"path","name":"ManualJournalID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/If-Modified-Since"}],"responses":{"200":{"$ref":"#/components/responses/AttachmentsResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Retrieve Attachments","tags":["ManualJournals"]}},"/ManualJournals/{ManualJournalID}/Attachments/{FileName}":{"get":{"description":"Download an Attachment","parameters":[{"description":"The filename of the attachment to be downloaded","in":"path","name":"FileName","required":true,"schema":{"type":"string"}},{"description":"The Xero generated unique identifier for a Manual Journal","in":"path","name":"ManualJournalID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/If-Modified-Since"}],"responses":{"200":{"description":"Successful response. The response message will contain the raw file content that was originally uploaded. The response won’t contain any xml or json encoded information"},"404":{"description":"Attachment does not exist"},"500":{"$ref":"#/components/responses/500ErrorResponse"}},"summary":"Download an Attachment","tags":["ManualJournals"]},"post":{"description":"Upload an Attachment","parameters":[{"description":"The filename of the attachment being uploaded","in":"path","name":"FileName","required":true,"schema":{"type":"string"}},{"description":"The Xero generated unique identifier for a Manual Journal","in":"path","name":"ManualJournalID","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/Content"},"responses":{"200"