xero-accounting - Pinkfish - AI Agents & Workflows for Getting Work Done

Server path: /xero-accounting | Type: Application | PCID required: Yes

Tools

Tool	Description
`xero_accounting_create_account`	Creates a new chart of accounts
`xero_accounting_create_branding_theme_payment_services`	Creates a new custom payment service for a specific branding theme
`xero_accounting_create_currency`	Create a new currency for a Xero organisation
`xero_accounting_create_manual_journals`	Creates one or more manual journals
`xero_accounting_create_tax_rates`	Creates one or more tax rates
`xero_accounting_delete_account`	Deletes a chart of accounts
`xero_accounting_get_account`	Retrieves a single chart of accounts by using a unique account Id
`xero_accounting_get_accounts`	Retrieves the full chart of accounts
`xero_accounting_get_branding_theme`	Retrieves a specific branding theme using a unique branding theme Id
`xero_accounting_get_branding_theme_payment_services`	Retrieves the payment services for a specific branding theme
`xero_accounting_get_branding_themes`	Retrieves all the branding themes
`xero_accounting_get_budget`	Retrieves a specific budget, which includes budget lines
`xero_accounting_get_budgets`	Retrieve a list of budgets
`xero_accounting_get_currencies`	Retrieves currencies for your Xero organisation
`xero_accounting_get_journal`	Retrieves a specific journal using a unique journal Id.
`xero_accounting_get_journal_by_number`	Retrieves a specific journal using a unique journal number.
`xero_accounting_get_journals`	Retrieves journals
`xero_accounting_get_manual_journal`	Retrieves a specific manual journal
`xero_accounting_get_manual_journals`	Retrieves manual journals
`xero_accounting_get_organisation_actions`	Retrieves a list of the key actions your app has permission to perform in the connected Xero organisation.
`xero_accounting_get_organisation_cissettings`	Retrieves the CIS settings for the Xero organistaion.
`xero_accounting_get_organisations`	Retrieves Xero organisation details
`xero_accounting_get_report_aged_payables_by_contact`	Retrieves report for aged payables by contact
`xero_accounting_get_report_aged_receivables_by_contact`	Retrieves report for aged receivables by contact
`xero_accounting_get_report_balance_sheet`	Retrieves report for balancesheet
`xero_accounting_get_report_bank_summary`	Retrieves report for bank summary
`xero_accounting_get_report_budget_summary`	Retrieves report for budget summary
`xero_accounting_get_report_executive_summary`	Retrieves report for executive summary
`xero_accounting_get_report_from_id`	Retrieves a specific report using a unique ReportID
`xero_accounting_get_report_profit_and_loss`	Retrieves report for profit and loss
`xero_accounting_get_report_ten_ninety_nine`	Retrieve reports for 1099
`xero_accounting_get_report_trial_balance`	Retrieves report for trial balance
`xero_accounting_get_reports_list`	Retrieves a list of the organistaions unique reports that require a uuid to fetch
`xero_accounting_get_tax_rate_by_tax_type`	Retrieves a specific tax rate according to given TaxType code
`xero_accounting_get_tax_rates`	Retrieves tax rates
`xero_accounting_get_user`	Retrieves a specific user
`xero_accounting_get_users`	Retrieves users
`xero_accounting_post_setup`	Sets the chart of accounts, the conversion date and conversion balances
`xero_accounting_update_account`	Updates a chart of accounts
`xero_accounting_update_manual_journal`	Updates a specific manual journal
`xero_accounting_update_or_create_manual_journals`	Updates or creates a single manual journal
`xero_accounting_update_tax_rate`	Updates tax rates

xero_accounting_create_account

Creates a new chart of accounts Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`Idempotency-Key`	string	No	—	This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
`AccountID`	string	No	—	The Xero identifier for an account – specified as a string following the endpoint name e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9
`AddToWatchlist`	boolean	No	—	Boolean – describes whether the account is shown in the watchlist widget on the dashboard
`BankAccountNumber`	string	No	—	For bank accounts only (Account Type BANK)
`BankAccountType`	string	No	—	For bank accounts only. See Bank Account types
`Class`	string	No	—	See Account Class Types
`Code`	string	No	—	Customer defined alpha numeric account code e.g 200 or SALES (max length = 10)
`CurrencyCode`	string	No	—	3 letter alpha code for the currency – see list of currency codes
`Description`	string	No	—	Description of the Account. Valid for all types of accounts except bank accounts (max length = 4000)
`EnablePaymentsToAccount`	boolean	No	—	Boolean – describes whether account can have payments applied to it
`HasAttachments`	boolean	No	—	boolean to indicate if an account has an attachment (read only)
`Name`	string	No	—	Name of account (max length = 150)
`ReportingCode`	string	No	—	Shown if set
`ReportingCodeName`	string	No	—	Shown if set
`ShowInExpenseClaims`	boolean	No	—	Boolean – describes whether account code is available for use with expense claims
`Status`	string	No	—	Accounts with a status of ACTIVE can be updated to ARCHIVED. See Account Status Codes
`SystemAccount`	string	No	—	If this is a system account then this element is returned. See System Account types. Note that non-system accounts may have this element set as either “” or null.
`TaxType`	string	No	—	The tax type from taxRates
`Type`	string	No	—	See Account Types
`UpdatedDateUTC`	string	No	—	Last modified date UTC format
`ValidationErrors`	object[]	No	—	Displays array of validation error messages from the API

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "Idempotency-Key": {
      "type": "string",
      "description": "This allows you to safely retry requests without the risk of duplicate processing. 128 character max."
    },
    "AccountID": {
      "type": "string",
      "description": "The Xero identifier for an account – specified as a string following  the endpoint name   e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9"
    },
    "AddToWatchlist": {
      "type": "boolean",
      "description": "Boolean – describes whether the account is shown in the watchlist widget on the dashboard"
    },
    "BankAccountNumber": {
      "type": "string",
      "description": "For bank accounts only (Account Type BANK)"
    },
    "BankAccountType": {
      "type": "string",
      "description": "For bank accounts only. See Bank Account types",
      "enum": [
        "BANK",
        "CREDITCARD",
        "PAYPAL",
        "NONE",
        ""
      ]
    },
    "Class": {
      "type": "string",
      "description": "See Account Class Types",
      "enum": [
        "ASSET",
        "EQUITY",
        "EXPENSE",
        "LIABILITY",
        "REVENUE"
      ]
    },
    "Code": {
      "type": "string",
      "description": "Customer defined alpha numeric account code e.g 200 or SALES (max length = 10)"
    },
    "CurrencyCode": {
      "type": "string",
      "description": "3 letter alpha code for the currency – see list of currency codes",
      "enum": [
        "AED",
        "AFN",
        "ALL",
        "AMD",
        "ANG",
        "AOA",
        "ARS",
        "AUD",
        "AWG",
        "AZN",
        "BAM",
        "BBD",
        "BDT",
        "BGN",
        "BHD",
        "BIF",
        "BMD",
        "BND",
        "BOB",
        "BRL",
        "BSD",
        "BTN",
        "BWP",
        "BYN",
        "BYR",
        "BZD",
        "CAD",
        "CDF",
        "CHF",
        "CLF",
        "CLP",
        "CNY",
        "COP",
        "CRC",
        "CUC",
        "CUP",
        "CVE",
        "CZK",
        "DJF",
        "DKK",
        "DOP",
        "DZD",
        "EEK",
        "EGP",
        "ERN",
        "ETB",
        "EUR",
        "FJD",
        "FKP",
        "GBP",
        "GEL",
        "GHS",
        "GIP",
        "GMD",
        "GNF",
        "GTQ",
        "GYD",
        "HKD",
        "HNL",
        "HRK",
        "HTG",
        "HUF",
        "IDR",
        "ILS",
        "INR",
        "IQD",
        "IRR",
        "ISK",
        "JMD",
        "JOD",
        "JPY",
        "KES",
        "KGS",
        "KHR",
        "KMF",
        "KPW",
        "KRW",
        "KWD",
        "KYD",
        "KZT",
        "LAK",
        "LBP",
        "LKR",
        "LRD",
        "LSL",
        "LTL",
        "LVL",
        "LYD",
        "MAD",
        "MDL",
        "MGA",
        "MKD",
        "MMK",
        "MNT",
        "MOP",
        "MRO",
        "MRU",
        "MUR",
        "MVR",
        "MWK",
        "MXN",
        "MXV",
        "MYR",
        "MZN",
        "NAD",
        "NGN",
        "NIO",
        "NOK",
        "NPR",
        "NZD",
        "OMR",
        "PAB",
        "PEN",
        "PGK",
        "PHP",
        "PKR",
        "PLN",
        "PYG",
        "QAR",
        "RON",
        "RSD",
        "RUB",
        "RWF",
        "SAR",
        "SBD",
        "SCR",
        "SDG",
        "SEK",
        "SGD",
        "SHP",
        "SKK",
        "SLE",
        "SLL",
        "SOS",
        "SRD",
        "STD",
        "STN",
        "SVC",
        "SYP",
        "SZL",
        "THB",
        "TJS",
        "TMT",
        "TND",
        "TOP",
        "TRY",
        "TTD",
        "TWD",
        "TZS",
        "UAH",
        "UGX",
        "USD",
        "UYU",
        "UZS",
        "VEF",
        "VES",
        "VND",
        "VUV",
        "WST",
        "XAF",
        "XCD",
        "XOF",
        "XPF",
        "YER",
        "ZAR",
        "ZMW",
        "ZMK",
        "ZWD"
      ]
    },
    "Description": {
      "type": "string",
      "description": "Description of the Account. Valid for all types of accounts except bank accounts (max length = 4000)"
    },
    "EnablePaymentsToAccount": {
      "type": "boolean",
      "description": "Boolean – describes whether account can have payments applied to it"
    },
    "HasAttachments": {
      "type": "boolean",
      "description": "boolean to indicate if an account has an attachment (read only)"
    },
    "Name": {
      "type": "string",
      "description": "Name of account (max length = 150)"
    },
    "ReportingCode": {
      "type": "string",
      "description": "Shown if set"
    },
    "ReportingCodeName": {
      "type": "string",
      "description": "Shown if set"
    },
    "ShowInExpenseClaims": {
      "type": "boolean",
      "description": "Boolean – describes whether account code is available for use with expense claims"
    },
    "Status": {
      "type": "string",
      "description": "Accounts with a status of ACTIVE can be updated to ARCHIVED. See Account Status Codes",
      "enum": [
        "ACTIVE",
        "ARCHIVED",
        "DELETED"
      ]
    },
    "SystemAccount": {
      "type": "string",
      "description": "If this is a system account then this element is returned. See System Account types. Note that non-system accounts may have this element set as either “” or null.",
      "enum": [
        "DEBTORS",
        "CREDITORS",
        "BANKCURRENCYGAIN",
        "GST",
        "GSTONIMPORTS",
        "HISTORICAL",
        "REALISEDCURRENCYGAIN",
        "RETAINEDEARNINGS",
        "ROUNDING",
        "TRACKINGTRANSFERS",
        "UNPAIDEXPCLM",
        "UNREALISEDCURRENCYGAIN",
        "WAGEPAYABLES",
        "CISASSETS",
        "CISASSET",
        "CISLABOUR",
        "CISLABOUREXPENSE",
        "CISLABOURINCOME",
        "CISLIABILITY",
        "CISMATERIALS",
        ""
      ]
    },
    "TaxType": {
      "type": "string",
      "description": "The tax type from taxRates"
    },
    "Type": {
      "type": "string",
      "description": "See Account Types",
      "enum": [
        "BANK",
        "CURRENT",
        "CURRLIAB",
        "DEPRECIATN",
        "DIRECTCOSTS",
        "EQUITY",
        "EXPENSE",
        "FIXED",
        "INVENTORY",
        "LIABILITY",
        "NONCURRENT",
        "OTHERINCOME",
        "OVERHEADS",
        "PREPAYMENT",
        "REVENUE",
        "SALES",
        "TERMLIAB",
        "PAYG"
      ]
    },
    "UpdatedDateUTC": {
      "type": "string",
      "description": "Last modified date UTC format"
    },
    "ValidationErrors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "Message": {
            "type": "string",
            "description": "Validation error message"
          }
        }
      },
      "description": "Displays array of validation error messages from the API"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id"
  ]
}

