Contact Us 1-800-596-4880
  1. Homepage
  2. Xero Accounting Connector (1.0)

  3. Xero Accounting Connector Reference

All Connectors

Xero Accounting Connector 1.0 Reference

Anypoint Connector for Xero Accounting (Xero Connector) enables you to access the Xero Accounting APIs.

Configurations

Name Type Description Default Value Required

Name

String

Name for the configuration that connectors use for reference.

x

Connection

Oauth2 Connection Provider

The connection types to provide to this configuration.

x

Response Timeout

Number

Timeout for the request to the remote service.

1

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

MINUTES

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Specifies how the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

AUTO

Name

String

Identifier of this element; used to reference the element in other components.

x

Expiration Policy

Expiration Policy

Minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Connection Types

Oauth2 Connection Provider

Name Type Description Default Value Required

Default Headers

Array of Default Header

Query Parameters

Array of Default Query Param

Connection Timeout

Number

Timeout for establishing connections to the remote service.

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Use Persistent Connections

Boolean

If false, each connection is closed after the first request is completed.

true

Max Connections

Number

Maximum number of outbound connections to keep open concurrently.

-1

Connection Idle Timeout

Number

Timeout for how long a connection can remain idle before it is closed.

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Idle Timeout field.

SECONDS

Proxy Config

Proxy

Reusable configuration element for outbound connections through a proxy.

Stream Response

Boolean

Whether or not to stream received responses.

false

Response Buffer Size

Number

The space in bytes for the buffer where the HTTP response will be stored.

-1

Base Uri

String

Parameter base URI. Each instance or tenant gets its own base URI.

https://api.xero.com/api.xro/2.0

Protocol

Enumeration, one of:

  • HTTP

  • HTTPS

Protocol to use for communication. Valid values are HTTP and HTTPS.

HTTP

TLS Configuration

TLS

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Consumer Key

String

The OAuth consumerKey as registered with the service provider.

x

Consumer Secret

String

The OAuth consumerSecret as registered with the service provider.

x

Authorization Url

String

The service provider’s authorization endpoint URL.

https://login.xero.com/identity/connect/authorize

Access Token Url

String

The service provider’s accessToken endpoint URL.

https://identity.xero.com/connect/token

Scopes

String

The OAuth scopes to request during the OAuth dance. If not provided, it defaults to the scopes provided in the annotation.

  • email

  • openid

  • profile

  • accounting.transactions

  • accounting.transactions.read

  • accounting.reports.read

  • accounting.reports.tenninetynine.read

  • accounting.journals.read

  • accounting.settings

  • accounting.settings.read

  • accounting.contacts

  • accounting.contacts.read

  • accounting.attachments

  • accounting.attachments.read

  • assets assets.read

  • bankfeeds

  • files

  • files.read

  • payroll

  • payroll.read

  • payroll.employees

  • payroll.employees.read

  • payroll.leaveapplications

  • payroll.leaveapplications.read

  • payroll.payitems

  • payroll.payitems.read

  • payroll.payrollcalendars

  • payroll.payrollcalendars.read

  • payroll.payruns

  • payroll.payruns.read

  • payroll.payslip

  • payroll.payslip.read

  • payroll.settings.read

  • payroll.superfunds

  • payroll.superfunds.read

  • payroll.superfundproducts.read

  • payroll.timesheets

  • payroll.timesheets.read

  • paymentservices

  • projects projects.read

Resource Owner Id

String

The resource owner ID that each component should use if it is not otherwise referenced.

Before

String

Name of the flow to execute immediately before starting the OAuth dance.

After

String

Name of the flow to execute immediately after an access token is received.

Listener Config

String

The HTTP configuration used to create the listener that catches the access token callback endpoint.

x

Callback Path

String

Path of the access token callback endpoint.

x

Authorize Path

String

Path of the local HTTP endpoint that triggers the OAuth dance.

x

External Callback Url

String

If the callback endpoint is behind a proxy or should be accessed through a non direct URL, use this parameter to tell the OAuth provider the URL to use to access the callback.

Object Store

String

Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.

Sources

On New Or Updated Contact Trigger

<xero-accounting:on-new-or-updated-contact-trigger>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Modified Since

String

Retrieve records starting at this point in time.

x

Xero tenant ID

String

Xero identifier for the Tenant.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster.

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Redelivery Policy

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

On New Or Updated Items Trigger

<xero-accounting:on-new-or-updated-items-trigger>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Modified Since

String

