{ "opencollection": "1.0.0", "info": { "name": "Xero Accounting Finance API", "version": "11.1.0" }, "items": [ { "info": { "name": "Finance", "type": "folder" }, "items": [ { "info": { "name": "Xero Get cash validation", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/CashValidation", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "balanceDate", "value": "2021-09-15", "type": "query", "description": "date, yyyy-MM-dd \r\n\r\nIf no parameter is provided, the current date will be used.\r\n\r\nThe ‘balance date’ will return transactions based on the accounting date entered by the user. Transactions before the balanceDate will be included.\r\nThe user has discretion as to which accounting period the transaction relates to.\r\n\r\nThe ‘balance date’ will control the latest maximum date of transactions included in the aggregate numbers. Balance date does not affect the CurrentStatement object, as this will always return the most recent statement before asAtSystemDate (if specified)" }, { "name": "asAtSystemDate", "value": "2021-09-15", "type": "query", "description": "date, yyyy-MM-dd \r\n\r\nIf no parameter is provided, the current date will be used.\r\n\r\nThe ‘as at’ date will return transactions based on the creation date. It reflects the date the transactions were entered into Xero, not the accounting date.\r\nThe ‘as at’ date can not be overridden by the user. This can be used to estimate a ‘historical frequency of reconciliation’.\r\n\r\nThe ‘as at’ date will affect the current statement in the response, as any candidate statements created after this date will be filtered out. Thus the current statement returned will be the most recent statement prior to the specified ‘as at’ date. Be aware that neither the begin date, nor the balance date, will affect the current statement.\r\n\r\nNote; information is only presented when system architecture allows, meaning historical cash validation information will be an estimate. In addition, delete events are not aware of the ‘as at’ functionality in this endpoint, meaning that transactions deleted at the time the API is accessed will be considered to always have been deleted." }, { "name": "beginDate", "value": "2021-09-15", "type": "query", "description": "date, yyyy-MM-dd \r\n\r\nIf no parameter is provided, the aggregate results will be drawn from the user’s total history.\r\n\r\nThe ‘begin date’ will return transactions based on the accounting date entered by the user. Transactions after the beginDate will be included.\r\nThe user has discretion as to which accounting period the transaction relates to." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.xero.com/identity/connect/authorize", "accessTokenUrl": "https://identity.xero.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Summarizes the total cash position for each account for an org" }, { "info": { "name": "Xero Get Balance Sheet report", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/FinancialStatements/BalanceSheet", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "balanceDate", "value": "2020-06-30", "type": "query", "description": "Specifies the date for balance sheet report.\r\n\r\nFormat yyyy-MM-dd. If no parameter is provided, the current date will be used." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.xero.com/identity/connect/authorize", "accessTokenUrl": "https://identity.xero.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "The balance sheet report is a standard financial report which describes the financial position of an organisation at a point in time." }, { "info": { "name": "Xero Get Cash flow report", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/FinancialStatements/Cashflow", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "startDate", "value": "2020-09-15", "type": "query", "description": "Date e.g. yyyy-MM-dd\r\n\r\nSpecifies the start date for cash flow report.\r\n\r\nIf no parameter is provided, the date of 12 months before the end date will be used." }, { "name": "endDate", "value": "2021-09-15", "type": "query", "description": "Date e.g. yyyy-MM-dd\r\n\r\nSpecifies the end date for cash flow report.\r\n\r\nIf no parameter is provided, the current date will be used." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.xero.com/identity/connect/authorize", "accessTokenUrl": "https://identity.xero.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "The statement of cash flows - direct method, provides the year to date changes in operating, financing and investing cash flow activities for an organisation. Cashflow statement is not available in US region at this stage." }, { "info": { "name": "Xero Get Profit & Loss report", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/FinancialStatements/ProfitAndLoss", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "startDate", "value": "2020-09-15", "type": "query", "description": "Date e.g. yyyy-MM-dd\r\n\r\nSpecifies the start date for profit and loss report\r\n\r\nIf no parameter is provided, the date of 12 months before the end date will be used." }, { "name": "endDate", "value": "2021-09-15", "type": "query", "description": "Date e.g. yyyy-MM-dd\r\n\r\nSpecifies the end date for profit and loss report \r\n\r\nIf no parameter is provided, the current date will be used." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.xero.com/identity/connect/authorize", "accessTokenUrl": "https://identity.xero.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "The profit and loss statement is a standard financial report providing detailed year to date income and expense detail for an organisation." }, { "info": { "name": "Xero Get Trial Balance report", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/FinancialStatements/TrialBalance", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "endDate", "value": "2021-09-15", "type": "query", "description": "Date e.g. yyyy-MM-dd \r\n\r\nSpecifies the end date for trial balance report \r\n\r\nIf no parameter is provided, the current date will be used." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.xero.com/identity/connect/authorize", "accessTokenUrl": "https://identity.xero.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "The trial balance provides a detailed list of all accounts of an organisation at a point in time, with revenue and expense items being year to date." }, { "info": { "name": "Xero Get revenue by contacts report", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/FinancialStatements/contacts/revenue", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "contactIds", "value": "", "type": "query", "description": "Specifies the customer contacts to be included in the report.\r\n\r\nIf no parameter is provided, all customer contacts will be included" }, { "name": "includeManualJournals", "value": "true", "type": "query", "description": "Specifies whether to include the manual journals in the report.\r\n \r\nIf no parameter is provided, manual journals will not be included." }, { "name": "startDate", "value": "2020-09-15", "type": "query", "description": "Date yyyy-MM-dd\r\n\r\nSpecifies the start date for the report.\r\n \r\nIf no parameter is provided, the date of 12 months before the end date will be used.\r\n \r\nIt is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency." }, { "name": "endDate", "value": "2020-09-15", "type": "query", "description": "Date yyyy-MM-dd\r\n\r\nSpecifies the end date for the report.\r\n\r\nIf no parameter is provided, the current date will be used.\r\n \r\nIt is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.xero.com/identity/connect/authorize", "accessTokenUrl": "https://identity.xero.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "The revenue by contact report provides a year to date profit and loss for customers and suppliers for a given organisation, including detailed contact information." }, { "info": { "name": "Xero Get expense by contacts report", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/FinancialStatements/contacts/expense", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "contactIds", "value": "", "type": "query", "description": "Specifies the customer contacts to be included in the report.\r\n\r\nIf no parameter is provided, all customer contacts will be included" }, { "name": "includeManualJournals", "value": "true", "type": "query", "description": "Specifies whether to include the manual journals in the report.\r\n \r\nIf no parameter is provided, manual journals will not be included." }, { "name": "startDate", "value": "2020-09-15", "type": "query", "description": "Date yyyy-MM-dd\r\n\r\nSpecifies the start date for the report.\r\n \r\nIf no parameter is provided, the date of 12 months before the end date will be used.\r\n \r\nIt is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency." }, { "name": "endDate", "value": "2020-09-15", "type": "query", "description": "Date yyyy-MM-dd\r\n\r\nSpecifies the end date for the report.\r\n\r\nIf no parameter is provided, the current date will be used.\r\n \r\nIt is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.xero.com/identity/connect/authorize", "accessTokenUrl": "https://identity.xero.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "The expense by contact report provides a year to date profit and loss for customers and suppliers for a given organisation, including detailed contact information." }, { "info": { "name": "Xero Get Bank Statement Accounting", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/BankStatementsPlus/statements", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "BankAccountID", "value": "", "type": "query", "description": "string, GUID\r\n\r\nBank account Id" }, { "name": "FromDate", "value": "2020-07-01", "type": "query", "description": "date, yyyy-MM-dd \r\n\r\nSpecifies the start date of the query period. \r\nThe maximum range of the query period is 12 months. If the specified query period is more than 12 months the request will be rejected." }, { "name": "ToDate", "value": "2021-06-30", "type": "query", "description": "date, yyyy-MM-dd \r\n\r\nSpecifies the end date of the query period. \r\nIf the end date is a future date, the request will be rejected." }, { "name": "SummaryOnly", "value": "true", "type": "query", "description": "boolean, true/false\r\n\r\nThe default value is true if no parameter is provided.\r\n\r\nIn summary mode, the response will exclude the computation-heavy LineItems fields from bank transaction, invoice, credit note, prepayment and overpayment data, making the API calls quicker and more efficient." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://login.xero.com/identity/connect/authorize", "accessTokenUrl": "https://identity.xero.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "For lenders that prefer using bank statement data as the source of truth. We provide a data point that will allow access to customer bank statements, plus for reconciled bank transactions the matching accounting, invoice and billing data as well. As customers reconcile bank statements to invoices and bills, this transaction detail will provide valuable insight for lender's assessment measures. " } ] } ], "bundled": true }