xero_accounting_create_branding_theme_payment_services

Creates a new custom payment service for a specific branding theme Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`Idempotency-Key`	string	No	—	This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
`BrandingThemeID`	string	Yes	—	Unique identifier for a Branding Theme
`PaymentServices`	any[]	No	—	Payment Services

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "Idempotency-Key": {
      "type": "string",
      "description": "This allows you to safely retry requests without the risk of duplicate processing. 128 character max."
    },
    "BrandingThemeID": {
      "type": "string",
      "description": "Unique identifier for a Branding Theme"
    },
    "PaymentServices": {
      "type": "array",
      "description": "Payment Services"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id",
    "BrandingThemeID"
  ]
}

xero_accounting_create_currency

Create a new currency for a Xero organisation Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`Idempotency-Key`	string	No	—	This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
`Code`	string	No	—	3 letter alpha code for the currency – see list of currency codes
`Description`	string	No	—	Name of Currency

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "Idempotency-Key": {
      "type": "string",
      "description": "This allows you to safely retry requests without the risk of duplicate processing. 128 character max."
    },
    "Code": {
      "type": "string",
      "description": "3 letter alpha code for the currency – see list of currency codes",
      "enum": [
        "AED",
        "AFN",
        "ALL",
        "AMD",
        "ANG",
        "AOA",
        "ARS",
        "AUD",
        "AWG",
        "AZN",
        "BAM",
        "BBD",
        "BDT",
        "BGN",
        "BHD",
        "BIF",
        "BMD",
        "BND",
        "BOB",
        "BRL",
        "BSD",
        "BTN",
        "BWP",
        "BYN",
        "BYR",
        "BZD",
        "CAD",
        "CDF",
        "CHF",
        "CLF",
        "CLP",
        "CNY",
        "COP",
        "CRC",
        "CUC",
        "CUP",
        "CVE",
        "CZK",
        "DJF",
        "DKK",
        "DOP",
        "DZD",
        "EEK",
        "EGP",
        "ERN",
        "ETB",
        "EUR",
        "FJD",
        "FKP",
        "GBP",
        "GEL",
        "GHS",
        "GIP",
        "GMD",
        "GNF",
        "GTQ",
        "GYD",
        "HKD",
        "HNL",
        "HRK",
        "HTG",
        "HUF",
        "IDR",
        "ILS",
        "INR",
        "IQD",
        "IRR",
        "ISK",
        "JMD",
        "JOD",
        "JPY",
        "KES",
        "KGS",
        "KHR",
        "KMF",
        "KPW",
        "KRW",
        "KWD",
        "KYD",
        "KZT",
        "LAK",
        "LBP",
        "LKR",
        "LRD",
        "LSL",
        "LTL",
        "LVL",
        "LYD",
        "MAD",
        "MDL",
        "MGA",
        "MKD",
        "MMK",
        "MNT",
        "MOP",
        "MRO",
        "MRU",
        "MUR",
        "MVR",
        "MWK",
        "MXN",
        "MXV",
        "MYR",
        "MZN",
        "NAD",
        "NGN",
        "NIO",
        "NOK",
        "NPR",
        "NZD",
        "OMR",
        "PAB",
        "PEN",
        "PGK",
        "PHP",
        "PKR",
        "PLN",
        "PYG",
        "QAR",
        "RON",
        "RSD",
        "RUB",
        "RWF",
        "SAR",
        "SBD",
        "SCR",
        "SDG",
        "SEK",
        "SGD",
        "SHP",
        "SKK",
        "SLE",
        "SLL",
        "SOS",
        "SRD",
        "STD",
        "STN",
        "SVC",
        "SYP",
        "SZL",
        "THB",
        "TJS",
        "TMT",
        "TND",
        "TOP",
        "TRY",
        "TTD",
        "TWD",
        "TZS",
        "UAH",
        "UGX",
        "USD",
        "UYU",
        "UZS",
        "VEF",
        "VES",
        "VND",
        "VUV",
        "WST",
        "XAF",
        "XCD",
        "XOF",
        "XPF",
        "YER",
        "ZAR",
        "ZMW",
        "ZMK",
        "ZWD"
      ]
    },
    "Description": {
      "type": "string",
      "description": "Name of Currency"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id"
  ]
}

xero_accounting_create_manual_journals