Retrieve records starting at this point in time.

x

Xero tenant ID

String

Xero identifier for the Tenant.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component

x

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster.

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Redelivery Policy

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

On New Or Updated Payments Trigger

<xero-accounting:on-new-or-updated-payments-trigger>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Modified Since

String

Retrieve records starting at this point in time.

x

Xero tenant ID

String

Xero identifier for the Tenant.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster.

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Redelivery Policy

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Operations

Create Contacts

<xero-accounting:create-contacts>

Updates or creates one or more contacts in a Xero organization. This operation makes an HTTP POST request to the /Contacts endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Summarize Errors

Boolean

If false, returns 200 OK and a mix of successfully created objects as well as any with validation errors.

false

Xero tenant ID

String

Xero identifier for the Tenant.

x

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Specifies how the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • XERO-ACCOUNTING:BAD_REQUEST

  • XERO-ACCOUNTING:CLIENT_ERROR

  • XERO-ACCOUNTING:CONNECTIVITY

  • XERO-ACCOUNTING:INTERNAL_SERVER_ERROR

  • XERO-ACCOUNTING:NOT_ACCEPTABLE

  • XERO-ACCOUNTING:NOT_FOUND

  • XERO-ACCOUNTING:RETRY_EXHAUSTED

  • XERO-ACCOUNTING:SERVER_ERROR

  • XERO-ACCOUNTING:SERVICE_UNAVAILABLE

  • XERO-ACCOUNTING:TIMEOUT

  • XERO-ACCOUNTING:TOO_MANY_REQUESTS

  • XERO-ACCOUNTING:UNAUTHORIZED

  • XERO-ACCOUNTING:UNSUPPORTED_MEDIA_TYPE

Create Invoices

<xero-accounting:create-invoices>

Updates or creates one or more sales invoice or purchase bill. This operation makes an HTTP POST request to the /Invoices endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Summarize Errors

Boolean

If false, returns 200 OK and a mix of successfully created objects as well as any with validation errors.

false

unitdp

Number

(Unit Decimal Places) You can opt in to use four decimal places for unit amounts.

Xero tenant ID

String

Xero identifier for tenant.

x

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Specifies how the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • XERO-ACCOUNTING:BAD_REQUEST

  • XERO-ACCOUNTING:CLIENT_ERROR

  • XERO-ACCOUNTING:CONNECTIVITY

  • XERO-ACCOUNTING:INTERNAL_SERVER_ERROR

  • XERO-ACCOUNTING:NOT_ACCEPTABLE

  • XERO-ACCOUNTING:NOT_FOUND

  • XERO-ACCOUNTING:RETRY_EXHAUSTED

  • XERO-ACCOUNTING:SERVER_ERROR

  • XERO-ACCOUNTING:SERVICE_UNAVAILABLE

  • XERO-ACCOUNTING:TIMEOUT

  • XERO-ACCOUNTING:TOO_MANY_REQUESTS

  • XERO-ACCOUNTING:UNAUTHORIZED

  • XERO-ACCOUNTING:UNSUPPORTED_MEDIA_TYPE

Create Items

<xero-accounting:create-items>

Updates or creates one or more items. This operation makes an HTTP POST request to the /Items endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Summarize Errors

Boolean

If false, returns 200 OK and a mix of successfully created objects as well as any with validation errors.

false

unitdp

Number

(Unit Decimal Places) You can opt in to use four decimal places for unit amounts.

Xero tenant ID

String

Xero identifier for the tenant.

x

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Timeout for requests to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Specifies how the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • XERO-ACCOUNTING:BAD_REQUEST

  • XERO-ACCOUNTING:CLIENT_ERROR

  • XERO-ACCOUNTING:CONNECTIVITY

  • XERO-ACCOUNTING:INTERNAL_SERVER_ERROR

  • XERO-ACCOUNTING:NOT_ACCEPTABLE

  • XERO-ACCOUNTING:NOT_FOUND

  • XERO-ACCOUNTING:RETRY_EXHAUSTED

  • XERO-ACCOUNTING:SERVER_ERROR

  • XERO-ACCOUNTING:SERVICE_UNAVAILABLE

  • XERO-ACCOUNTING:TIMEOUT

  • XERO-ACCOUNTING:TOO_MANY_REQUESTS

  • XERO-ACCOUNTING:UNAUTHORIZED

  • XERO-ACCOUNTING:UNSUPPORTED_MEDIA_TYPE

Get Contacts

