{ "opencollection": "1.0.0", "info": { "name": "Xero Accounting API", "version": "11.1.0" }, "items": [ { "info": { "name": "Accounting", "type": "folder" }, "items": [ { "info": { "name": "Xero Retrieves the full chart of accounts", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Accounts", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "If-Modified-Since", "value": "2020-02-06T12:17:43.202-08:00" } ], "params": [ { "name": "where", "value": "Status=="ACTIVE" AND Type=="BANK"", "type": "query", "description": "Filter by an any element" }, { "name": "order", "value": "Name ASC", "type": "query", "description": "Order by an any element" } ], "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": "Xero Retrieves the full chart of accounts" }, { "info": { "name": "Xero Creates a new chart of accounts", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/Accounts", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates a new chart of accounts" }, { "info": { "name": "Xero Retrieves a single chart of accounts by using a unique account Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Accounts/:AccountID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "AccountID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for Account object" } ], "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": "Xero Retrieves a single chart of accounts by using a unique account Id" }, { "info": { "name": "Xero Updates a chart of accounts", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/Accounts/:AccountID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "AccountID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for Account object" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Updates a chart of accounts" }, { "info": { "name": "Xero Deletes a chart of accounts", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.xero.com/api.xro/2.0/Accounts/:AccountID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "AccountID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for Account object" } ], "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": "Xero Deletes a chart of accounts" }, { "info": { "name": "Xero Retrieves attachments for a specific accounts by using a unique account Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Accounts/:AccountID/Attachments", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "AccountID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for Account object" } ], "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": "Xero Retrieves attachments for a specific accounts by using a unique account Id" }, { "info": { "name": "Xero Retrieves a specific attachment from a specific account using a unique attachment Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Accounts/:AccountID/Attachments/:AttachmentID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "contentType", "value": "image/jpg" } ], "params": [ { "name": "AccountID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for Account object" }, { "name": "AttachmentID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for Attachment object" } ], "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": "Xero Retrieves a specific attachment from a specific account using a unique attachment Id" }, { "info": { "name": "Xero Retrieves an attachment for a specific account by filename", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Accounts/:AccountID/Attachments/:FileName", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "contentType", "value": "image/jpg" } ], "params": [ { "name": "AccountID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for Account object" }, { "name": "FileName", "value": "xero-dev.jpg", "type": "path", "description": "Name of the attachment" } ], "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": "Xero Retrieves an attachment for a specific account by filename" }, { "info": { "name": "Xero Updates attachment on a specific account by filename", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/Accounts/:AccountID/Attachments/:FileName", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "AccountID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for Account object" }, { "name": "FileName", "value": "xero-dev.jpg", "type": "path", "description": "Name of the attachment" } ], "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": "Xero Updates attachment on a specific account by filename" }, { "info": { "name": "Xero Creates an attachment on a specific account", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/Accounts/:AccountID/Attachments/:FileName", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "AccountID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for Account object" }, { "name": "FileName", "value": "xero-dev.jpg", "type": "path", "description": "Name of the attachment" } ], "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": "Xero Creates an attachment on a specific account" }, { "info": { "name": "Xero Retrieves either one or many batch payments for invoices", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/BatchPayments", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "If-Modified-Since", "value": "2020-02-06T12:17:43.202-08:00" } ], "params": [ { "name": "where", "value": "Status==\"AUTHORISED\"", "type": "query", "description": "Filter by an any element" }, { "name": "order", "value": "Date ASC", "type": "query", "description": "Order by an any element" } ], "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": "Xero Retrieves either one or many batch payments for invoices" }, { "info": { "name": "Xero Updates a specific batch payment for invoices and credit notes", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/BatchPayments", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Updates a specific batch payment for invoices and credit notes" }, { "info": { "name": "Xero Creates one or many batch payments for invoices", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/BatchPayments", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "summarizeErrors", "value": "true", "type": "query", "description": "If false return 200 OK and mix of successfully created objects and any with validation errors" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates one or many batch payments for invoices" }, { "info": { "name": "Xero Retrieves a specific batch payment using a unique batch payment Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/BatchPayments/:BatchPaymentID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "BatchPaymentID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for BatchPayment" } ], "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": "Xero Retrieves a specific batch payment using a unique batch payment Id" }, { "info": { "name": "Xero Updates a specific batch payment for invoices and credit notes", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/BatchPayments/:BatchPaymentID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "BatchPaymentID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for BatchPayment" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Updates a specific batch payment for invoices and credit notes" }, { "info": { "name": "Xero Retrieves history from a specific batch payment", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/BatchPayments/:BatchPaymentID/History", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "BatchPaymentID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for BatchPayment" } ], "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": "Xero Retrieves history from a specific batch payment" }, { "info": { "name": "Xero Creates a history record for a specific batch payment", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/BatchPayments/:BatchPaymentID/History", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "BatchPaymentID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for BatchPayment" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates a history record for a specific batch payment" }, { "info": { "name": "Xero Retrieves any spent or received money transactions", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/BankTransactions", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "If-Modified-Since", "value": "2020-02-06T12:17:43.202-08:00" } ], "params": [ { "name": "where", "value": "Status==\"AUTHORISED\"", "type": "query", "description": "Filter by an any element" }, { "name": "order", "value": "Type ASC", "type": "query", "description": "Order by an any element" }, { "name": "page", "value": "1", "type": "query", "description": "Up to 100 bank transactions will be returned in a single API call with line items details" }, { "name": "unitdp", "value": "4", "type": "query", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" }, { "name": "pageSize", "value": "100", "type": "query", "description": "Number of records to retrieve per page" } ], "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": "Xero Retrieves any spent or received money transactions" }, { "info": { "name": "Xero Updates or creates one or more spent or received money transaction", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/BankTransactions", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "summarizeErrors", "value": "true", "type": "query", "description": "If false return 200 OK and mix of successfully created objects and any with validation errors" }, { "name": "unitdp", "value": "4", "type": "query", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Updates or creates one or more spent or received money transaction" }, { "info": { "name": "Xero Creates one or more spent or received money transaction", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/BankTransactions", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "summarizeErrors", "value": "true", "type": "query", "description": "If false return 200 OK and mix of successfully created objects and any with validation errors" }, { "name": "unitdp", "value": "4", "type": "query", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates one or more spent or received money transaction" }, { "info": { "name": "Xero Retrieves a single spent or received money transaction by using a unique bank transaction Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/BankTransactions/:BankTransactionID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "BankTransactionID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Xero generated unique identifier for a bank transaction" }, { "name": "unitdp", "value": "4", "type": "query", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" } ], "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": "Xero Retrieves a single spent or received money transaction by using a unique bank transaction Id" }, { "info": { "name": "Xero Updates a single spent or received money transaction", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/BankTransactions/:BankTransactionID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "BankTransactionID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Xero generated unique identifier for a bank transaction" }, { "name": "unitdp", "value": "4", "type": "query", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Updates a single spent or received money transaction" }, { "info": { "name": "Xero Retrieves any attachments from a specific bank transactions", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/BankTransactions/:BankTransactionID/Attachments", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "BankTransactionID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Xero generated unique identifier for a bank transaction" } ], "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": "Xero Retrieves any attachments from a specific bank transactions" }, { "info": { "name": "Xero Retrieves specific attachments from a specific BankTransaction using a unique attachment Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/BankTransactions/:BankTransactionID/Attachments/:AttachmentID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "contentType", "value": "image/jpg" } ], "params": [ { "name": "BankTransactionID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Xero generated unique identifier for a bank transaction" }, { "name": "AttachmentID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for Attachment object" } ], "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": "Xero Retrieves specific attachments from a specific BankTransaction using a unique attachment Id" }, { "info": { "name": "Xero Retrieves a specific attachment from a specific bank transaction by filename", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/BankTransactions/:BankTransactionID/Attachments/:FileName", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "contentType", "value": "image/jpg" } ], "params": [ { "name": "BankTransactionID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Xero generated unique identifier for a bank transaction" }, { "name": "FileName", "value": "xero-dev.jpg", "type": "path", "description": "Name of the attachment" } ], "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": "Xero Retrieves a specific attachment from a specific bank transaction by filename" }, { "info": { "name": "Xero Updates a specific attachment from a specific bank transaction by filename", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/BankTransactions/:BankTransactionID/Attachments/:FileName", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "BankTransactionID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Xero generated unique identifier for a bank transaction" }, { "name": "FileName", "value": "xero-dev.jpg", "type": "path", "description": "Name of the attachment" } ], "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": "Xero Updates a specific attachment from a specific bank transaction by filename" }, { "info": { "name": "Xero Creates an attachment for a specific bank transaction by filename", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/BankTransactions/:BankTransactionID/Attachments/:FileName", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "BankTransactionID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Xero generated unique identifier for a bank transaction" }, { "name": "FileName", "value": "xero-dev.jpg", "type": "path", "description": "Name of the attachment" } ], "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": "Xero Creates an attachment for a specific bank transaction by filename" }, { "info": { "name": "Xero Retrieves history from a specific bank transaction using a unique bank transaction Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/BankTransactions/:BankTransactionID/History", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "BankTransactionID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Xero generated unique identifier for a bank transaction" } ], "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": "Xero Retrieves history from a specific bank transaction using a unique bank transaction Id" }, { "info": { "name": "Xero Creates a history record for a specific bank transactions", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/BankTransactions/:BankTransactionID/History", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "BankTransactionID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Xero generated unique identifier for a bank transaction" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates a history record for a specific bank transactions" }, { "info": { "name": "Xero Retrieves all bank transfers", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/BankTransfers", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "If-Modified-Since", "value": "2020-02-06T12:17:43.202-08:00" } ], "params": [ { "name": "where", "value": "HasAttachments==true", "type": "query", "description": "Filter by an any element" }, { "name": "order", "value": "Amount ASC", "type": "query", "description": "Order by an any element" } ], "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": "Xero Retrieves all bank transfers" }, { "info": { "name": "Xero Creates a bank transfer", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/BankTransfers", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates a bank transfer" }, { "info": { "name": "Xero Retrieves specific bank transfers by using a unique bank transfer Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/BankTransfers/:BankTransferID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "BankTransferID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Xero generated unique identifier for a bank transfer" } ], "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": "Xero Retrieves specific bank transfers by using a unique bank transfer Id" }, { "info": { "name": "Xero Retrieves attachments from a specific bank transfer", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/BankTransfers/:BankTransferID/Attachments", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "BankTransferID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Xero generated unique identifier for a bank transfer" } ], "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": "Xero Retrieves attachments from a specific bank transfer" }, { "info": { "name": "Xero Retrieves a specific attachment from a specific bank transfer using a unique attachment ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/BankTransfers/:BankTransferID/Attachments/:AttachmentID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "contentType", "value": "image/jpg" } ], "params": [ { "name": "BankTransferID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Xero generated unique identifier for a bank transfer" }, { "name": "AttachmentID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for Attachment object" } ], "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": "Xero Retrieves a specific attachment from a specific bank transfer using a unique attachment ID" }, { "info": { "name": "Xero Retrieves a specific attachment on a specific bank transfer by file name", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/BankTransfers/:BankTransferID/Attachments/:FileName", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "contentType", "value": "image/jpg" } ], "params": [ { "name": "BankTransferID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Xero generated unique identifier for a bank transfer" }, { "name": "FileName", "value": "xero-dev.jpg", "type": "path", "description": "Name of the attachment" } ], "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": "Xero Retrieves a specific attachment on a specific bank transfer by file name" }, { "info": { "name": "updateBankTransferAttachmentByFileName", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/BankTransfers/:BankTransferID/Attachments/:FileName", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "BankTransferID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Xero generated unique identifier for a bank transfer" }, { "name": "FileName", "value": "xero-dev.jpg", "type": "path", "description": "Name of the attachment" } ], "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}}" } } } }, { "info": { "name": "createBankTransferAttachmentByFileName", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/BankTransfers/:BankTransferID/Attachments/:FileName", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "BankTransferID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Xero generated unique identifier for a bank transfer" }, { "name": "FileName", "value": "xero-dev.jpg", "type": "path", "description": "Name of the attachment" } ], "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}}" } } } }, { "info": { "name": "Xero Retrieves history from a specific bank transfer using a unique bank transfer Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/BankTransfers/:BankTransferID/History", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "BankTransferID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Xero generated unique identifier for a bank transfer" } ], "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": "Xero Retrieves history from a specific bank transfer using a unique bank transfer Id" }, { "info": { "name": "Xero Creates a history record for a specific bank transfer", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/BankTransfers/:BankTransferID/History", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "BankTransferID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Xero generated unique identifier for a bank transfer" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates a history record for a specific bank transfer" }, { "info": { "name": "Xero Retrieves all the branding themes", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/BrandingThemes", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "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": "Xero Retrieves all the branding themes" }, { "info": { "name": "Xero Retrieves a specific branding theme using a unique branding theme Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/BrandingThemes/:BrandingThemeID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "BrandingThemeID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Branding Theme" } ], "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": "Xero Retrieves a specific branding theme using a unique branding theme Id" }, { "info": { "name": "Xero Retrieves the payment services for a specific branding theme", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/BrandingThemes/:BrandingThemeID/PaymentServices", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "BrandingThemeID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Branding Theme" } ], "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": "Xero Retrieves the payment services for a specific branding theme" }, { "info": { "name": "Xero Creates a new custom payment service for a specific branding theme", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/BrandingThemes/:BrandingThemeID/PaymentServices", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "BrandingThemeID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Branding Theme" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates a new custom payment service for a specific branding theme" }, { "info": { "name": "Xero Retrieve a list of budgets", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Budgets", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "IDs", "value": ""00000000-0000-0000-0000-000000000000"", "type": "query", "description": "Filter by BudgetID. Allows you to retrieve a specific individual budget." }, { "name": "DateTo", "value": "2019-10-31", "type": "query", "description": "Filter by start date" }, { "name": "DateFrom", "value": "2019-10-31", "type": "query", "description": "Filter by end date" } ], "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": "Xero Retrieve a list of budgets" }, { "info": { "name": "Xero Retrieves a specific budget, which includes budget lines", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Budgets/:BudgetID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "BudgetID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for Budgets" }, { "name": "DateTo", "value": "2019-10-31", "type": "query", "description": "Filter by start date" }, { "name": "DateFrom", "value": "2019-10-31", "type": "query", "description": "Filter by end date" } ], "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": "Xero Retrieves a specific budget, which includes budget lines" }, { "info": { "name": "Retrieves all contacts in a Xero organisation", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Contacts", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "If-Modified-Since", "value": "2020-02-06T12:17:43.202-08:00" } ], "params": [ { "name": "where", "value": "ContactStatus=="ACTIVE"", "type": "query", "description": "Filter by an any element" }, { "name": "order", "value": "Name ASC", "type": "query", "description": "Order by an any element" }, { "name": "IDs", "value": ""00000000-0000-0000-0000-000000000000"", "type": "query", "description": "Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call." }, { "name": "page", "value": "1", "type": "query", "description": "e.g. page=1 - Up to 100 contacts will be returned in a single API call." }, { "name": "includeArchived", "value": "true", "type": "query", "description": "e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response" }, { "name": "summaryOnly", "value": "true", "type": "query", "description": "Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient." }, { "name": "searchTerm", "value": "Joe Bloggs", "type": "query", "description": "Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields." }, { "name": "pageSize", "value": "100", "type": "query", "description": "Number of records to retrieve per page" } ], "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": "Retrieves all contacts in a Xero organisation" }, { "info": { "name": "Updates or creates one or more contacts in a Xero organisation", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/Contacts", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "summarizeErrors", "value": "true", "type": "query", "description": "If false return 200 OK and mix of successfully created objects and any with validation errors" } ], "body": { "type": "json", "data": "{}" }, "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": "Updates or creates one or more contacts in a Xero organisation" }, { "info": { "name": "Creates multiple contacts (bulk) in a Xero organisation", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/Contacts", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "summarizeErrors", "value": "true", "type": "query", "description": "If false return 200 OK and mix of successfully created objects and any with validation errors" } ], "body": { "type": "json", "data": "{}" }, "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": "Creates multiple contacts (bulk) in a Xero organisation" }, { "info": { "name": "Retrieves a specific contact by contact number in a Xero organisation", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Contacts/:ContactNumber", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "ContactNumber", "value": "SB2", "type": "path", "description": "This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50)." } ], "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": "Retrieves a specific contact by contact number in a Xero organisation" }, { "info": { "name": "Retrieves a specific contacts in a Xero organisation using a unique contact Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Contacts/:ContactID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "ContactID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Contact" } ], "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": "Retrieves a specific contacts in a Xero organisation using a unique contact Id" }, { "info": { "name": "Updates a specific contact in a Xero organisation", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/Contacts/:ContactID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "ContactID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Contact" } ], "body": { "type": "json", "data": "{}" }, "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": "Updates a specific contact in a Xero organisation" }, { "info": { "name": "Retrieves attachments for a specific contact in a Xero organisation", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Contacts/:ContactID/Attachments", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "ContactID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Contact" } ], "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": "Retrieves attachments for a specific contact in a Xero organisation" }, { "info": { "name": "Xero Retrieves a specific attachment from a specific contact using a unique attachment Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Contacts/:ContactID/Attachments/:AttachmentID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "contentType", "value": "image/jpg" } ], "params": [ { "name": "ContactID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Contact" }, { "name": "AttachmentID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for Attachment object" } ], "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": "Xero Retrieves a specific attachment from a specific contact using a unique attachment Id" }, { "info": { "name": "Xero Retrieves a specific attachment from a specific contact by file name", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Contacts/:ContactID/Attachments/:FileName", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "contentType", "value": "image/jpg" } ], "params": [ { "name": "ContactID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Contact" }, { "name": "FileName", "value": "xero-dev.jpg", "type": "path", "description": "Name of the attachment" } ], "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": "Xero Retrieves a specific attachment from a specific contact by file name" }, { "info": { "name": "updateContactAttachmentByFileName", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/Contacts/:ContactID/Attachments/:FileName", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "ContactID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Contact" }, { "name": "FileName", "value": "xero-dev.jpg", "type": "path", "description": "Name of the attachment" } ], "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}}" } } } }, { "info": { "name": "createContactAttachmentByFileName", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/Contacts/:ContactID/Attachments/:FileName", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "ContactID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Contact" }, { "name": "FileName", "value": "xero-dev.jpg", "type": "path", "description": "Name of the attachment" } ], "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}}" } } } }, { "info": { "name": "Retrieves CIS settings for a specific contact in a Xero organisation", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Contacts/:ContactID/CISSettings", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "ContactID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Contact" } ], "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": "Retrieves CIS settings for a specific contact in a Xero organisation" }, { "info": { "name": "Xero Retrieves history records for a specific contact", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Contacts/:ContactID/History", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "ContactID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Contact" } ], "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": "Xero Retrieves history records for a specific contact" }, { "info": { "name": "Xero Creates a new history record for a specific contact", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/Contacts/:ContactID/History", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "ContactID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Contact" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates a new history record for a specific contact" }, { "info": { "name": "Xero Retrieves the contact Id and name of each contact group", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/ContactGroups", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "where", "value": "Status==\"ACTIVE\"", "type": "query", "description": "Filter by an any element" }, { "name": "order", "value": "Name ASC", "type": "query", "description": "Order by an any element" } ], "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": "Xero Retrieves the contact Id and name of each contact group" }, { "info": { "name": "Xero Creates a contact group", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/ContactGroups", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates a contact group" }, { "info": { "name": "Xero Retrieves a specific contact group by using a unique contact group Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/ContactGroups/:ContactGroupID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "ContactGroupID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Contact Group" } ], "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": "Xero Retrieves a specific contact group by using a unique contact group Id" }, { "info": { "name": "Xero Updates a specific contact group", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/ContactGroups/:ContactGroupID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "ContactGroupID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Contact Group" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Updates a specific contact group" }, { "info": { "name": "Xero Creates contacts to a specific contact group", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/ContactGroups/:ContactGroupID/Contacts", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "ContactGroupID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Contact Group" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates contacts to a specific contact group" }, { "info": { "name": "Xero Deletes all contacts from a specific contact group", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.xero.com/api.xro/2.0/ContactGroups/:ContactGroupID/Contacts", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "ContactGroupID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Contact Group" } ], "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": "Xero Deletes all contacts from a specific contact group" }, { "info": { "name": "Xero Deletes a specific contact from a contact group using a unique contact Id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.xero.com/api.xro/2.0/ContactGroups/:ContactGroupID/Contacts/:ContactID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "ContactGroupID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Contact Group" }, { "name": "ContactID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Contact" } ], "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": "Xero Deletes a specific contact from a contact group using a unique contact Id" }, { "info": { "name": "Xero Retrieves any credit notes", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/CreditNotes", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "If-Modified-Since", "value": "2020-02-06T12:17:43.202-08:00" } ], "params": [ { "name": "where", "value": "Status==\"DRAFT\"", "type": "query", "description": "Filter by an any element" }, { "name": "order", "value": "CreditNoteNumber ASC", "type": "query", "description": "Order by an any element" }, { "name": "page", "value": "1", "type": "query", "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": "unitdp", "value": "4", "type": "query", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" }, { "name": "pageSize", "value": "100", "type": "query", "description": "Number of records to retrieve per page" } ], "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": "Xero Retrieves any credit notes" }, { "info": { "name": "Xero Updates or creates one or more credit notes", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/CreditNotes", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "summarizeErrors", "value": "true", "type": "query", "description": "If false return 200 OK and mix of successfully created objects and any with validation errors" }, { "name": "unitdp", "value": "4", "type": "query", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Updates or creates one or more credit notes" }, { "info": { "name": "Xero Creates a new credit note", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/CreditNotes", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "summarizeErrors", "value": "true", "type": "query", "description": "If false return 200 OK and mix of successfully created objects and any with validation errors" }, { "name": "unitdp", "value": "4", "type": "query", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates a new credit note" }, { "info": { "name": "Xero Retrieves a specific credit note using a unique credit note Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/CreditNotes/:CreditNoteID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "CreditNoteID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Credit Note" }, { "name": "unitdp", "value": "4", "type": "query", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" } ], "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": "Xero Retrieves a specific credit note using a unique credit note Id" }, { "info": { "name": "Xero Updates a specific credit note", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/CreditNotes/:CreditNoteID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "CreditNoteID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Credit Note" }, { "name": "unitdp", "value": "4", "type": "query", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Updates a specific credit note" }, { "info": { "name": "Xero Retrieves attachments for a specific credit notes", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/CreditNotes/:CreditNoteID/Attachments", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "CreditNoteID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Credit Note" } ], "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": "Xero Retrieves attachments for a specific credit notes" }, { "info": { "name": "Xero Retrieves a specific attachment from a specific credit note using a unique attachment Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/CreditNotes/:CreditNoteID/Attachments/:AttachmentID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "contentType", "value": "image/jpg" } ], "params": [ { "name": "CreditNoteID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Credit Note" }, { "name": "AttachmentID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for Attachment object" } ], "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": "Xero Retrieves a specific attachment from a specific credit note using a unique attachment Id" }, { "info": { "name": "Xero Retrieves a specific attachment on a specific credit note by file name", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/CreditNotes/:CreditNoteID/Attachments/:FileName", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "contentType", "value": "image/jpg" } ], "params": [ { "name": "CreditNoteID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Credit Note" }, { "name": "FileName", "value": "xero-dev.jpg", "type": "path", "description": "Name of the attachment" } ], "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": "Xero Retrieves a specific attachment on a specific credit note by file name" }, { "info": { "name": "Xero Updates attachments on a specific credit note by file name", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/CreditNotes/:CreditNoteID/Attachments/:FileName", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "CreditNoteID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Credit Note" }, { "name": "FileName", "value": "xero-dev.jpg", "type": "path", "description": "Name of the attachment" } ], "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": "Xero Updates attachments on a specific credit note by file name" }, { "info": { "name": "Xero Creates an attachment for a specific credit note", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/CreditNotes/:CreditNoteID/Attachments/:FileName", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "CreditNoteID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Credit Note" }, { "name": "FileName", "value": "xero-dev.jpg", "type": "path", "description": "Name of the attachment" }, { "name": "IncludeOnline", "value": "true", "type": "query", "description": "Allows an attachment to be seen by the end customer within their online invoice" } ], "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": "Xero Creates an attachment for a specific credit note" }, { "info": { "name": "Xero Retrieves credit notes as PDF files", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/CreditNotes/:CreditNoteID/pdf", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "CreditNoteID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Credit Note" } ], "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": "Xero Retrieves credit notes as PDF files" }, { "info": { "name": "Xero Creates allocation for a specific credit note", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/CreditNotes/:CreditNoteID/Allocations", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "CreditNoteID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Credit Note" }, { "name": "summarizeErrors", "value": "true", "type": "query", "description": "If false return 200 OK and mix of successfully created objects and any with validation errors" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates allocation for a specific credit note" }, { "info": { "name": "Xero Deletes an Allocation from a Credit Note", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.xero.com/api.xro/2.0/CreditNotes/:CreditNoteID/Allocations/:AllocationID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "CreditNoteID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Credit Note" }, { "name": "AllocationID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for Allocation object" } ], "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": "Xero Deletes an Allocation from a Credit Note" }, { "info": { "name": "Xero Retrieves history records of a specific credit note", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/CreditNotes/:CreditNoteID/History", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "CreditNoteID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Credit Note" } ], "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": "Xero Retrieves history records of a specific credit note" }, { "info": { "name": "Xero Retrieves history records of a specific credit note", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/CreditNotes/:CreditNoteID/History", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "CreditNoteID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Credit Note" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Retrieves history records of a specific credit note" }, { "info": { "name": "Retrieves currencies for your Xero organisation", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Currencies", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "where", "value": "Code==\"USD\"", "type": "query", "description": "Filter by an any element" }, { "name": "order", "value": "Code ASC", "type": "query", "description": "Order by an any element" } ], "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": "Retrieves currencies for your Xero organisation" }, { "info": { "name": "Create a new currency for a Xero organisation", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/Currencies", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "body": { "type": "json", "data": "{}" }, "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": "Create a new currency for a Xero organisation" }, { "info": { "name": "Retrieves employees used in Xero payrun", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Employees", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "If-Modified-Since", "value": "2020-02-06T12:17:43.202-08:00" } ], "params": [ { "name": "where", "value": "Status==\"ACTIVE\"", "type": "query", "description": "Filter by an any element" }, { "name": "order", "value": "LastName ASC", "type": "query", "description": "Order by an any element" } ], "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": "This endpoint is deprecated and will be removed April 28, 2026" }, { "info": { "name": "Creates a single new employees used in Xero payrun", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/Employees", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "summarizeErrors", "value": "true", "type": "query", "description": "If false return 200 OK and mix of successfully created objects and any with validation errors" } ], "body": { "type": "json", "data": "{}" }, "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": "This endpoint is deprecated and will be removed April 28, 2026" }, { "info": { "name": "Creates new employees used in Xero payrun", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/Employees", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "summarizeErrors", "value": "true", "type": "query", "description": "If false return 200 OK and mix of successfully created objects and any with validation errors" } ], "body": { "type": "json", "data": "{}" }, "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": "This endpoint is deprecated and will be removed April 28, 2026" }, { "info": { "name": "Retrieves a specific employee used in Xero payrun using a unique employee Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Employees/:EmployeeID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "EmployeeID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Employee" } ], "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": "This endpoint is deprecated and will be removed April 28, 2026" }, { "info": { "name": "Xero Retrieves expense claims", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/ExpenseClaims", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "If-Modified-Since", "value": "2020-02-06T12:17:43.202-08:00" } ], "params": [ { "name": "where", "value": "Status==\"SUBMITTED\"", "type": "query", "description": "Filter by an any element" }, { "name": "order", "value": "Status ASC", "type": "query", "description": "Order by an any element" } ], "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": "Xero Retrieves expense claims" }, { "info": { "name": "Xero Creates expense claims", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/ExpenseClaims", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates expense claims" }, { "info": { "name": "Xero Retrieves a specific expense claim using a unique expense claim Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/ExpenseClaims/:ExpenseClaimID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "ExpenseClaimID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a ExpenseClaim" } ], "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": "Xero Retrieves a specific expense claim using a unique expense claim Id" }, { "info": { "name": "Xero Updates a specific expense claims", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/ExpenseClaims/:ExpenseClaimID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "ExpenseClaimID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a ExpenseClaim" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Updates a specific expense claims" }, { "info": { "name": "Xero Retrieves history records of a specific expense claim", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/ExpenseClaims/:ExpenseClaimID/History", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "ExpenseClaimID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a ExpenseClaim" } ], "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": "Xero Retrieves history records of a specific expense claim" }, { "info": { "name": "Xero Creates a history record for a specific expense claim", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/ExpenseClaims/:ExpenseClaimID/History", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "ExpenseClaimID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a ExpenseClaim" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates a history record for a specific expense claim" }, { "info": { "name": "Xero Retrieves sales invoices or purchase bills", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Invoices", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "If-Modified-Since", "value": "2020-02-06T12:17:43.202-08:00" } ], "params": [ { "name": "where", "value": "Status==\"DRAFT\"", "type": "query", "description": "Filter by an any element" }, { "name": "order", "value": "InvoiceNumber ASC", "type": "query", "description": "Order by an any element" }, { "name": "IDs", "value": ""00000000-0000-0000-0000-000000000000"", "type": "query", "description": "Filter by a comma-separated list of InvoicesIDs." }, { "name": "InvoiceNumbers", "value": ""INV-001", "INV-002"", "type": "query", "description": "Filter by a comma-separated list of InvoiceNumbers." }, { "name": "ContactIDs", "value": ""00000000-0000-0000-0000-000000000000"", "type": "query", "description": "Filter by a comma-separated list of ContactIDs." }, { "name": "Statuses", "value": ""DRAFT", "SUBMITTED"", "type": "query", "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 Where filter." }, { "name": "page", "value": "1", "type": "query", "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", "value": "true", "type": "query", "description": "e.g. includeArchived=true - Invoices with a status of ARCHIVED will be included in the response" }, { "name": "createdByMyApp", "value": "false", "type": "query", "description": "When set to true you'll only retrieve Invoices created by your app" }, { "name": "unitdp", "value": "4", "type": "query", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" }, { "name": "summaryOnly", "value": "true", "type": "query", "description": "Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient." }, { "name": "pageSize", "value": "100", "type": "query", "description": "Number of records to retrieve per page" }, { "name": "searchTerm", "value": "SearchTerm=REF12", "type": "query", "description": "Search parameter that performs a case-insensitive text search across the fields e.g. InvoiceNumber, Reference." } ], "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": "Xero Retrieves sales invoices or purchase bills" }, { "info": { "name": "Xero Updates or creates one or more sales invoices or purchase bills", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/Invoices", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "summarizeErrors", "value": "true", "type": "query", "description": "If false return 200 OK and mix of successfully created objects and any with validation errors" }, { "name": "unitdp", "value": "4", "type": "query", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Updates or creates one or more sales invoices or purchase bills" }, { "info": { "name": "Xero Creates one or more sales invoices or purchase bills", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/Invoices", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "summarizeErrors", "value": "true", "type": "query", "description": "If false return 200 OK and mix of successfully created objects and any with validation errors" }, { "name": "unitdp", "value": "4", "type": "query", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates one or more sales invoices or purchase bills" }, { "info": { "name": "Xero Retrieves a specific sales invoice or purchase bill using a unique invoice Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Invoices/:InvoiceID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "InvoiceID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Invoice" }, { "name": "unitdp", "value": "4", "type": "query", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" } ], "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": "Xero Retrieves a specific sales invoice or purchase bill using a unique invoice Id" }, { "info": { "name": "Xero Updates a specific sales invoices or purchase bills", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/Invoices/:InvoiceID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "InvoiceID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Invoice" }, { "name": "unitdp", "value": "4", "type": "query", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Updates a specific sales invoices or purchase bills" }, { "info": { "name": "Xero Retrieves invoices or purchase bills as PDF files", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Invoices/:InvoiceID/pdf", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "InvoiceID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Invoice" } ], "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": "Xero Retrieves invoices or purchase bills as PDF files" }, { "info": { "name": "Xero Retrieves attachments for a specific invoice or purchase bill", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Invoices/:InvoiceID/Attachments", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "InvoiceID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Invoice" } ], "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": "Xero Retrieves attachments for a specific invoice or purchase bill" }, { "info": { "name": "Xero Retrieves a specific attachment from a specific invoices or purchase bills by using a unique attachment Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Invoices/:InvoiceID/Attachments/:AttachmentID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "contentType", "value": "image/jpg" } ], "params": [ { "name": "InvoiceID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Invoice" }, { "name": "AttachmentID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for Attachment object" } ], "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": "Xero Retrieves a specific attachment from a specific invoices or purchase bills by using a unique attachment Id" }, { "info": { "name": "Xero Retrieves an attachment from a specific invoice or purchase bill by filename", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Invoices/:InvoiceID/Attachments/:FileName", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "contentType", "value": "image/jpg" } ], "params": [ { "name": "InvoiceID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Invoice" }, { "name": "FileName", "value": "xero-dev.jpg", "type": "path", "description": "Name of the attachment" } ], "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": "Xero Retrieves an attachment from a specific invoice or purchase bill by filename" }, { "info": { "name": "Xero Updates an attachment from a specific invoices or purchase bill by filename", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/Invoices/:InvoiceID/Attachments/:FileName", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "InvoiceID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Invoice" }, { "name": "FileName", "value": "xero-dev.jpg", "type": "path", "description": "Name of the attachment" } ], "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": "Xero Updates an attachment from a specific invoices or purchase bill by filename" }, { "info": { "name": "Xero Creates an attachment for a specific invoice or purchase bill by filename", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/Invoices/:InvoiceID/Attachments/:FileName", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "InvoiceID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Invoice" }, { "name": "FileName", "value": "xero-dev.jpg", "type": "path", "description": "Name of the attachment" }, { "name": "IncludeOnline", "value": "true", "type": "query", "description": "Allows an attachment to be seen by the end customer within their online invoice" } ], "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": "Xero Creates an attachment for a specific invoice or purchase bill by filename" }, { "info": { "name": "Xero Retrieves a URL to an online invoice", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Invoices/:InvoiceID/OnlineInvoice", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "InvoiceID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Invoice" } ], "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": "Xero Retrieves a URL to an online invoice" }, { "info": { "name": "Xero Sends a copy of a specific invoice to related contact via email", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/Invoices/:InvoiceID/Email", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "InvoiceID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Invoice" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Sends a copy of a specific invoice to related contact via email" }, { "info": { "name": "Xero Retrieves history records for a specific invoice", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Invoices/:InvoiceID/History", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "InvoiceID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Invoice" } ], "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": "Xero Retrieves history records for a specific invoice" }, { "info": { "name": "Xero Creates a history record for a specific invoice", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/Invoices/:InvoiceID/History", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "InvoiceID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Invoice" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates a history record for a specific invoice" }, { "info": { "name": "Xero Retrieves invoice reminder settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/InvoiceReminders/Settings", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "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": "Xero Retrieves invoice reminder settings" }, { "info": { "name": "Xero Retrieves items", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Items", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "If-Modified-Since", "value": "2020-02-06T12:17:43.202-08:00" } ], "params": [ { "name": "where", "value": "IsSold==true", "type": "query", "description": "Filter by an any element" }, { "name": "order", "value": "Code ASC", "type": "query", "description": "Order by an any element" }, { "name": "unitdp", "value": "4", "type": "query", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" } ], "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": "Xero Retrieves items" }, { "info": { "name": "Xero Updates or creates one or more items", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/Items", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "summarizeErrors", "value": "true", "type": "query", "description": "If false return 200 OK and mix of successfully created objects and any with validation errors" }, { "name": "unitdp", "value": "4", "type": "query", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Updates or creates one or more items" }, { "info": { "name": "Xero Creates one or more items", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/Items", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "summarizeErrors", "value": "true", "type": "query", "description": "If false return 200 OK and mix of successfully created objects and any with validation errors" }, { "name": "unitdp", "value": "4", "type": "query", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates one or more items" }, { "info": { "name": "Xero Retrieves a specific item using a unique item Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Items/:ItemID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "ItemID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Item" }, { "name": "unitdp", "value": "4", "type": "query", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" } ], "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": "Xero Retrieves a specific item using a unique item Id" }, { "info": { "name": "Xero Updates a specific item", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/Items/:ItemID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "ItemID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Item" }, { "name": "unitdp", "value": "4", "type": "query", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Updates a specific item" }, { "info": { "name": "Xero Deletes a specific item", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.xero.com/api.xro/2.0/Items/:ItemID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "ItemID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Item" } ], "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": "Xero Deletes a specific item" }, { "info": { "name": "Xero Retrieves history for a specific item", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Items/:ItemID/History", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "ItemID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Item" } ], "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": "Xero Retrieves history for a specific item" }, { "info": { "name": "Xero Creates a history record for a specific item", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/Items/:ItemID/History", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "ItemID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Item" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates a history record for a specific item" }, { "info": { "name": "Xero Retrieves journals", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Journals", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "If-Modified-Since", "value": "2020-02-06T12:17:43.202-08:00" } ], "params": [ { "name": "offset", "value": "10", "type": "query", "description": "Offset by a specified journal number. e.g. journals with a JournalNumber greater than the offset will be returned" }, { "name": "paymentsOnly", "value": "true", "type": "query", "description": "Filter to retrieve journals on a cash basis. Journals are returned on an accrual basis by default." } ], "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": "Xero Retrieves journals" }, { "info": { "name": "Xero Retrieves a specific journal using a unique journal Id.", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Journals/:JournalID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "JournalID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Journal" } ], "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": "Xero Retrieves a specific journal using a unique journal Id." }, { "info": { "name": "Xero Retrieves a specific journal using a unique journal number.", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Journals/:JournalNumber", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "JournalNumber", "value": "1000", "type": "path", "description": "Number of a Journal" } ], "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": "Xero Retrieves a specific journal using a unique journal number." }, { "info": { "name": "Xero Retrieves linked transactions (billable expenses)", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/LinkedTransactions", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "page", "value": "1", "type": "query", "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", "value": "00000000-0000-0000-0000-000000000000", "type": "query", "description": "The Xero identifier for an Linked Transaction" }, { "name": "SourceTransactionID", "value": "00000000-0000-0000-0000-000000000000", "type": "query", "description": "Filter by the SourceTransactionID. Get the linked transactions created from a particular ACCPAY invoice" }, { "name": "ContactID", "value": "00000000-0000-0000-0000-000000000000", "type": "query", "description": "Filter by the ContactID. Get all the linked transactions that have been assigned to a particular customer." }, { "name": "Status", "value": "APPROVED", "type": "query", "description": "Filter by the combination of ContactID and Status. Get the linked transactions associated to a customer and with a status" }, { "name": "TargetTransactionID", "value": "00000000-0000-0000-0000-000000000000", "type": "query", "description": "Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice" } ], "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": "Xero Retrieves linked transactions (billable expenses)" }, { "info": { "name": "Xero Creates linked transactions (billable expenses)", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/LinkedTransactions", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates linked transactions (billable expenses)" }, { "info": { "name": "Xero Retrieves a specific linked transaction (billable expenses) using a unique linked transaction Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/LinkedTransactions/:LinkedTransactionID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "LinkedTransactionID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a LinkedTransaction" } ], "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": "Xero Retrieves a specific linked transaction (billable expenses) using a unique linked transaction Id" }, { "info": { "name": "Xero Updates a specific linked transactions (billable expenses)", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/LinkedTransactions/:LinkedTransactionID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "LinkedTransactionID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a LinkedTransaction" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Updates a specific linked transactions (billable expenses)" }, { "info": { "name": "Xero Deletes a specific linked transactions (billable expenses)", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.xero.com/api.xro/2.0/LinkedTransactions/:LinkedTransactionID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "LinkedTransactionID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a LinkedTransaction" } ], "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": "Xero Deletes a specific linked transactions (billable expenses)" }, { "info": { "name": "Xero Retrieves manual journals", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/ManualJournals", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "If-Modified-Since", "value": "2020-02-06T12:17:43.202-08:00" } ], "params": [ { "name": "where", "value": "Status==\"DRAFT\"", "type": "query", "description": "Filter by an any element" }, { "name": "order", "value": "Date ASC", "type": "query", "description": "Order by an any element" }, { "name": "page", "value": "1", "type": "query", "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": "pageSize", "value": "100", "type": "query", "description": "Number of records to retrieve per page" } ], "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": "Xero Retrieves manual journals" }, { "info": { "name": "Xero Updates or creates a single manual journal", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/ManualJournals", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "summarizeErrors", "value": "true", "type": "query", "description": "If false return 200 OK and mix of successfully created objects and any with validation errors" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Updates or creates a single manual journal" }, { "info": { "name": "Xero Creates one or more manual journals", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/ManualJournals", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "summarizeErrors", "value": "true", "type": "query", "description": "If false return 200 OK and mix of successfully created objects and any with validation errors" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates one or more manual journals" }, { "info": { "name": "Xero Retrieves a specific manual journal", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/ManualJournals/:ManualJournalID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "ManualJournalID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a ManualJournal" } ], "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": "Xero Retrieves a specific manual journal" }, { "info": { "name": "Xero Updates a specific manual journal", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/ManualJournals/:ManualJournalID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "ManualJournalID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a ManualJournal" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Updates a specific manual journal" }, { "info": { "name": "Xero Retrieves attachment for a specific manual journal", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/ManualJournals/:ManualJournalID/Attachments", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "ManualJournalID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a ManualJournal" } ], "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": "Xero Retrieves attachment for a specific manual journal" }, { "info": { "name": "Xero Allows you to retrieve a specific attachment from a specific manual journal using a unique attachment Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/ManualJournals/:ManualJournalID/Attachments/:AttachmentID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "contentType", "value": "image/jpg" } ], "params": [ { "name": "ManualJournalID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a ManualJournal" }, { "name": "AttachmentID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for Attachment object" } ], "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": "Xero Allows you to retrieve a specific attachment from a specific manual journal using a unique attachment Id" }, { "info": { "name": "Xero Retrieves a specific attachment from a specific manual journal by file name", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/ManualJournals/:ManualJournalID/Attachments/:FileName", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "contentType", "value": "image/jpg" } ], "params": [ { "name": "ManualJournalID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a ManualJournal" }, { "name": "FileName", "value": "xero-dev.jpg", "type": "path", "description": "Name of the attachment" } ], "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": "Xero Retrieves a specific attachment from a specific manual journal by file name" }, { "info": { "name": "Xero Updates a specific attachment from a specific manual journal by file name", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/ManualJournals/:ManualJournalID/Attachments/:FileName", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "ManualJournalID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a ManualJournal" }, { "name": "FileName", "value": "xero-dev.jpg", "type": "path", "description": "Name of the attachment" } ], "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": "Xero Updates a specific attachment from a specific manual journal by file name" }, { "info": { "name": "Xero Creates a specific attachment for a specific manual journal by file name", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/ManualJournals/:ManualJournalID/Attachments/:FileName", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "ManualJournalID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a ManualJournal" }, { "name": "FileName", "value": "xero-dev.jpg", "type": "path", "description": "Name of the attachment" } ], "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": "Xero Creates a specific attachment for a specific manual journal by file name" }, { "info": { "name": "Xero Retrieves history for a specific manual journal", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/ManualJournals/:ManualJournalID/History", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "ManualJournalID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a ManualJournal" } ], "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": "Xero Retrieves history for a specific manual journal" }, { "info": { "name": "Xero Creates a history record for a specific manual journal", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/ManualJournals/:ManualJournalID/History", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "ManualJournalID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a ManualJournal" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates a history record for a specific manual journal" }, { "info": { "name": "Retrieves Xero organisation details", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Organisation", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "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": "Retrieves Xero organisation details" }, { "info": { "name": "Retrieves a list of the key actions your app has permission to perform in the connected Xero organisation.", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Organisation/Actions", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "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": "Retrieves a list of the key actions your app has permission to perform in the connected Xero organisation." }, { "info": { "name": "Retrieves the CIS settings for the Xero organistaion.", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Organisation/:OrganisationID/CISSettings", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "OrganisationID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "The unique Xero identifier for an organisation" } ], "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": "Retrieves the CIS settings for the Xero organistaion." }, { "info": { "name": "Xero Retrieves overpayments", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Overpayments", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "If-Modified-Since", "value": "2020-02-06T12:17:43.202-08:00" } ], "params": [ { "name": "where", "value": "Status==\"AUTHORISED\"", "type": "query", "description": "Filter by an any element" }, { "name": "order", "value": "Status ASC", "type": "query", "description": "Order by an any element" }, { "name": "page", "value": "1", "type": "query", "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": "unitdp", "value": "4", "type": "query", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" }, { "name": "pageSize", "value": "100", "type": "query", "description": "Number of records to retrieve per page" }, { "name": "References", "value": ""Ref1", "Ref2"", "type": "query", "description": "Filter by a comma-separated list of References" } ], "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": "Xero Retrieves overpayments" }, { "info": { "name": "Xero Retrieves a specific overpayment using a unique overpayment Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Overpayments/:OverpaymentID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "OverpaymentID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Overpayment" } ], "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": "Xero Retrieves a specific overpayment using a unique overpayment Id" }, { "info": { "name": "Xero Creates a single allocation for a specific overpayment", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/Overpayments/:OverpaymentID/Allocations", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "OverpaymentID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Overpayment" }, { "name": "summarizeErrors", "value": "true", "type": "query", "description": "If false return 200 OK and mix of successfully created objects and any with validation errors" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates a single allocation for a specific overpayment" }, { "info": { "name": "Xero Deletes an Allocation from an overpayment", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.xero.com/api.xro/2.0/Overpayments/:OverpaymentID/Allocations/:AllocationID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "OverpaymentID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Overpayment" }, { "name": "AllocationID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for Allocation object" } ], "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": "Xero Deletes an Allocation from an overpayment" }, { "info": { "name": "Xero Retrieves history records of a specific overpayment", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Overpayments/:OverpaymentID/History", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "OverpaymentID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Overpayment" } ], "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": "Xero Retrieves history records of a specific overpayment" }, { "info": { "name": "Xero Creates a history record for a specific overpayment", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/Overpayments/:OverpaymentID/History", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "OverpaymentID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Overpayment" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates a history record for a specific overpayment" }, { "info": { "name": "Xero Retrieves payments for invoices and credit notes", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Payments", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "If-Modified-Since", "value": "2020-02-06T12:17:43.202-08:00" } ], "params": [ { "name": "where", "value": "Status==\"AUTHORISED\"", "type": "query", "description": "Filter by an any element" }, { "name": "order", "value": "Amount ASC", "type": "query", "description": "Order by an any element" }, { "name": "page", "value": "1", "type": "query", "description": "Up to 100 payments will be returned in a single API call" }, { "name": "pageSize", "value": "100", "type": "query", "description": "Number of records to retrieve per page" } ], "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": "Xero Retrieves payments for invoices and credit notes" }, { "info": { "name": "Xero Creates a single payment for invoice or credit notes", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/Payments", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates a single payment for invoice or credit notes" }, { "info": { "name": "Xero Creates multiple payments for invoices or credit notes", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/Payments", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "summarizeErrors", "value": "true", "type": "query", "description": "If false return 200 OK and mix of successfully created objects and any with validation errors" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates multiple payments for invoices or credit notes" }, { "info": { "name": "Xero Retrieves a specific payment for invoices and credit notes using a unique payment Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Payments/:PaymentID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "PaymentID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Payment" } ], "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": "Xero Retrieves a specific payment for invoices and credit notes using a unique payment Id" }, { "info": { "name": "Xero Updates a specific payment for invoices and credit notes", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/Payments/:PaymentID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "PaymentID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Payment" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Updates a specific payment for invoices and credit notes" }, { "info": { "name": "Xero Retrieves history records of a specific payment", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Payments/:PaymentID/History", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "PaymentID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Payment" } ], "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": "Xero Retrieves history records of a specific payment" }, { "info": { "name": "Xero Creates a history record for a specific payment", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/Payments/:PaymentID/History", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "PaymentID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Payment" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates a history record for a specific payment" }, { "info": { "name": "Xero Retrieves payment services", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/PaymentServices", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "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": "Xero Retrieves payment services" }, { "info": { "name": "Xero Creates a payment service", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/PaymentServices", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates a payment service" }, { "info": { "name": "Xero Retrieves prepayments", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Prepayments", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "If-Modified-Since", "value": "2020-02-06T12:17:43.202-08:00" } ], "params": [ { "name": "where", "value": "Status==\"AUTHORISED\"", "type": "query", "description": "Filter by an any element" }, { "name": "order", "value": "Reference ASC", "type": "query", "description": "Order by an any element" }, { "name": "page", "value": "1", "type": "query", "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": "unitdp", "value": "4", "type": "query", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" }, { "name": "pageSize", "value": "100", "type": "query", "description": "Number of records to retrieve per page" }, { "name": "InvoiceNumbers", "value": ""INV-001", "INV-002"", "type": "query", "description": "Filter by a comma-separated list of InvoiceNumbers" } ], "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": "Xero Retrieves prepayments" }, { "info": { "name": "Xero Allows you to retrieve a specified prepayments", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Prepayments/:PrepaymentID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "PrepaymentID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a PrePayment" } ], "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": "Xero Allows you to retrieve a specified prepayments" }, { "info": { "name": "Xero Allows you to create an Allocation for prepayments", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/Prepayments/:PrepaymentID/Allocations", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "PrepaymentID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a PrePayment" }, { "name": "summarizeErrors", "value": "true", "type": "query", "description": "If false return 200 OK and mix of successfully created objects and any with validation errors" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Allows you to create an Allocation for prepayments" }, { "info": { "name": "Xero Deletes an Allocation from a Prepayment", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.xero.com/api.xro/2.0/Prepayments/:PrepaymentID/Allocations/:AllocationID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "PrepaymentID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a PrePayment" }, { "name": "AllocationID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for Allocation object" } ], "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": "Xero Deletes an Allocation from a Prepayment" }, { "info": { "name": "Xero Retrieves history record for a specific prepayment", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Prepayments/:PrepaymentID/History", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "PrepaymentID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a PrePayment" } ], "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": "Xero Retrieves history record for a specific prepayment" }, { "info": { "name": "Xero Creates a history record for a specific prepayment", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/Prepayments/:PrepaymentID/History", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "PrepaymentID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a PrePayment" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates a history record for a specific prepayment" }, { "info": { "name": "Xero Retrieves purchase orders", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/PurchaseOrders", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "If-Modified-Since", "value": "2020-02-06T12:17:43.202-08:00" } ], "params": [ { "name": "Status", "value": "SUBMITTED", "type": "query", "description": "Filter by purchase order status" }, { "name": "DateFrom", "value": "2019-12-01", "type": "query", "description": "Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31" }, { "name": "DateTo", "value": "2019-12-31", "type": "query", "description": "Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31" }, { "name": "order", "value": "PurchaseOrderNumber ASC", "type": "query", "description": "Order by an any element" }, { "name": "page", "value": "1", "type": "query", "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 by fetching the next page e.g ?page=2 and continuing this process until no more results are returned." }, { "name": "pageSize", "value": "100", "type": "query", "description": "Number of records to retrieve per page" } ], "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": "Xero Retrieves purchase orders" }, { "info": { "name": "Xero Updates or creates one or more purchase orders", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/PurchaseOrders", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "summarizeErrors", "value": "true", "type": "query", "description": "If false return 200 OK and mix of successfully created objects and any with validation errors" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Updates or creates one or more purchase orders" }, { "info": { "name": "Xero Creates one or more purchase orders", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/PurchaseOrders", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "summarizeErrors", "value": "true", "type": "query", "description": "If false return 200 OK and mix of successfully created objects and any with validation errors" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates one or more purchase orders" }, { "info": { "name": "Xero Retrieves specific purchase order as PDF files using a unique purchase order Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/PurchaseOrders/:PurchaseOrderID/pdf", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "PurchaseOrderID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Purchase Order" } ], "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": "Xero Retrieves specific purchase order as PDF files using a unique purchase order Id" }, { "info": { "name": "Xero Retrieves a specific purchase order using a unique purchase order Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/PurchaseOrders/:PurchaseOrderID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "PurchaseOrderID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Purchase Order" } ], "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": "Xero Retrieves a specific purchase order using a unique purchase order Id" }, { "info": { "name": "Xero Updates a specific purchase order", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/PurchaseOrders/:PurchaseOrderID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "PurchaseOrderID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Purchase Order" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Updates a specific purchase order" }, { "info": { "name": "Xero Retrieves a specific purchase order using purchase order number", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/PurchaseOrders/:PurchaseOrderNumber", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "PurchaseOrderNumber", "value": "PO1234", "type": "path", "description": "Unique identifier for a PurchaseOrder" } ], "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": "Xero Retrieves a specific purchase order using purchase order number" }, { "info": { "name": "Xero Retrieves history for a specific purchase order", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/PurchaseOrders/:PurchaseOrderID/History", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "PurchaseOrderID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Purchase Order" } ], "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": "Xero Retrieves history for a specific purchase order" }, { "info": { "name": "Xero Creates a history record for a specific purchase orders", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/PurchaseOrders/:PurchaseOrderID/History", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "PurchaseOrderID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Purchase Order" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates a history record for a specific purchase orders" }, { "info": { "name": "Xero Retrieves attachments for a specific purchase order", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/PurchaseOrders/:PurchaseOrderID/Attachments", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "PurchaseOrderID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Purchase Order" } ], "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": "Xero Retrieves attachments for a specific purchase order" }, { "info": { "name": "Xero Retrieves specific attachment for a specific purchase order using a unique attachment Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/PurchaseOrders/:PurchaseOrderID/Attachments/:AttachmentID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "contentType", "value": "image/jpg" } ], "params": [ { "name": "PurchaseOrderID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Purchase Order" }, { "name": "AttachmentID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for Attachment object" } ], "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": "Xero Retrieves specific attachment for a specific purchase order using a unique attachment Id" }, { "info": { "name": "Xero Retrieves a specific attachment for a specific purchase order by filename", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/PurchaseOrders/:PurchaseOrderID/Attachments/:FileName", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "contentType", "value": "image/jpg" } ], "params": [ { "name": "PurchaseOrderID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Purchase Order" }, { "name": "FileName", "value": "xero-dev.jpg", "type": "path", "description": "Name of the attachment" } ], "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": "Xero Retrieves a specific attachment for a specific purchase order by filename" }, { "info": { "name": "Xero Updates a specific attachment for a specific purchase order by filename", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/PurchaseOrders/:PurchaseOrderID/Attachments/:FileName", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "PurchaseOrderID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Purchase Order" }, { "name": "FileName", "value": "xero-dev.jpg", "type": "path", "description": "Name of the attachment" } ], "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": "Xero Updates a specific attachment for a specific purchase order by filename" }, { "info": { "name": "Xero Creates attachment for a specific purchase order", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/PurchaseOrders/:PurchaseOrderID/Attachments/:FileName", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "PurchaseOrderID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Purchase Order" }, { "name": "FileName", "value": "xero-dev.jpg", "type": "path", "description": "Name of the attachment" } ], "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": "Xero Creates attachment for a specific purchase order" }, { "info": { "name": "Xero Retrieves sales quotes", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Quotes", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "If-Modified-Since", "value": "2020-02-06T12:17:43.202-08:00" } ], "params": [ { "name": "DateFrom", "value": "2019-10-31", "type": "query", "description": "Filter for quotes after a particular date" }, { "name": "DateTo", "value": "2019-10-31", "type": "query", "description": "Filter for quotes before a particular date" }, { "name": "ExpiryDateFrom", "value": "2019-10-31", "type": "query", "description": "Filter for quotes expiring after a particular date" }, { "name": "ExpiryDateTo", "value": "2019-10-31", "type": "query", "description": "Filter for quotes before a particular date" }, { "name": "ContactID", "value": "00000000-0000-0000-0000-000000000000", "type": "query", "description": "Filter for quotes belonging to a particular contact" }, { "name": "Status", "value": "DRAFT", "type": "query", "description": "Filter for quotes of a particular Status" }, { "name": "page", "value": "1", "type": "query", "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", "value": "Status ASC", "type": "query", "description": "Order by an any element" }, { "name": "QuoteNumber", "value": "QU-0001", "type": "query", "description": "Filter by quote number (e.g. GET https://.../Quotes?QuoteNumber=QU-0001)" } ], "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": "Xero Retrieves sales quotes" }, { "info": { "name": "Xero Updates or creates one or more quotes", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/Quotes", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "summarizeErrors", "value": "true", "type": "query", "description": "If false return 200 OK and mix of successfully created objects and any with validation errors" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Updates or creates one or more quotes" }, { "info": { "name": "Xero Create one or more quotes", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/Quotes", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "summarizeErrors", "value": "true", "type": "query", "description": "If false return 200 OK and mix of successfully created objects and any with validation errors" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Create one or more quotes" }, { "info": { "name": "Xero Retrieves a specific quote using a unique quote Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Quotes/:QuoteID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "QuoteID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Quote" } ], "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": "Xero Retrieves a specific quote using a unique quote Id" }, { "info": { "name": "Xero Updates a specific quote", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/Quotes/:QuoteID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "QuoteID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Quote" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Updates a specific quote" }, { "info": { "name": "Xero Retrieves history records of a specific quote", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Quotes/:QuoteID/History", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "QuoteID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Quote" } ], "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": "Xero Retrieves history records of a specific quote" }, { "info": { "name": "Xero Creates a history record for a specific quote", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/Quotes/:QuoteID/History", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "QuoteID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Quote" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates a history record for a specific quote" }, { "info": { "name": "Xero Retrieves a specific quote as a PDF file using a unique quote Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Quotes/:QuoteID/pdf", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "QuoteID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Quote" } ], "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": "Xero Retrieves a specific quote as a PDF file using a unique quote Id" }, { "info": { "name": "Xero Retrieves attachments for a specific quote", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Quotes/:QuoteID/Attachments", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "QuoteID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Quote" } ], "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": "Xero Retrieves attachments for a specific quote" }, { "info": { "name": "Xero Retrieves a specific attachment from a specific quote using a unique attachment Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Quotes/:QuoteID/Attachments/:AttachmentID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "contentType", "value": "image/jpg" } ], "params": [ { "name": "QuoteID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Quote" }, { "name": "AttachmentID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for Attachment object" } ], "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": "Xero Retrieves a specific attachment from a specific quote using a unique attachment Id" }, { "info": { "name": "Xero Retrieves a specific attachment from a specific quote by filename", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Quotes/:QuoteID/Attachments/:FileName", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "contentType", "value": "image/jpg" } ], "params": [ { "name": "QuoteID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Quote" }, { "name": "FileName", "value": "xero-dev.jpg", "type": "path", "description": "Name of the attachment" } ], "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": "Xero Retrieves a specific attachment from a specific quote by filename" }, { "info": { "name": "Xero Updates a specific attachment from a specific quote by filename", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/Quotes/:QuoteID/Attachments/:FileName", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "QuoteID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Quote" }, { "name": "FileName", "value": "xero-dev.jpg", "type": "path", "description": "Name of the attachment" } ], "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": "Xero Updates a specific attachment from a specific quote by filename" }, { "info": { "name": "Xero Creates attachment for a specific quote", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/Quotes/:QuoteID/Attachments/:FileName", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "QuoteID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for an Quote" }, { "name": "FileName", "value": "xero-dev.jpg", "type": "path", "description": "Name of the attachment" } ], "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": "Xero Creates attachment for a specific quote" }, { "info": { "name": "Xero Retrieves draft expense claim receipts for any user", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Receipts", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "If-Modified-Since", "value": "2020-02-06T12:17:43.202-08:00" } ], "params": [ { "name": "where", "value": "Status==\"DRAFT\"", "type": "query", "description": "Filter by an any element" }, { "name": "order", "value": "ReceiptNumber ASC", "type": "query", "description": "Order by an any element" }, { "name": "unitdp", "value": "4", "type": "query", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" } ], "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": "Xero Retrieves draft expense claim receipts for any user" }, { "info": { "name": "Xero Creates draft expense claim receipts for any user", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/Receipts", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "unitdp", "value": "4", "type": "query", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates draft expense claim receipts for any user" }, { "info": { "name": "Xero Retrieves a specific draft expense claim receipt by using a unique receipt Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Receipts/:ReceiptID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "ReceiptID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Receipt" }, { "name": "unitdp", "value": "4", "type": "query", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" } ], "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": "Xero Retrieves a specific draft expense claim receipt by using a unique receipt Id" }, { "info": { "name": "Xero Updates a specific draft expense claim receipts", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/Receipts/:ReceiptID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "ReceiptID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Receipt" }, { "name": "unitdp", "value": "4", "type": "query", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Updates a specific draft expense claim receipts" }, { "info": { "name": "Xero Retrieves attachments for a specific expense claim receipt", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Receipts/:ReceiptID/Attachments", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "ReceiptID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Receipt" } ], "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": "Xero Retrieves attachments for a specific expense claim receipt" }, { "info": { "name": "Xero Retrieves a specific attachments from a specific expense claim receipts by using a unique attachment Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Receipts/:ReceiptID/Attachments/:AttachmentID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "contentType", "value": "image/jpg" } ], "params": [ { "name": "ReceiptID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Receipt" }, { "name": "AttachmentID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for Attachment object" } ], "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": "Xero Retrieves a specific attachments from a specific expense claim receipts by using a unique attachment Id" }, { "info": { "name": "Xero Retrieves a specific attachment from a specific expense claim receipts by file name", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Receipts/:ReceiptID/Attachments/:FileName", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "contentType", "value": "image/jpg" } ], "params": [ { "name": "ReceiptID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Receipt" }, { "name": "FileName", "value": "xero-dev.jpg", "type": "path", "description": "Name of the attachment" } ], "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": "Xero Retrieves a specific attachment from a specific expense claim receipts by file name" }, { "info": { "name": "Xero Updates a specific attachment on a specific expense claim receipts by file name", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/Receipts/:ReceiptID/Attachments/:FileName", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "ReceiptID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Receipt" }, { "name": "FileName", "value": "xero-dev.jpg", "type": "path", "description": "Name of the attachment" } ], "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": "Xero Updates a specific attachment on a specific expense claim receipts by file name" }, { "info": { "name": "Xero Creates an attachment on a specific expense claim receipts by file name", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/Receipts/:ReceiptID/Attachments/:FileName", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "ReceiptID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Receipt" }, { "name": "FileName", "value": "xero-dev.jpg", "type": "path", "description": "Name of the attachment" } ], "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": "Xero Creates an attachment on a specific expense claim receipts by file name" }, { "info": { "name": "Xero Retrieves a history record for a specific receipt", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Receipts/:ReceiptID/History", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "ReceiptID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Receipt" } ], "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": "Xero Retrieves a history record for a specific receipt" }, { "info": { "name": "Xero Creates a history record for a specific receipt", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/Receipts/:ReceiptID/History", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "ReceiptID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Receipt" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates a history record for a specific receipt" }, { "info": { "name": "Xero Retrieves repeating invoices", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/RepeatingInvoices", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "where", "value": "Status==\"DRAFT\"", "type": "query", "description": "Filter by an any element" }, { "name": "order", "value": "Total ASC", "type": "query", "description": "Order by an any element" } ], "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": "Xero Retrieves repeating invoices" }, { "info": { "name": "Xero Creates or deletes one or more repeating invoice templates", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/RepeatingInvoices", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "summarizeErrors", "value": "true", "type": "query", "description": "If false return 200 OK and mix of successfully created objects and any with validation errors" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates or deletes one or more repeating invoice templates" }, { "info": { "name": "Xero Creates one or more repeating invoice templates", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/RepeatingInvoices", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "summarizeErrors", "value": "true", "type": "query", "description": "If false return 200 OK and mix of successfully created objects and any with validation errors" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates one or more repeating invoice templates" }, { "info": { "name": "Xero Retrieves a specific repeating invoice by using a unique repeating invoice Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/RepeatingInvoices/:RepeatingInvoiceID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "RepeatingInvoiceID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Repeating Invoice" } ], "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": "Xero Retrieves a specific repeating invoice by using a unique repeating invoice Id" }, { "info": { "name": "Xero Deletes a specific repeating invoice template", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/RepeatingInvoices/:RepeatingInvoiceID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "RepeatingInvoiceID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Repeating Invoice" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Deletes a specific repeating invoice template" }, { "info": { "name": "Xero Retrieves attachments from a specific repeating invoice", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/RepeatingInvoices/:RepeatingInvoiceID/Attachments", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "RepeatingInvoiceID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Repeating Invoice" } ], "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": "Xero Retrieves attachments from a specific repeating invoice" }, { "info": { "name": "Xero Retrieves a specific attachment from a specific repeating invoice", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/RepeatingInvoices/:RepeatingInvoiceID/Attachments/:AttachmentID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "contentType", "value": "image/jpg" } ], "params": [ { "name": "RepeatingInvoiceID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Repeating Invoice" }, { "name": "AttachmentID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for Attachment object" } ], "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": "Xero Retrieves a specific attachment from a specific repeating invoice" }, { "info": { "name": "Xero Retrieves a specific attachment from a specific repeating invoices by file name", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/RepeatingInvoices/:RepeatingInvoiceID/Attachments/:FileName", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "contentType", "value": "image/jpg" } ], "params": [ { "name": "RepeatingInvoiceID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Repeating Invoice" }, { "name": "FileName", "value": "xero-dev.jpg", "type": "path", "description": "Name of the attachment" } ], "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": "Xero Retrieves a specific attachment from a specific repeating invoices by file name" }, { "info": { "name": "Xero Updates a specific attachment from a specific repeating invoices by file name", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/RepeatingInvoices/:RepeatingInvoiceID/Attachments/:FileName", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "RepeatingInvoiceID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Repeating Invoice" }, { "name": "FileName", "value": "xero-dev.jpg", "type": "path", "description": "Name of the attachment" } ], "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": "Xero Updates a specific attachment from a specific repeating invoices by file name" }, { "info": { "name": "Xero Creates an attachment from a specific repeating invoices by file name", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/RepeatingInvoices/:RepeatingInvoiceID/Attachments/:FileName", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "RepeatingInvoiceID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Repeating Invoice" }, { "name": "FileName", "value": "xero-dev.jpg", "type": "path", "description": "Name of the attachment" } ], "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": "Xero Creates an attachment from a specific repeating invoices by file name" }, { "info": { "name": "Xero Retrieves history record for a specific repeating invoice", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/RepeatingInvoices/:RepeatingInvoiceID/History", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "RepeatingInvoiceID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Repeating Invoice" } ], "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": "Xero Retrieves history record for a specific repeating invoice" }, { "info": { "name": "Xero Creates a history record for a specific repeating invoice", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/RepeatingInvoices/:RepeatingInvoiceID/History", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "RepeatingInvoiceID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Repeating Invoice" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates a history record for a specific repeating invoice" }, { "info": { "name": "Xero Retrieve reports for 1099", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Reports/TenNinetyNine", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "reportYear", "value": "2019", "type": "query", "description": "The year of the 1099 report" } ], "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": "Xero Retrieve reports for 1099" }, { "info": { "name": "Xero Retrieves report for aged payables by contact", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Reports/AgedPayablesByContact", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "contactId", "value": "00000000-0000-0000-0000-000000000000", "type": "query", "description": "Unique identifier for a Contact" }, { "name": "date", "value": "2019-10-31", "type": "query", "description": "The date of the Aged Payables By Contact report" }, { "name": "fromDate", "value": "2019-10-31", "type": "query", "description": "filter by the from date of the report e.g. 2021-02-01" }, { "name": "toDate", "value": "2019-10-31", "type": "query", "description": "filter by the to date of the report e.g. 2021-02-28" } ], "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": "Xero Retrieves report for aged payables by contact" }, { "info": { "name": "Xero Retrieves report for aged receivables by contact", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Reports/AgedReceivablesByContact", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "contactId", "value": "00000000-0000-0000-0000-000000000000", "type": "query", "description": "Unique identifier for a Contact" }, { "name": "date", "value": "2019-10-31", "type": "query", "description": "The date of the Aged Receivables By Contact report" }, { "name": "fromDate", "value": "2019-10-31", "type": "query", "description": "filter by the from date of the report e.g. 2021-02-01" }, { "name": "toDate", "value": "2019-10-31", "type": "query", "description": "filter by the to date of the report e.g. 2021-02-28" } ], "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": "Xero Retrieves report for aged receivables by contact" }, { "info": { "name": "Xero Retrieves report for balancesheet", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Reports/BalanceSheet", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "date", "value": "2019-11-01", "type": "query", "description": "The date of the Balance Sheet report" }, { "name": "periods", "value": "3", "type": "query", "description": "The number of periods for the Balance Sheet report" }, { "name": "timeframe", "value": "MONTH", "type": "query", "description": "The period size to compare to (MONTH, QUARTER, YEAR)" }, { "name": "trackingOptionID1", "value": "00000000-0000-0000-0000-000000000000", "type": "query", "description": "The tracking option 1 for the Balance Sheet report" }, { "name": "trackingOptionID2", "value": "00000000-0000-0000-0000-000000000000", "type": "query", "description": "The tracking option 2 for the Balance Sheet report" }, { "name": "standardLayout", "value": "true", "type": "query", "description": "The standard layout boolean for the Balance Sheet report" }, { "name": "paymentsOnly", "value": "false", "type": "query", "description": "return a cash basis for the Balance Sheet report" } ], "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": "Xero Retrieves report for balancesheet" }, { "info": { "name": "Xero Retrieves report for bank summary", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Reports/BankSummary", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "fromDate", "value": "2019-10-31", "type": "query", "description": "filter by the from date of the report e.g. 2021-02-01" }, { "name": "toDate", "value": "2019-10-31", "type": "query", "description": "filter by the to date of the report e.g. 2021-02-28" } ], "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": "Xero Retrieves report for bank summary" }, { "info": { "name": "Xero Retrieves a specific report using a unique ReportID", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Reports/:ReportID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "ReportID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Report" } ], "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": "Xero Retrieves a specific report using a unique ReportID" }, { "info": { "name": "Xero Retrieves report for budget summary", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Reports/BudgetSummary", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "date", "value": "2019-03-31", "type": "query", "description": "The date for the Bank Summary report e.g. 2018-03-31" }, { "name": "periods", "value": "2", "type": "query", "description": "The number of periods to compare (integer between 1 and 12)" }, { "name": "timeframe", "value": "3", "type": "query", "description": "The period size to compare to (1=month, 3=quarter, 12=year)" } ], "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": "Xero Retrieves report for budget summary" }, { "info": { "name": "Xero Retrieves report for executive summary", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Reports/ExecutiveSummary", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "date", "value": "2019-03-31", "type": "query", "description": "The date for the Bank Summary report e.g. 2018-03-31" } ], "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": "Xero Retrieves report for executive summary" }, { "info": { "name": "Xero Retrieves a list of the organistaions unique reports that require a uuid to fetch", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Reports", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "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": "Xero Retrieves a list of the organistaions unique reports that require a uuid to fetch" }, { "info": { "name": "Xero Retrieves report for profit and loss", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Reports/ProfitAndLoss", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "fromDate", "value": "2019-10-31", "type": "query", "description": "filter by the from date of the report e.g. 2021-02-01" }, { "name": "toDate", "value": "2019-10-31", "type": "query", "description": "filter by the to date of the report e.g. 2021-02-28" }, { "name": "periods", "value": "3", "type": "query", "description": "The number of periods to compare (integer between 1 and 12)" }, { "name": "timeframe", "value": "MONTH", "type": "query", "description": "The period size to compare to (MONTH, QUARTER, YEAR)" }, { "name": "trackingCategoryID", "value": "00000000-0000-0000-0000-000000000000", "type": "query", "description": "The trackingCategory 1 for the ProfitAndLoss report" }, { "name": "trackingCategoryID2", "value": "00000000-0000-0000-0000-000000000000", "type": "query", "description": "The trackingCategory 2 for the ProfitAndLoss report" }, { "name": "trackingOptionID", "value": "00000000-0000-0000-0000-000000000000", "type": "query", "description": "The tracking option 1 for the ProfitAndLoss report" }, { "name": "trackingOptionID2", "value": "00000000-0000-0000-0000-000000000000", "type": "query", "description": "The tracking option 2 for the ProfitAndLoss report" }, { "name": "standardLayout", "value": "true", "type": "query", "description": "Return the standard layout for the ProfitAndLoss report" }, { "name": "paymentsOnly", "value": "false", "type": "query", "description": "Return cash only basis for the ProfitAndLoss report" } ], "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": "Xero Retrieves report for profit and loss" }, { "info": { "name": "Xero Retrieves report for trial balance", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Reports/TrialBalance", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "date", "value": "2019-10-31", "type": "query", "description": "The date for the Trial Balance report e.g. 2018-03-31" }, { "name": "paymentsOnly", "value": "true", "type": "query", "description": "Return cash only basis for the Trial Balance report" } ], "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": "Xero Retrieves report for trial balance" }, { "info": { "name": "Xero Sets the chart of accounts, the conversion date and conversion balances", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/Setup", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Sets the chart of accounts, the conversion date and conversion balances" }, { "info": { "name": "Xero Retrieves tax rates", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/TaxRates", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "where", "value": "Status==\"ACTIVE\"", "type": "query", "description": "Filter by an any element" }, { "name": "order", "value": "Name ASC", "type": "query", "description": "Order by an any element" } ], "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": "Xero Retrieves tax rates" }, { "info": { "name": "Xero Updates tax rates", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/TaxRates", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Updates tax rates" }, { "info": { "name": "Xero Creates one or more tax rates", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/TaxRates", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates one or more tax rates" }, { "info": { "name": "Xero Retrieves a specific tax rate according to given TaxType code", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/TaxRates/:TaxType", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "TaxType", "value": "INPUT2", "type": "path", "description": "A valid TaxType code" } ], "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": "Xero Retrieves a specific tax rate according to given TaxType code" }, { "info": { "name": "Xero Retrieves tracking categories and options", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/TrackingCategories", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "where", "value": "Status==\"ACTIVE\"", "type": "query", "description": "Filter by an any element" }, { "name": "order", "value": "Name ASC", "type": "query", "description": "Order by an any element" }, { "name": "includeArchived", "value": "true", "type": "query", "description": "e.g. includeArchived=true - Categories and options with a status of ARCHIVED will be included in the response" } ], "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": "Xero Retrieves tracking categories and options" }, { "info": { "name": "Xero Create tracking categories", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/TrackingCategories", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Create tracking categories" }, { "info": { "name": "Xero Retrieves specific tracking categories and options using a unique tracking category Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/TrackingCategories/:TrackingCategoryID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "TrackingCategoryID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a TrackingCategory" } ], "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": "Xero Retrieves specific tracking categories and options using a unique tracking category Id" }, { "info": { "name": "Xero Updates a specific tracking category", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/TrackingCategories/:TrackingCategoryID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "TrackingCategoryID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a TrackingCategory" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Updates a specific tracking category" }, { "info": { "name": "Xero Deletes a specific tracking category", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.xero.com/api.xro/2.0/TrackingCategories/:TrackingCategoryID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "TrackingCategoryID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a TrackingCategory" } ], "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": "Xero Deletes a specific tracking category" }, { "info": { "name": "Xero Creates options for a specific tracking category", "type": "http" }, "http": { "method": "PUT", "url": "https://api.xero.com/api.xro/2.0/TrackingCategories/:TrackingCategoryID/Options", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "TrackingCategoryID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a TrackingCategory" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Creates options for a specific tracking category" }, { "info": { "name": "Xero Updates a specific option for a specific tracking category", "type": "http" }, "http": { "method": "POST", "url": "https://api.xero.com/api.xro/2.0/TrackingCategories/:TrackingCategoryID/Options/:TrackingOptionID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "Idempotency-Key", "value": "KEY_VALUE" } ], "params": [ { "name": "TrackingCategoryID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a TrackingCategory" }, { "name": "TrackingOptionID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Tracking Option" } ], "body": { "type": "json", "data": "{}" }, "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": "Xero Updates a specific option for a specific tracking category" }, { "info": { "name": "Xero Deletes a specific option for a specific tracking category", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.xero.com/api.xro/2.0/TrackingCategories/:TrackingCategoryID/Options/:TrackingOptionID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "TrackingCategoryID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a TrackingCategory" }, { "name": "TrackingOptionID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a Tracking Option" } ], "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": "Xero Deletes a specific option for a specific tracking category" }, { "info": { "name": "Xero Retrieves users", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Users", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" }, { "name": "If-Modified-Since", "value": "2020-02-06T12:17:43.202-08:00" } ], "params": [ { "name": "where", "value": "IsSubscriber==true", "type": "query", "description": "Filter by an any element" }, { "name": "order", "value": "LastName ASC", "type": "query", "description": "Order by an any element" } ], "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": "Xero Retrieves users" }, { "info": { "name": "Xero Retrieves a specific user", "type": "http" }, "http": { "method": "GET", "url": "https://api.xero.com/api.xro/2.0/Users/:UserID", "headers": [ { "name": "xero-tenant-id", "value": "YOUR_XERO_TENANT_ID" } ], "params": [ { "name": "UserID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Unique identifier for a User" } ], "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": "Xero Retrieves a specific user" } ] } ], "bundled": true }