Creates one or more manual journals Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`summarizeErrors`	boolean	No	—	If false return 200 OK and mix of successfully created objects and any with validation errors
`Idempotency-Key`	string	No	—	This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
`ManualJournals`	object[]	No	—	Manual Journals
`pagination`	object	No	—	The pagination value
`Warnings`	object[]	No	—	Displays array of warning messages from the API

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "summarizeErrors": {
      "type": "boolean",
      "description": "If false return 200 OK and mix of successfully created objects and any with validation errors"
    },
    "Idempotency-Key": {
      "type": "string",
      "description": "This allows you to safely retry requests without the risk of duplicate processing. 128 character max."
    },
    "ManualJournals": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "Narration": {
            "type": "string",
            "description": "Description of journal being posted"
          },
          "JournalLines": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "LineAmount": {
                  "type": "number",
                  "description": "total for line. Debits are positive, credits are negative value"
                },
                "AccountCode": {
                  "type": "string",
                  "description": "See Accounts"
                },
                "AccountID": {
                  "type": "string",
                  "description": "See Accounts"
                },
                "Description": {
                  "type": "string",
                  "description": "Description for journal line"
                },
                "TaxType": {
                  "type": "string",
                  "description": "The tax type from TaxRates"
                },
                "Tracking": {
                  "type": "array",
                  "description": "Optional Tracking Category – see Tracking. Any JournalLine can have a maximum of 2 <TrackingCategory> elements."
                },
                "TaxAmount": {
                  "type": "number",
                  "description": "The calculated tax amount based on the TaxType and LineAmount"
                },
                "IsBlank": {
                  "type": "boolean",
                  "description": "is the line blank"
                }
              }
            },
            "description": "See JournalLines"
          },
          "Date": {
            "type": "string",
            "description": "Date journal was posted – YYYY-MM-DD"
          },
          "LineAmountTypes": {
            "type": "string",
            "enum": [
              "Exclusive",
              "Inclusive",
              "NoTax"
            ],
            "description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types"
          },
          "Status": {
            "type": "string",
            "enum": [
              "DRAFT",
              "POSTED",
              "DELETED",
              "VOIDED",
              "ARCHIVED"
            ],
            "description": "See Manual Journal Status Codes"
          },
          "Url": {
            "type": "string",
            "description": "Url link to a source document – shown as “Go to [appName]” in the Xero app"
          },
          "ShowOnCashBasisReports": {
            "type": "boolean",
            "description": "Boolean – default is true if not specified"
          },
          "HasAttachments": {
            "type": "boolean",
            "description": "Boolean to indicate if a manual journal has an attachment"
          },
          "UpdatedDateUTC": {
            "type": "string",
            "description": "Last modified date UTC format"
          },
          "ManualJournalID": {
            "type": "string",
            "format": "uuid",
            "description": "The Xero identifier for a Manual Journal"
          },
          "StatusAttributeString": {
            "type": "string",
            "description": "A string to indicate if a invoice status"
          },
          "Warnings": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "Message": {
                  "type": "string",
                  "description": "Validation error message"
                }
              }
            },
            "description": "Displays array of warning messages from the API"
          },
          "ValidationErrors": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "Message": {
                  "type": "string",
                  "description": "Validation error message"
                }
              }
            },
            "description": "Displays array of validation error messages from the API"
          },
          "Attachments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "AttachmentID": {
                  "type": "string",
                  "description": "Unique ID for the file"
                },
                "FileName": {
                  "type": "string",
                  "description": "Name of the file"
                },
                "Url": {
                  "type": "string",
                  "description": "URL to the file on xero.com"
                },
                "MimeType": {
                  "type": "string",
                  "description": "Type of file"
                },
                "ContentLength": {
                  "type": "integer",
                  "description": "Length of the file content"
                },
                "IncludeOnline": {
                  "type": "boolean",
                  "description": "Include the file with the online invoice"
                }
              }
            },
            "description": "Displays array of attachments from the API"
          }
        },
        "required": [
          "Narration"
        ]
      },
      "description": "Manual Journals"
    },
    "pagination": {
      "type": "object",
      "description": "The pagination value",
      "properties": {
        "page": {
          "type": "integer",
          "description": "Page number for pagination"
        },
        "pageSize": {
          "type": "integer",
          "description": "Number of results per page"
        },
        "pageCount": {
          "type": "integer",
          "description": "Page Count"
        },
        "itemCount": {
          "type": "integer",
          "description": "Item Count"
        }
      }
    },
    "Warnings": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "Message": {
            "type": "string",
            "description": "Validation error message"
          }
        }
      },
      "description": "Displays array of warning messages from the API"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id"
  ]
}

xero_accounting_create_tax_rates

Creates one or more tax rates Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`Idempotency-Key`	string	No	—	This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
`TaxRates`	object[]	No	—	Tax Rates

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "Idempotency-Key": {
      "type": "string",
      "description": "This allows you to safely retry requests without the risk of duplicate processing. 128 character max."
    },
    "TaxRates": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "Name": {
            "type": "string",
            "description": "Name of tax rate"
          },
          "TaxType": {
            "type": "string",
            "description": "The tax type"
          },
          "TaxComponents": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "Name": {
                  "type": "string",
                  "description": "Name of Tax Component"
                },
                "Rate": {
                  "type": "number",
                  "description": "Tax Rate (up to 4dp)"
                },
                "IsCompound": {
                  "type": "boolean",
                  "description": "Boolean to describe if Tax rate is compounded."
                },
                "IsNonRecoverable": {
                  "type": "boolean",
                  "description": "Boolean to describe if tax rate is non-recoverable. Non-recoverable rates are only applicable to Canadian organisations"
                }
              }
            },
            "description": "See TaxComponents"
          },
          "Status": {
            "type": "string",
            "enum": [
              "ACTIVE",
              "DELETED",
              "ARCHIVED",
              "PENDING"
            ],
            "description": "See Status Codes"
          },
          "ReportTaxType": {
            "type": "string",
            "enum": [
              "AVALARA",
              "BASEXCLUDED",
              "CAPITALSALESOUTPUT",
              "CAPITALEXPENSESINPUT",
              "ECOUTPUT",
              "ECOUTPUTSERVICES",
              "ECINPUT",
              "ECACQUISITIONS",
              "EXEMPTEXPENSES",
              "EXEMPTINPUT",
              "EXEMPTOUTPUT",
              "GSTONIMPORTS",
              "INPUT",
              "INPUTTAXED",
              "MOSSSALES",
              "NONE",
              "NONEOUTPUT",
              "OUTPUT",
              "PURCHASESINPUT",
              "SALESOUTPUT",
              "EXEMPTCAPITAL",
              "EXEMPTEXPORT",
              "CAPITALEXINPUT",
              "GSTONCAPIMPORTS",
              "GSTONCAPITALIMPORTS",
              "REVERSECHARGES",
              "PAYMENTS",
              "INVOICE",
              "CASH",
              "ACCRUAL",
              "FLATRATECASH",
              "FLATRATEACCRUAL",
              "ACCRUALS",
              "TXCA",
              "SRCAS",
              "DSOUTPUT",
              "BLINPUT2",
              "EPINPUT",
              "IMINPUT2",
              "MEINPUT",
              "IGDSINPUT2",
              "ESN33OUTPUT",
              "OPINPUT",
              "OSOUTPUT",
              "TXN33INPUT",
              "TXESSINPUT",
              "TXREINPUT",
              "TXPETINPUT",
              "NRINPUT",
              "ES33OUTPUT",
              "ZERORATEDINPUT",
              "ZERORATEDOUTPUT",
              "DRCHARGESUPPLY",
              "DRCHARGE",
              "CAPINPUT",
              "CAPIMPORTS",
              "IMINPUT",
              "INPUT2",
              "CIUINPUT",
              "SRINPUT",
              "OUTPUT2",
              "SROUTPUT",
              "CAPOUTPUT",
              "SROUTPUT2",
              "CIUOUTPUT",
              "ZROUTPUT",
              "ZREXPORT",
              "ACC28PLUS",
              "ACCUPTO28",
              "OTHEROUTPUT",
              "SHOUTPUT",
              "ZRINPUT",
              "BADDEBT",
              "OTHERINPUT",
              "BADDEBTRELIEF",
              "IGDSINPUT3",
              "SROVR",
              "TOURISTREFUND",
              "TXRCN33",
              "TXRCRE",
              "TXRCESS",
              "TXRCTS",
              "CAPEXINPUT",
              "UNDEFINED",
              "CAPEXOUTPUT",
              "ZEROEXPOUTPUT",
              "GOODSIMPORT",
              "NONEINPUT",
              "NOTREPORTED",
              "SROVRRS",
              "SROVRLVG",
              "SRLVG",
              "IM",
              "IMESS",
              "IMN33",
              "IMRE",
              "BADDEBTRECOVERY",
              "USSALESTAX",
              "BLINPUT3"
            ],
            "description": "See ReportTaxTypes"
          },
          "CanApplyToAssets": {
            "type": "boolean",
            "description": "Boolean to describe if tax rate can be used for asset accounts i.e.  true,false"
          },
          "CanApplyToEquity": {
            "type": "boolean",
            "description": "Boolean to describe if tax rate can be used for equity accounts i.e true,false"
          },
          "CanApplyToExpenses": {
            "type": "boolean",
            "description": "Boolean to describe if tax rate can be used for expense accounts  i.e. true,false"
          },
          "CanApplyToLiabilities": {
            "type": "boolean",
            "description": "Boolean to describe if tax rate can be used for liability accounts  i.e. true,false"
          },
          "CanApplyToRevenue": {
            "type": "boolean",
            "description": "Boolean to describe if tax rate can be used for revenue accounts i.e. true,false"
          },
          "DisplayTaxRate": {
            "type": "number",
            "format": "double",
            "description": "Tax Rate (decimal to 4dp) e.g 12.5000"
          },
          "EffectiveRate": {
            "type": "number",
            "format": "double",
            "description": "Effective Tax Rate (decimal to 4dp) e.g 12.5000"
          }
        }
      },
      "description": "Tax Rates"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id"
  ]
}