<xero-accounting:get-contacts>

Retrieves all contacts in a Xero organization. This operation makes an HTTP GET request to the /Contacts endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

IDs

Array of String

Filter by a comma-separated list of contact IDs, which enables you to retrieve a specific set of contacts in a single call.

page

Number

For example, page=1. Up to 100 contacts will be returned in a single API call.

1

Include Archived

Boolean

For example, includeArchived=true. Contacts with a status of ARCHIVED are included in the response.

false

order

String

Order by an element.

where

String

Filter by an element.

Xero tenant ID

String

Xero identifier for the tenant.

x

If Modified Since

String

Only records created or modified since this timestamp will be returned.

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Timeout for requests to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Specifies how the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Any

For Configurations

Throws

  • XERO-ACCOUNTING:BAD_REQUEST

  • XERO-ACCOUNTING:CLIENT_ERROR

  • XERO-ACCOUNTING:CONNECTIVITY

  • XERO-ACCOUNTING:INTERNAL_SERVER_ERROR

  • XERO-ACCOUNTING:NOT_ACCEPTABLE

  • XERO-ACCOUNTING:NOT_FOUND

  • XERO-ACCOUNTING:SERVER_ERROR

  • XERO-ACCOUNTING:SERVICE_UNAVAILABLE

  • XERO-ACCOUNTING:TIMEOUT

  • XERO-ACCOUNTING:TOO_MANY_REQUESTS

  • XERO-ACCOUNTING:UNAUTHORIZED

  • XERO-ACCOUNTING:UNSUPPORTED_MEDIA_TYPE

Get Contacts By Contact ID

<xero-accounting:get-contacts-by-contact-id>

Retrieves a specific contact in a Xero organization using a unique contact ID. This operation makes an HTTP GET request to the /Contacts/{ContactID} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Contact ID

String

Unique identifier for a Contact.

x

Xero tenant ID

String

Xero identifier for the Tenant.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Specifies how the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • XERO-ACCOUNTING:BAD_REQUEST

  • XERO-ACCOUNTING:CLIENT_ERROR

  • XERO-ACCOUNTING:CONNECTIVITY

  • XERO-ACCOUNTING:INTERNAL_SERVER_ERROR

  • XERO-ACCOUNTING:NOT_ACCEPTABLE

  • XERO-ACCOUNTING:NOT_FOUND

  • XERO-ACCOUNTING:RETRY_EXHAUSTED

  • XERO-ACCOUNTING:SERVER_ERROR

  • XERO-ACCOUNTING:SERVICE_UNAVAILABLE

  • XERO-ACCOUNTING:TIMEOUT

  • XERO-ACCOUNTING:TOO_MANY_REQUESTS

  • XERO-ACCOUNTING:UNAUTHORIZED

  • XERO-ACCOUNTING:UNSUPPORTED_MEDIA_TYPE

Retrieves items

<xero-accounting:get-items>

Retrieves items. This operation makes an HTTP GET request to the /Items endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

where

String

Filter by an element.

order

String

Order by an element.

unitdp

Number

(Unit Decimal Places) You can opt in to use four decimal places for unit amounts.

Xero tenant ID

String

Xero identifier for the Tenant.

x

If Modified Since

String

Only records created or modified since this timestamp will be returned.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Specifies how the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

Throws

  • XERO-ACCOUNTING:BAD_REQUEST

  • XERO-ACCOUNTING:CLIENT_ERROR

  • XERO-ACCOUNTING:CONNECTIVITY

  • XERO-ACCOUNTING:INTERNAL_SERVER_ERROR

  • XERO-ACCOUNTING:NOT_ACCEPTABLE

  • XERO-ACCOUNTING:NOT_FOUND

  • XERO-ACCOUNTING:RETRY_EXHAUSTED

  • XERO-ACCOUNTING:SERVER_ERROR

  • XERO-ACCOUNTING:SERVICE_UNAVAILABLE

  • XERO-ACCOUNTING:TIMEOUT

  • XERO-ACCOUNTING:TOO_MANY_REQUESTS

  • XERO-ACCOUNTING:UNAUTHORIZED

  • XERO-ACCOUNTING:UNSUPPORTED_MEDIA_TYPE

Get Payments

<xero-accounting:get-payments>

Retrieves payments for invoices and credit notes. This operation makes an HTTP GET request to the /Payments endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

where

String

Filter by an element.

order

String

Order by an element.

page

Number

Up to 100 payments will be returned in a single API call.

1

