Skip to main content

Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow, DB-CDC, Spark ETL, or Replication data flow that sends data to a Paymo location.
paymo_api.png

Paymo

Create a Paymo Destination​

  1. Click the + icon on the Nexset that will be sent to the Paymo destination, and select the Send to Destination option from the menu.

  2. Select the Paymo connector from the list of available destination connectors. Then, select the credential that will be used to connect to your Paymo account, and click Next; or, create a new Paymo credential for use in this flow.

  3. In Nexla, Paymo destinations can be created using pre-built endpoint templates, which expedite destination setup for common Paymo endpoints. Each template is designed specifically for the corresponding Paymo endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    Paymo destinations can also be configured manually, allowing you to send data to Paymo endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Paymo endpoints. Each template is designed specifically for the corresponding Paymo endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    Create Client

    This endpoint template creates a client in your Paymo account using records from a Nexset. Use this template when you need to create new clients in Paymo for project management, invoicing, or other client management purposes.

    • This endpoint automatically creates clients from your data. No additional configuration is required beyond selecting this endpoint template. The request body should contain the client data in JSON format matching the Paymo API structure.

    This endpoint sends data as JSON in the request body to create clients in your Paymo account. Each record from your Nexset will be sent as a separate API request to create a new client in Paymo. The request body should contain the client data in the format required by the Paymo API.

    The client structure must match the Paymo API's expected format. For detailed information about client creation, request body formats, available client properties, and client management, see the Paymo API documentation.

    Update company

    This endpoint template updates company information or adds/modifies company settings in your Paymo account using records from a Nexset. Use this template when you need to update company details, company settings, or other company-related information.

    • This endpoint automatically updates company information from your data. No additional configuration is required beyond selecting this endpoint template. The request body should contain the company data in JSON format matching the Paymo API structure.

    This endpoint sends data as JSON in the request body to update company information in your Paymo account. Each record from your Nexset will be sent as a separate API request to update company information in Paymo. The request body should contain the company data in the format required by the Paymo API.

    The company structure must match the Paymo API's expected format. For detailed information about company updates, request body formats, available company properties, and company management, see the Paymo API documentation.

Configure Manually​

Paymo destinations can be manually configured to send data to any valid Paymo API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Paymo API after each call to a new Nexla webhook data source.

API Method​

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Paymo API from the Method pulldown menu. Paymo API typically uses POST method for creating resources and PUT method for updating resources.

Data Format​

  1. Select the format in which the Nexset data will be sent to the Paymo API from the Content Format pulldown menu. Paymo API expects JSON format for all requests.

API Endpoint URL​

  1. Enter the URL of the Paymo API endpoint to which data will be sent in the URL field. This should be the complete URL to your Paymo endpoint (e.g., https://app.paymoapp.com/api/clients, https://app.paymoapp.com/api/company). Include any required path parameters in the URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. The Paymo API endpoint URL should point to the endpoint where you want to create or update resources. You can test the endpoint using the Test button after configuring the URL.

Request Body​

  1. Configure the request body that will be sent to the Paymo API. The request body should contain the resource data formatted as JSON, with field names matching the Paymo API's expected structure. The request body format is typically {message.json} to send the entire Nexset data as JSON, or you can construct a custom JSON structure with specific field mappings.

The request body must be valid JSON and must match the Paymo API's expected format for the specific endpoint you're using. Paymo API uses specific structures for different endpoints (clients, company, etc.). For detailed information about request body formats, available endpoints, and resource structures, see the Paymo API documentation.

Save the Destination​

  1. Once all of the relevant steps in the above sections have been completed, click the Next button to proceed with the rest of the data flow configuration, or click Save to save the destination configuration for later use.