xero_accounting_delete_account

Deletes a chart of accounts Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`AccountID`	string	Yes	—	Unique identifier for Account object

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "AccountID": {
      "type": "string",
      "description": "Unique identifier for Account object"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id",
    "AccountID"
  ]
}

xero_accounting_get_account

Retrieves a single chart of accounts by using a unique account Id Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`AccountID`	string	Yes	—	Unique identifier for Account object

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "AccountID": {
      "type": "string",
      "description": "Unique identifier for Account object"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id",
    "AccountID"
  ]
}

xero_accounting_get_accounts

Retrieves the full chart of accounts Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`If-Modified-Since`	string	No	—	Only records created or modified since this timestamp will be returned
`where`	string	No	—	Filter by an any element
`order`	string	No	—	Order by an any element

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "If-Modified-Since": {
      "type": "string",
      "description": "Only records created or modified since this timestamp will be returned"
    },
    "where": {
      "type": "string",
      "description": "Filter by an any element"
    },
    "order": {
      "type": "string",
      "description": "Order by an any element"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id"
  ]
}

xero_accounting_get_branding_theme

Retrieves a specific branding theme using a unique branding theme Id Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`BrandingThemeID`	string	Yes	—	Unique identifier for a Branding Theme

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "BrandingThemeID": {
      "type": "string",
      "description": "Unique identifier for a Branding Theme"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id",
    "BrandingThemeID"
  ]
}

xero_accounting_get_branding_theme_payment_services

Retrieves the payment services for a specific branding theme Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`BrandingThemeID`	string	Yes	—	Unique identifier for a Branding Theme

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "BrandingThemeID": {
      "type": "string",
      "description": "Unique identifier for a Branding Theme"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id",
    "BrandingThemeID"
  ]
}

xero_accounting_get_branding_themes

Retrieves all the branding themes Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id"
  ]
}

xero_accounting_get_budget

Retrieves a specific budget, which includes budget lines Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`BudgetID`	string	Yes	—	Unique identifier for Budgets
`DateTo`	string	No	—	Filter by start date
`DateFrom`	string	No	—	Filter by end date

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "BudgetID": {
      "type": "string",
      "description": "Unique identifier for Budgets"
    },
    "DateTo": {
      "type": "string",
      "description": "Filter by start date"
    },
    "DateFrom": {
      "type": "string",
      "description": "Filter by end date"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id",
    "BudgetID"
  ]
}

xero_accounting_get_budgets

Retrieve a list of budgets Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`IDs`	string	No	—	Filter by BudgetID. Allows you to retrieve a specific individual budget.
`DateTo`	string	No	—	Filter by start date
`DateFrom`	string	No	—	Filter by end date

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "IDs": {
      "type": "string",
      "description": "Filter by BudgetID. Allows you to retrieve a specific individual budget."
    },
    "DateTo": {
      "type": "string",
      "description": "Filter by start date"
    },
    "DateFrom": {
      "type": "string",
      "description": "Filter by end date"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id"
  ]
}

xero_accounting_get_currencies

Retrieves currencies for your Xero organisation Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`where`	string	No	—	Filter by an any element
`order`	string	No	—	Order by an any element

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "where": {
      "type": "string",
      "description": "Filter by an any element"
    },
    "order": {
      "type": "string",
      "description": "Order by an any element"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id"
  ]
}

xero_accounting_get_journal

Retrieves a specific journal using a unique journal Id. Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`JournalID`	string	Yes	—	Unique identifier for a Journal

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "JournalID": {
      "type": "string",
      "description": "Unique identifier for a Journal"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id",
    "JournalID"
  ]
}

xero_accounting_get_journal_by_number

Retrieves a specific journal using a unique journal number. Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`JournalNumber`	integer	Yes	—	Number of a Journal

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "JournalNumber": {
      "type": "integer",
      "description": "Number of a Journal"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id",
    "JournalNumber"
  ]
}

xero_accounting_get_journals

Retrieves journals Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`If-Modified-Since`	string	No	—	Only records created or modified since this timestamp will be returned
`offset`	integer	No	—	Offset by a specified journal number. e.g. journals with a JournalNumber greater than the offset will be returned
`paymentsOnly`	boolean	No	—	Filter to retrieve journals on a cash basis. Journals are returned on an accrual basis by default.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "If-Modified-Since": {
      "type": "string",
      "description": "Only records created or modified since this timestamp will be returned"
    },
    "offset": {
      "type": "integer",
      "description": "Offset by a specified journal number. e.g. journals with a JournalNumber greater than the offset will be returned"
    },
    "paymentsOnly": {
      "type": "boolean",
      "description": "Filter to retrieve journals on a cash basis. Journals are returned on an accrual basis by default."
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id"
  ]
}

xero_accounting_get_manual_journal

Retrieves a specific manual journal Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`ManualJournalID`	string	Yes	—	Unique identifier for a ManualJournal

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "ManualJournalID": {
      "type": "string",
      "description": "Unique identifier for a ManualJournal"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id",
    "ManualJournalID"
  ]
}

xero_accounting_get_manual_journals

Retrieves manual journals Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`If-Modified-Since`	string	No	—	Only records created or modified since this timestamp will be returned
`where`	string	No	—	Filter by an any element
`order`	string	No	—	Order by an any element
`page`	integer	No	—	e.g. page=1 – Up to 100 manual journals will be returned in a single API call with line items shown for each overpayment
`pageSize`	integer	No	—	Number of records to retrieve per page

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "If-Modified-Since": {
      "type": "string",
      "description": "Only records created or modified since this timestamp will be returned"
    },
    "where": {
      "type": "string",
      "description": "Filter by an any element"
    },
    "order": {
      "type": "string",
      "description": "Order by an any element"
    },
    "page": {
      "type": "integer",
      "description": "e.g. page=1 – Up to 100 manual journals will be returned in a single API call with line items shown for each overpayment"
    },
    "pageSize": {
      "type": "integer",
      "description": "Number of records to retrieve per page"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id"
  ]
}

xero_accounting_get_organisation_actions

Retrieves a list of the key actions your app has permission to perform in the connected Xero organisation. Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id"
  ]
}

xero_accounting_get_organisation_cissettings

Retrieves the CIS settings for the Xero organistaion. Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`OrganisationID`	string	Yes	—	The unique Xero identifier for an organisation

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "OrganisationID": {
      "type": "string",
      "description": "The unique Xero identifier for an organisation"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id",
    "OrganisationID"
  ]
}

xero_accounting_get_organisations

Retrieves Xero organisation details Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id"
  ]
}

xero_accounting_get_report_aged_payables_by_contact

Retrieves report for aged payables by contact Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`contactId`	string	Yes	—	Unique identifier for a Contact
`date`	string	No	—	The date of the Aged Payables By Contact report
`fromDate`	string	No	—	filter by the from date of the report e.g. 2021-02-01
`toDate`	string	No	—	filter by the to date of the report e.g. 2021-02-28

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "contactId": {
      "type": "string",
      "description": "Unique identifier for a Contact"
    },
    "date": {
      "type": "string",
      "description": "The date of the Aged Payables By Contact report"
    },
    "fromDate": {
      "type": "string",
      "description": "filter by the from date of the report e.g. 2021-02-01"
    },
    "toDate": {
      "type": "string",
      "description": "filter by the to date of the report e.g. 2021-02-28"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id",
    "contactId"
  ]
}

xero_accounting_get_report_aged_receivables_by_contact

Retrieves report for aged receivables by contact Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`contactId`	string	Yes	—	Unique identifier for a Contact
`date`	string	No	—	The date of the Aged Receivables By Contact report
`fromDate`	string	No	—	filter by the from date of the report e.g. 2021-02-01
`toDate`	string	No	—	filter by the to date of the report e.g. 2021-02-28

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "contactId": {
      "type": "string",
      "description": "Unique identifier for a Contact"
    },
    "date": {
      "type": "string",
      "description": "The date of the Aged Receivables By Contact report"
    },
    "fromDate": {
      "type": "string",
      "description": "filter by the from date of the report e.g. 2021-02-01"
    },
    "toDate": {
      "type": "string",
      "description": "filter by the to date of the report e.g. 2021-02-28"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id",
    "contactId"
  ]
}

