package
0.0.0-20210419211115-7d59a5414f55
Repository: https://github.com/xeroapi/xerogolang.git
Documentation: pkg.go.dev

# Functions

FindAccount will get a single account - accountID must be a GUID for an account.
FindAccounts will get all accounts.
FindAccountsModifiedSince will get all accounts modified after a specified date.additional querystringParameters such as where and order can be added as a map.
FindBankTransaction will get a single BankTransaction - BankTransactionID can be a GUID for an BankTransaction or an BankTransaction number.
FindBankTransactions will get all BankTransactions.
FindBankTransactionsModifiedSince will get all BankTransactions modified after a specified date.These BankTransactions will not have details like default account codes and tracking categories by default.If you need details then then add a 'page' querystringParameter and get 100 BankTransactions at a timeadditional querystringParameters such as where, page, order can be added as a map.
FindBankTransfer will get a single bankTransfer - bankTransferID can be a GUID for an bankTransfer or an bankTransfer number.
FindBankTransfers will get all BankTransfers.
FindBankTransfersModifiedSince will get all BankTransfers modified after a specified date.These BankTransfers will not have details like default line items by default.If you need details then add a 'page' querystringParameter and get 100 BankTransfers at a timeadditional querystringParameters such as where and order can be added as a map.
FindBrandingThemes will get all BrandingThemes.
FindContact will get a single Contact - ContactID can be a GUID for an Contact or an Contact number.
FindContactGroup will get a single contactGroup - contactGroupID must be a GUID for an contactGroup.
FindContactGroups will get all contactGroups.
FindContacts will get all Contacts.
FindContactsModifiedSince will get all Contacts modified after a specified date.These Contacts will not have details like default account codes and tracking categories.If you need details then then add a 'page' querystringParameter and get 100 Contacts at a timeadditional querystringParameters such as where, page, order can be added as a map.
FindCreditNote will get a single creditNote - creditNoteID can be a GUID for a creditNote or a creditNote number.
FindCreditNotes will get all CreditNotes.
FindCreditNotesModifiedSince will get all Credit Notes modified after a specified date.These Credit Notes will not have details like line items by default.If you need details then then add a 'page' querystringParameter and get 100 Credit Notes at a timeadditional querystringParameters such as where, page, order can be added as a map.
FindCurrencies will get all currencies.
FindExpenseClaim will get a single expenseClaim - expenseClaimID can be a GUID for an expenseClaim or an expenseClaim number.
FindExpenseClaims will get all ExpenseClaims.
FindExpenseClaimsModifiedSince will get all ExpenseClaims modified after a specified date.These ExpenseClaims will not have details like default line items by default.If you need details then add a 'page' querystringParameter and get 100 ExpenseClaims at a timeadditional querystringParameters such as where and order can be added as a map.
FindHistoryAndNotes gets all history items and notes for a given type and ID.it is not supported on all endpoints.
FindInvoice will get a single invoice - invoiceID can be a GUID for an invoice or an invoice number.
FindInvoices will get all Invoices.
FindInvoicesModifiedSince will get all Invoices modified after a specified date.These Invoices will not have details like default line items by default.If you need details then add a 'page' querystringParameter and get 100 Invoices at a timeadditional querystringParameters such as where, page, order can be added as a map.
FindItem will get a single item - itemID must be a GUID for an item.
FindItems will get all items.
FindItemsModifiedSince will get all items modified after a specified date.additional querystringParameters such as where, page, order can be added as a map.
FindJournal will get a single journal - journalID can be a GUID for an journal or an journal number.
FindJournals will get all journals.A maximum of 100 journals will be returned in any response.Use the offset or ModifiedSince filters with multiple API calls to retrieve larger sets of journals.Journals are ordered oldest to newest.additional querystringParameters such as offset and paymentsOnly can be added as a map.
FindJournalsModifiedSince will get all journals modified after a specified date.A maximum of 100 journals will be returned in any response.Use the offset or ModifiedSince filters with multiple API calls to retrieve larger sets of journals.Journals are ordered oldest to newest.additional querystringParameters such as offset and paymentsOnly can be added as a map.
FindLinkedTransaction will get a single LinkedTransaction - LinkedTransactionID must be a GUID for an LinkedTransaction.
FindLinkedTransactions will get all LinkedTransactions.additional querystringParameters such as page, SourceTransactionID, ContactID,Status, and TargetTransactionID can be added as a map.
FindLinkedTransactionsModifiedSince will get all LinkedTransactions modified after a specified date.additional querystringParameters such as page, SourceTransactionID, ContactID,Status, and TargetTransactionID can be added as a map.
FindManualJournal will get a single manualJournal - manualJournalID can be a GUID for an manualJournal or an manualJournal number.
FindManualJournals will get all ManualJournals.
FindManualJournalsModifiedSince will get all ManualJournals modified after a specified date.These ManualJournals will not have details like line items by defaultIf you need details then then add a 'page' querystringParameter and get 100 ManualJournals at a timeadditional querystringParameters such as where, page, order can be added as a map.
FindOrganisation returns details about the Xero organisation you're connected to.
FindOverpayment will get a single overpayment - overpaymentID can be a GUID for an overpayment or an overpayment number.
FindOverpayments will get all Overpayments.
FindOverpaymentsModifiedSince will get all Overpayments modified after a specified date.These Overpayments will not have details like default line items by default.If you need details then add a 'page' querystringParameter and get 100 Overpayments at a timeadditional querystringParameters such as where, page, order can be added as a map.
FindPayment will get a single payment - paymentID must be a GUID for an payment.
FindPayments will get all payments.
FindPaymentsModifiedSince will get all payments modified after a specified date.additional querystringParameters such as where, page, order can be added as a map.
FindPrepayment will get a single prepayment - prepaymentID can be a GUID for an prepayment or an prepayment number.
FindPrepayments will get all Prepayments.
FindPrepaymentsModifiedSince will get all Prepayments modified after a specified date.These Prepayments will not have details like default line items by default.If you need details then add a 'page' querystringParameter and get 100 Prepayments at a timeadditional querystringParameters such as where, page, order can be added as a map.
FindPurchaseOrder will get a single purchaseOrder - purchaseOrderID can be a GUID for an purchaseOrder or an purchaseOrder number.
FindPurchaseOrders will get all PurchaseOrders.
FindPurchaseOrdersModifiedSince will get all PurchaseOrders modified after a specified date.Paging is enforced by default.
FindReceipt will get a single receipt - receiptID can be a GUID for an receipt or an receipt number.
FindReceipts will get all Receipts.
FindReceiptsModifiedSince will get all Receipts modified after a specified date.These Receipts will not have details like default line items by default.If you need details then add a 'page' querystringParameter and get 100 Receipts at a timeadditional querystringParameters such as where, page, order can be added as a map.
FindRepeatingInvoice will get a single repeatingInvoice - RepeatingInvoiceID must be a GUID for a repeatingInvoice.
FindRepeatingInvoices will get all repeatingInvoicesadditional querystringParameters such as where and order can be added as a map.
FindTaxRates will get all TaxRates.additional querystringParameters such as taxType, where and order can be added as a map.
FindTrackingCategories will get all trackingCategories.
FindTrackingCategory will get a single trackingCategory - trackingCategoryID must be a GUID for an trackingCategory.
FindUser will get a single user - UserID must be a GUID for a user.
FindUsers will get all usersadditional querystringParameters such as where and order can be added as a map.
FindUsersModifiedSince will get all users modified after a specified dateadditional querystringParameters such as where and order can be added as a map.
GenerateExampleAccount Creates an Example account.
GenerateExampleBankTransaction Creates an Example bankTransaction.
GenerateExampleBankTransfer Creates an Example bankTransfer.
GenerateExampleContact Creates an Example contact.
GenerateExampleContactGroup Creates an Example contactGroup.
GenerateExampleCreditNote Creates an Example creditNote.
GenerateExampleExpenseClaim Creates an Example expenseClaim.
GenerateExampleBankTransfer Creates an Example bankTransfer.
GenerateExampleInvoice Creates an Example invoice.
GenerateExampleItem Creates an Example item.
GenerateExampleLinkedTransaction Creates an Example LinkedTransaction.
GenerateExampleManualJournal Creates an Example manualJournal.
GenerateExamplePayment Creates an Example payment.
GenerateExamplePurchaseOrder Creates an Example purchaseOrder.
GenerateExampleReceipt Creates an Example receipt.
GenerateExampleTaxRate Creates an Example taxRate.
GenerateExampleTrackingCategory Generates an Example trackingCategory.
RemoveAccount will get a single account - accountID must be a GUID for an account.
RemoveContactGroup will get a single contactGroup - contactGroupID must be a GUID for an contactGroup.
RemoveItem will get a single item - itemID must be a GUID for an item.
RemoveLinkedTransaction will get a single LinkedTransaction - LinkedTransactionID must be a GUID for an LinkedTransaction.
RemovePayment will get a single payment - paymentID must be a GUID for an payment.
RemoveTrackingCategory will get a single trackingCategory - trackingCategoryID must be a GUID for an trackingCategory.
Run1099 will run the 1099 Report and marshal the results to a Report StructThis Report will only work for US based Organisations.
RunAgedPayablesByContact will run the Aged Payables By Contact Report and marshal the results to a Report StructDate, FromDate and ToDate can be added as optional paramters as a map.
RunAgedReceivablesByContact will run the Aged Receivables By Contact Report and marshal the results to a Report StructDate, FromDate and ToDate can be added as optional paramters as a map.
RunBalanceSheet will run the Balance Sheet Report and marshal the results to a Report Structdate, trackingOptionID1, trackingOptionID2, standardLayout, and paymentsOnly can be added as optional paramters as a map.
RunBankStatement will run the Bank Statement Report and marshal the results to a Report StructFromDate and ToDate can be added as optional paramters as a map.
RunBankSummary will run the Bank Summary Report and marshal the results to a Report StructFromDate and ToDate can be added as optional paramters as a map.
RunBASReport will retrieve an individual BAS Report given a reportID and marshal the results to a Report StructWill only work for AU based Organisations.
RunBASReports will retrieve all BAS Reports and marshal the results to a Report StructWill only work for AU based Organisations.
RunBudgetSummary will run the Budget Summary Report and marshal the results to a Report Struct.
RunExecutiveSummary will run the Executive Summary Report and marshal the results to a Report Structdate can be added as an optional paramter as a map.
RunGSTReport will retrieve an individual GST Report given a reportID and marshal the results to a Report StructWill only work for NZ based Organisations.
RunGSTReports will retrieve all GST Reports and marshal the results to a Report StructWill only work for NZ based Organisations.
RunProfitAndLoss will run the Profit And Loss Report and marshal the results to a Report Structdate, trackingCategoryID, trackingOptionID, trackingCategoryID2, trackingOptionID2,standardLayout, and paymentsOnly can be added as optional paramters as a map.
RunTrialBalance will run the TrialBalance Report and marshal the results to a Report Structdate and paymentsOnly can be added as optional paramters as a map.

