naftiko: 1.0.0-alpha2 info: label: Xero Accounting API — Accounting description: 'Xero Accounting API — Accounting. 237 operations. Lead operation: Xero Retrieves the full chart of accounts. Self-contained Naftiko capability covering one Xero business surface.' tags: - Xero - Accounting created: '2026-05-19' modified: '2026-05-19' binds: - namespace: env keys: XERO_API_KEY: XERO_API_KEY capability: consumes: - type: http namespace: accounting-accounting baseUri: https://api.xero.com/api.xro/2.0 description: Xero Accounting API — Accounting business capability. Self-contained, no shared references. resources: - name: Accounts path: /Accounts operations: - name: getaccounts method: GET description: Xero Retrieves the full chart of accounts outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: where in: query type: string description: Filter by an any element - name: order in: query type: string description: Order by an any element - name: createaccount method: PUT description: Xero Creates a new chart of accounts outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: Accounts-AccountID path: /Accounts/{AccountID} operations: - name: getaccount method: GET description: Xero Retrieves a single chart of accounts by using a unique account Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updateaccount method: POST description: Xero Updates a chart of accounts outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: deleteaccount method: DELETE description: Xero Deletes a chart of accounts outputRawFormat: json outputParameters: - name: result type: object value: $. - name: Accounts-AccountID-Attachments path: /Accounts/{AccountID}/Attachments operations: - name: getaccountattachments method: GET description: Xero Retrieves attachments for a specific accounts by using a unique account Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: Accounts-AccountID-Attachments-AttachmentID path: /Accounts/{AccountID}/Attachments/{AttachmentID} operations: - name: getaccountattachmentbyid method: GET description: Xero Retrieves a specific attachment from a specific account using a unique attachment Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: Accounts-AccountID-Attachments-FileName path: /Accounts/{AccountID}/Attachments/{FileName} operations: - name: getaccountattachmentbyfilename method: GET description: Xero Retrieves an attachment for a specific account by filename outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updateaccountattachmentbyfilename method: POST description: Xero Updates attachment on a specific account by filename outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: createaccountattachmentbyfilename method: PUT description: Xero Creates an attachment on a specific account outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: BankTransactions path: /BankTransactions operations: - name: getbanktransactions method: GET description: Xero Retrieves any spent or received money transactions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: where in: query type: string description: Filter by an any element - name: order in: query type: string description: Order by an any element - name: page in: query type: integer description: Up to 100 bank transactions will be returned in a single API call with line items details - name: createbanktransactions method: PUT description: Xero Creates one or more spent or received money transaction outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: updateorcreatebanktransactions method: POST description: Xero Updates or creates one or more spent or received money transaction outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: BankTransactions-BankTransactionID path: /BankTransactions/{BankTransactionID} operations: - name: getbanktransaction method: GET description: Xero Retrieves a single spent or received money transaction by using a unique bank transaction Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updatebanktransaction method: POST description: Xero Updates a single spent or received money transaction outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: BankTransactions-BankTransactionID-Attachments path: /BankTransactions/{BankTransactionID}/Attachments operations: - name: getbanktransactionattachments method: GET description: Xero Retrieves any attachments from a specific bank transactions outputRawFormat: json outputParameters: - name: result type: object value: $. - name: BankTransactions-BankTransactionID-Attachments-AttachmentID path: /BankTransactions/{BankTransactionID}/Attachments/{AttachmentID} operations: - name: getbanktransactionattachmentbyid method: GET description: Xero Retrieves specific attachments from a specific BankTransaction using a unique attachment Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: BankTransactions-BankTransactionID-Attachments-FileName path: /BankTransactions/{BankTransactionID}/Attachments/{FileName} operations: - name: getbanktransactionattachmentbyfilename method: GET description: Xero Retrieves a specific attachment from a specific bank transaction by filename outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updatebanktransactionattachmentbyfilename method: POST description: Xero Updates a specific attachment from a specific bank transaction by filename outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: createbanktransactionattachmentbyfilename method: PUT description: Xero Creates an attachment for a specific bank transaction by filename outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: BankTransactions-BankTransactionID-History path: /BankTransactions/{BankTransactionID}/History operations: - name: getbanktransactionshistory method: GET description: Xero Retrieves history from a specific bank transaction using a unique bank transaction Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createbanktransactionhistoryrecord method: PUT description: Xero Creates a history record for a specific bank transactions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: false - name: BankTransfers path: /BankTransfers operations: - name: getbanktransfers method: GET description: Xero Retrieves all bank transfers outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: where in: query type: string description: Filter by an any element - name: order in: query type: string description: Order by an any element - name: createbanktransfer method: PUT description: Xero Creates a bank transfer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: BankTransfers-BankTransferID path: /BankTransfers/{BankTransferID} operations: - name: getbanktransfer method: GET description: Xero Retrieves specific bank transfers by using a unique bank transfer Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: BankTransfers-BankTransferID-Attachments path: /BankTransfers/{BankTransferID}/Attachments operations: - name: getbanktransferattachments method: GET description: Xero Retrieves attachments from a specific bank transfer outputRawFormat: json outputParameters: - name: result type: object value: $. - name: BankTransfers-BankTransferID-Attachments-AttachmentID path: /BankTransfers/{BankTransferID}/Attachments/{AttachmentID} operations: - name: getbanktransferattachmentbyid method: GET description: Xero Retrieves a specific attachment from a specific bank transfer using a unique attachment ID outputRawFormat: json outputParameters: - name: result type: object value: $. - name: BankTransfers-BankTransferID-Attachments-FileName path: /BankTransfers/{BankTransferID}/Attachments/{FileName} operations: - name: getbanktransferattachmentbyfilename method: GET description: Xero Retrieves a specific attachment on a specific bank transfer by file name outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updatebanktransferattachmentbyfilename method: POST description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: createbanktransferattachmentbyfilename method: PUT description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: BankTransfers-BankTransferID-History path: /BankTransfers/{BankTransferID}/History operations: - name: getbanktransferhistory method: GET description: Xero Retrieves history from a specific bank transfer using a unique bank transfer Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createbanktransferhistoryrecord method: PUT description: Xero Creates a history record for a specific bank transfer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: false - name: BatchPayments path: /BatchPayments operations: - name: getbatchpayments method: GET description: Xero Retrieves either one or many batch payments for invoices outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: where in: query type: string description: Filter by an any element - name: order in: query type: string description: Order by an any element - name: createbatchpayment method: PUT description: Xero Creates one or many batch payments for invoices outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: deletebatchpayment method: POST description: Xero Updates a specific batch payment for invoices and credit notes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: BatchPayments-BatchPaymentID path: /BatchPayments/{BatchPaymentID} operations: - name: getbatchpayment method: GET description: Xero Retrieves a specific batch payment using a unique batch payment Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: deletebatchpaymentbyurlparam method: POST description: Xero Updates a specific batch payment for invoices and credit notes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: BatchPayments-BatchPaymentID-History path: /BatchPayments/{BatchPaymentID}/History operations: - name: getbatchpaymenthistory method: GET description: Xero Retrieves history from a specific batch payment outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createbatchpaymenthistoryrecord method: PUT description: Xero Creates a history record for a specific batch payment outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: false - name: BrandingThemes path: /BrandingThemes operations: - name: getbrandingthemes method: GET description: Xero Retrieves all the branding themes outputRawFormat: json outputParameters: - name: result type: object value: $. - name: BrandingThemes-BrandingThemeID path: /BrandingThemes/{BrandingThemeID} operations: - name: getbrandingtheme method: GET description: Xero Retrieves a specific branding theme using a unique branding theme Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: BrandingThemes-BrandingThemeID-PaymentServices path: /BrandingThemes/{BrandingThemeID}/PaymentServices operations: - name: getbrandingthemepaymentservices method: GET description: Xero Retrieves the payment services for a specific branding theme outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createbrandingthemepaymentservices method: POST description: Xero Creates a new custom payment service for a specific branding theme outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: Budgets path: /Budgets operations: - name: getbudgets method: GET description: Xero Retrieve a list of budgets outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: IDs in: query type: string description: Filter by BudgetID. Allows you to retrieve a specific individual budget. - name: DateTo in: query type: string description: Filter by start date - name: DateFrom in: query type: string description: Filter by end date - name: Budgets-BudgetID path: /Budgets/{BudgetID} operations: - name: getbudget method: GET description: Xero Retrieves a specific budget, which includes budget lines outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: DateTo in: query type: string description: Filter by start date - name: DateFrom in: query type: string description: Filter by end date - name: ContactGroups path: /ContactGroups operations: - name: getcontactgroups method: GET description: Xero Retrieves the contact Id and name of each contact group outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: where in: query type: string description: Filter by an any element - name: order in: query type: string description: Order by an any element - name: createcontactgroup method: PUT description: Xero Creates a contact group outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ContactGroups-ContactGroupID path: /ContactGroups/{ContactGroupID} operations: - name: getcontactgroup method: GET description: Xero Retrieves a specific contact group by using a unique contact group Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updatecontactgroup method: POST description: Xero Updates a specific contact group outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ContactGroups-ContactGroupID-Contacts path: /ContactGroups/{ContactGroupID}/Contacts operations: - name: createcontactgroupcontacts method: PUT description: Xero Creates contacts to a specific contact group outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: deletecontactgroupcontacts method: DELETE description: Xero Deletes all contacts from a specific contact group outputRawFormat: json outputParameters: - name: result type: object value: $. - name: ContactGroups-ContactGroupID-Contacts-ContactID path: /ContactGroups/{ContactGroupID}/Contacts/{ContactID} operations: - name: deletecontactgroupcontact method: DELETE description: Xero Deletes a specific contact from a contact group using a unique contact Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: Contacts path: /Contacts operations: - name: getcontacts method: GET description: Retrieves all contacts in a Xero organisation outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: where in: query type: string description: Filter by an any element - name: order in: query type: string description: Order by an any element - name: IDs in: query type: array description: Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call. - name: page in: query type: integer description: e.g. page=1 - Up to 100 contacts will be returned in a single API call. - name: includeArchived in: query type: boolean description: e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response - name: searchTerm in: query type: string description: Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields. - name: createcontacts method: PUT description: Creates multiple contacts (bulk) in a Xero organisation outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: updateorcreatecontacts method: POST description: Updates or creates one or more contacts in a Xero organisation outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: Contacts-ContactID path: /Contacts/{ContactID} operations: - name: getcontact method: GET description: Retrieves a specific contacts in a Xero organisation using a unique contact Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updatecontact method: POST description: Updates a specific contact in a Xero organisation outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: Contacts-ContactID-Attachments path: /Contacts/{ContactID}/Attachments operations: - name: getcontactattachments method: GET description: Retrieves attachments for a specific contact in a Xero organisation outputRawFormat: json outputParameters: - name: result type: object value: $. - name: Contacts-ContactID-Attachments-AttachmentID path: /Contacts/{ContactID}/Attachments/{AttachmentID} operations: - name: getcontactattachmentbyid method: GET description: Xero Retrieves a specific attachment from a specific contact using a unique attachment Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: Contacts-ContactID-Attachments-FileName path: /Contacts/{ContactID}/Attachments/{FileName} operations: - name: getcontactattachmentbyfilename method: GET description: Xero Retrieves a specific attachment from a specific contact by file name outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updatecontactattachmentbyfilename method: POST description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: createcontactattachmentbyfilename method: PUT description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: Contacts-ContactID-CISSettings path: /Contacts/{ContactID}/CISSettings operations: - name: getcontactcissettings method: GET description: Retrieves CIS settings for a specific contact in a Xero organisation outputRawFormat: json outputParameters: - name: result type: object value: $. - name: Contacts-ContactID-History path: /Contacts/{ContactID}/History operations: - name: getcontacthistory method: GET description: Xero Retrieves history records for a specific contact outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createcontacthistory method: PUT description: Xero Creates a new history record for a specific contact outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: false - name: Contacts-ContactNumber path: /Contacts/{ContactNumber} operations: - name: getcontactbycontactnumber method: GET description: Retrieves a specific contact by contact number in a Xero organisation outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: ContactNumber in: path type: string description: This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50). required: true - name: CreditNotes path: /CreditNotes operations: - name: getcreditnotes method: GET description: Xero Retrieves any credit notes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: where in: query type: string description: Filter by an any element - name: order in: query type: string description: Order by an any element - name: page in: query type: integer description: e.g. page=1 – Up to 100 credit notes will be returned in a single API call with line items shown for each credit note - name: createcreditnotes method: PUT description: Xero Creates a new credit note outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: updateorcreatecreditnotes method: POST description: Xero Updates or creates one or more credit notes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: CreditNotes-CreditNoteID path: /CreditNotes/{CreditNoteID} operations: - name: getcreditnote method: GET description: Xero Retrieves a specific credit note using a unique credit note Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updatecreditnote method: POST description: Xero Updates a specific credit note outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: CreditNotes-CreditNoteID-Allocations path: /CreditNotes/{CreditNoteID}/Allocations operations: - name: createcreditnoteallocation method: PUT description: Xero Creates allocation for a specific credit note outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: CreditNotes-CreditNoteID-Allocations-AllocationID path: /CreditNotes/{CreditNoteID}/Allocations/{AllocationID} operations: - name: deletecreditnoteallocations method: DELETE description: Xero Deletes an Allocation from a Credit Note outputRawFormat: json outputParameters: - name: result type: object value: $. - name: CreditNotes-CreditNoteID-Attachments path: /CreditNotes/{CreditNoteID}/Attachments operations: - name: getcreditnoteattachments method: GET description: Xero Retrieves attachments for a specific credit notes outputRawFormat: json outputParameters: - name: result type: object value: $. - name: CreditNotes-CreditNoteID-Attachments-AttachmentID path: /CreditNotes/{CreditNoteID}/Attachments/{AttachmentID} operations: - name: getcreditnoteattachmentbyid method: GET description: Xero Retrieves a specific attachment from a specific credit note using a unique attachment Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: CreditNotes-CreditNoteID-Attachments-FileName path: /CreditNotes/{CreditNoteID}/Attachments/{FileName} operations: - name: getcreditnoteattachmentbyfilename method: GET description: Xero Retrieves a specific attachment on a specific credit note by file name outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updatecreditnoteattachmentbyfilename method: POST description: Xero Updates attachments on a specific credit note by file name outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: createcreditnoteattachmentbyfilename method: PUT description: Xero Creates an attachment for a specific credit note outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: CreditNotes-CreditNoteID-History path: /CreditNotes/{CreditNoteID}/History operations: - name: getcreditnotehistory method: GET description: Xero Retrieves history records of a specific credit note outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createcreditnotehistory method: PUT description: Xero Retrieves history records of a specific credit note outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: false - name: CreditNotes-CreditNoteID-pdf path: /CreditNotes/{CreditNoteID}/pdf operations: - name: getcreditnoteaspdf method: GET description: Xero Retrieves credit notes as PDF files outputRawFormat: json outputParameters: - name: result type: object value: $. - name: Currencies path: /Currencies operations: - name: getcurrencies method: GET description: Retrieves currencies for your Xero organisation outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: where in: query type: string description: Filter by an any element - name: order in: query type: string description: Order by an any element - name: createcurrency method: PUT description: Create a new currency for a Xero organisation outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: Employees path: /Employees operations: - name: getemployees method: GET description: Retrieves employees used in Xero payrun outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: where in: query type: string description: Filter by an any element - name: order in: query type: string description: Order by an any element - name: createemployees method: PUT description: Creates new employees used in Xero payrun outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: updateorcreateemployees method: POST description: Creates a single new employees used in Xero payrun outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: Employees-EmployeeID path: /Employees/{EmployeeID} operations: - name: getemployee method: GET description: Retrieves a specific employee used in Xero payrun using a unique employee Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: ExpenseClaims path: /ExpenseClaims operations: - name: getexpenseclaims method: GET description: Xero Retrieves expense claims outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: where in: query type: string description: Filter by an any element - name: order in: query type: string description: Order by an any element - name: createexpenseclaims method: PUT description: Xero Creates expense claims outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ExpenseClaims-ExpenseClaimID path: /ExpenseClaims/{ExpenseClaimID} operations: - name: getexpenseclaim method: GET description: Xero Retrieves a specific expense claim using a unique expense claim Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updateexpenseclaim method: POST description: Xero Updates a specific expense claims outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ExpenseClaims-ExpenseClaimID-History path: /ExpenseClaims/{ExpenseClaimID}/History operations: - name: getexpenseclaimhistory method: GET description: Xero Retrieves history records of a specific expense claim outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createexpenseclaimhistory method: PUT description: Xero Creates a history record for a specific expense claim outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: false - name: InvoiceReminders-Settings path: /InvoiceReminders/Settings operations: - name: getinvoicereminders method: GET description: Xero Retrieves invoice reminder settings outputRawFormat: json outputParameters: - name: result type: object value: $. - name: Invoices path: /Invoices operations: - name: getinvoices method: GET description: Xero Retrieves sales invoices or purchase bills outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: where in: query type: string description: Filter by an any element - name: order in: query type: string description: Order by an any element - name: IDs in: query type: array description: Filter by a comma-separated list of InvoicesIDs. - name: InvoiceNumbers in: query type: array description: Filter by a comma-separated list of InvoiceNumbers. - name: ContactIDs in: query type: array description: Filter by a comma-separated list of ContactIDs. - name: Statuses in: query type: array description: Filter by a comma-separated list Statuses. For faster response times we recommend using these explicit parameters instead of passing OR conditions into the Wher - name: page in: query type: integer description: e.g. page=1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice - name: includeArchived in: query type: boolean description: e.g. includeArchived=true - Invoices with a status of ARCHIVED will be included in the response - name: createdByMyApp in: query type: boolean description: When set to true you'll only retrieve Invoices created by your app - name: createinvoices method: PUT description: Xero Creates one or more sales invoices or purchase bills outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: updateorcreateinvoices method: POST description: Xero Updates or creates one or more sales invoices or purchase bills outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: Invoices-InvoiceID path: /Invoices/{InvoiceID} operations: - name: getinvoice method: GET description: Xero Retrieves a specific sales invoice or purchase bill using a unique invoice Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updateinvoice method: POST description: Xero Updates a specific sales invoices or purchase bills outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: Invoices-InvoiceID-Attachments path: /Invoices/{InvoiceID}/Attachments operations: - name: getinvoiceattachments method: GET description: Xero Retrieves attachments for a specific invoice or purchase bill outputRawFormat: json outputParameters: - name: result type: object value: $. - name: Invoices-InvoiceID-Attachments-AttachmentID path: /Invoices/{InvoiceID}/Attachments/{AttachmentID} operations: - name: getinvoiceattachmentbyid method: GET description: Xero Retrieves a specific attachment from a specific invoices or purchase bills by using a unique attachment Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: Invoices-InvoiceID-Attachments-FileName path: /Invoices/{InvoiceID}/Attachments/{FileName} operations: - name: getinvoiceattachmentbyfilename method: GET description: Xero Retrieves an attachment from a specific invoice or purchase bill by filename outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updateinvoiceattachmentbyfilename method: POST description: Xero Updates an attachment from a specific invoices or purchase bill by filename outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: createinvoiceattachmentbyfilename method: PUT description: Xero Creates an attachment for a specific invoice or purchase bill by filename outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: Invoices-InvoiceID-Email path: /Invoices/{InvoiceID}/Email operations: - name: emailinvoice method: POST description: Xero Sends a copy of a specific invoice to related contact via email outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: Invoices-InvoiceID-History path: /Invoices/{InvoiceID}/History operations: - name: getinvoicehistory method: GET description: Xero Retrieves history records for a specific invoice outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createinvoicehistory method: PUT description: Xero Creates a history record for a specific invoice outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: false - name: Invoices-InvoiceID-OnlineInvoice path: /Invoices/{InvoiceID}/OnlineInvoice operations: - name: getonlineinvoice method: GET description: Xero Retrieves a URL to an online invoice outputRawFormat: json outputParameters: - name: result type: object value: $. - name: Invoices-InvoiceID-pdf path: /Invoices/{InvoiceID}/pdf operations: - name: getinvoiceaspdf method: GET description: Xero Retrieves invoices or purchase bills as PDF files outputRawFormat: json outputParameters: - name: result type: object value: $. - name: Items path: /Items operations: - name: getitems method: GET description: Xero Retrieves items outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: where in: query type: string description: Filter by an any element - name: order in: query type: string description: Order by an any element - name: createitems method: PUT description: Xero Creates one or more items outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: updateorcreateitems method: POST description: Xero Updates or creates one or more items outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: Items-ItemID path: /Items/{ItemID} operations: - name: getitem method: GET description: Xero Retrieves a specific item using a unique item Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updateitem method: POST description: Xero Updates a specific item outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: deleteitem method: DELETE description: Xero Deletes a specific item outputRawFormat: json outputParameters: - name: result type: object value: $. - name: Items-ItemID-History path: /Items/{ItemID}/History operations: - name: getitemhistory method: GET description: Xero Retrieves history for a specific item outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createitemhistory method: PUT description: Xero Creates a history record for a specific item outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: false - name: Journals path: /Journals operations: - name: getjournals method: GET description: Xero Retrieves journals outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: offset in: query type: integer description: Offset by a specified journal number. e.g. journals with a JournalNumber greater than the offset will be returned - name: paymentsOnly in: query type: boolean description: Filter to retrieve journals on a cash basis. Journals are returned on an accrual basis by default. - name: Journals-JournalID path: /Journals/{JournalID} operations: - name: getjournal method: GET description: Xero Retrieves a specific journal using a unique journal Id. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: Journals-JournalNumber path: /Journals/{JournalNumber} operations: - name: getjournalbynumber method: GET description: Xero Retrieves a specific journal using a unique journal number. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: LinkedTransactions path: /LinkedTransactions operations: - name: getlinkedtransactions method: GET description: Xero Retrieves linked transactions (billable expenses) outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: page in: query type: integer description: Up to 100 linked transactions will be returned in a single API call. Use the page parameter to specify the page to be returned e.g. page=1. - name: LinkedTransactionID in: query type: string description: The Xero identifier for an Linked Transaction - name: SourceTransactionID in: query type: string description: Filter by the SourceTransactionID. Get the linked transactions created from a particular ACCPAY invoice - name: ContactID in: query type: string description: Filter by the ContactID. Get all the linked transactions that have been assigned to a particular customer. - name: Status in: query type: string description: Filter by the combination of ContactID and Status. Get the linked transactions associated to a customer and with a status - name: TargetTransactionID in: query type: string description: Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice - name: createlinkedtransaction method: PUT description: Xero Creates linked transactions (billable expenses) outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: LinkedTransactions-LinkedTransactionID path: /LinkedTransactions/{LinkedTransactionID} operations: - name: getlinkedtransaction method: GET description: Xero Retrieves a specific linked transaction (billable expenses) using a unique linked transaction Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updatelinkedtransaction method: POST description: Xero Updates a specific linked transactions (billable expenses) outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: deletelinkedtransaction method: DELETE description: Xero Deletes a specific linked transactions (billable expenses) outputRawFormat: json outputParameters: - name: result type: object value: $. - name: ManualJournals path: /ManualJournals operations: - name: getmanualjournals method: GET description: Xero Retrieves manual journals outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: where in: query type: string description: Filter by an any element - name: order in: query type: string description: Order by an any element - name: page in: query type: integer description: e.g. page=1 – Up to 100 manual journals will be returned in a single API call with line items shown for each overpayment - name: createmanualjournals method: PUT description: Xero Creates one or more manual journals outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: updateorcreatemanualjournals method: POST description: Xero Updates or creates a single manual journal outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ManualJournals-ManualJournalID path: /ManualJournals/{ManualJournalID} operations: - name: getmanualjournal method: GET description: Xero Retrieves a specific manual journal outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updatemanualjournal method: POST description: Xero Updates a specific manual journal outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ManualJournals-ManualJournalID-Attachments path: /ManualJournals/{ManualJournalID}/Attachments operations: - name: getmanualjournalattachments method: GET description: Xero Retrieves attachment for a specific manual journal outputRawFormat: json outputParameters: - name: result type: object value: $. - name: ManualJournals-ManualJournalID-Attachments-AttachmentID path: /ManualJournals/{ManualJournalID}/Attachments/{AttachmentID} operations: - name: getmanualjournalattachmentbyid method: GET description: Xero Allows you to retrieve a specific attachment from a specific manual journal using a unique attachment Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: ManualJournals-ManualJournalID-Attachments-FileName path: /ManualJournals/{ManualJournalID}/Attachments/{FileName} operations: - name: getmanualjournalattachmentbyfilename method: GET description: Xero Retrieves a specific attachment from a specific manual journal by file name outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updatemanualjournalattachmentbyfilename method: POST description: Xero Updates a specific attachment from a specific manual journal by file name outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: createmanualjournalattachmentbyfilename method: PUT description: Xero Creates a specific attachment for a specific manual journal by file name outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ManualJournals-ManualJournalID-History path: /ManualJournals/{ManualJournalID}/History operations: - name: getmanualjournalshistory method: GET description: Xero Retrieves history for a specific manual journal outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createmanualjournalhistoryrecord method: PUT description: Xero Creates a history record for a specific manual journal outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: false - name: Organisation path: /Organisation operations: - name: getorganisations method: GET description: Retrieves Xero organisation details outputRawFormat: json outputParameters: - name: result type: object value: $. - name: Organisation-Actions path: /Organisation/Actions operations: - name: getorganisationactions method: GET description: Retrieves a list of the key actions your app has permission to perform in the connected Xero organisation. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: Organisation-OrganisationID-CISSettings path: /Organisation/{OrganisationID}/CISSettings operations: - name: getorganisationcissettings method: GET description: Retrieves the CIS settings for the Xero organistaion. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: Overpayments path: /Overpayments operations: - name: getoverpayments method: GET description: Xero Retrieves overpayments outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: where in: query type: string description: Filter by an any element - name: order in: query type: string description: Order by an any element - name: page in: query type: integer description: e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment - name: References in: query type: array description: Filter by a comma-separated list of References - name: Overpayments-OverpaymentID path: /Overpayments/{OverpaymentID} operations: - name: getoverpayment method: GET description: Xero Retrieves a specific overpayment using a unique overpayment Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: Overpayments-OverpaymentID-Allocations path: /Overpayments/{OverpaymentID}/Allocations operations: - name: createoverpaymentallocations method: PUT description: Xero Creates a single allocation for a specific overpayment outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: Overpayments-OverpaymentID-Allocations-AllocationID path: /Overpayments/{OverpaymentID}/Allocations/{AllocationID} operations: - name: deleteoverpaymentallocations method: DELETE description: Xero Deletes an Allocation from an overpayment outputRawFormat: json outputParameters: - name: result type: object value: $. - name: Overpayments-OverpaymentID-History path: /Overpayments/{OverpaymentID}/History operations: - name: getoverpaymenthistory method: GET description: Xero Retrieves history records of a specific overpayment outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createoverpaymenthistory method: PUT description: Xero Creates a history record for a specific overpayment outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: false - name: PaymentServices path: /PaymentServices operations: - name: getpaymentservices method: GET description: Xero Retrieves payment services outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createpaymentservice method: PUT description: Xero Creates a payment service outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: Payments path: /Payments operations: - name: getpayments method: GET description: Xero Retrieves payments for invoices and credit notes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: where in: query type: string description: Filter by an any element - name: order in: query type: string description: Order by an any element - name: page in: query type: integer description: Up to 100 payments will be returned in a single API call - name: createpayments method: PUT description: Xero Creates multiple payments for invoices or credit notes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: createpayment method: POST description: Xero Creates a single payment for invoice or credit notes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: Payments-PaymentID path: /Payments/{PaymentID} operations: - name: getpayment method: GET description: Xero Retrieves a specific payment for invoices and credit notes using a unique payment Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: deletepayment method: POST description: Xero Updates a specific payment for invoices and credit notes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: Payments-PaymentID-History path: /Payments/{PaymentID}/History operations: - name: getpaymenthistory method: GET description: Xero Retrieves history records of a specific payment outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createpaymenthistory method: PUT description: Xero Creates a history record for a specific payment outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: false - name: Prepayments path: /Prepayments operations: - name: getprepayments method: GET description: Xero Retrieves prepayments outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: where in: query type: string description: Filter by an any element - name: order in: query type: string description: Order by an any element - name: page in: query type: integer description: e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each overpayment - name: InvoiceNumbers in: query type: array description: Filter by a comma-separated list of InvoiceNumbers - name: Prepayments-PrepaymentID path: /Prepayments/{PrepaymentID} operations: - name: getprepayment method: GET description: Xero Allows you to retrieve a specified prepayments outputRawFormat: json outputParameters: - name: result type: object value: $. - name: Prepayments-PrepaymentID-Allocations path: /Prepayments/{PrepaymentID}/Allocations operations: - name: createprepaymentallocations method: PUT description: Xero Allows you to create an Allocation for prepayments outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: Prepayments-PrepaymentID-Allocations-AllocationID path: /Prepayments/{PrepaymentID}/Allocations/{AllocationID} operations: - name: deleteprepaymentallocations method: DELETE description: Xero Deletes an Allocation from a Prepayment outputRawFormat: json outputParameters: - name: result type: object value: $. - name: Prepayments-PrepaymentID-History path: /Prepayments/{PrepaymentID}/History operations: - name: getprepaymenthistory method: GET description: Xero Retrieves history record for a specific prepayment outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createprepaymenthistory method: PUT description: Xero Creates a history record for a specific prepayment outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: false - name: PurchaseOrders path: /PurchaseOrders operations: - name: getpurchaseorders method: GET description: Xero Retrieves purchase orders outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: Status in: query type: string description: Filter by purchase order status - name: DateFrom in: query type: string description: Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31 - name: DateTo in: query type: string description: Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31 - name: order in: query type: string description: Order by an any element - name: page in: query type: integer description: 'To specify a page, append the page parameter to the URL e.g. ?page=1. If there are 100 records in the response you will need to check if there is any more data ' - name: createpurchaseorders method: PUT description: Xero Creates one or more purchase orders outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: updateorcreatepurchaseorders method: POST description: Xero Updates or creates one or more purchase orders outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: PurchaseOrders-PurchaseOrderID path: /PurchaseOrders/{PurchaseOrderID} operations: - name: getpurchaseorder method: GET description: Xero Retrieves a specific purchase order using a unique purchase order Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updatepurchaseorder method: POST description: Xero Updates a specific purchase order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: PurchaseOrders-PurchaseOrderID-Attachments path: /PurchaseOrders/{PurchaseOrderID}/Attachments operations: - name: getpurchaseorderattachments method: GET description: Xero Retrieves attachments for a specific purchase order outputRawFormat: json outputParameters: - name: result type: object value: $. - name: PurchaseOrders-PurchaseOrderID-Attachments-AttachmentID path: /PurchaseOrders/{PurchaseOrderID}/Attachments/{AttachmentID} operations: - name: getpurchaseorderattachmentbyid method: GET description: Xero Retrieves specific attachment for a specific purchase order using a unique attachment Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: PurchaseOrders-PurchaseOrderID-Attachments-FileName path: /PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName} operations: - name: getpurchaseorderattachmentbyfilename method: GET description: Xero Retrieves a specific attachment for a specific purchase order by filename outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updatepurchaseorderattachmentbyfilename method: POST description: Xero Updates a specific attachment for a specific purchase order by filename outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: createpurchaseorderattachmentbyfilename method: PUT description: Xero Creates attachment for a specific purchase order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: PurchaseOrders-PurchaseOrderID-History path: /PurchaseOrders/{PurchaseOrderID}/History operations: - name: getpurchaseorderhistory method: GET description: Xero Retrieves history for a specific purchase order outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createpurchaseorderhistory method: PUT description: Xero Creates a history record for a specific purchase orders outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: false - name: PurchaseOrders-PurchaseOrderID-pdf path: /PurchaseOrders/{PurchaseOrderID}/pdf operations: - name: getpurchaseorderaspdf method: GET description: Xero Retrieves specific purchase order as PDF files using a unique purchase order Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: PurchaseOrders-PurchaseOrderNumber path: /PurchaseOrders/{PurchaseOrderNumber} operations: - name: getpurchaseorderbynumber method: GET description: Xero Retrieves a specific purchase order using purchase order number outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: PurchaseOrderNumber in: path type: string description: Unique identifier for a PurchaseOrder required: true - name: Quotes path: /Quotes operations: - name: getquotes method: GET description: Xero Retrieves sales quotes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: DateFrom in: query type: string description: Filter for quotes after a particular date - name: DateTo in: query type: string description: Filter for quotes before a particular date - name: ExpiryDateFrom in: query type: string description: Filter for quotes expiring after a particular date - name: ExpiryDateTo in: query type: string description: Filter for quotes before a particular date - name: ContactID in: query type: string description: Filter for quotes belonging to a particular contact - name: Status in: query type: string description: Filter for quotes of a particular Status - name: page in: query type: integer description: e.g. page=1 – Up to 100 Quotes will be returned in a single API call with line items shown for each quote - name: order in: query type: string description: Order by an any element - name: QuoteNumber in: query type: string description: Filter by quote number (e.g. GET https://.../Quotes?QuoteNumber=QU-0001) - name: createquotes method: PUT description: Xero Create one or more quotes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: updateorcreatequotes method: POST description: Xero Updates or creates one or more quotes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: Quotes-QuoteID path: /Quotes/{QuoteID} operations: - name: getquote method: GET description: Xero Retrieves a specific quote using a unique quote Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updatequote method: POST description: Xero Updates a specific quote outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: Quotes-QuoteID-Attachments path: /Quotes/{QuoteID}/Attachments operations: - name: getquoteattachments method: GET description: Xero Retrieves attachments for a specific quote outputRawFormat: json outputParameters: - name: result type: object value: $. - name: Quotes-QuoteID-Attachments-AttachmentID path: /Quotes/{QuoteID}/Attachments/{AttachmentID} operations: - name: getquoteattachmentbyid method: GET description: Xero Retrieves a specific attachment from a specific quote using a unique attachment Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: Quotes-QuoteID-Attachments-FileName path: /Quotes/{QuoteID}/Attachments/{FileName} operations: - name: getquoteattachmentbyfilename method: GET description: Xero Retrieves a specific attachment from a specific quote by filename outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updatequoteattachmentbyfilename method: POST description: Xero Updates a specific attachment from a specific quote by filename outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: createquoteattachmentbyfilename method: PUT description: Xero Creates attachment for a specific quote outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: Quotes-QuoteID-History path: /Quotes/{QuoteID}/History operations: - name: getquotehistory method: GET description: Xero Retrieves history records of a specific quote outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createquotehistory method: PUT description: Xero Creates a history record for a specific quote outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: false - name: Quotes-QuoteID-pdf path: /Quotes/{QuoteID}/pdf operations: - name: getquoteaspdf method: GET description: Xero Retrieves a specific quote as a PDF file using a unique quote Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: Receipts path: /Receipts operations: - name: getreceipts method: GET description: Xero Retrieves draft expense claim receipts for any user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: where in: query type: string description: Filter by an any element - name: order in: query type: string description: Order by an any element - name: createreceipt method: PUT description: Xero Creates draft expense claim receipts for any user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: Receipts-ReceiptID path: /Receipts/{ReceiptID} operations: - name: getreceipt method: GET description: Xero Retrieves a specific draft expense claim receipt by using a unique receipt Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updatereceipt method: POST description: Xero Updates a specific draft expense claim receipts outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: Receipts-ReceiptID-Attachments path: /Receipts/{ReceiptID}/Attachments operations: - name: getreceiptattachments method: GET description: Xero Retrieves attachments for a specific expense claim receipt outputRawFormat: json outputParameters: - name: result type: object value: $. - name: Receipts-ReceiptID-Attachments-AttachmentID path: /Receipts/{ReceiptID}/Attachments/{AttachmentID} operations: - name: getreceiptattachmentbyid method: GET description: Xero Retrieves a specific attachments from a specific expense claim receipts by using a unique attachment Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: Receipts-ReceiptID-Attachments-FileName path: /Receipts/{ReceiptID}/Attachments/{FileName} operations: - name: getreceiptattachmentbyfilename method: GET description: Xero Retrieves a specific attachment from a specific expense claim receipts by file name outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updatereceiptattachmentbyfilename method: POST description: Xero Updates a specific attachment on a specific expense claim receipts by file name outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: createreceiptattachmentbyfilename method: PUT description: Xero Creates an attachment on a specific expense claim receipts by file name outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: Receipts-ReceiptID-History path: /Receipts/{ReceiptID}/History operations: - name: getreceipthistory method: GET description: Xero Retrieves a history record for a specific receipt outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createreceipthistory method: PUT description: Xero Creates a history record for a specific receipt outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: false - name: RepeatingInvoices path: /RepeatingInvoices operations: - name: getrepeatinginvoices method: GET description: Xero Retrieves repeating invoices outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: where in: query type: string description: Filter by an any element - name: order in: query type: string description: Order by an any element - name: createrepeatinginvoices method: PUT description: Xero Creates one or more repeating invoice templates outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: updateorcreaterepeatinginvoices method: POST description: Xero Creates or deletes one or more repeating invoice templates outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: RepeatingInvoices-RepeatingInvoiceID path: /RepeatingInvoices/{RepeatingInvoiceID} operations: - name: getrepeatinginvoice method: GET description: Xero Retrieves a specific repeating invoice by using a unique repeating invoice Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updaterepeatinginvoice method: POST description: Xero Deletes a specific repeating invoice template outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: RepeatingInvoices-RepeatingInvoiceID-Attachments path: /RepeatingInvoices/{RepeatingInvoiceID}/Attachments operations: - name: getrepeatinginvoiceattachments method: GET description: Xero Retrieves attachments from a specific repeating invoice outputRawFormat: json outputParameters: - name: result type: object value: $. - name: RepeatingInvoices-RepeatingInvoiceID-Attachments-AttachmentID path: /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{AttachmentID} operations: - name: getrepeatinginvoiceattachmentbyid method: GET description: Xero Retrieves a specific attachment from a specific repeating invoice outputRawFormat: json outputParameters: - name: result type: object value: $. - name: RepeatingInvoices-RepeatingInvoiceID-Attachments-FileName path: /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName} operations: - name: getrepeatinginvoiceattachmentbyfilename method: GET description: Xero Retrieves a specific attachment from a specific repeating invoices by file name outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updaterepeatinginvoiceattachmentbyfilename method: POST description: Xero Updates a specific attachment from a specific repeating invoices by file name outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: createrepeatinginvoiceattachmentbyfilename method: PUT description: Xero Creates an attachment from a specific repeating invoices by file name outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: RepeatingInvoices-RepeatingInvoiceID-History path: /RepeatingInvoices/{RepeatingInvoiceID}/History operations: - name: getrepeatinginvoicehistory method: GET description: Xero Retrieves history record for a specific repeating invoice outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createrepeatinginvoicehistory method: PUT description: Xero Creates a history record for a specific repeating invoice outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: false - name: Reports path: /Reports operations: - name: getreportslist method: GET description: Xero Retrieves a list of the organistaions unique reports that require a uuid to fetch outputRawFormat: json outputParameters: - name: result type: object value: $. - name: Reports-AgedPayablesByContact path: /Reports/AgedPayablesByContact operations: - name: getreportagedpayablesbycontact method: GET description: Xero Retrieves report for aged payables by contact outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: contactId in: query type: string description: Unique identifier for a Contact required: true - name: date in: query type: string description: The date of the Aged Payables By Contact report - name: Reports-AgedReceivablesByContact path: /Reports/AgedReceivablesByContact operations: - name: getreportagedreceivablesbycontact method: GET description: Xero Retrieves report for aged receivables by contact outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: contactId in: query type: string description: Unique identifier for a Contact required: true - name: date in: query type: string description: The date of the Aged Receivables By Contact report - name: Reports-BalanceSheet path: /Reports/BalanceSheet operations: - name: getreportbalancesheet method: GET description: Xero Retrieves report for balancesheet outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: date in: query type: string description: The date of the Balance Sheet report - name: periods in: query type: integer description: The number of periods for the Balance Sheet report - name: timeframe in: query type: string description: The period size to compare to (MONTH, QUARTER, YEAR) - name: trackingOptionID1 in: query type: string description: The tracking option 1 for the Balance Sheet report - name: trackingOptionID2 in: query type: string description: The tracking option 2 for the Balance Sheet report - name: standardLayout in: query type: boolean description: The standard layout boolean for the Balance Sheet report - name: paymentsOnly in: query type: boolean description: return a cash basis for the Balance Sheet report - name: Reports-BankSummary path: /Reports/BankSummary operations: - name: getreportbanksummary method: GET description: Xero Retrieves report for bank summary outputRawFormat: json outputParameters: - name: result type: object value: $. - name: Reports-BudgetSummary path: /Reports/BudgetSummary operations: - name: getreportbudgetsummary method: GET description: Xero Retrieves report for budget summary outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: date in: query type: string description: The date for the Bank Summary report e.g. 2018-03-31 - name: periods in: query type: integer description: The number of periods to compare (integer between 1 and 12) - name: timeframe in: query type: integer description: The period size to compare to (1=month, 3=quarter, 12=year) - name: Reports-ExecutiveSummary path: /Reports/ExecutiveSummary operations: - name: getreportexecutivesummary method: GET description: Xero Retrieves report for executive summary outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: date in: query type: string description: The date for the Bank Summary report e.g. 2018-03-31 - name: Reports-ProfitAndLoss path: /Reports/ProfitAndLoss operations: - name: getreportprofitandloss method: GET description: Xero Retrieves report for profit and loss outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: periods in: query type: integer description: The number of periods to compare (integer between 1 and 12) - name: timeframe in: query type: string description: The period size to compare to (MONTH, QUARTER, YEAR) - name: trackingCategoryID in: query type: string description: The trackingCategory 1 for the ProfitAndLoss report - name: trackingCategoryID2 in: query type: string description: The trackingCategory 2 for the ProfitAndLoss report - name: trackingOptionID in: query type: string description: The tracking option 1 for the ProfitAndLoss report - name: trackingOptionID2 in: query type: string description: The tracking option 2 for the ProfitAndLoss report - name: standardLayout in: query type: boolean description: Return the standard layout for the ProfitAndLoss report - name: paymentsOnly in: query type: boolean description: Return cash only basis for the ProfitAndLoss report - name: Reports-TenNinetyNine path: /Reports/TenNinetyNine operations: - name: getreporttenninetynine method: GET description: Xero Retrieve reports for 1099 outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: reportYear in: query type: string description: The year of the 1099 report - name: Reports-TrialBalance path: /Reports/TrialBalance operations: - name: getreporttrialbalance method: GET description: Xero Retrieves report for trial balance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: date in: query type: string description: The date for the Trial Balance report e.g. 2018-03-31 - name: paymentsOnly in: query type: boolean description: Return cash only basis for the Trial Balance report - name: Reports-ReportID path: /Reports/{ReportID} operations: - name: getreportfromid method: GET description: Xero Retrieves a specific report using a unique ReportID outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: ReportID in: path type: string description: Unique identifier for a Report required: true - name: Setup path: /Setup operations: - name: postsetup method: POST description: Xero Sets the chart of accounts, the conversion date and conversion balances outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: TaxRates path: /TaxRates operations: - name: gettaxrates method: GET description: Xero Retrieves tax rates outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: where in: query type: string description: Filter by an any element - name: order in: query type: string description: Order by an any element - name: createtaxrates method: PUT description: Xero Creates one or more tax rates outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: updatetaxrate method: POST description: Xero Updates tax rates outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: TaxRates-TaxType path: /TaxRates/{TaxType} operations: - name: gettaxratebytaxtype method: GET description: Xero Retrieves a specific tax rate according to given TaxType code outputRawFormat: json outputParameters: - name: result type: object value: $. - name: TrackingCategories path: /TrackingCategories operations: - name: gettrackingcategories method: GET description: Xero Retrieves tracking categories and options outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: where in: query type: string description: Filter by an any element - name: order in: query type: string description: Order by an any element - name: includeArchived in: query type: boolean description: e.g. includeArchived=true - Categories and options with a status of ARCHIVED will be included in the response - name: createtrackingcategory method: PUT description: Xero Create tracking categories outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: TrackingCategories-TrackingCategoryID path: /TrackingCategories/{TrackingCategoryID} operations: - name: gettrackingcategory method: GET description: Xero Retrieves specific tracking categories and options using a unique tracking category Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updatetrackingcategory method: POST description: Xero Updates a specific tracking category outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: deletetrackingcategory method: DELETE description: Xero Deletes a specific tracking category outputRawFormat: json outputParameters: - name: result type: object value: $. - name: TrackingCategories-TrackingCategoryID-Options path: /TrackingCategories/{TrackingCategoryID}/Options operations: - name: createtrackingoptions method: PUT description: Xero Creates options for a specific tracking category outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: TrackingCategories-TrackingCategoryID-Options-TrackingOptionID path: /TrackingCategories/{TrackingCategoryID}/Options/{TrackingOptionID} operations: - name: updatetrackingoptions method: POST description: Xero Updates a specific option for a specific tracking category outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: deletetrackingoptions method: DELETE description: Xero Deletes a specific option for a specific tracking category outputRawFormat: json outputParameters: - name: result type: object value: $. - name: Users path: /Users operations: - name: getusers method: GET description: Xero Retrieves users outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: where in: query type: string description: Filter by an any element - name: order in: query type: string description: Order by an any element - name: Users-UserID path: /Users/{UserID} operations: - name: getuser method: GET description: Xero Retrieves a specific user outputRawFormat: json outputParameters: - name: result type: object value: $. authentication: type: bearer token: '{{env.XERO_API_KEY}}' exposes: - type: rest namespace: accounting-accounting-rest port: 8080 description: REST adapter for Xero Accounting API — Accounting. One Spectral-compliant resource per consumed operation, prefixed with /v1. resources: - path: /v1/accounts name: accounts description: REST surface for Accounts. operations: - method: GET name: getaccounts description: Xero Retrieves the full chart of accounts call: accounting-accounting.getaccounts with: where: rest.where order: rest.order outputParameters: - type: object mapping: $. - method: PUT name: createaccount description: Xero Creates a new chart of accounts call: accounting-accounting.createaccount with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/accounts/{accountid} name: accounts-accountid description: REST surface for Accounts-AccountID. operations: - method: GET name: getaccount description: Xero Retrieves a single chart of accounts by using a unique account Id call: accounting-accounting.getaccount outputParameters: - type: object mapping: $. - method: POST name: updateaccount description: Xero Updates a chart of accounts call: accounting-accounting.updateaccount with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: deleteaccount description: Xero Deletes a chart of accounts call: accounting-accounting.deleteaccount outputParameters: - type: object mapping: $. - path: /v1/accounts/{accountid}/attachments name: accounts-accountid-attachments description: REST surface for Accounts-AccountID-Attachments. operations: - method: GET name: getaccountattachments description: Xero Retrieves attachments for a specific accounts by using a unique account Id call: accounting-accounting.getaccountattachments outputParameters: - type: object mapping: $. - path: /v1/accounts/{accountid}/attachments/{attachmentid} name: accounts-accountid-attachments-attachmentid description: REST surface for Accounts-AccountID-Attachments-AttachmentID. operations: - method: GET name: getaccountattachmentbyid description: Xero Retrieves a specific attachment from a specific account using a unique attachment Id call: accounting-accounting.getaccountattachmentbyid outputParameters: - type: object mapping: $. - path: /v1/accounts/{accountid}/attachments/{filename} name: accounts-accountid-attachments-filename description: REST surface for Accounts-AccountID-Attachments-FileName. operations: - method: GET name: getaccountattachmentbyfilename description: Xero Retrieves an attachment for a specific account by filename call: accounting-accounting.getaccountattachmentbyfilename outputParameters: - type: object mapping: $. - method: POST name: updateaccountattachmentbyfilename description: Xero Updates attachment on a specific account by filename call: accounting-accounting.updateaccountattachmentbyfilename with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: createaccountattachmentbyfilename description: Xero Creates an attachment on a specific account call: accounting-accounting.createaccountattachmentbyfilename with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/banktransactions name: banktransactions description: REST surface for BankTransactions. operations: - method: GET name: getbanktransactions description: Xero Retrieves any spent or received money transactions call: accounting-accounting.getbanktransactions with: where: rest.where order: rest.order page: rest.page outputParameters: - type: object mapping: $. - method: PUT name: createbanktransactions description: Xero Creates one or more spent or received money transaction call: accounting-accounting.createbanktransactions with: body: rest.body outputParameters: - type: object mapping: $. - method: POST name: updateorcreatebanktransactions description: Xero Updates or creates one or more spent or received money transaction call: accounting-accounting.updateorcreatebanktransactions with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/banktransactions/{banktransactionid} name: banktransactions-banktransactionid description: REST surface for BankTransactions-BankTransactionID. operations: - method: GET name: getbanktransaction description: Xero Retrieves a single spent or received money transaction by using a unique bank transaction Id call: accounting-accounting.getbanktransaction outputParameters: - type: object mapping: $. - method: POST name: updatebanktransaction description: Xero Updates a single spent or received money transaction call: accounting-accounting.updatebanktransaction with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/banktransactions/{banktransactionid}/attachments name: banktransactions-banktransactionid-attachments description: REST surface for BankTransactions-BankTransactionID-Attachments. operations: - method: GET name: getbanktransactionattachments description: Xero Retrieves any attachments from a specific bank transactions call: accounting-accounting.getbanktransactionattachments outputParameters: - type: object mapping: $. - path: /v1/banktransactions/{banktransactionid}/attachments/{attachmentid} name: banktransactions-banktransactionid-attachments-attachmentid description: REST surface for BankTransactions-BankTransactionID-Attachments-AttachmentID. operations: - method: GET name: getbanktransactionattachmentbyid description: Xero Retrieves specific attachments from a specific BankTransaction using a unique attachment Id call: accounting-accounting.getbanktransactionattachmentbyid outputParameters: - type: object mapping: $. - path: /v1/banktransactions/{banktransactionid}/attachments/{filename} name: banktransactions-banktransactionid-attachments-filename description: REST surface for BankTransactions-BankTransactionID-Attachments-FileName. operations: - method: GET name: getbanktransactionattachmentbyfilename description: Xero Retrieves a specific attachment from a specific bank transaction by filename call: accounting-accounting.getbanktransactionattachmentbyfilename outputParameters: - type: object mapping: $. - method: POST name: updatebanktransactionattachmentbyfilename description: Xero Updates a specific attachment from a specific bank transaction by filename call: accounting-accounting.updatebanktransactionattachmentbyfilename with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: createbanktransactionattachmentbyfilename description: Xero Creates an attachment for a specific bank transaction by filename call: accounting-accounting.createbanktransactionattachmentbyfilename with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/banktransactions/{banktransactionid}/history name: banktransactions-banktransactionid-history description: REST surface for BankTransactions-BankTransactionID-History. operations: - method: GET name: getbanktransactionshistory description: Xero Retrieves history from a specific bank transaction using a unique bank transaction Id call: accounting-accounting.getbanktransactionshistory outputParameters: - type: object mapping: $. - method: PUT name: createbanktransactionhistoryrecord description: Xero Creates a history record for a specific bank transactions call: accounting-accounting.createbanktransactionhistoryrecord with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/banktransfers name: banktransfers description: REST surface for BankTransfers. operations: - method: GET name: getbanktransfers description: Xero Retrieves all bank transfers call: accounting-accounting.getbanktransfers with: where: rest.where order: rest.order outputParameters: - type: object mapping: $. - method: PUT name: createbanktransfer description: Xero Creates a bank transfer call: accounting-accounting.createbanktransfer with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/banktransfers/{banktransferid} name: banktransfers-banktransferid description: REST surface for BankTransfers-BankTransferID. operations: - method: GET name: getbanktransfer description: Xero Retrieves specific bank transfers by using a unique bank transfer Id call: accounting-accounting.getbanktransfer outputParameters: - type: object mapping: $. - path: /v1/banktransfers/{banktransferid}/attachments name: banktransfers-banktransferid-attachments description: REST surface for BankTransfers-BankTransferID-Attachments. operations: - method: GET name: getbanktransferattachments description: Xero Retrieves attachments from a specific bank transfer call: accounting-accounting.getbanktransferattachments outputParameters: - type: object mapping: $. - path: /v1/banktransfers/{banktransferid}/attachments/{attachmentid} name: banktransfers-banktransferid-attachments-attachmentid description: REST surface for BankTransfers-BankTransferID-Attachments-AttachmentID. operations: - method: GET name: getbanktransferattachmentbyid description: Xero Retrieves a specific attachment from a specific bank transfer using a unique attachment ID call: accounting-accounting.getbanktransferattachmentbyid outputParameters: - type: object mapping: $. - path: /v1/banktransfers/{banktransferid}/attachments/{filename} name: banktransfers-banktransferid-attachments-filename description: REST surface for BankTransfers-BankTransferID-Attachments-FileName. operations: - method: GET name: getbanktransferattachmentbyfilename description: Xero Retrieves a specific attachment on a specific bank transfer by file name call: accounting-accounting.getbanktransferattachmentbyfilename outputParameters: - type: object mapping: $. - method: POST name: updatebanktransferattachmentbyfilename description: updatebanktransferattachmentbyfilename call: accounting-accounting.updatebanktransferattachmentbyfilename with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: createbanktransferattachmentbyfilename description: createbanktransferattachmentbyfilename call: accounting-accounting.createbanktransferattachmentbyfilename with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/banktransfers/{banktransferid}/history name: banktransfers-banktransferid-history description: REST surface for BankTransfers-BankTransferID-History. operations: - method: GET name: getbanktransferhistory description: Xero Retrieves history from a specific bank transfer using a unique bank transfer Id call: accounting-accounting.getbanktransferhistory outputParameters: - type: object mapping: $. - method: PUT name: createbanktransferhistoryrecord description: Xero Creates a history record for a specific bank transfer call: accounting-accounting.createbanktransferhistoryrecord with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/batchpayments name: batchpayments description: REST surface for BatchPayments. operations: - method: GET name: getbatchpayments description: Xero Retrieves either one or many batch payments for invoices call: accounting-accounting.getbatchpayments with: where: rest.where order: rest.order outputParameters: - type: object mapping: $. - method: PUT name: createbatchpayment description: Xero Creates one or many batch payments for invoices call: accounting-accounting.createbatchpayment with: body: rest.body outputParameters: - type: object mapping: $. - method: POST name: deletebatchpayment description: Xero Updates a specific batch payment for invoices and credit notes call: accounting-accounting.deletebatchpayment with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/batchpayments/{batchpaymentid} name: batchpayments-batchpaymentid description: REST surface for BatchPayments-BatchPaymentID. operations: - method: GET name: getbatchpayment description: Xero Retrieves a specific batch payment using a unique batch payment Id call: accounting-accounting.getbatchpayment outputParameters: - type: object mapping: $. - method: POST name: deletebatchpaymentbyurlparam description: Xero Updates a specific batch payment for invoices and credit notes call: accounting-accounting.deletebatchpaymentbyurlparam with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/batchpayments/{batchpaymentid}/history name: batchpayments-batchpaymentid-history description: REST surface for BatchPayments-BatchPaymentID-History. operations: - method: GET name: getbatchpaymenthistory description: Xero Retrieves history from a specific batch payment call: accounting-accounting.getbatchpaymenthistory outputParameters: - type: object mapping: $. - method: PUT name: createbatchpaymenthistoryrecord description: Xero Creates a history record for a specific batch payment call: accounting-accounting.createbatchpaymenthistoryrecord with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/brandingthemes name: brandingthemes description: REST surface for BrandingThemes. operations: - method: GET name: getbrandingthemes description: Xero Retrieves all the branding themes call: accounting-accounting.getbrandingthemes outputParameters: - type: object mapping: $. - path: /v1/brandingthemes/{brandingthemeid} name: brandingthemes-brandingthemeid description: REST surface for BrandingThemes-BrandingThemeID. operations: - method: GET name: getbrandingtheme description: Xero Retrieves a specific branding theme using a unique branding theme Id call: accounting-accounting.getbrandingtheme outputParameters: - type: object mapping: $. - path: /v1/brandingthemes/{brandingthemeid}/paymentservices name: brandingthemes-brandingthemeid-paymentservices description: REST surface for BrandingThemes-BrandingThemeID-PaymentServices. operations: - method: GET name: getbrandingthemepaymentservices description: Xero Retrieves the payment services for a specific branding theme call: accounting-accounting.getbrandingthemepaymentservices outputParameters: - type: object mapping: $. - method: POST name: createbrandingthemepaymentservices description: Xero Creates a new custom payment service for a specific branding theme call: accounting-accounting.createbrandingthemepaymentservices with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/budgets name: budgets description: REST surface for Budgets. operations: - method: GET name: getbudgets description: Xero Retrieve a list of budgets call: accounting-accounting.getbudgets with: IDs: rest.IDs DateTo: rest.DateTo DateFrom: rest.DateFrom outputParameters: - type: object mapping: $. - path: /v1/budgets/{budgetid} name: budgets-budgetid description: REST surface for Budgets-BudgetID. operations: - method: GET name: getbudget description: Xero Retrieves a specific budget, which includes budget lines call: accounting-accounting.getbudget with: DateTo: rest.DateTo DateFrom: rest.DateFrom outputParameters: - type: object mapping: $. - path: /v1/contactgroups name: contactgroups description: REST surface for ContactGroups. operations: - method: GET name: getcontactgroups description: Xero Retrieves the contact Id and name of each contact group call: accounting-accounting.getcontactgroups with: where: rest.where order: rest.order outputParameters: - type: object mapping: $. - method: PUT name: createcontactgroup description: Xero Creates a contact group call: accounting-accounting.createcontactgroup with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/contactgroups/{contactgroupid} name: contactgroups-contactgroupid description: REST surface for ContactGroups-ContactGroupID. operations: - method: GET name: getcontactgroup description: Xero Retrieves a specific contact group by using a unique contact group Id call: accounting-accounting.getcontactgroup outputParameters: - type: object mapping: $. - method: POST name: updatecontactgroup description: Xero Updates a specific contact group call: accounting-accounting.updatecontactgroup with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/contactgroups/{contactgroupid}/contacts name: contactgroups-contactgroupid-contacts description: REST surface for ContactGroups-ContactGroupID-Contacts. operations: - method: PUT name: createcontactgroupcontacts description: Xero Creates contacts to a specific contact group call: accounting-accounting.createcontactgroupcontacts with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: deletecontactgroupcontacts description: Xero Deletes all contacts from a specific contact group call: accounting-accounting.deletecontactgroupcontacts outputParameters: - type: object mapping: $. - path: /v1/contactgroups/{contactgroupid}/contacts/{contactid} name: contactgroups-contactgroupid-contacts-contactid description: REST surface for ContactGroups-ContactGroupID-Contacts-ContactID. operations: - method: DELETE name: deletecontactgroupcontact description: Xero Deletes a specific contact from a contact group using a unique contact Id call: accounting-accounting.deletecontactgroupcontact outputParameters: - type: object mapping: $. - path: /v1/contacts name: contacts description: REST surface for Contacts. operations: - method: GET name: getcontacts description: Retrieves all contacts in a Xero organisation call: accounting-accounting.getcontacts with: where: rest.where order: rest.order IDs: rest.IDs page: rest.page includeArchived: rest.includeArchived searchTerm: rest.searchTerm outputParameters: - type: object mapping: $. - method: PUT name: createcontacts description: Creates multiple contacts (bulk) in a Xero organisation call: accounting-accounting.createcontacts with: body: rest.body outputParameters: - type: object mapping: $. - method: POST name: updateorcreatecontacts description: Updates or creates one or more contacts in a Xero organisation call: accounting-accounting.updateorcreatecontacts with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/contacts/{contactid} name: contacts-contactid description: REST surface for Contacts-ContactID. operations: - method: GET name: getcontact description: Retrieves a specific contacts in a Xero organisation using a unique contact Id call: accounting-accounting.getcontact outputParameters: - type: object mapping: $. - method: POST name: updatecontact description: Updates a specific contact in a Xero organisation call: accounting-accounting.updatecontact with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/contacts/{contactid}/attachments name: contacts-contactid-attachments description: REST surface for Contacts-ContactID-Attachments. operations: - method: GET name: getcontactattachments description: Retrieves attachments for a specific contact in a Xero organisation call: accounting-accounting.getcontactattachments outputParameters: - type: object mapping: $. - path: /v1/contacts/{contactid}/attachments/{attachmentid} name: contacts-contactid-attachments-attachmentid description: REST surface for Contacts-ContactID-Attachments-AttachmentID. operations: - method: GET name: getcontactattachmentbyid description: Xero Retrieves a specific attachment from a specific contact using a unique attachment Id call: accounting-accounting.getcontactattachmentbyid outputParameters: - type: object mapping: $. - path: /v1/contacts/{contactid}/attachments/{filename} name: contacts-contactid-attachments-filename description: REST surface for Contacts-ContactID-Attachments-FileName. operations: - method: GET name: getcontactattachmentbyfilename description: Xero Retrieves a specific attachment from a specific contact by file name call: accounting-accounting.getcontactattachmentbyfilename outputParameters: - type: object mapping: $. - method: POST name: updatecontactattachmentbyfilename description: updatecontactattachmentbyfilename call: accounting-accounting.updatecontactattachmentbyfilename with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: createcontactattachmentbyfilename description: createcontactattachmentbyfilename call: accounting-accounting.createcontactattachmentbyfilename with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/contacts/{contactid}/cissettings name: contacts-contactid-cissettings description: REST surface for Contacts-ContactID-CISSettings. operations: - method: GET name: getcontactcissettings description: Retrieves CIS settings for a specific contact in a Xero organisation call: accounting-accounting.getcontactcissettings outputParameters: - type: object mapping: $. - path: /v1/contacts/{contactid}/history name: contacts-contactid-history description: REST surface for Contacts-ContactID-History. operations: - method: GET name: getcontacthistory description: Xero Retrieves history records for a specific contact call: accounting-accounting.getcontacthistory outputParameters: - type: object mapping: $. - method: PUT name: createcontacthistory description: Xero Creates a new history record for a specific contact call: accounting-accounting.createcontacthistory with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/contacts/{contactnumber} name: contacts-contactnumber description: REST surface for Contacts-ContactNumber. operations: - method: GET name: getcontactbycontactnumber description: Retrieves a specific contact by contact number in a Xero organisation call: accounting-accounting.getcontactbycontactnumber with: ContactNumber: rest.ContactNumber outputParameters: - type: object mapping: $. - path: /v1/creditnotes name: creditnotes description: REST surface for CreditNotes. operations: - method: GET name: getcreditnotes description: Xero Retrieves any credit notes call: accounting-accounting.getcreditnotes with: where: rest.where order: rest.order page: rest.page outputParameters: - type: object mapping: $. - method: PUT name: createcreditnotes description: Xero Creates a new credit note call: accounting-accounting.createcreditnotes with: body: rest.body outputParameters: - type: object mapping: $. - method: POST name: updateorcreatecreditnotes description: Xero Updates or creates one or more credit notes call: accounting-accounting.updateorcreatecreditnotes with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/creditnotes/{creditnoteid} name: creditnotes-creditnoteid description: REST surface for CreditNotes-CreditNoteID. operations: - method: GET name: getcreditnote description: Xero Retrieves a specific credit note using a unique credit note Id call: accounting-accounting.getcreditnote outputParameters: - type: object mapping: $. - method: POST name: updatecreditnote description: Xero Updates a specific credit note call: accounting-accounting.updatecreditnote with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/creditnotes/{creditnoteid}/allocations name: creditnotes-creditnoteid-allocations description: REST surface for CreditNotes-CreditNoteID-Allocations. operations: - method: PUT name: createcreditnoteallocation description: Xero Creates allocation for a specific credit note call: accounting-accounting.createcreditnoteallocation with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/creditnotes/{creditnoteid}/allocations/{allocationid} name: creditnotes-creditnoteid-allocations-allocationid description: REST surface for CreditNotes-CreditNoteID-Allocations-AllocationID. operations: - method: DELETE name: deletecreditnoteallocations description: Xero Deletes an Allocation from a Credit Note call: accounting-accounting.deletecreditnoteallocations outputParameters: - type: object mapping: $. - path: /v1/creditnotes/{creditnoteid}/attachments name: creditnotes-creditnoteid-attachments description: REST surface for CreditNotes-CreditNoteID-Attachments. operations: - method: GET name: getcreditnoteattachments description: Xero Retrieves attachments for a specific credit notes call: accounting-accounting.getcreditnoteattachments outputParameters: - type: object mapping: $. - path: /v1/creditnotes/{creditnoteid}/attachments/{attachmentid} name: creditnotes-creditnoteid-attachments-attachmentid description: REST surface for CreditNotes-CreditNoteID-Attachments-AttachmentID. operations: - method: GET name: getcreditnoteattachmentbyid description: Xero Retrieves a specific attachment from a specific credit note using a unique attachment Id call: accounting-accounting.getcreditnoteattachmentbyid outputParameters: - type: object mapping: $. - path: /v1/creditnotes/{creditnoteid}/attachments/{filename} name: creditnotes-creditnoteid-attachments-filename description: REST surface for CreditNotes-CreditNoteID-Attachments-FileName. operations: - method: GET name: getcreditnoteattachmentbyfilename description: Xero Retrieves a specific attachment on a specific credit note by file name call: accounting-accounting.getcreditnoteattachmentbyfilename outputParameters: - type: object mapping: $. - method: POST name: updatecreditnoteattachmentbyfilename description: Xero Updates attachments on a specific credit note by file name call: accounting-accounting.updatecreditnoteattachmentbyfilename with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: createcreditnoteattachmentbyfilename description: Xero Creates an attachment for a specific credit note call: accounting-accounting.createcreditnoteattachmentbyfilename with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/creditnotes/{creditnoteid}/history name: creditnotes-creditnoteid-history description: REST surface for CreditNotes-CreditNoteID-History. operations: - method: GET name: getcreditnotehistory description: Xero Retrieves history records of a specific credit note call: accounting-accounting.getcreditnotehistory outputParameters: - type: object mapping: $. - method: PUT name: createcreditnotehistory description: Xero Retrieves history records of a specific credit note call: accounting-accounting.createcreditnotehistory with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/creditnotes/{creditnoteid}/pdf name: creditnotes-creditnoteid-pdf description: REST surface for CreditNotes-CreditNoteID-pdf. operations: - method: GET name: getcreditnoteaspdf description: Xero Retrieves credit notes as PDF files call: accounting-accounting.getcreditnoteaspdf outputParameters: - type: object mapping: $. - path: /v1/currencies name: currencies description: REST surface for Currencies. operations: - method: GET name: getcurrencies description: Retrieves currencies for your Xero organisation call: accounting-accounting.getcurrencies with: where: rest.where order: rest.order outputParameters: - type: object mapping: $. - method: PUT name: createcurrency description: Create a new currency for a Xero organisation call: accounting-accounting.createcurrency with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/employees name: employees description: REST surface for Employees. operations: - method: GET name: getemployees description: Retrieves employees used in Xero payrun call: accounting-accounting.getemployees with: where: rest.where order: rest.order outputParameters: - type: object mapping: $. - method: PUT name: createemployees description: Creates new employees used in Xero payrun call: accounting-accounting.createemployees with: body: rest.body outputParameters: - type: object mapping: $. - method: POST name: updateorcreateemployees description: Creates a single new employees used in Xero payrun call: accounting-accounting.updateorcreateemployees with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/employees/{employeeid} name: employees-employeeid description: REST surface for Employees-EmployeeID. operations: - method: GET name: getemployee description: Retrieves a specific employee used in Xero payrun using a unique employee Id call: accounting-accounting.getemployee outputParameters: - type: object mapping: $. - path: /v1/expenseclaims name: expenseclaims description: REST surface for ExpenseClaims. operations: - method: GET name: getexpenseclaims description: Xero Retrieves expense claims call: accounting-accounting.getexpenseclaims with: where: rest.where order: rest.order outputParameters: - type: object mapping: $. - method: PUT name: createexpenseclaims description: Xero Creates expense claims call: accounting-accounting.createexpenseclaims with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/expenseclaims/{expenseclaimid} name: expenseclaims-expenseclaimid description: REST surface for ExpenseClaims-ExpenseClaimID. operations: - method: GET name: getexpenseclaim description: Xero Retrieves a specific expense claim using a unique expense claim Id call: accounting-accounting.getexpenseclaim outputParameters: - type: object mapping: $. - method: POST name: updateexpenseclaim description: Xero Updates a specific expense claims call: accounting-accounting.updateexpenseclaim with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/expenseclaims/{expenseclaimid}/history name: expenseclaims-expenseclaimid-history description: REST surface for ExpenseClaims-ExpenseClaimID-History. operations: - method: GET name: getexpenseclaimhistory description: Xero Retrieves history records of a specific expense claim call: accounting-accounting.getexpenseclaimhistory outputParameters: - type: object mapping: $. - method: PUT name: createexpenseclaimhistory description: Xero Creates a history record for a specific expense claim call: accounting-accounting.createexpenseclaimhistory with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/invoicereminders/settings name: invoicereminders-settings description: REST surface for InvoiceReminders-Settings. operations: - method: GET name: getinvoicereminders description: Xero Retrieves invoice reminder settings call: accounting-accounting.getinvoicereminders outputParameters: - type: object mapping: $. - path: /v1/invoices name: invoices description: REST surface for Invoices. operations: - method: GET name: getinvoices description: Xero Retrieves sales invoices or purchase bills call: accounting-accounting.getinvoices with: where: rest.where order: rest.order IDs: rest.IDs InvoiceNumbers: rest.InvoiceNumbers ContactIDs: rest.ContactIDs Statuses: rest.Statuses page: rest.page includeArchived: rest.includeArchived createdByMyApp: rest.createdByMyApp outputParameters: - type: object mapping: $. - method: PUT name: createinvoices description: Xero Creates one or more sales invoices or purchase bills call: accounting-accounting.createinvoices with: body: rest.body outputParameters: - type: object mapping: $. - method: POST name: updateorcreateinvoices description: Xero Updates or creates one or more sales invoices or purchase bills call: accounting-accounting.updateorcreateinvoices with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/invoices/{invoiceid} name: invoices-invoiceid description: REST surface for Invoices-InvoiceID. operations: - method: GET name: getinvoice description: Xero Retrieves a specific sales invoice or purchase bill using a unique invoice Id call: accounting-accounting.getinvoice outputParameters: - type: object mapping: $. - method: POST name: updateinvoice description: Xero Updates a specific sales invoices or purchase bills call: accounting-accounting.updateinvoice with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/invoices/{invoiceid}/attachments name: invoices-invoiceid-attachments description: REST surface for Invoices-InvoiceID-Attachments. operations: - method: GET name: getinvoiceattachments description: Xero Retrieves attachments for a specific invoice or purchase bill call: accounting-accounting.getinvoiceattachments outputParameters: - type: object mapping: $. - path: /v1/invoices/{invoiceid}/attachments/{attachmentid} name: invoices-invoiceid-attachments-attachmentid description: REST surface for Invoices-InvoiceID-Attachments-AttachmentID. operations: - method: GET name: getinvoiceattachmentbyid description: Xero Retrieves a specific attachment from a specific invoices or purchase bills by using a unique attachment Id call: accounting-accounting.getinvoiceattachmentbyid outputParameters: - type: object mapping: $. - path: /v1/invoices/{invoiceid}/attachments/{filename} name: invoices-invoiceid-attachments-filename description: REST surface for Invoices-InvoiceID-Attachments-FileName. operations: - method: GET name: getinvoiceattachmentbyfilename description: Xero Retrieves an attachment from a specific invoice or purchase bill by filename call: accounting-accounting.getinvoiceattachmentbyfilename outputParameters: - type: object mapping: $. - method: POST name: updateinvoiceattachmentbyfilename description: Xero Updates an attachment from a specific invoices or purchase bill by filename call: accounting-accounting.updateinvoiceattachmentbyfilename with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: createinvoiceattachmentbyfilename description: Xero Creates an attachment for a specific invoice or purchase bill by filename call: accounting-accounting.createinvoiceattachmentbyfilename with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/invoices/{invoiceid}/email name: invoices-invoiceid-email description: REST surface for Invoices-InvoiceID-Email. operations: - method: POST name: emailinvoice description: Xero Sends a copy of a specific invoice to related contact via email call: accounting-accounting.emailinvoice with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/invoices/{invoiceid}/history name: invoices-invoiceid-history description: REST surface for Invoices-InvoiceID-History. operations: - method: GET name: getinvoicehistory description: Xero Retrieves history records for a specific invoice call: accounting-accounting.getinvoicehistory outputParameters: - type: object mapping: $. - method: PUT name: createinvoicehistory description: Xero Creates a history record for a specific invoice call: accounting-accounting.createinvoicehistory with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/invoices/{invoiceid}/onlineinvoice name: invoices-invoiceid-onlineinvoice description: REST surface for Invoices-InvoiceID-OnlineInvoice. operations: - method: GET name: getonlineinvoice description: Xero Retrieves a URL to an online invoice call: accounting-accounting.getonlineinvoice outputParameters: - type: object mapping: $. - path: /v1/invoices/{invoiceid}/pdf name: invoices-invoiceid-pdf description: REST surface for Invoices-InvoiceID-pdf. operations: - method: GET name: getinvoiceaspdf description: Xero Retrieves invoices or purchase bills as PDF files call: accounting-accounting.getinvoiceaspdf outputParameters: - type: object mapping: $. - path: /v1/items name: items description: REST surface for Items. operations: - method: GET name: getitems description: Xero Retrieves items call: accounting-accounting.getitems with: where: rest.where order: rest.order outputParameters: - type: object mapping: $. - method: PUT name: createitems description: Xero Creates one or more items call: accounting-accounting.createitems with: body: rest.body outputParameters: - type: object mapping: $. - method: POST name: updateorcreateitems description: Xero Updates or creates one or more items call: accounting-accounting.updateorcreateitems with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/items/{itemid} name: items-itemid description: REST surface for Items-ItemID. operations: - method: GET name: getitem description: Xero Retrieves a specific item using a unique item Id call: accounting-accounting.getitem outputParameters: - type: object mapping: $. - method: POST name: updateitem description: Xero Updates a specific item call: accounting-accounting.updateitem with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: deleteitem description: Xero Deletes a specific item call: accounting-accounting.deleteitem outputParameters: - type: object mapping: $. - path: /v1/items/{itemid}/history name: items-itemid-history description: REST surface for Items-ItemID-History. operations: - method: GET name: getitemhistory description: Xero Retrieves history for a specific item call: accounting-accounting.getitemhistory outputParameters: - type: object mapping: $. - method: PUT name: createitemhistory description: Xero Creates a history record for a specific item call: accounting-accounting.createitemhistory with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/journals name: journals description: REST surface for Journals. operations: - method: GET name: getjournals description: Xero Retrieves journals call: accounting-accounting.getjournals with: offset: rest.offset paymentsOnly: rest.paymentsOnly outputParameters: - type: object mapping: $. - path: /v1/journals/{journalid} name: journals-journalid description: REST surface for Journals-JournalID. operations: - method: GET name: getjournal description: Xero Retrieves a specific journal using a unique journal Id. call: accounting-accounting.getjournal outputParameters: - type: object mapping: $. - path: /v1/journals/{journalnumber} name: journals-journalnumber description: REST surface for Journals-JournalNumber. operations: - method: GET name: getjournalbynumber description: Xero Retrieves a specific journal using a unique journal number. call: accounting-accounting.getjournalbynumber outputParameters: - type: object mapping: $. - path: /v1/linkedtransactions name: linkedtransactions description: REST surface for LinkedTransactions. operations: - method: GET name: getlinkedtransactions description: Xero Retrieves linked transactions (billable expenses) call: accounting-accounting.getlinkedtransactions with: page: rest.page LinkedTransactionID: rest.LinkedTransactionID SourceTransactionID: rest.SourceTransactionID ContactID: rest.ContactID Status: rest.Status TargetTransactionID: rest.TargetTransactionID outputParameters: - type: object mapping: $. - method: PUT name: createlinkedtransaction description: Xero Creates linked transactions (billable expenses) call: accounting-accounting.createlinkedtransaction with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/linkedtransactions/{linkedtransactionid} name: linkedtransactions-linkedtransactionid description: REST surface for LinkedTransactions-LinkedTransactionID. operations: - method: GET name: getlinkedtransaction description: Xero Retrieves a specific linked transaction (billable expenses) using a unique linked transaction Id call: accounting-accounting.getlinkedtransaction outputParameters: - type: object mapping: $. - method: POST name: updatelinkedtransaction description: Xero Updates a specific linked transactions (billable expenses) call: accounting-accounting.updatelinkedtransaction with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: deletelinkedtransaction description: Xero Deletes a specific linked transactions (billable expenses) call: accounting-accounting.deletelinkedtransaction outputParameters: - type: object mapping: $. - path: /v1/manualjournals name: manualjournals description: REST surface for ManualJournals. operations: - method: GET name: getmanualjournals description: Xero Retrieves manual journals call: accounting-accounting.getmanualjournals with: where: rest.where order: rest.order page: rest.page outputParameters: - type: object mapping: $. - method: PUT name: createmanualjournals description: Xero Creates one or more manual journals call: accounting-accounting.createmanualjournals with: body: rest.body outputParameters: - type: object mapping: $. - method: POST name: updateorcreatemanualjournals description: Xero Updates or creates a single manual journal call: accounting-accounting.updateorcreatemanualjournals with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/manualjournals/{manualjournalid} name: manualjournals-manualjournalid description: REST surface for ManualJournals-ManualJournalID. operations: - method: GET name: getmanualjournal description: Xero Retrieves a specific manual journal call: accounting-accounting.getmanualjournal outputParameters: - type: object mapping: $. - method: POST name: updatemanualjournal description: Xero Updates a specific manual journal call: accounting-accounting.updatemanualjournal with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/manualjournals/{manualjournalid}/attachments name: manualjournals-manualjournalid-attachments description: REST surface for ManualJournals-ManualJournalID-Attachments. operations: - method: GET name: getmanualjournalattachments description: Xero Retrieves attachment for a specific manual journal call: accounting-accounting.getmanualjournalattachments outputParameters: - type: object mapping: $. - path: /v1/manualjournals/{manualjournalid}/attachments/{attachmentid} name: manualjournals-manualjournalid-attachments-attachmentid description: REST surface for ManualJournals-ManualJournalID-Attachments-AttachmentID. operations: - method: GET name: getmanualjournalattachmentbyid description: Xero Allows you to retrieve a specific attachment from a specific manual journal using a unique attachment Id call: accounting-accounting.getmanualjournalattachmentbyid outputParameters: - type: object mapping: $. - path: /v1/manualjournals/{manualjournalid}/attachments/{filename} name: manualjournals-manualjournalid-attachments-filename description: REST surface for ManualJournals-ManualJournalID-Attachments-FileName. operations: - method: GET name: getmanualjournalattachmentbyfilename description: Xero Retrieves a specific attachment from a specific manual journal by file name call: accounting-accounting.getmanualjournalattachmentbyfilename outputParameters: - type: object mapping: $. - method: POST name: updatemanualjournalattachmentbyfilename description: Xero Updates a specific attachment from a specific manual journal by file name call: accounting-accounting.updatemanualjournalattachmentbyfilename with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: createmanualjournalattachmentbyfilename description: Xero Creates a specific attachment for a specific manual journal by file name call: accounting-accounting.createmanualjournalattachmentbyfilename with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/manualjournals/{manualjournalid}/history name: manualjournals-manualjournalid-history description: REST surface for ManualJournals-ManualJournalID-History. operations: - method: GET name: getmanualjournalshistory description: Xero Retrieves history for a specific manual journal call: accounting-accounting.getmanualjournalshistory outputParameters: - type: object mapping: $. - method: PUT name: createmanualjournalhistoryrecord description: Xero Creates a history record for a specific manual journal call: accounting-accounting.createmanualjournalhistoryrecord with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/organisation name: organisation description: REST surface for Organisation. operations: - method: GET name: getorganisations description: Retrieves Xero organisation details call: accounting-accounting.getorganisations outputParameters: - type: object mapping: $. - path: /v1/organisation/actions name: organisation-actions description: REST surface for Organisation-Actions. operations: - method: GET name: getorganisationactions description: Retrieves a list of the key actions your app has permission to perform in the connected Xero organisation. call: accounting-accounting.getorganisationactions outputParameters: - type: object mapping: $. - path: /v1/organisation/{organisationid}/cissettings name: organisation-organisationid-cissettings description: REST surface for Organisation-OrganisationID-CISSettings. operations: - method: GET name: getorganisationcissettings description: Retrieves the CIS settings for the Xero organistaion. call: accounting-accounting.getorganisationcissettings outputParameters: - type: object mapping: $. - path: /v1/overpayments name: overpayments description: REST surface for Overpayments. operations: - method: GET name: getoverpayments description: Xero Retrieves overpayments call: accounting-accounting.getoverpayments with: where: rest.where order: rest.order page: rest.page References: rest.References outputParameters: - type: object mapping: $. - path: /v1/overpayments/{overpaymentid} name: overpayments-overpaymentid description: REST surface for Overpayments-OverpaymentID. operations: - method: GET name: getoverpayment description: Xero Retrieves a specific overpayment using a unique overpayment Id call: accounting-accounting.getoverpayment outputParameters: - type: object mapping: $. - path: /v1/overpayments/{overpaymentid}/allocations name: overpayments-overpaymentid-allocations description: REST surface for Overpayments-OverpaymentID-Allocations. operations: - method: PUT name: createoverpaymentallocations description: Xero Creates a single allocation for a specific overpayment call: accounting-accounting.createoverpaymentallocations with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/overpayments/{overpaymentid}/allocations/{allocationid} name: overpayments-overpaymentid-allocations-allocationid description: REST surface for Overpayments-OverpaymentID-Allocations-AllocationID. operations: - method: DELETE name: deleteoverpaymentallocations description: Xero Deletes an Allocation from an overpayment call: accounting-accounting.deleteoverpaymentallocations outputParameters: - type: object mapping: $. - path: /v1/overpayments/{overpaymentid}/history name: overpayments-overpaymentid-history description: REST surface for Overpayments-OverpaymentID-History. operations: - method: GET name: getoverpaymenthistory description: Xero Retrieves history records of a specific overpayment call: accounting-accounting.getoverpaymenthistory outputParameters: - type: object mapping: $. - method: PUT name: createoverpaymenthistory description: Xero Creates a history record for a specific overpayment call: accounting-accounting.createoverpaymenthistory with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/paymentservices name: paymentservices description: REST surface for PaymentServices. operations: - method: GET name: getpaymentservices description: Xero Retrieves payment services call: accounting-accounting.getpaymentservices outputParameters: - type: object mapping: $. - method: PUT name: createpaymentservice description: Xero Creates a payment service call: accounting-accounting.createpaymentservice with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/payments name: payments description: REST surface for Payments. operations: - method: GET name: getpayments description: Xero Retrieves payments for invoices and credit notes call: accounting-accounting.getpayments with: where: rest.where order: rest.order page: rest.page outputParameters: - type: object mapping: $. - method: PUT name: createpayments description: Xero Creates multiple payments for invoices or credit notes call: accounting-accounting.createpayments with: body: rest.body outputParameters: - type: object mapping: $. - method: POST name: createpayment description: Xero Creates a single payment for invoice or credit notes call: accounting-accounting.createpayment with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/payments/{paymentid} name: payments-paymentid description: REST surface for Payments-PaymentID. operations: - method: GET name: getpayment description: Xero Retrieves a specific payment for invoices and credit notes using a unique payment Id call: accounting-accounting.getpayment outputParameters: - type: object mapping: $. - method: POST name: deletepayment description: Xero Updates a specific payment for invoices and credit notes call: accounting-accounting.deletepayment with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/payments/{paymentid}/history name: payments-paymentid-history description: REST surface for Payments-PaymentID-History. operations: - method: GET name: getpaymenthistory description: Xero Retrieves history records of a specific payment call: accounting-accounting.getpaymenthistory outputParameters: - type: object mapping: $. - method: PUT name: createpaymenthistory description: Xero Creates a history record for a specific payment call: accounting-accounting.createpaymenthistory with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/prepayments name: prepayments description: REST surface for Prepayments. operations: - method: GET name: getprepayments description: Xero Retrieves prepayments call: accounting-accounting.getprepayments with: where: rest.where order: rest.order page: rest.page InvoiceNumbers: rest.InvoiceNumbers outputParameters: - type: object mapping: $. - path: /v1/prepayments/{prepaymentid} name: prepayments-prepaymentid description: REST surface for Prepayments-PrepaymentID. operations: - method: GET name: getprepayment description: Xero Allows you to retrieve a specified prepayments call: accounting-accounting.getprepayment outputParameters: - type: object mapping: $. - path: /v1/prepayments/{prepaymentid}/allocations name: prepayments-prepaymentid-allocations description: REST surface for Prepayments-PrepaymentID-Allocations. operations: - method: PUT name: createprepaymentallocations description: Xero Allows you to create an Allocation for prepayments call: accounting-accounting.createprepaymentallocations with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/prepayments/{prepaymentid}/allocations/{allocationid} name: prepayments-prepaymentid-allocations-allocationid description: REST surface for Prepayments-PrepaymentID-Allocations-AllocationID. operations: - method: DELETE name: deleteprepaymentallocations description: Xero Deletes an Allocation from a Prepayment call: accounting-accounting.deleteprepaymentallocations outputParameters: - type: object mapping: $. - path: /v1/prepayments/{prepaymentid}/history name: prepayments-prepaymentid-history description: REST surface for Prepayments-PrepaymentID-History. operations: - method: GET name: getprepaymenthistory description: Xero Retrieves history record for a specific prepayment call: accounting-accounting.getprepaymenthistory outputParameters: - type: object mapping: $. - method: PUT name: createprepaymenthistory description: Xero Creates a history record for a specific prepayment call: accounting-accounting.createprepaymenthistory with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/purchaseorders name: purchaseorders description: REST surface for PurchaseOrders. operations: - method: GET name: getpurchaseorders description: Xero Retrieves purchase orders call: accounting-accounting.getpurchaseorders with: Status: rest.Status DateFrom: rest.DateFrom DateTo: rest.DateTo order: rest.order page: rest.page outputParameters: - type: object mapping: $. - method: PUT name: createpurchaseorders description: Xero Creates one or more purchase orders call: accounting-accounting.createpurchaseorders with: body: rest.body outputParameters: - type: object mapping: $. - method: POST name: updateorcreatepurchaseorders description: Xero Updates or creates one or more purchase orders call: accounting-accounting.updateorcreatepurchaseorders with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/purchaseorders/{purchaseorderid} name: purchaseorders-purchaseorderid description: REST surface for PurchaseOrders-PurchaseOrderID. operations: - method: GET name: getpurchaseorder description: Xero Retrieves a specific purchase order using a unique purchase order Id call: accounting-accounting.getpurchaseorder outputParameters: - type: object mapping: $. - method: POST name: updatepurchaseorder description: Xero Updates a specific purchase order call: accounting-accounting.updatepurchaseorder with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/purchaseorders/{purchaseorderid}/attachments name: purchaseorders-purchaseorderid-attachments description: REST surface for PurchaseOrders-PurchaseOrderID-Attachments. operations: - method: GET name: getpurchaseorderattachments description: Xero Retrieves attachments for a specific purchase order call: accounting-accounting.getpurchaseorderattachments outputParameters: - type: object mapping: $. - path: /v1/purchaseorders/{purchaseorderid}/attachments/{attachmentid} name: purchaseorders-purchaseorderid-attachments-attachmentid description: REST surface for PurchaseOrders-PurchaseOrderID-Attachments-AttachmentID. operations: - method: GET name: getpurchaseorderattachmentbyid description: Xero Retrieves specific attachment for a specific purchase order using a unique attachment Id call: accounting-accounting.getpurchaseorderattachmentbyid outputParameters: - type: object mapping: $. - path: /v1/purchaseorders/{purchaseorderid}/attachments/{filename} name: purchaseorders-purchaseorderid-attachments-filename description: REST surface for PurchaseOrders-PurchaseOrderID-Attachments-FileName. operations: - method: GET name: getpurchaseorderattachmentbyfilename description: Xero Retrieves a specific attachment for a specific purchase order by filename call: accounting-accounting.getpurchaseorderattachmentbyfilename outputParameters: - type: object mapping: $. - method: POST name: updatepurchaseorderattachmentbyfilename description: Xero Updates a specific attachment for a specific purchase order by filename call: accounting-accounting.updatepurchaseorderattachmentbyfilename with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: createpurchaseorderattachmentbyfilename description: Xero Creates attachment for a specific purchase order call: accounting-accounting.createpurchaseorderattachmentbyfilename with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/purchaseorders/{purchaseorderid}/history name: purchaseorders-purchaseorderid-history description: REST surface for PurchaseOrders-PurchaseOrderID-History. operations: - method: GET name: getpurchaseorderhistory description: Xero Retrieves history for a specific purchase order call: accounting-accounting.getpurchaseorderhistory outputParameters: - type: object mapping: $. - method: PUT name: createpurchaseorderhistory description: Xero Creates a history record for a specific purchase orders call: accounting-accounting.createpurchaseorderhistory with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/purchaseorders/{purchaseorderid}/pdf name: purchaseorders-purchaseorderid-pdf description: REST surface for PurchaseOrders-PurchaseOrderID-pdf. operations: - method: GET name: getpurchaseorderaspdf description: Xero Retrieves specific purchase order as PDF files using a unique purchase order Id call: accounting-accounting.getpurchaseorderaspdf outputParameters: - type: object mapping: $. - path: /v1/purchaseorders/{purchaseordernumber} name: purchaseorders-purchaseordernumber description: REST surface for PurchaseOrders-PurchaseOrderNumber. operations: - method: GET name: getpurchaseorderbynumber description: Xero Retrieves a specific purchase order using purchase order number call: accounting-accounting.getpurchaseorderbynumber with: PurchaseOrderNumber: rest.PurchaseOrderNumber outputParameters: - type: object mapping: $. - path: /v1/quotes name: quotes description: REST surface for Quotes. operations: - method: GET name: getquotes description: Xero Retrieves sales quotes call: accounting-accounting.getquotes with: DateFrom: rest.DateFrom DateTo: rest.DateTo ExpiryDateFrom: rest.ExpiryDateFrom ExpiryDateTo: rest.ExpiryDateTo ContactID: rest.ContactID Status: rest.Status page: rest.page order: rest.order QuoteNumber: rest.QuoteNumber outputParameters: - type: object mapping: $. - method: PUT name: createquotes description: Xero Create one or more quotes call: accounting-accounting.createquotes with: body: rest.body outputParameters: - type: object mapping: $. - method: POST name: updateorcreatequotes description: Xero Updates or creates one or more quotes call: accounting-accounting.updateorcreatequotes with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/quotes/{quoteid} name: quotes-quoteid description: REST surface for Quotes-QuoteID. operations: - method: GET name: getquote description: Xero Retrieves a specific quote using a unique quote Id call: accounting-accounting.getquote outputParameters: - type: object mapping: $. - method: POST name: updatequote description: Xero Updates a specific quote call: accounting-accounting.updatequote with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/quotes/{quoteid}/attachments name: quotes-quoteid-attachments description: REST surface for Quotes-QuoteID-Attachments. operations: - method: GET name: getquoteattachments description: Xero Retrieves attachments for a specific quote call: accounting-accounting.getquoteattachments outputParameters: - type: object mapping: $. - path: /v1/quotes/{quoteid}/attachments/{attachmentid} name: quotes-quoteid-attachments-attachmentid description: REST surface for Quotes-QuoteID-Attachments-AttachmentID. operations: - method: GET name: getquoteattachmentbyid description: Xero Retrieves a specific attachment from a specific quote using a unique attachment Id call: accounting-accounting.getquoteattachmentbyid outputParameters: - type: object mapping: $. - path: /v1/quotes/{quoteid}/attachments/{filename} name: quotes-quoteid-attachments-filename description: REST surface for Quotes-QuoteID-Attachments-FileName. operations: - method: GET name: getquoteattachmentbyfilename description: Xero Retrieves a specific attachment from a specific quote by filename call: accounting-accounting.getquoteattachmentbyfilename outputParameters: - type: object mapping: $. - method: POST name: updatequoteattachmentbyfilename description: Xero Updates a specific attachment from a specific quote by filename call: accounting-accounting.updatequoteattachmentbyfilename with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: createquoteattachmentbyfilename description: Xero Creates attachment for a specific quote call: accounting-accounting.createquoteattachmentbyfilename with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/quotes/{quoteid}/history name: quotes-quoteid-history description: REST surface for Quotes-QuoteID-History. operations: - method: GET name: getquotehistory description: Xero Retrieves history records of a specific quote call: accounting-accounting.getquotehistory outputParameters: - type: object mapping: $. - method: PUT name: createquotehistory description: Xero Creates a history record for a specific quote call: accounting-accounting.createquotehistory with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/quotes/{quoteid}/pdf name: quotes-quoteid-pdf description: REST surface for Quotes-QuoteID-pdf. operations: - method: GET name: getquoteaspdf description: Xero Retrieves a specific quote as a PDF file using a unique quote Id call: accounting-accounting.getquoteaspdf outputParameters: - type: object mapping: $. - path: /v1/receipts name: receipts description: REST surface for Receipts. operations: - method: GET name: getreceipts description: Xero Retrieves draft expense claim receipts for any user call: accounting-accounting.getreceipts with: where: rest.where order: rest.order outputParameters: - type: object mapping: $. - method: PUT name: createreceipt description: Xero Creates draft expense claim receipts for any user call: accounting-accounting.createreceipt with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/receipts/{receiptid} name: receipts-receiptid description: REST surface for Receipts-ReceiptID. operations: - method: GET name: getreceipt description: Xero Retrieves a specific draft expense claim receipt by using a unique receipt Id call: accounting-accounting.getreceipt outputParameters: - type: object mapping: $. - method: POST name: updatereceipt description: Xero Updates a specific draft expense claim receipts call: accounting-accounting.updatereceipt with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/receipts/{receiptid}/attachments name: receipts-receiptid-attachments description: REST surface for Receipts-ReceiptID-Attachments. operations: - method: GET name: getreceiptattachments description: Xero Retrieves attachments for a specific expense claim receipt call: accounting-accounting.getreceiptattachments outputParameters: - type: object mapping: $. - path: /v1/receipts/{receiptid}/attachments/{attachmentid} name: receipts-receiptid-attachments-attachmentid description: REST surface for Receipts-ReceiptID-Attachments-AttachmentID. operations: - method: GET name: getreceiptattachmentbyid description: Xero Retrieves a specific attachments from a specific expense claim receipts by using a unique attachment Id call: accounting-accounting.getreceiptattachmentbyid outputParameters: - type: object mapping: $. - path: /v1/receipts/{receiptid}/attachments/{filename} name: receipts-receiptid-attachments-filename description: REST surface for Receipts-ReceiptID-Attachments-FileName. operations: - method: GET name: getreceiptattachmentbyfilename description: Xero Retrieves a specific attachment from a specific expense claim receipts by file name call: accounting-accounting.getreceiptattachmentbyfilename outputParameters: - type: object mapping: $. - method: POST name: updatereceiptattachmentbyfilename description: Xero Updates a specific attachment on a specific expense claim receipts by file name call: accounting-accounting.updatereceiptattachmentbyfilename with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: createreceiptattachmentbyfilename description: Xero Creates an attachment on a specific expense claim receipts by file name call: accounting-accounting.createreceiptattachmentbyfilename with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/receipts/{receiptid}/history name: receipts-receiptid-history description: REST surface for Receipts-ReceiptID-History. operations: - method: GET name: getreceipthistory description: Xero Retrieves a history record for a specific receipt call: accounting-accounting.getreceipthistory outputParameters: - type: object mapping: $. - method: PUT name: createreceipthistory description: Xero Creates a history record for a specific receipt call: accounting-accounting.createreceipthistory with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/repeatinginvoices name: repeatinginvoices description: REST surface for RepeatingInvoices. operations: - method: GET name: getrepeatinginvoices description: Xero Retrieves repeating invoices call: accounting-accounting.getrepeatinginvoices with: where: rest.where order: rest.order outputParameters: - type: object mapping: $. - method: PUT name: createrepeatinginvoices description: Xero Creates one or more repeating invoice templates call: accounting-accounting.createrepeatinginvoices with: body: rest.body outputParameters: - type: object mapping: $. - method: POST name: updateorcreaterepeatinginvoices description: Xero Creates or deletes one or more repeating invoice templates call: accounting-accounting.updateorcreaterepeatinginvoices with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/repeatinginvoices/{repeatinginvoiceid} name: repeatinginvoices-repeatinginvoiceid description: REST surface for RepeatingInvoices-RepeatingInvoiceID. operations: - method: GET name: getrepeatinginvoice description: Xero Retrieves a specific repeating invoice by using a unique repeating invoice Id call: accounting-accounting.getrepeatinginvoice outputParameters: - type: object mapping: $. - method: POST name: updaterepeatinginvoice description: Xero Deletes a specific repeating invoice template call: accounting-accounting.updaterepeatinginvoice with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/repeatinginvoices/{repeatinginvoiceid}/attachments name: repeatinginvoices-repeatinginvoiceid-attachments description: REST surface for RepeatingInvoices-RepeatingInvoiceID-Attachments. operations: - method: GET name: getrepeatinginvoiceattachments description: Xero Retrieves attachments from a specific repeating invoice call: accounting-accounting.getrepeatinginvoiceattachments outputParameters: - type: object mapping: $. - path: /v1/repeatinginvoices/{repeatinginvoiceid}/attachments/{attachmentid} name: repeatinginvoices-repeatinginvoiceid-attachments-attachmentid description: REST surface for RepeatingInvoices-RepeatingInvoiceID-Attachments-AttachmentID. operations: - method: GET name: getrepeatinginvoiceattachmentbyid description: Xero Retrieves a specific attachment from a specific repeating invoice call: accounting-accounting.getrepeatinginvoiceattachmentbyid outputParameters: - type: object mapping: $. - path: /v1/repeatinginvoices/{repeatinginvoiceid}/attachments/{filename} name: repeatinginvoices-repeatinginvoiceid-attachments-filename description: REST surface for RepeatingInvoices-RepeatingInvoiceID-Attachments-FileName. operations: - method: GET name: getrepeatinginvoiceattachmentbyfilename description: Xero Retrieves a specific attachment from a specific repeating invoices by file name call: accounting-accounting.getrepeatinginvoiceattachmentbyfilename outputParameters: - type: object mapping: $. - method: POST name: updaterepeatinginvoiceattachmentbyfilename description: Xero Updates a specific attachment from a specific repeating invoices by file name call: accounting-accounting.updaterepeatinginvoiceattachmentbyfilename with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: createrepeatinginvoiceattachmentbyfilename description: Xero Creates an attachment from a specific repeating invoices by file name call: accounting-accounting.createrepeatinginvoiceattachmentbyfilename with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/repeatinginvoices/{repeatinginvoiceid}/history name: repeatinginvoices-repeatinginvoiceid-history description: REST surface for RepeatingInvoices-RepeatingInvoiceID-History. operations: - method: GET name: getrepeatinginvoicehistory description: Xero Retrieves history record for a specific repeating invoice call: accounting-accounting.getrepeatinginvoicehistory outputParameters: - type: object mapping: $. - method: PUT name: createrepeatinginvoicehistory description: Xero Creates a history record for a specific repeating invoice call: accounting-accounting.createrepeatinginvoicehistory with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/reports name: reports description: REST surface for Reports. operations: - method: GET name: getreportslist description: Xero Retrieves a list of the organistaions unique reports that require a uuid to fetch call: accounting-accounting.getreportslist outputParameters: - type: object mapping: $. - path: /v1/reports/agedpayablesbycontact name: reports-agedpayablesbycontact description: REST surface for Reports-AgedPayablesByContact. operations: - method: GET name: getreportagedpayablesbycontact description: Xero Retrieves report for aged payables by contact call: accounting-accounting.getreportagedpayablesbycontact with: contactId: rest.contactId date: rest.date outputParameters: - type: object mapping: $. - path: /v1/reports/agedreceivablesbycontact name: reports-agedreceivablesbycontact description: REST surface for Reports-AgedReceivablesByContact. operations: - method: GET name: getreportagedreceivablesbycontact description: Xero Retrieves report for aged receivables by contact call: accounting-accounting.getreportagedreceivablesbycontact with: contactId: rest.contactId date: rest.date outputParameters: - type: object mapping: $. - path: /v1/reports/balancesheet name: reports-balancesheet description: REST surface for Reports-BalanceSheet. operations: - method: GET name: getreportbalancesheet description: Xero Retrieves report for balancesheet call: accounting-accounting.getreportbalancesheet with: date: rest.date periods: rest.periods timeframe: rest.timeframe trackingOptionID1: rest.trackingOptionID1 trackingOptionID2: rest.trackingOptionID2 standardLayout: rest.standardLayout paymentsOnly: rest.paymentsOnly outputParameters: - type: object mapping: $. - path: /v1/reports/banksummary name: reports-banksummary description: REST surface for Reports-BankSummary. operations: - method: GET name: getreportbanksummary description: Xero Retrieves report for bank summary call: accounting-accounting.getreportbanksummary outputParameters: - type: object mapping: $. - path: /v1/reports/budgetsummary name: reports-budgetsummary description: REST surface for Reports-BudgetSummary. operations: - method: GET name: getreportbudgetsummary description: Xero Retrieves report for budget summary call: accounting-accounting.getreportbudgetsummary with: date: rest.date periods: rest.periods timeframe: rest.timeframe outputParameters: - type: object mapping: $. - path: /v1/reports/executivesummary name: reports-executivesummary description: REST surface for Reports-ExecutiveSummary. operations: - method: GET name: getreportexecutivesummary description: Xero Retrieves report for executive summary call: accounting-accounting.getreportexecutivesummary with: date: rest.date outputParameters: - type: object mapping: $. - path: /v1/reports/profitandloss name: reports-profitandloss description: REST surface for Reports-ProfitAndLoss. operations: - method: GET name: getreportprofitandloss description: Xero Retrieves report for profit and loss call: accounting-accounting.getreportprofitandloss with: periods: rest.periods timeframe: rest.timeframe trackingCategoryID: rest.trackingCategoryID trackingCategoryID2: rest.trackingCategoryID2 trackingOptionID: rest.trackingOptionID trackingOptionID2: rest.trackingOptionID2 standardLayout: rest.standardLayout paymentsOnly: rest.paymentsOnly outputParameters: - type: object mapping: $. - path: /v1/reports/tenninetynine name: reports-tenninetynine description: REST surface for Reports-TenNinetyNine. operations: - method: GET name: getreporttenninetynine description: Xero Retrieve reports for 1099 call: accounting-accounting.getreporttenninetynine with: reportYear: rest.reportYear outputParameters: - type: object mapping: $. - path: /v1/reports/trialbalance name: reports-trialbalance description: REST surface for Reports-TrialBalance. operations: - method: GET name: getreporttrialbalance description: Xero Retrieves report for trial balance call: accounting-accounting.getreporttrialbalance with: date: rest.date paymentsOnly: rest.paymentsOnly outputParameters: - type: object mapping: $. - path: /v1/reports/{reportid} name: reports-reportid description: REST surface for Reports-ReportID. operations: - method: GET name: getreportfromid description: Xero Retrieves a specific report using a unique ReportID call: accounting-accounting.getreportfromid with: ReportID: rest.ReportID outputParameters: - type: object mapping: $. - path: /v1/setup name: setup description: REST surface for Setup. operations: - method: POST name: postsetup description: Xero Sets the chart of accounts, the conversion date and conversion balances call: accounting-accounting.postsetup with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/taxrates name: taxrates description: REST surface for TaxRates. operations: - method: GET name: gettaxrates description: Xero Retrieves tax rates call: accounting-accounting.gettaxrates with: where: rest.where order: rest.order outputParameters: - type: object mapping: $. - method: PUT name: createtaxrates description: Xero Creates one or more tax rates call: accounting-accounting.createtaxrates with: body: rest.body outputParameters: - type: object mapping: $. - method: POST name: updatetaxrate description: Xero Updates tax rates call: accounting-accounting.updatetaxrate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/taxrates/{taxtype} name: taxrates-taxtype description: REST surface for TaxRates-TaxType. operations: - method: GET name: gettaxratebytaxtype description: Xero Retrieves a specific tax rate according to given TaxType code call: accounting-accounting.gettaxratebytaxtype outputParameters: - type: object mapping: $. - path: /v1/trackingcategories name: trackingcategories description: REST surface for TrackingCategories. operations: - method: GET name: gettrackingcategories description: Xero Retrieves tracking categories and options call: accounting-accounting.gettrackingcategories with: where: rest.where order: rest.order includeArchived: rest.includeArchived outputParameters: - type: object mapping: $. - method: PUT name: createtrackingcategory description: Xero Create tracking categories call: accounting-accounting.createtrackingcategory with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/trackingcategories/{trackingcategoryid} name: trackingcategories-trackingcategoryid description: REST surface for TrackingCategories-TrackingCategoryID. operations: - method: GET name: gettrackingcategory description: Xero Retrieves specific tracking categories and options using a unique tracking category Id call: accounting-accounting.gettrackingcategory outputParameters: - type: object mapping: $. - method: POST name: updatetrackingcategory description: Xero Updates a specific tracking category call: accounting-accounting.updatetrackingcategory with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: deletetrackingcategory description: Xero Deletes a specific tracking category call: accounting-accounting.deletetrackingcategory outputParameters: - type: object mapping: $. - path: /v1/trackingcategories/{trackingcategoryid}/options name: trackingcategories-trackingcategoryid-options description: REST surface for TrackingCategories-TrackingCategoryID-Options. operations: - method: PUT name: createtrackingoptions description: Xero Creates options for a specific tracking category call: accounting-accounting.createtrackingoptions with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/trackingcategories/{trackingcategoryid}/options/{trackingoptionid} name: trackingcategories-trackingcategoryid-options-trackingoptionid description: REST surface for TrackingCategories-TrackingCategoryID-Options-TrackingOptionID. operations: - method: POST name: updatetrackingoptions description: Xero Updates a specific option for a specific tracking category call: accounting-accounting.updatetrackingoptions with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: deletetrackingoptions description: Xero Deletes a specific option for a specific tracking category call: accounting-accounting.deletetrackingoptions outputParameters: - type: object mapping: $. - path: /v1/users name: users description: REST surface for Users. operations: - method: GET name: getusers description: Xero Retrieves users call: accounting-accounting.getusers with: where: rest.where order: rest.order outputParameters: - type: object mapping: $. - path: /v1/users/{userid} name: users-userid description: REST surface for Users-UserID. operations: - method: GET name: getuser description: Xero Retrieves a specific user call: accounting-accounting.getuser outputParameters: - type: object mapping: $. - type: mcp namespace: accounting-accounting-mcp port: 9090 transport: http description: MCP adapter for Xero Accounting API — Accounting. One tool per consumed operation, routed inline through this capability's consumes block. tools: - name: xero-retrieves-full-chart-accounts description: Xero Retrieves the full chart of accounts hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getaccounts with: where: tools.where order: tools.order outputParameters: - type: object mapping: $. - name: xero-creates-new-chart-accounts description: Xero Creates a new chart of accounts hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createaccount with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-single-chart-accounts description: Xero Retrieves a single chart of accounts by using a unique account Id hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getaccount outputParameters: - type: object mapping: $. - name: xero-updates-chart-accounts description: Xero Updates a chart of accounts hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updateaccount with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-deletes-chart-accounts description: Xero Deletes a chart of accounts hints: readOnly: false destructive: true idempotent: true call: accounting-accounting.deleteaccount outputParameters: - type: object mapping: $. - name: xero-retrieves-attachments-specific-accounts description: Xero Retrieves attachments for a specific accounts by using a unique account Id hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getaccountattachments outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-attachment-specific description: Xero Retrieves a specific attachment from a specific account using a unique attachment Id hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getaccountattachmentbyid outputParameters: - type: object mapping: $. - name: xero-retrieves-attachment-specific-account description: Xero Retrieves an attachment for a specific account by filename hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getaccountattachmentbyfilename outputParameters: - type: object mapping: $. - name: xero-updates-attachment-specific-account description: Xero Updates attachment on a specific account by filename hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updateaccountattachmentbyfilename with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-creates-attachment-specific-account description: Xero Creates an attachment on a specific account hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createaccountattachmentbyfilename with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-any-spent-received description: Xero Retrieves any spent or received money transactions hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getbanktransactions with: where: tools.where order: tools.order page: tools.page outputParameters: - type: object mapping: $. - name: xero-creates-one-more-spent description: Xero Creates one or more spent or received money transaction hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createbanktransactions with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-updates-creates-one-more description: Xero Updates or creates one or more spent or received money transaction hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updateorcreatebanktransactions with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-single-spent-received description: Xero Retrieves a single spent or received money transaction by using a unique bank transaction Id hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getbanktransaction outputParameters: - type: object mapping: $. - name: xero-updates-single-spent-received description: Xero Updates a single spent or received money transaction hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updatebanktransaction with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-any-attachments-specific description: Xero Retrieves any attachments from a specific bank transactions hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getbanktransactionattachments outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-attachments-specific description: Xero Retrieves specific attachments from a specific BankTransaction using a unique attachment Id hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getbanktransactionattachmentbyid outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-attachment-specific-2 description: Xero Retrieves a specific attachment from a specific bank transaction by filename hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getbanktransactionattachmentbyfilename outputParameters: - type: object mapping: $. - name: xero-updates-specific-attachment-specific description: Xero Updates a specific attachment from a specific bank transaction by filename hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updatebanktransactionattachmentbyfilename with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-creates-attachment-specific-bank description: Xero Creates an attachment for a specific bank transaction by filename hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createbanktransactionattachmentbyfilename with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-history-specific-bank description: Xero Retrieves history from a specific bank transaction using a unique bank transaction Id hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getbanktransactionshistory outputParameters: - type: object mapping: $. - name: xero-creates-history-record-specific description: Xero Creates a history record for a specific bank transactions hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createbanktransactionhistoryrecord with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-all-bank-transfers description: Xero Retrieves all bank transfers hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getbanktransfers with: where: tools.where order: tools.order outputParameters: - type: object mapping: $. - name: xero-creates-bank-transfer description: Xero Creates a bank transfer hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createbanktransfer with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-bank-transfers description: Xero Retrieves specific bank transfers by using a unique bank transfer Id hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getbanktransfer outputParameters: - type: object mapping: $. - name: xero-retrieves-attachments-specific-bank description: Xero Retrieves attachments from a specific bank transfer hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getbanktransferattachments outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-attachment-specific-3 description: Xero Retrieves a specific attachment from a specific bank transfer using a unique attachment ID hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getbanktransferattachmentbyid outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-attachment-specific-4 description: Xero Retrieves a specific attachment on a specific bank transfer by file name hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getbanktransferattachmentbyfilename outputParameters: - type: object mapping: $. - name: updatebanktransferattachmentbyfilename description: updatebanktransferattachmentbyfilename hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updatebanktransferattachmentbyfilename with: body: tools.body outputParameters: - type: object mapping: $. - name: createbanktransferattachmentbyfilename description: createbanktransferattachmentbyfilename hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createbanktransferattachmentbyfilename with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-history-specific-bank-2 description: Xero Retrieves history from a specific bank transfer using a unique bank transfer Id hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getbanktransferhistory outputParameters: - type: object mapping: $. - name: xero-creates-history-record-specific-2 description: Xero Creates a history record for a specific bank transfer hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createbanktransferhistoryrecord with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-either-one-many description: Xero Retrieves either one or many batch payments for invoices hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getbatchpayments with: where: tools.where order: tools.order outputParameters: - type: object mapping: $. - name: xero-creates-one-many-batch description: Xero Creates one or many batch payments for invoices hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createbatchpayment with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-updates-specific-batch-payment description: Xero Updates a specific batch payment for invoices and credit notes hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.deletebatchpayment with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-batch-payment description: Xero Retrieves a specific batch payment using a unique batch payment Id hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getbatchpayment outputParameters: - type: object mapping: $. - name: xero-updates-specific-batch-payment-2 description: Xero Updates a specific batch payment for invoices and credit notes hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.deletebatchpaymentbyurlparam with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-history-specific-batch description: Xero Retrieves history from a specific batch payment hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getbatchpaymenthistory outputParameters: - type: object mapping: $. - name: xero-creates-history-record-specific-3 description: Xero Creates a history record for a specific batch payment hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createbatchpaymenthistoryrecord with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-all-branding-themes description: Xero Retrieves all the branding themes hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getbrandingthemes outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-branding-theme description: Xero Retrieves a specific branding theme using a unique branding theme Id hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getbrandingtheme outputParameters: - type: object mapping: $. - name: xero-retrieves-payment-services-specific description: Xero Retrieves the payment services for a specific branding theme hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getbrandingthemepaymentservices outputParameters: - type: object mapping: $. - name: xero-creates-new-custom-payment description: Xero Creates a new custom payment service for a specific branding theme hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.createbrandingthemepaymentservices with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieve-list-budgets description: Xero Retrieve a list of budgets hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getbudgets with: IDs: tools.IDs DateTo: tools.DateTo DateFrom: tools.DateFrom outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-budget-which description: Xero Retrieves a specific budget, which includes budget lines hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getbudget with: DateTo: tools.DateTo DateFrom: tools.DateFrom outputParameters: - type: object mapping: $. - name: xero-retrieves-contact-id-and description: Xero Retrieves the contact Id and name of each contact group hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getcontactgroups with: where: tools.where order: tools.order outputParameters: - type: object mapping: $. - name: xero-creates-contact-group description: Xero Creates a contact group hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createcontactgroup with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-contact-group description: Xero Retrieves a specific contact group by using a unique contact group Id hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getcontactgroup outputParameters: - type: object mapping: $. - name: xero-updates-specific-contact-group description: Xero Updates a specific contact group hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updatecontactgroup with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-creates-contacts-specific-contact description: Xero Creates contacts to a specific contact group hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createcontactgroupcontacts with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-deletes-all-contacts-specific description: Xero Deletes all contacts from a specific contact group hints: readOnly: false destructive: true idempotent: true call: accounting-accounting.deletecontactgroupcontacts outputParameters: - type: object mapping: $. - name: xero-deletes-specific-contact-contact description: Xero Deletes a specific contact from a contact group using a unique contact Id hints: readOnly: false destructive: true idempotent: true call: accounting-accounting.deletecontactgroupcontact outputParameters: - type: object mapping: $. - name: retrieves-all-contacts-xero-organisation description: Retrieves all contacts in a Xero organisation hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getcontacts with: where: tools.where order: tools.order IDs: tools.IDs page: tools.page includeArchived: tools.includeArchived searchTerm: tools.searchTerm outputParameters: - type: object mapping: $. - name: creates-multiple-contacts-bulk-xero description: Creates multiple contacts (bulk) in a Xero organisation hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createcontacts with: body: tools.body outputParameters: - type: object mapping: $. - name: updates-creates-one-more-contacts description: Updates or creates one or more contacts in a Xero organisation hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updateorcreatecontacts with: body: tools.body outputParameters: - type: object mapping: $. - name: retrieves-specific-contacts-xero-organisation description: Retrieves a specific contacts in a Xero organisation using a unique contact Id hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getcontact outputParameters: - type: object mapping: $. - name: updates-specific-contact-xero-organisation description: Updates a specific contact in a Xero organisation hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updatecontact with: body: tools.body outputParameters: - type: object mapping: $. - name: retrieves-attachments-specific-contact-xero description: Retrieves attachments for a specific contact in a Xero organisation hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getcontactattachments outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-attachment-specific-5 description: Xero Retrieves a specific attachment from a specific contact using a unique attachment Id hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getcontactattachmentbyid outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-attachment-specific-6 description: Xero Retrieves a specific attachment from a specific contact by file name hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getcontactattachmentbyfilename outputParameters: - type: object mapping: $. - name: updatecontactattachmentbyfilename description: updatecontactattachmentbyfilename hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updatecontactattachmentbyfilename with: body: tools.body outputParameters: - type: object mapping: $. - name: createcontactattachmentbyfilename description: createcontactattachmentbyfilename hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createcontactattachmentbyfilename with: body: tools.body outputParameters: - type: object mapping: $. - name: retrieves-cis-settings-specific-contact description: Retrieves CIS settings for a specific contact in a Xero organisation hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getcontactcissettings outputParameters: - type: object mapping: $. - name: xero-retrieves-history-records-specific description: Xero Retrieves history records for a specific contact hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getcontacthistory outputParameters: - type: object mapping: $. - name: xero-creates-new-history-record description: Xero Creates a new history record for a specific contact hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createcontacthistory with: body: tools.body outputParameters: - type: object mapping: $. - name: retrieves-specific-contact-contact-number description: Retrieves a specific contact by contact number in a Xero organisation hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getcontactbycontactnumber with: ContactNumber: tools.ContactNumber outputParameters: - type: object mapping: $. - name: xero-retrieves-any-credit-notes description: Xero Retrieves any credit notes hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getcreditnotes with: where: tools.where order: tools.order page: tools.page outputParameters: - type: object mapping: $. - name: xero-creates-new-credit-note description: Xero Creates a new credit note hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createcreditnotes with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-updates-creates-one-more-2 description: Xero Updates or creates one or more credit notes hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updateorcreatecreditnotes with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-credit-note description: Xero Retrieves a specific credit note using a unique credit note Id hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getcreditnote outputParameters: - type: object mapping: $. - name: xero-updates-specific-credit-note description: Xero Updates a specific credit note hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updatecreditnote with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-creates-allocation-specific-credit description: Xero Creates allocation for a specific credit note hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createcreditnoteallocation with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-deletes-allocation-credit-note description: Xero Deletes an Allocation from a Credit Note hints: readOnly: false destructive: true idempotent: true call: accounting-accounting.deletecreditnoteallocations outputParameters: - type: object mapping: $. - name: xero-retrieves-attachments-specific-credit description: Xero Retrieves attachments for a specific credit notes hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getcreditnoteattachments outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-attachment-specific-7 description: Xero Retrieves a specific attachment from a specific credit note using a unique attachment Id hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getcreditnoteattachmentbyid outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-attachment-specific-8 description: Xero Retrieves a specific attachment on a specific credit note by file name hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getcreditnoteattachmentbyfilename outputParameters: - type: object mapping: $. - name: xero-updates-attachments-specific-credit description: Xero Updates attachments on a specific credit note by file name hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updatecreditnoteattachmentbyfilename with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-creates-attachment-specific-credit description: Xero Creates an attachment for a specific credit note hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createcreditnoteattachmentbyfilename with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-history-records-specific-2 description: Xero Retrieves history records of a specific credit note hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getcreditnotehistory outputParameters: - type: object mapping: $. - name: xero-retrieves-history-records-specific-3 description: Xero Retrieves history records of a specific credit note hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createcreditnotehistory with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-credit-notes-pdf description: Xero Retrieves credit notes as PDF files hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getcreditnoteaspdf outputParameters: - type: object mapping: $. - name: retrieves-currencies-your-xero-organisation description: Retrieves currencies for your Xero organisation hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getcurrencies with: where: tools.where order: tools.order outputParameters: - type: object mapping: $. - name: create-new-currency-xero-organisation description: Create a new currency for a Xero organisation hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createcurrency with: body: tools.body outputParameters: - type: object mapping: $. - name: retrieves-employees-used-xero-payrun description: Retrieves employees used in Xero payrun hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getemployees with: where: tools.where order: tools.order outputParameters: - type: object mapping: $. - name: creates-new-employees-used-xero description: Creates new employees used in Xero payrun hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createemployees with: body: tools.body outputParameters: - type: object mapping: $. - name: creates-single-new-employees-used description: Creates a single new employees used in Xero payrun hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updateorcreateemployees with: body: tools.body outputParameters: - type: object mapping: $. - name: retrieves-specific-employee-used-xero description: Retrieves a specific employee used in Xero payrun using a unique employee Id hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getemployee outputParameters: - type: object mapping: $. - name: xero-retrieves-expense-claims description: Xero Retrieves expense claims hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getexpenseclaims with: where: tools.where order: tools.order outputParameters: - type: object mapping: $. - name: xero-creates-expense-claims description: Xero Creates expense claims hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createexpenseclaims with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-expense-claim description: Xero Retrieves a specific expense claim using a unique expense claim Id hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getexpenseclaim outputParameters: - type: object mapping: $. - name: xero-updates-specific-expense-claims description: Xero Updates a specific expense claims hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updateexpenseclaim with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-history-records-specific-4 description: Xero Retrieves history records of a specific expense claim hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getexpenseclaimhistory outputParameters: - type: object mapping: $. - name: xero-creates-history-record-specific-4 description: Xero Creates a history record for a specific expense claim hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createexpenseclaimhistory with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-invoice-reminder-settings description: Xero Retrieves invoice reminder settings hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getinvoicereminders outputParameters: - type: object mapping: $. - name: xero-retrieves-sales-invoices-purchase description: Xero Retrieves sales invoices or purchase bills hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getinvoices with: where: tools.where order: tools.order IDs: tools.IDs InvoiceNumbers: tools.InvoiceNumbers ContactIDs: tools.ContactIDs Statuses: tools.Statuses page: tools.page includeArchived: tools.includeArchived createdByMyApp: tools.createdByMyApp outputParameters: - type: object mapping: $. - name: xero-creates-one-more-sales description: Xero Creates one or more sales invoices or purchase bills hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createinvoices with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-updates-creates-one-more-3 description: Xero Updates or creates one or more sales invoices or purchase bills hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updateorcreateinvoices with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-sales-invoice description: Xero Retrieves a specific sales invoice or purchase bill using a unique invoice Id hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getinvoice outputParameters: - type: object mapping: $. - name: xero-updates-specific-sales-invoices description: Xero Updates a specific sales invoices or purchase bills hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updateinvoice with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-attachments-specific-invoice description: Xero Retrieves attachments for a specific invoice or purchase bill hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getinvoiceattachments outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-attachment-specific-9 description: Xero Retrieves a specific attachment from a specific invoices or purchase bills by using a unique attachment Id hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getinvoiceattachmentbyid outputParameters: - type: object mapping: $. - name: xero-retrieves-attachment-specific-invoice description: Xero Retrieves an attachment from a specific invoice or purchase bill by filename hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getinvoiceattachmentbyfilename outputParameters: - type: object mapping: $. - name: xero-updates-attachment-specific-invoices description: Xero Updates an attachment from a specific invoices or purchase bill by filename hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updateinvoiceattachmentbyfilename with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-creates-attachment-specific-invoice description: Xero Creates an attachment for a specific invoice or purchase bill by filename hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createinvoiceattachmentbyfilename with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-sends-copy-specific-invoice description: Xero Sends a copy of a specific invoice to related contact via email hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.emailinvoice with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-history-records-specific-5 description: Xero Retrieves history records for a specific invoice hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getinvoicehistory outputParameters: - type: object mapping: $. - name: xero-creates-history-record-specific-5 description: Xero Creates a history record for a specific invoice hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createinvoicehistory with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-url-online-invoice description: Xero Retrieves a URL to an online invoice hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getonlineinvoice outputParameters: - type: object mapping: $. - name: xero-retrieves-invoices-purchase-bills description: Xero Retrieves invoices or purchase bills as PDF files hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getinvoiceaspdf outputParameters: - type: object mapping: $. - name: xero-retrieves-items description: Xero Retrieves items hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getitems with: where: tools.where order: tools.order outputParameters: - type: object mapping: $. - name: xero-creates-one-more-items description: Xero Creates one or more items hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createitems with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-updates-creates-one-more-4 description: Xero Updates or creates one or more items hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updateorcreateitems with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-item-using description: Xero Retrieves a specific item using a unique item Id hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getitem outputParameters: - type: object mapping: $. - name: xero-updates-specific-item description: Xero Updates a specific item hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updateitem with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-deletes-specific-item description: Xero Deletes a specific item hints: readOnly: false destructive: true idempotent: true call: accounting-accounting.deleteitem outputParameters: - type: object mapping: $. - name: xero-retrieves-history-specific-item description: Xero Retrieves history for a specific item hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getitemhistory outputParameters: - type: object mapping: $. - name: xero-creates-history-record-specific-6 description: Xero Creates a history record for a specific item hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createitemhistory with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-journals description: Xero Retrieves journals hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getjournals with: offset: tools.offset paymentsOnly: tools.paymentsOnly outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-journal-using description: Xero Retrieves a specific journal using a unique journal Id. hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getjournal outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-journal-using-2 description: Xero Retrieves a specific journal using a unique journal number. hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getjournalbynumber outputParameters: - type: object mapping: $. - name: xero-retrieves-linked-transactions-billable description: Xero Retrieves linked transactions (billable expenses) hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getlinkedtransactions with: page: tools.page LinkedTransactionID: tools.LinkedTransactionID SourceTransactionID: tools.SourceTransactionID ContactID: tools.ContactID Status: tools.Status TargetTransactionID: tools.TargetTransactionID outputParameters: - type: object mapping: $. - name: xero-creates-linked-transactions-billable description: Xero Creates linked transactions (billable expenses) hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createlinkedtransaction with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-linked-transaction description: Xero Retrieves a specific linked transaction (billable expenses) using a unique linked transaction Id hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getlinkedtransaction outputParameters: - type: object mapping: $. - name: xero-updates-specific-linked-transactions description: Xero Updates a specific linked transactions (billable expenses) hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updatelinkedtransaction with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-deletes-specific-linked-transactions description: Xero Deletes a specific linked transactions (billable expenses) hints: readOnly: false destructive: true idempotent: true call: accounting-accounting.deletelinkedtransaction outputParameters: - type: object mapping: $. - name: xero-retrieves-manual-journals description: Xero Retrieves manual journals hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getmanualjournals with: where: tools.where order: tools.order page: tools.page outputParameters: - type: object mapping: $. - name: xero-creates-one-more-manual description: Xero Creates one or more manual journals hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createmanualjournals with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-updates-creates-single-manual description: Xero Updates or creates a single manual journal hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updateorcreatemanualjournals with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-manual-journal description: Xero Retrieves a specific manual journal hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getmanualjournal outputParameters: - type: object mapping: $. - name: xero-updates-specific-manual-journal description: Xero Updates a specific manual journal hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updatemanualjournal with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-attachment-specific-manual description: Xero Retrieves attachment for a specific manual journal hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getmanualjournalattachments outputParameters: - type: object mapping: $. - name: xero-allows-you-retrieve-specific description: Xero Allows you to retrieve a specific attachment from a specific manual journal using a unique attachment Id hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getmanualjournalattachmentbyid outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-attachment-specific-10 description: Xero Retrieves a specific attachment from a specific manual journal by file name hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getmanualjournalattachmentbyfilename outputParameters: - type: object mapping: $. - name: xero-updates-specific-attachment-specific-2 description: Xero Updates a specific attachment from a specific manual journal by file name hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updatemanualjournalattachmentbyfilename with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-creates-specific-attachment-specific description: Xero Creates a specific attachment for a specific manual journal by file name hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createmanualjournalattachmentbyfilename with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-history-specific-manual description: Xero Retrieves history for a specific manual journal hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getmanualjournalshistory outputParameters: - type: object mapping: $. - name: xero-creates-history-record-specific-7 description: Xero Creates a history record for a specific manual journal hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createmanualjournalhistoryrecord with: body: tools.body outputParameters: - type: object mapping: $. - name: retrieves-xero-organisation-details description: Retrieves Xero organisation details hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getorganisations outputParameters: - type: object mapping: $. - name: retrieves-list-key-actions-your description: Retrieves a list of the key actions your app has permission to perform in the connected Xero organisation. hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getorganisationactions outputParameters: - type: object mapping: $. - name: retrieves-cis-settings-xero-organistaion description: Retrieves the CIS settings for the Xero organistaion. hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getorganisationcissettings outputParameters: - type: object mapping: $. - name: xero-retrieves-overpayments description: Xero Retrieves overpayments hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getoverpayments with: where: tools.where order: tools.order page: tools.page References: tools.References outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-overpayment-using description: Xero Retrieves a specific overpayment using a unique overpayment Id hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getoverpayment outputParameters: - type: object mapping: $. - name: xero-creates-single-allocation-specific description: Xero Creates a single allocation for a specific overpayment hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createoverpaymentallocations with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-deletes-allocation-overpayment description: Xero Deletes an Allocation from an overpayment hints: readOnly: false destructive: true idempotent: true call: accounting-accounting.deleteoverpaymentallocations outputParameters: - type: object mapping: $. - name: xero-retrieves-history-records-specific-6 description: Xero Retrieves history records of a specific overpayment hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getoverpaymenthistory outputParameters: - type: object mapping: $. - name: xero-creates-history-record-specific-8 description: Xero Creates a history record for a specific overpayment hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createoverpaymenthistory with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-payment-services description: Xero Retrieves payment services hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getpaymentservices outputParameters: - type: object mapping: $. - name: xero-creates-payment-service description: Xero Creates a payment service hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createpaymentservice with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-payments-invoices-and description: Xero Retrieves payments for invoices and credit notes hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getpayments with: where: tools.where order: tools.order page: tools.page outputParameters: - type: object mapping: $. - name: xero-creates-multiple-payments-invoices description: Xero Creates multiple payments for invoices or credit notes hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createpayments with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-creates-single-payment-invoice description: Xero Creates a single payment for invoice or credit notes hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.createpayment with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-payment-invoices description: Xero Retrieves a specific payment for invoices and credit notes using a unique payment Id hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getpayment outputParameters: - type: object mapping: $. - name: xero-updates-specific-payment-invoices description: Xero Updates a specific payment for invoices and credit notes hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.deletepayment with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-history-records-specific-7 description: Xero Retrieves history records of a specific payment hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getpaymenthistory outputParameters: - type: object mapping: $. - name: xero-creates-history-record-specific-9 description: Xero Creates a history record for a specific payment hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createpaymenthistory with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-prepayments description: Xero Retrieves prepayments hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getprepayments with: where: tools.where order: tools.order page: tools.page InvoiceNumbers: tools.InvoiceNumbers outputParameters: - type: object mapping: $. - name: xero-allows-you-retrieve-specified description: Xero Allows you to retrieve a specified prepayments hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getprepayment outputParameters: - type: object mapping: $. - name: xero-allows-you-create-allocation description: Xero Allows you to create an Allocation for prepayments hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createprepaymentallocations with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-deletes-allocation-prepayment description: Xero Deletes an Allocation from a Prepayment hints: readOnly: false destructive: true idempotent: true call: accounting-accounting.deleteprepaymentallocations outputParameters: - type: object mapping: $. - name: xero-retrieves-history-record-specific description: Xero Retrieves history record for a specific prepayment hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getprepaymenthistory outputParameters: - type: object mapping: $. - name: xero-creates-history-record-specific-10 description: Xero Creates a history record for a specific prepayment hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createprepaymenthistory with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-purchase-orders description: Xero Retrieves purchase orders hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getpurchaseorders with: Status: tools.Status DateFrom: tools.DateFrom DateTo: tools.DateTo order: tools.order page: tools.page outputParameters: - type: object mapping: $. - name: xero-creates-one-more-purchase description: Xero Creates one or more purchase orders hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createpurchaseorders with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-updates-creates-one-more-5 description: Xero Updates or creates one or more purchase orders hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updateorcreatepurchaseorders with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-purchase-order description: Xero Retrieves a specific purchase order using a unique purchase order Id hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getpurchaseorder outputParameters: - type: object mapping: $. - name: xero-updates-specific-purchase-order description: Xero Updates a specific purchase order hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updatepurchaseorder with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-attachments-specific-purchase description: Xero Retrieves attachments for a specific purchase order hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getpurchaseorderattachments outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-attachment-specific-11 description: Xero Retrieves specific attachment for a specific purchase order using a unique attachment Id hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getpurchaseorderattachmentbyid outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-attachment-specific-12 description: Xero Retrieves a specific attachment for a specific purchase order by filename hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getpurchaseorderattachmentbyfilename outputParameters: - type: object mapping: $. - name: xero-updates-specific-attachment-specific-3 description: Xero Updates a specific attachment for a specific purchase order by filename hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updatepurchaseorderattachmentbyfilename with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-creates-attachment-specific-purchase description: Xero Creates attachment for a specific purchase order hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createpurchaseorderattachmentbyfilename with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-history-specific-purchase description: Xero Retrieves history for a specific purchase order hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getpurchaseorderhistory outputParameters: - type: object mapping: $. - name: xero-creates-history-record-specific-11 description: Xero Creates a history record for a specific purchase orders hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createpurchaseorderhistory with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-purchase-order-2 description: Xero Retrieves specific purchase order as PDF files using a unique purchase order Id hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getpurchaseorderaspdf outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-purchase-order-3 description: Xero Retrieves a specific purchase order using purchase order number hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getpurchaseorderbynumber with: PurchaseOrderNumber: tools.PurchaseOrderNumber outputParameters: - type: object mapping: $. - name: xero-retrieves-sales-quotes description: Xero Retrieves sales quotes hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getquotes with: DateFrom: tools.DateFrom DateTo: tools.DateTo ExpiryDateFrom: tools.ExpiryDateFrom ExpiryDateTo: tools.ExpiryDateTo ContactID: tools.ContactID Status: tools.Status page: tools.page order: tools.order QuoteNumber: tools.QuoteNumber outputParameters: - type: object mapping: $. - name: xero-create-one-more-quotes description: Xero Create one or more quotes hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createquotes with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-updates-creates-one-more-6 description: Xero Updates or creates one or more quotes hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updateorcreatequotes with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-quote-using description: Xero Retrieves a specific quote using a unique quote Id hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getquote outputParameters: - type: object mapping: $. - name: xero-updates-specific-quote description: Xero Updates a specific quote hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updatequote with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-attachments-specific-quote description: Xero Retrieves attachments for a specific quote hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getquoteattachments outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-attachment-specific-13 description: Xero Retrieves a specific attachment from a specific quote using a unique attachment Id hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getquoteattachmentbyid outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-attachment-specific-14 description: Xero Retrieves a specific attachment from a specific quote by filename hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getquoteattachmentbyfilename outputParameters: - type: object mapping: $. - name: xero-updates-specific-attachment-specific-4 description: Xero Updates a specific attachment from a specific quote by filename hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updatequoteattachmentbyfilename with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-creates-attachment-specific-quote description: Xero Creates attachment for a specific quote hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createquoteattachmentbyfilename with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-history-records-specific-8 description: Xero Retrieves history records of a specific quote hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getquotehistory outputParameters: - type: object mapping: $. - name: xero-creates-history-record-specific-12 description: Xero Creates a history record for a specific quote hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createquotehistory with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-quote-pdf description: Xero Retrieves a specific quote as a PDF file using a unique quote Id hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getquoteaspdf outputParameters: - type: object mapping: $. - name: xero-retrieves-draft-expense-claim description: Xero Retrieves draft expense claim receipts for any user hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getreceipts with: where: tools.where order: tools.order outputParameters: - type: object mapping: $. - name: xero-creates-draft-expense-claim description: Xero Creates draft expense claim receipts for any user hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createreceipt with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-draft-expense description: Xero Retrieves a specific draft expense claim receipt by using a unique receipt Id hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getreceipt outputParameters: - type: object mapping: $. - name: xero-updates-specific-draft-expense description: Xero Updates a specific draft expense claim receipts hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updatereceipt with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-attachments-specific-expense description: Xero Retrieves attachments for a specific expense claim receipt hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getreceiptattachments outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-attachments-specific-2 description: Xero Retrieves a specific attachments from a specific expense claim receipts by using a unique attachment Id hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getreceiptattachmentbyid outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-attachment-specific-15 description: Xero Retrieves a specific attachment from a specific expense claim receipts by file name hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getreceiptattachmentbyfilename outputParameters: - type: object mapping: $. - name: xero-updates-specific-attachment-specific-5 description: Xero Updates a specific attachment on a specific expense claim receipts by file name hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updatereceiptattachmentbyfilename with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-creates-attachment-specific-expense description: Xero Creates an attachment on a specific expense claim receipts by file name hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createreceiptattachmentbyfilename with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-history-record-specific-2 description: Xero Retrieves a history record for a specific receipt hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getreceipthistory outputParameters: - type: object mapping: $. - name: xero-creates-history-record-specific-13 description: Xero Creates a history record for a specific receipt hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createreceipthistory with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-repeating-invoices description: Xero Retrieves repeating invoices hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getrepeatinginvoices with: where: tools.where order: tools.order outputParameters: - type: object mapping: $. - name: xero-creates-one-more-repeating description: Xero Creates one or more repeating invoice templates hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createrepeatinginvoices with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-creates-deletes-one-more description: Xero Creates or deletes one or more repeating invoice templates hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updateorcreaterepeatinginvoices with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-repeating-invoice description: Xero Retrieves a specific repeating invoice by using a unique repeating invoice Id hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getrepeatinginvoice outputParameters: - type: object mapping: $. - name: xero-deletes-specific-repeating-invoice description: Xero Deletes a specific repeating invoice template hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updaterepeatinginvoice with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-attachments-specific-repeating description: Xero Retrieves attachments from a specific repeating invoice hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getrepeatinginvoiceattachments outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-attachment-specific-16 description: Xero Retrieves a specific attachment from a specific repeating invoice hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getrepeatinginvoiceattachmentbyid outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-attachment-specific-17 description: Xero Retrieves a specific attachment from a specific repeating invoices by file name hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getrepeatinginvoiceattachmentbyfilename outputParameters: - type: object mapping: $. - name: xero-updates-specific-attachment-specific-6 description: Xero Updates a specific attachment from a specific repeating invoices by file name hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updaterepeatinginvoiceattachmentbyfilename with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-creates-attachment-specific-repeating description: Xero Creates an attachment from a specific repeating invoices by file name hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createrepeatinginvoiceattachmentbyfilename with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-history-record-specific-3 description: Xero Retrieves history record for a specific repeating invoice hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getrepeatinginvoicehistory outputParameters: - type: object mapping: $. - name: xero-creates-history-record-specific-14 description: Xero Creates a history record for a specific repeating invoice hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createrepeatinginvoicehistory with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-list-organistaions-unique description: Xero Retrieves a list of the organistaions unique reports that require a uuid to fetch hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getreportslist outputParameters: - type: object mapping: $. - name: xero-retrieves-report-aged-payables description: Xero Retrieves report for aged payables by contact hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getreportagedpayablesbycontact with: contactId: tools.contactId date: tools.date outputParameters: - type: object mapping: $. - name: xero-retrieves-report-aged-receivables description: Xero Retrieves report for aged receivables by contact hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getreportagedreceivablesbycontact with: contactId: tools.contactId date: tools.date outputParameters: - type: object mapping: $. - name: xero-retrieves-report-balancesheet description: Xero Retrieves report for balancesheet hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getreportbalancesheet with: date: tools.date periods: tools.periods timeframe: tools.timeframe trackingOptionID1: tools.trackingOptionID1 trackingOptionID2: tools.trackingOptionID2 standardLayout: tools.standardLayout paymentsOnly: tools.paymentsOnly outputParameters: - type: object mapping: $. - name: xero-retrieves-report-bank-summary description: Xero Retrieves report for bank summary hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getreportbanksummary outputParameters: - type: object mapping: $. - name: xero-retrieves-report-budget-summary description: Xero Retrieves report for budget summary hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getreportbudgetsummary with: date: tools.date periods: tools.periods timeframe: tools.timeframe outputParameters: - type: object mapping: $. - name: xero-retrieves-report-executive-summary description: Xero Retrieves report for executive summary hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getreportexecutivesummary with: date: tools.date outputParameters: - type: object mapping: $. - name: xero-retrieves-report-profit-and description: Xero Retrieves report for profit and loss hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getreportprofitandloss with: periods: tools.periods timeframe: tools.timeframe trackingCategoryID: tools.trackingCategoryID trackingCategoryID2: tools.trackingCategoryID2 trackingOptionID: tools.trackingOptionID trackingOptionID2: tools.trackingOptionID2 standardLayout: tools.standardLayout paymentsOnly: tools.paymentsOnly outputParameters: - type: object mapping: $. - name: xero-retrieve-reports-1099 description: Xero Retrieve reports for 1099 hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getreporttenninetynine with: reportYear: tools.reportYear outputParameters: - type: object mapping: $. - name: xero-retrieves-report-trial-balance description: Xero Retrieves report for trial balance hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getreporttrialbalance with: date: tools.date paymentsOnly: tools.paymentsOnly outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-report-using description: Xero Retrieves a specific report using a unique ReportID hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getreportfromid with: ReportID: tools.ReportID outputParameters: - type: object mapping: $. - name: xero-sets-chart-accounts-conversion description: Xero Sets the chart of accounts, the conversion date and conversion balances hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.postsetup with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-tax-rates description: Xero Retrieves tax rates hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.gettaxrates with: where: tools.where order: tools.order outputParameters: - type: object mapping: $. - name: xero-creates-one-more-tax description: Xero Creates one or more tax rates hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createtaxrates with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-updates-tax-rates description: Xero Updates tax rates hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updatetaxrate with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-tax-rate description: Xero Retrieves a specific tax rate according to given TaxType code hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.gettaxratebytaxtype outputParameters: - type: object mapping: $. - name: xero-retrieves-tracking-categories-and description: Xero Retrieves tracking categories and options hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.gettrackingcategories with: where: tools.where order: tools.order includeArchived: tools.includeArchived outputParameters: - type: object mapping: $. - name: xero-create-tracking-categories description: Xero Create tracking categories hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createtrackingcategory with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-tracking-categories description: Xero Retrieves specific tracking categories and options using a unique tracking category Id hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.gettrackingcategory outputParameters: - type: object mapping: $. - name: xero-updates-specific-tracking-category description: Xero Updates a specific tracking category hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updatetrackingcategory with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-deletes-specific-tracking-category description: Xero Deletes a specific tracking category hints: readOnly: false destructive: true idempotent: true call: accounting-accounting.deletetrackingcategory outputParameters: - type: object mapping: $. - name: xero-creates-options-specific-tracking description: Xero Creates options for a specific tracking category hints: readOnly: false destructive: false idempotent: true call: accounting-accounting.createtrackingoptions with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-updates-specific-option-specific description: Xero Updates a specific option for a specific tracking category hints: readOnly: false destructive: false idempotent: false call: accounting-accounting.updatetrackingoptions with: body: tools.body outputParameters: - type: object mapping: $. - name: xero-deletes-specific-option-specific description: Xero Deletes a specific option for a specific tracking category hints: readOnly: false destructive: true idempotent: true call: accounting-accounting.deletetrackingoptions outputParameters: - type: object mapping: $. - name: xero-retrieves-users description: Xero Retrieves users hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getusers with: where: tools.where order: tools.order outputParameters: - type: object mapping: $. - name: xero-retrieves-specific-user description: Xero Retrieves a specific user hints: readOnly: true destructive: false idempotent: true call: accounting-accounting.getuser outputParameters: - type: object mapping: $.