xero_accounting_get_report_balance_sheet

Retrieves report for balancesheet Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`date`	string	No	—	The date of the Balance Sheet report
`periods`	integer	No	—	The number of periods for the Balance Sheet report
`timeframe`	string	No	—	The period size to compare to (MONTH, QUARTER, YEAR)
`trackingOptionID1`	string	No	—	The tracking option 1 for the Balance Sheet report
`trackingOptionID2`	string	No	—	The tracking option 2 for the Balance Sheet report
`standardLayout`	boolean	No	—	The standard layout boolean for the Balance Sheet report
`paymentsOnly`	boolean	No	—	return a cash basis for the Balance Sheet report

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "date": {
      "type": "string",
      "description": "The date of the Balance Sheet report"
    },
    "periods": {
      "type": "integer",
      "description": "The number of periods for the Balance Sheet report"
    },
    "timeframe": {
      "type": "string",
      "description": "The period size to compare to (MONTH, QUARTER, YEAR)",
      "enum": [
        "MONTH",
        "QUARTER",
        "YEAR"
      ]
    },
    "trackingOptionID1": {
      "type": "string",
      "description": "The tracking option 1 for the Balance Sheet report"
    },
    "trackingOptionID2": {
      "type": "string",
      "description": "The tracking option 2 for the Balance Sheet report"
    },
    "standardLayout": {
      "type": "boolean",
      "description": "The standard layout boolean for the Balance Sheet report"
    },
    "paymentsOnly": {
      "type": "boolean",
      "description": "return a cash basis for the Balance Sheet report"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id"
  ]
}

xero_accounting_get_report_bank_summary

Retrieves report for bank summary Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`fromDate`	string	No	—	filter by the from date of the report e.g. 2021-02-01
`toDate`	string	No	—	filter by the to date of the report e.g. 2021-02-28

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "fromDate": {
      "type": "string",
      "description": "filter by the from date of the report e.g. 2021-02-01"
    },
    "toDate": {
      "type": "string",
      "description": "filter by the to date of the report e.g. 2021-02-28"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id"
  ]
}

xero_accounting_get_report_budget_summary

Retrieves report for budget summary Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`date`	string	No	—	The date for the Bank Summary report e.g. 2018-03-31
`periods`	integer	No	—	The number of periods to compare (integer between 1 and 12)
`timeframe`	integer	No	—	The period size to compare to (1=month, 3=quarter, 12=year)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "date": {
      "type": "string",
      "description": "The date for the Bank Summary report e.g. 2018-03-31"
    },
    "periods": {
      "type": "integer",
      "description": "The number of periods to compare (integer between 1 and 12)"
    },
    "timeframe": {
      "type": "integer",
      "description": "The period size to compare to (1=month, 3=quarter, 12=year)"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id"
  ]
}

xero_accounting_get_report_executive_summary

Retrieves report for executive summary Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`date`	string	No	—	The date for the Bank Summary report e.g. 2018-03-31

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "date": {
      "type": "string",
      "description": "The date for the Bank Summary report e.g. 2018-03-31"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id"
  ]
}

xero_accounting_get_report_from_id

Retrieves a specific report using a unique ReportID Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`ReportID`	string	Yes	—	Unique identifier for a Report

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "ReportID": {
      "type": "string",
      "description": "Unique identifier for a Report"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id",
    "ReportID"
  ]
}

xero_accounting_get_report_profit_and_loss

Retrieves report for profit and loss Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`fromDate`	string	No	—	filter by the from date of the report e.g. 2021-02-01
`toDate`	string	No	—	filter by the to date of the report e.g. 2021-02-28
`periods`	integer	No	—	The number of periods to compare (integer between 1 and 12)
`timeframe`	string	No	—	The period size to compare to (MONTH, QUARTER, YEAR)
`trackingCategoryID`	string	No	—	The trackingCategory 1 for the ProfitAndLoss report
`trackingCategoryID2`	string	No	—	The trackingCategory 2 for the ProfitAndLoss report
`trackingOptionID`	string	No	—	The tracking option 1 for the ProfitAndLoss report
`trackingOptionID2`	string	No	—	The tracking option 2 for the ProfitAndLoss report
`standardLayout`	boolean	No	—	Return the standard layout for the ProfitAndLoss report
`paymentsOnly`	boolean	No	—	Return cash only basis for the ProfitAndLoss report

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "fromDate": {
      "type": "string",
      "description": "filter by the from date of the report e.g. 2021-02-01"
    },
    "toDate": {
      "type": "string",
      "description": "filter by the to date of the report e.g. 2021-02-28"
    },
    "periods": {
      "type": "integer",
      "description": "The number of periods to compare (integer between 1 and 12)"
    },
    "timeframe": {
      "type": "string",
      "description": "The period size to compare to (MONTH, QUARTER, YEAR)",
      "enum": [
        "MONTH",
        "QUARTER",
        "YEAR"
      ]
    },
    "trackingCategoryID": {
      "type": "string",
      "description": "The trackingCategory 1 for the ProfitAndLoss report"
    },
    "trackingCategoryID2": {
      "type": "string",
      "description": "The trackingCategory 2 for the ProfitAndLoss report"
    },
    "trackingOptionID": {
      "type": "string",
      "description": "The tracking option 1 for the ProfitAndLoss report"
    },
    "trackingOptionID2": {
      "type": "string",
      "description": "The tracking option 2 for the ProfitAndLoss report"
    },
    "standardLayout": {
      "type": "boolean",
      "description": "Return the standard layout for the ProfitAndLoss report"
    },
    "paymentsOnly": {
      "type": "boolean",
      "description": "Return cash only basis for the ProfitAndLoss report"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id"
  ]
}

xero_accounting_get_report_ten_ninety_nine

Retrieve reports for 1099 Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`reportYear`	string	No	—	The year of the 1099 report

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "reportYear": {
      "type": "string",
      "description": "The year of the 1099 report"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id"
  ]
}

xero_accounting_get_report_trial_balance

Retrieves report for trial balance Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`date`	string	No	—	The date for the Trial Balance report e.g. 2018-03-31
`paymentsOnly`	boolean	No	—	Return cash only basis for the Trial Balance report

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "date": {
      "type": "string",
      "description": "The date for the Trial Balance report e.g. 2018-03-31"
    },
    "paymentsOnly": {
      "type": "boolean",
      "description": "Return cash only basis for the Trial Balance report"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id"
  ]
}

xero_accounting_get_reports_list

Retrieves a list of the organistaions unique reports that require a uuid to fetch Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id"
  ]
}

xero_accounting_get_tax_rate_by_tax_type

Retrieves a specific tax rate according to given TaxType code Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`TaxType`	string	Yes	—	A valid TaxType code

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "TaxType": {
      "type": "string",
      "description": "A valid TaxType code"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id",
    "TaxType"
  ]
}

xero_accounting_get_tax_rates

Retrieves tax rates Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`where`	string	No	—	Filter by an any element
`order`	string	No	—	Order by an any element

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "where": {
      "type": "string",
      "description": "Filter by an any element"
    },
    "order": {
      "type": "string",
      "description": "Order by an any element"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id"
  ]
}

xero_accounting_get_user

Retrieves a specific user Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`UserID`	string	Yes	—	Unique identifier for a User

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "UserID": {
      "type": "string",
      "description": "Unique identifier for a User"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id",
    "UserID"
  ]
}

xero_accounting_get_users

Retrieves users Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`If-Modified-Since`	string	No	—	Only records created or modified since this timestamp will be returned
`where`	string	No	—	Filter by an any element
`order`	string	No	—	Order by an any element

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "If-Modified-Since": {
      "type": "string",
      "description": "Only records created or modified since this timestamp will be returned"
    },
    "where": {
      "type": "string",
      "description": "Filter by an any element"
    },
    "order": {
      "type": "string",
      "description": "Order by an any element"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id"
  ]
}

xero_accounting_post_setup

Sets the chart of accounts, the conversion date and conversion balances Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`Idempotency-Key`	string	No	—	This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
`body`	object	Yes	—	Object including an accounts array, a conversion balances array and a conversion date object in body of request

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "Idempotency-Key": {
      "type": "string",
      "description": "This allows you to safely retry requests without the risk of duplicate processing. 128 character max."
    },
    "body": {
      "description": "Object including an accounts array, a conversion balances array and a conversion date object in body of request"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id",
    "body"
  ]
}