# Structs

Account represents individual accounts in a Xero organisation.
Accounts contains a collection of Accounts.
Address is an address for a contact.
Allocation allocated an overpayment or Prepayment to an Invoice.
Allocations is a collection of Allocations.
Attribute is an element within a Cell on a Report.
Balance is the raw AccountsReceivable(sales invoices) and AccountsPayable(bills)outstanding and overdue amounts, not converted to base currency.
Balances are the raw AccountsReceivable(sales invoices) and AccountsPayable(bills)outstanding and overdue amounts, not converted to base currency.
BankAccount is an element on a BankTransfer - it is not to be used alone and has no methods.
BankTransaction is a bank transaction.
BankTransactions contains a collection of BankTransactions.
BankTransfer is a record of monies transferred from one bank account to another.
BankTransfers contains a collection of BankTransfers.
No description provided by the author
No description provided by the author
BrandingTheme applies structure and visuals to an invoice when printed or sent.
BrandingThemes contains a collection of BrandingThemes.
Cell is an element within a Row on a Report.
Contact is a debtor/customer or creditor/supplier in a Xero Organisation.
ContactGroup is a way of organising Contacts into groups.
ContactGroups is a collection of ContactGroups.
ContactPerson is a Contact Person against a Contact.
Contacts contains a collection of Contacts.
CreditNote an be raised directly against a customer or supplier,allowing the customer or supplier to be held in credit until a future invoice or bill is raised.
CreditNotes is a collection of CreditNote.
Currencies is a collection of Currencies.
Currency is the local currency set up to be used in Xero.
Employee is for the deprecated Pay run feature.
ExpenseClaim is a collection of receipts from personal spending that needs to be reimbursed by the business.
ExpenseClaims contains a collection of ExpenseClaims.
No description provided by the author
BankTransfer is a record of monies transferred from one bank account to another.
BankTransfers contains a collection of BankTransfers.
Invoice is an Accounts Payable or Accounts Recievable document in a Xero organisation.
InvoiceID should only be used when you only need to return an Invoice ID and/or InvoiceNumber.
Invoices contains a collection of Invoices.
Item is something that is sold or purchased.
Items is a collection of Items.
Journal is a record of a financial transaction in Xero.
JournalLine is a line on a Journal.
Journals is a collection of Journals.
LineItem is a line containing detail on an Invoice.
LinkedTransaction can link transactions from an Accounts Payable invoice to anaccounts recievable invoice - also known as a billable expense.
LinkedTransactions is a collection of LinkedTransactions.
ManualJournal used by accountants or bookkeepers to work directly with the general ledger.
ManualJournalLine is a line on a Manual Journal.
ManualJournals is a collection of ManualJournals.
Options is a collection of TrackingOptions.
Organisation is information about a Xero organisation.
OrganisationCollection contains a collection of Organisations - but there will only ever be one.
Overpayment is used when a debtor overpays an invoice.
Overpayments is a collection of Overpayments.
Payment details payments against invoices and CreditNotes.
Payments is a collection of Payments.
No description provided by the author
No description provided by the author
Prepayment are payments made before the associated document has been created.
Prepayments is a collection of Prepayments.
No description provided by the author
PurchaseAndSaleDetails are Elements for Purchases and Sales.
PurchaseOrder is the first official offer issued by a buyer to a seller, indicating types, quantities, and agreed prices for products or services.
PurchaseOrders contains a collection of PurchaseOrders.
Receipt is a record of personal money spent that a user would like to be reimbursed for - see also ExpenseClaim.
Receipts contains a collection of Receipts.
RepeatingInvoice a template for the invoices you send and bills you receive regularly.
RepeatingInvoices is a collection of RepeatingInvoices.
Report is an organised set of financial information.
ReportAttribute is an element on a report.
ReportField is an element on a report.
Reports is a collection of reports.
Row is a Row on a Report.
Schedule is an element on a Repeating Invoice - do not use it separately.
TaxComponent is a component of tax witjin a TaxRate.
TaxRate is a rate at which an item or service is taxed when sold or purchased.
No description provided by the author
TrackingCategories is a collection of TrackingCategories.
TrackingCategory is used to segment data within a Xero organisation.
TrackingOption is an option from within a Tracking category.
User represents a login that has been granted access to the Xero organisation you're connected to.
Users is a collection of Users.