Xero tenant ID

String

Xero identifier for the Tenant.

x

If Modified Since

String

Only records created or modified since this timestamp will be returned.

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Specifies how the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Any

For Configurations

Throws

  • XERO-ACCOUNTING:BAD_REQUEST

  • XERO-ACCOUNTING:CLIENT_ERROR

  • XERO-ACCOUNTING:CONNECTIVITY

  • XERO-ACCOUNTING:INTERNAL_SERVER_ERROR

  • XERO-ACCOUNTING:NOT_ACCEPTABLE

  • XERO-ACCOUNTING:NOT_FOUND

  • XERO-ACCOUNTING:SERVER_ERROR

  • XERO-ACCOUNTING:SERVICE_UNAVAILABLE

  • XERO-ACCOUNTING:TIMEOUT

  • XERO-ACCOUNTING:TOO_MANY_REQUESTS

  • XERO-ACCOUNTING:UNAUTHORIZED

  • XERO-ACCOUNTING:UNSUPPORTED_MEDIA_TYPE

Unauthorize

<xero-accounting:unauthorize>

Deletes all the access token information of a given resource owner ID so that it’s impossible to execute any operation for that user without repeating the authorization dance.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Resource Owner Id

String

ID of the resource owner for which to invalidate access.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

For Configurations

Types

Default Header

Field Type Description Default Value Required

Key

String

x

Value

String

x

Default Query Param

Field Type Description Default Value Required

Key

String

x

Value

String

x

Proxy

Field Type Description Default Value Required

Host

String

x

Port

Number

x

Username

String

Password

String

Non Proxy Hosts

String

TLS

Field Type Description Default Value Required

Enabled Protocols

String

A comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma-separated list of cipher suites enabled for this context.

Trust Store

Truststore

Key Store

Keystore

Revocation Check

Truststore

Field Type Description Default Value Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the truststore.

Password

String

The password used to protect the truststore.

Type

String

The type of truststore used.

Algorithm

String

The algorithm used by the truststore.

Insecure

Boolean

If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

Keystore

Field Type Description Default Value Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the keystore.

Type

String

The type of keystore used.

Alias

String

When the keystore contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the keystore.

Algorithm

String

The algorithm used by the keystore.

Standard Revocation Check

Field Type Description Default Value Required

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

Soft Fail

Boolean

Avoid verification failure when the revocation server cannot be reached or is busy.

Custom OCSP Responder

Field Type Description Default Value Required

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

CRL File

Field Type Description Default Value Required

Path

String

The path to the CRL file.

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread

Count

Number

How many reconnection attempts to make.

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

HTTP Response Attributes

Field Type Description Default Value Required

Status Code

Number

x

Headers

Object

x

Reason Phrase

String

x

Repeatable In Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

The amount of memory that will be allocated to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.

Max Buffer Size

Number

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

Repeatable File Store Stream

File store repeatable streams require buffering, and there are different buffering strategies. Mule keeps a portion of contents in memory. If the stream contents are larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.

See Streaming in Mule Apps.

Field Type Description Default Value Required

In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed content on the disk is buffered.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

Redelivery Policy

Field Type Description Default Value Required

Max Redelivery Count

Number

The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message

Message Digest Algorithm

String

The secure hashing algorithm to use. If not set, the default is SHA-256.

Message Identifier

Redelivery Policy Message Identifier

Defines which strategy is used to identify the messages.

Object Store

ObjectStore

The object store where the redelivery counter for each message is stored.

Redelivery Policy Message Identifier

Field Type Description Default Value Required

Use Secure Hash

Boolean

Whether to use a secure hash algorithm to identify a redelivered message.

Id Expression

String

Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false.

Repeatable In Memory Iterable

This configuration, which is the default for the Mule Kernel, configures a default buffer size of 500 Objects. If the query result is larger than that, the buffer expands to a default increment size of 100 objects until it reaches the configured maximum buffer size. If the stream exceeds this limit, the app fails.

See Streaming in Mule Apps.

Field Type Description Default Value Required

Initial Buffer Size

Number

The number of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.

Max Buffer Size

Number

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

Repeatable File Store Iterable

This configuration is the default for Mule Enterprise Edition. This strategy uses a default configured in-memory buffer of 500 objects. If your query returns more results than the buffer size, Mule serializes those objects and writes them to your disk.

See Streaming in Mule Apps.

Field Type Description Default Value Required

In Memory Objects

Number

The maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

See Also

Back to top
View on GitHub