xero_accounting_update_account

Updates a chart of accounts Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`AccountID`	string	Yes	—	Unique identifier for Account object
`Idempotency-Key`	string	No	—	This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
`Accounts`	object[]	No	—	The accounts value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "AccountID": {
      "type": "string",
      "description": "Unique identifier for Account object"
    },
    "Idempotency-Key": {
      "type": "string",
      "description": "This allows you to safely retry requests without the risk of duplicate processing. 128 character max."
    },
    "Accounts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "Code": {
            "type": "string",
            "description": "Customer defined alpha numeric account code e.g 200 or SALES (max length = 10)"
          },
          "Name": {
            "type": "string",
            "description": "Name of account (max length = 150)"
          },
          "AccountID": {
            "type": "string",
            "format": "uuid",
            "description": "The Xero identifier for an account – specified as a string following  the endpoint name   e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9"
          },
          "Type": {
            "type": "string",
            "enum": [
              "BANK",
              "CURRENT",
              "CURRLIAB",
              "DEPRECIATN",
              "DIRECTCOSTS",
              "EQUITY",
              "EXPENSE",
              "FIXED",
              "INVENTORY",
              "LIABILITY",
              "NONCURRENT",
              "OTHERINCOME",
              "OVERHEADS",
              "PREPAYMENT",
              "REVENUE",
              "SALES",
              "TERMLIAB",
              "PAYG"
            ],
            "description": "See Account Types"
          },
          "BankAccountNumber": {
            "type": "string",
            "description": "For bank accounts only (Account Type BANK)"
          },
          "Status": {
            "type": "string",
            "enum": [
              "ACTIVE",
              "ARCHIVED",
              "DELETED"
            ],
            "description": "Accounts with a status of ACTIVE can be updated to ARCHIVED. See Account Status Codes"
          },
          "Description": {
            "type": "string",
            "description": "Description of the Account. Valid for all types of accounts except bank accounts (max length = 4000)"
          },
          "BankAccountType": {
            "type": "string",
            "enum": [
              "BANK",
              "CREDITCARD",
              "PAYPAL",
              "NONE",
              ""
            ],
            "description": "For bank accounts only. See Bank Account types"
          },
          "CurrencyCode": {
            "type": "string",
            "enum": [
              "AED",
              "AFN",
              "ALL",
              "AMD",
              "ANG",
              "AOA",
              "ARS",
              "AUD",
              "AWG",
              "AZN",
              "BAM",
              "BBD",
              "BDT",
              "BGN",
              "BHD",
              "BIF",
              "BMD",
              "BND",
              "BOB",
              "BRL",
              "BSD",
              "BTN",
              "BWP",
              "BYN",
              "BYR",
              "BZD",
              "CAD",
              "CDF",
              "CHF",
              "CLF",
              "CLP",
              "CNY",
              "COP",
              "CRC",
              "CUC",
              "CUP",
              "CVE",
              "CZK",
              "DJF",
              "DKK",
              "DOP",
              "DZD",
              "EEK",
              "EGP",
              "ERN",
              "ETB",
              "EUR",
              "FJD",
              "FKP",
              "GBP",
              "GEL",
              "GHS",
              "GIP",
              "GMD",
              "GNF",
              "GTQ",
              "GYD",
              "HKD",
              "HNL",
              "HRK",
              "HTG",
              "HUF",
              "IDR",
              "ILS",
              "INR",
              "IQD",
              "IRR",
              "ISK",
              "JMD",
              "JOD",
              "JPY",
              "KES",
              "KGS",
              "KHR",
              "KMF",
              "KPW",
              "KRW",
              "KWD",
              "KYD",
              "KZT",
              "LAK",
              "LBP",
              "LKR",
              "LRD",
              "LSL",
              "LTL",
              "LVL",
              "LYD",
              "MAD",
              "MDL",
              "MGA",
              "MKD",
              "MMK",
              "MNT",
              "MOP",
              "MRO",
              "MRU",
              "MUR",
              "MVR",
              "MWK",
              "MXN",
              "MXV",
              "MYR",
              "MZN",
              "NAD",
              "NGN",
              "NIO",
              "NOK",
              "NPR",
              "NZD",
              "OMR",
              "PAB",
              "PEN",
              "PGK",
              "PHP",
              "PKR",
              "PLN",
              "PYG",
              "QAR",
              "RON",
              "RSD",
              "RUB",
              "RWF",
              "SAR",
              "SBD",
              "SCR",
              "SDG",
              "SEK",
              "SGD",
              "SHP",
              "SKK",
              "SLE",
              "SLL",
              "SOS",
              "SRD",
              "STD",
              "STN",
              "SVC",
              "SYP",
              "SZL",
              "THB",
              "TJS",
              "TMT",
              "TND",
              "TOP",
              "TRY",
              "TTD",
              "TWD",
              "TZS",
              "UAH",
              "UGX",
              "USD",
              "UYU",
              "UZS",
              "VEF",
              "VES",
              "VND",
              "VUV",
              "WST",
              "XAF",
              "XCD",
              "XOF",
              "XPF",
              "YER",
              "ZAR",
              "ZMW",
              "ZMK",
              "ZWD"
            ],
            "description": "3 letter alpha code for the currency – see list of currency codes"
          },
          "TaxType": {
            "type": "string",
            "description": "The tax type from taxRates"
          },
          "EnablePaymentsToAccount": {
            "type": "boolean",
            "description": "Boolean – describes whether account can have payments applied to it"
          },
          "ShowInExpenseClaims": {
            "type": "boolean",
            "description": "Boolean – describes whether account code is available for use with expense claims"
          },
          "Class": {
            "type": "string",
            "enum": [
              "ASSET",
              "EQUITY",
              "EXPENSE",
              "LIABILITY",
              "REVENUE"
            ],
            "description": "See Account Class Types"
          },
          "SystemAccount": {
            "type": "string",
            "enum": [
              "DEBTORS",
              "CREDITORS",
              "BANKCURRENCYGAIN",
              "GST",
              "GSTONIMPORTS",
              "HISTORICAL",
              "REALISEDCURRENCYGAIN",
              "RETAINEDEARNINGS",
              "ROUNDING",
              "TRACKINGTRANSFERS",
              "UNPAIDEXPCLM",
              "UNREALISEDCURRENCYGAIN",
              "WAGEPAYABLES",
              "CISASSETS",
              "CISASSET",
              "CISLABOUR",
              "CISLABOUREXPENSE",
              "CISLABOURINCOME",
              "CISLIABILITY",
              "CISMATERIALS",
              ""
            ],
            "description": "If this is a system account then this element is returned. See System Account types. Note that non-system accounts may have this element set as either “” or null."
          },
          "ReportingCode": {
            "type": "string",
            "description": "Shown if set"
          },
          "ReportingCodeName": {
            "type": "string",
            "description": "Shown if set"
          },
          "HasAttachments": {
            "type": "boolean",
            "description": "boolean to indicate if an account has an attachment (read only)"
          },
          "UpdatedDateUTC": {
            "type": "string",
            "description": "Last modified date UTC format"
          },
          "AddToWatchlist": {
            "type": "boolean",
            "description": "Boolean – describes whether the account is shown in the watchlist widget on the dashboard"
          },
          "ValidationErrors": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "Message": {
                  "type": "string",
                  "description": "Validation error message"
                }
              }
            },
            "description": "Displays array of validation error messages from the API"
          }
        }
      },
      "description": "The accounts value"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id",
    "AccountID"
  ]
}

xero_accounting_update_manual_journal

Updates a specific manual journal Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`Idempotency-Key`	string	No	—	This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
`ManualJournalID`	string	Yes	—	Unique identifier for a ManualJournal
`ManualJournals`	object[]	No	—	Manual Journals
`pagination`	object	No	—	The pagination value
`Warnings`	object[]	No	—	Displays array of warning messages from the API

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "Idempotency-Key": {
      "type": "string",
      "description": "This allows you to safely retry requests without the risk of duplicate processing. 128 character max."
    },
    "ManualJournalID": {
      "type": "string",
      "description": "Unique identifier for a ManualJournal"
    },
    "ManualJournals": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "Narration": {
            "type": "string",
            "description": "Description of journal being posted"
          },
          "JournalLines": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "LineAmount": {
                  "type": "number",
                  "description": "total for line. Debits are positive, credits are negative value"
                },
                "AccountCode": {
                  "type": "string",
                  "description": "See Accounts"
                },
                "AccountID": {
                  "type": "string",
                  "description": "See Accounts"
                },
                "Description": {
                  "type": "string",
                  "description": "Description for journal line"
                },
                "TaxType": {
                  "type": "string",
                  "description": "The tax type from TaxRates"
                },
                "Tracking": {
                  "type": "array",
                  "description": "Optional Tracking Category – see Tracking. Any JournalLine can have a maximum of 2 <TrackingCategory> elements."
                },
                "TaxAmount": {
                  "type": "number",
                  "description": "The calculated tax amount based on the TaxType and LineAmount"
                },
                "IsBlank": {
                  "type": "boolean",
                  "description": "is the line blank"
                }
              }
            },
            "description": "See JournalLines"
          },
          "Date": {
            "type": "string",
            "description": "Date journal was posted – YYYY-MM-DD"
          },
          "LineAmountTypes": {
            "type": "string",
            "enum": [
              "Exclusive",
              "Inclusive",
              "NoTax"
            ],
            "description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types"
          },
          "Status": {
            "type": "string",
            "enum": [
              "DRAFT",
              "POSTED",
              "DELETED",
              "VOIDED",
              "ARCHIVED"
            ],
            "description": "See Manual Journal Status Codes"
          },
          "Url": {
            "type": "string",
            "description": "Url link to a source document – shown as “Go to [appName]” in the Xero app"
          },
          "ShowOnCashBasisReports": {
            "type": "boolean",
            "description": "Boolean – default is true if not specified"
          },
          "HasAttachments": {
            "type": "boolean",
            "description": "Boolean to indicate if a manual journal has an attachment"
          },
          "UpdatedDateUTC": {
            "type": "string",
            "description": "Last modified date UTC format"
          },
          "ManualJournalID": {
            "type": "string",
            "format": "uuid",
            "description": "The Xero identifier for a Manual Journal"
          },
          "StatusAttributeString": {
            "type": "string",
            "description": "A string to indicate if a invoice status"
          },
          "Warnings": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "Message": {
                  "type": "string",
                  "description": "Validation error message"
                }
              }
            },
            "description": "Displays array of warning messages from the API"
          },
          "ValidationErrors": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "Message": {
                  "type": "string",
                  "description": "Validation error message"
                }
              }
            },
            "description": "Displays array of validation error messages from the API"
          },
          "Attachments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "AttachmentID": {
                  "type": "string",
                  "description": "Unique ID for the file"
                },
                "FileName": {
                  "type": "string",
                  "description": "Name of the file"
                },
                "Url": {
                  "type": "string",
                  "description": "URL to the file on xero.com"
                },
                "MimeType": {
                  "type": "string",
                  "description": "Type of file"
                },
                "ContentLength": {
                  "type": "integer",
                  "description": "Length of the file content"
                },
                "IncludeOnline": {
                  "type": "boolean",
                  "description": "Include the file with the online invoice"
                }
              }
            },
            "description": "Displays array of attachments from the API"
          }
        },
        "required": [
          "Narration"
        ]
      },
      "description": "Manual Journals"
    },
    "pagination": {
      "type": "object",
      "description": "The pagination value",
      "properties": {
        "page": {
          "type": "integer",
          "description": "Page number for pagination"
        },
        "pageSize": {
          "type": "integer",
          "description": "Number of results per page"
        },
        "pageCount": {
          "type": "integer",
          "description": "Page Count"
        },
        "itemCount": {
          "type": "integer",
          "description": "Item Count"
        }
      }
    },
    "Warnings": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "Message": {
            "type": "string",
            "description": "Validation error message"
          }
        }
      },
      "description": "Displays array of warning messages from the API"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id",
    "ManualJournalID"
  ]
}

xero_accounting_update_or_create_manual_journals

Updates or creates a single manual journal Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`summarizeErrors`	boolean	No	—	If false return 200 OK and mix of successfully created objects and any with validation errors
`Idempotency-Key`	string	No	—	This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
`ManualJournals`	object[]	No	—	Manual Journals
`pagination`	object	No	—	The pagination value
`Warnings`	object[]	No	—	Displays array of warning messages from the API

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "summarizeErrors": {
      "type": "boolean",
      "description": "If false return 200 OK and mix of successfully created objects and any with validation errors"
    },
    "Idempotency-Key": {
      "type": "string",
      "description": "This allows you to safely retry requests without the risk of duplicate processing. 128 character max."
    },
    "ManualJournals": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "Narration": {
            "type": "string",
            "description": "Description of journal being posted"
          },
          "JournalLines": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "LineAmount": {
                  "type": "number",
                  "description": "total for line. Debits are positive, credits are negative value"
                },
                "AccountCode": {
                  "type": "string",
                  "description": "See Accounts"
                },
                "AccountID": {
                  "type": "string",
                  "description": "See Accounts"
                },
                "Description": {
                  "type": "string",
                  "description": "Description for journal line"
                },
                "TaxType": {
                  "type": "string",
                  "description": "The tax type from TaxRates"
                },
                "Tracking": {
                  "type": "array",
                  "description": "Optional Tracking Category – see Tracking. Any JournalLine can have a maximum of 2 <TrackingCategory> elements."
                },
                "TaxAmount": {
                  "type": "number",
                  "description": "The calculated tax amount based on the TaxType and LineAmount"
                },
                "IsBlank": {
                  "type": "boolean",
                  "description": "is the line blank"
                }
              }
            },
            "description": "See JournalLines"
          },
          "Date": {
            "type": "string",
            "description": "Date journal was posted – YYYY-MM-DD"
          },
          "LineAmountTypes": {
            "type": "string",
            "enum": [
              "Exclusive",
              "Inclusive",
              "NoTax"
            ],
            "description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types"
          },
          "Status": {
            "type": "string",
            "enum": [
              "DRAFT",
              "POSTED",
              "DELETED",
              "VOIDED",
              "ARCHIVED"
            ],
            "description": "See Manual Journal Status Codes"
          },
          "Url": {
            "type": "string",
            "description": "Url link to a source document – shown as “Go to [appName]” in the Xero app"
          },
          "ShowOnCashBasisReports": {
            "type": "boolean",
            "description": "Boolean – default is true if not specified"
          },
          "HasAttachments": {
            "type": "boolean",
            "description": "Boolean to indicate if a manual journal has an attachment"
          },
          "UpdatedDateUTC": {
            "type": "string",
            "description": "Last modified date UTC format"
          },
          "ManualJournalID": {
            "type": "string",
            "format": "uuid",
            "description": "The Xero identifier for a Manual Journal"
          },
          "StatusAttributeString": {
            "type": "string",
            "description": "A string to indicate if a invoice status"
          },
          "Warnings": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "Message": {
                  "type": "string",
                  "description": "Validation error message"
                }
              }
            },
            "description": "Displays array of warning messages from the API"
          },
          "ValidationErrors": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "Message": {
                  "type": "string",
                  "description": "Validation error message"
                }
              }
            },
            "description": "Displays array of validation error messages from the API"
          },
          "Attachments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "AttachmentID": {
                  "type": "string",
                  "description": "Unique ID for the file"
                },
                "FileName": {
                  "type": "string",
                  "description": "Name of the file"
                },
                "Url": {
                  "type": "string",
                  "description": "URL to the file on xero.com"
                },
                "MimeType": {
                  "type": "string",
                  "description": "Type of file"
                },
                "ContentLength": {
                  "type": "integer",
                  "description": "Length of the file content"
                },
                "IncludeOnline": {
                  "type": "boolean",
                  "description": "Include the file with the online invoice"
                }
              }
            },
            "description": "Displays array of attachments from the API"
          }
        },
        "required": [
          "Narration"
        ]
      },
      "description": "Manual Journals"
    },
    "pagination": {
      "type": "object",
      "description": "The pagination value",
      "properties": {
        "page": {
          "type": "integer",
          "description": "Page number for pagination"
        },
        "pageSize": {
          "type": "integer",
          "description": "Number of results per page"
        },
        "pageCount": {
          "type": "integer",
          "description": "Page Count"
        },
        "itemCount": {
          "type": "integer",
          "description": "Item Count"
        }
      }
    },
    "Warnings": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "Message": {
            "type": "string",
            "description": "Validation error message"
          }
        }
      },
      "description": "Displays array of warning messages from the API"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id"
  ]
}

xero_accounting_update_tax_rate

Updates tax rates Parameters:

Parameter	Type	Required	Default	Description
`xero-tenant-id`	string	Yes	—	Xero identifier for Tenant
`Idempotency-Key`	string	No	—	This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
`TaxRates`	object[]	No	—	Tax Rates

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "xero-tenant-id": {
      "type": "string",
      "description": "Xero identifier for Tenant"
    },
    "Idempotency-Key": {
      "type": "string",
      "description": "This allows you to safely retry requests without the risk of duplicate processing. 128 character max."
    },
    "TaxRates": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "Name": {
            "type": "string",
            "description": "Name of tax rate"
          },
          "TaxType": {
            "type": "string",
            "description": "The tax type"
          },
          "TaxComponents": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "Name": {
                  "type": "string",
                  "description": "Name of Tax Component"
                },
                "Rate": {
                  "type": "number",
                  "description": "Tax Rate (up to 4dp)"
                },
                "IsCompound": {
                  "type": "boolean",
                  "description": "Boolean to describe if Tax rate is compounded."
                },
                "IsNonRecoverable": {
                  "type": "boolean",
                  "description": "Boolean to describe if tax rate is non-recoverable. Non-recoverable rates are only applicable to Canadian organisations"
                }
              }
            },
            "description": "See TaxComponents"
          },
          "Status": {
            "type": "string",
            "enum": [
              "ACTIVE",
              "DELETED",
              "ARCHIVED",
              "PENDING"
            ],
            "description": "See Status Codes"
          },
          "ReportTaxType": {
            "type": "string",
            "enum": [
              "AVALARA",
              "BASEXCLUDED",
              "CAPITALSALESOUTPUT",
              "CAPITALEXPENSESINPUT",
              "ECOUTPUT",
              "ECOUTPUTSERVICES",
              "ECINPUT",
              "ECACQUISITIONS",
              "EXEMPTEXPENSES",
              "EXEMPTINPUT",
              "EXEMPTOUTPUT",
              "GSTONIMPORTS",
              "INPUT",
              "INPUTTAXED",
              "MOSSSALES",
              "NONE",
              "NONEOUTPUT",
              "OUTPUT",
              "PURCHASESINPUT",
              "SALESOUTPUT",
              "EXEMPTCAPITAL",
              "EXEMPTEXPORT",
              "CAPITALEXINPUT",
              "GSTONCAPIMPORTS",
              "GSTONCAPITALIMPORTS",
              "REVERSECHARGES",
              "PAYMENTS",
              "INVOICE",
              "CASH",
              "ACCRUAL",
              "FLATRATECASH",
              "FLATRATEACCRUAL",
              "ACCRUALS",
              "TXCA",
              "SRCAS",
              "DSOUTPUT",
              "BLINPUT2",
              "EPINPUT",
              "IMINPUT2",
              "MEINPUT",
              "IGDSINPUT2",
              "ESN33OUTPUT",
              "OPINPUT",
              "OSOUTPUT",
              "TXN33INPUT",
              "TXESSINPUT",
              "TXREINPUT",
              "TXPETINPUT",
              "NRINPUT",
              "ES33OUTPUT",
              "ZERORATEDINPUT",
              "ZERORATEDOUTPUT",
              "DRCHARGESUPPLY",
              "DRCHARGE",
              "CAPINPUT",
              "CAPIMPORTS",
              "IMINPUT",
              "INPUT2",
              "CIUINPUT",
              "SRINPUT",
              "OUTPUT2",
              "SROUTPUT",
              "CAPOUTPUT",
              "SROUTPUT2",
              "CIUOUTPUT",
              "ZROUTPUT",
              "ZREXPORT",
              "ACC28PLUS",
              "ACCUPTO28",
              "OTHEROUTPUT",
              "SHOUTPUT",
              "ZRINPUT",
              "BADDEBT",
              "OTHERINPUT",
              "BADDEBTRELIEF",
              "IGDSINPUT3",
              "SROVR",
              "TOURISTREFUND",
              "TXRCN33",
              "TXRCRE",
              "TXRCESS",
              "TXRCTS",
              "CAPEXINPUT",
              "UNDEFINED",
              "CAPEXOUTPUT",
              "ZEROEXPOUTPUT",
              "GOODSIMPORT",
              "NONEINPUT",
              "NOTREPORTED",
              "SROVRRS",
              "SROVRLVG",
              "SRLVG",
              "IM",
              "IMESS",
              "IMN33",
              "IMRE",
              "BADDEBTRECOVERY",
              "USSALESTAX",
              "BLINPUT3"
            ],
            "description": "See ReportTaxTypes"
          },
          "CanApplyToAssets": {
            "type": "boolean",
            "description": "Boolean to describe if tax rate can be used for asset accounts i.e.  true,false"
          },
          "CanApplyToEquity": {
            "type": "boolean",
            "description": "Boolean to describe if tax rate can be used for equity accounts i.e true,false"
          },
          "CanApplyToExpenses": {
            "type": "boolean",
            "description": "Boolean to describe if tax rate can be used for expense accounts  i.e. true,false"
          },
          "CanApplyToLiabilities": {
            "type": "boolean",
            "description": "Boolean to describe if tax rate can be used for liability accounts  i.e. true,false"
          },
          "CanApplyToRevenue": {
            "type": "boolean",
            "description": "Boolean to describe if tax rate can be used for revenue accounts i.e. true,false"
          },
          "DisplayTaxRate": {
            "type": "number",
            "format": "double",
            "description": "Tax Rate (decimal to 4dp) e.g 12.5000"
          },
          "EffectiveRate": {
            "type": "number",
            "format": "double",
            "description": "Effective Tax Rate (decimal to 4dp) e.g 12.5000"
          }
        }
      },
      "description": "Tax Rates"
    }
  },
  "required": [
    "PCID",
    "xero-tenant-id"
  ]
}

​Tools

​xero_accounting_create_account

​xero_accounting_create_branding_theme_payment_services

​xero_accounting_create_currency

​xero_accounting_create_manual_journals

​xero_accounting_create_tax_rates

​xero_accounting_delete_account

​xero_accounting_get_account

​xero_accounting_get_accounts

​xero_accounting_get_branding_theme

​xero_accounting_get_branding_theme_payment_services

​xero_accounting_get_branding_themes

​xero_accounting_get_budget

​xero_accounting_get_budgets

​xero_accounting_get_currencies

​xero_accounting_get_journal

​xero_accounting_get_journal_by_number

​xero_accounting_get_journals

​xero_accounting_get_manual_journal

​xero_accounting_get_manual_journals

​xero_accounting_get_organisation_actions

​xero_accounting_get_organisation_cissettings

​xero_accounting_get_organisations

​xero_accounting_get_report_aged_payables_by_contact

​xero_accounting_get_report_aged_receivables_by_contact

​xero_accounting_get_report_balance_sheet

​xero_accounting_get_report_bank_summary

​xero_accounting_get_report_budget_summary

​xero_accounting_get_report_executive_summary

​xero_accounting_get_report_from_id

​xero_accounting_get_report_profit_and_loss

​xero_accounting_get_report_ten_ninety_nine

​xero_accounting_get_report_trial_balance

​xero_accounting_get_reports_list

​xero_accounting_get_tax_rate_by_tax_type

​xero_accounting_get_tax_rates

​xero_accounting_get_user

​xero_accounting_get_users

​xero_accounting_post_setup

​xero_accounting_update_account

​xero_accounting_update_manual_journal

​xero_accounting_update_or_create_manual_journals

​xero_accounting_update_tax_rate

Tools

xero_accounting_create_account

xero_accounting_create_branding_theme_payment_services

xero_accounting_create_currency

xero_accounting_create_manual_journals

xero_accounting_create_tax_rates

xero_accounting_delete_account

xero_accounting_get_account

xero_accounting_get_accounts

xero_accounting_get_branding_theme

xero_accounting_get_branding_theme_payment_services

xero_accounting_get_branding_themes

xero_accounting_get_budget

xero_accounting_get_budgets

xero_accounting_get_currencies

xero_accounting_get_journal

xero_accounting_get_journal_by_number

xero_accounting_get_journals

xero_accounting_get_manual_journal

xero_accounting_get_manual_journals

xero_accounting_get_organisation_actions

xero_accounting_get_organisation_cissettings

xero_accounting_get_organisations

xero_accounting_get_report_aged_payables_by_contact

xero_accounting_get_report_aged_receivables_by_contact

xero_accounting_get_report_balance_sheet

xero_accounting_get_report_bank_summary

xero_accounting_get_report_budget_summary

xero_accounting_get_report_executive_summary

xero_accounting_get_report_from_id

xero_accounting_get_report_profit_and_loss

xero_accounting_get_report_ten_ninety_nine

xero_accounting_get_report_trial_balance

xero_accounting_get_reports_list

xero_accounting_get_tax_rate_by_tax_type

xero_accounting_get_tax_rates

xero_accounting_get_user

xero_accounting_get_users

xero_accounting_post_setup

xero_accounting_update_account

xero_accounting_update_manual_journal

xero_accounting_update_or_create_manual_journals

xero_accounting_update_tax_rate