Invoiced Destination

Invoiced
-
Click the + icon on the Nexset that will be sent to the Invoiced destination, and select the Send to Destination option from the menu.
-
Select the Invoiced connector from the list of available destination connectors. Then, select the credential that will be used to connect to the Invoiced account, and click Next; or, create a new Invoiced credential for use in this flow.
-
In Nexla, Invoiced destinations can be created using pre-built endpoint templates, which expedite destination setup for common Invoiced write operations. Each template is designed specifically for the corresponding Invoiced endpoint, making destination setup easy and efficient.
• To configure this destination using a template, follow the instructions in Configure Using a Template.Invoiced destinations can also be configured manually, allowing you to send data to any valid Invoiced REST API endpoint — including creating invoices, customers, payments, subscriptions, and other billing records.
• 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 Invoiced endpoints. Each template is designed specifically for the corresponding Invoiced endpoint, making destination setup easy and efficient.
Endpoint Settings
-
Select the endpoint to which this destination will send data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your destination for this endpoint.
Endpoint Testing
Once the selected endpoint template has been configured, Nexla can send a test payload to the Invoiced API to ensure that the destination is configured correctly.
-
To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.
-
If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.
-
Click the Send Test Data button at the top of a sample payload to send the test payload to the Invoiced API using the current settings.
Configure Manually
Invoiced destinations can be manually configured to send data to any valid Invoiced REST API endpoint. This allows you to create invoices, customers, payments, subscriptions, and other billing records in Invoiced from data flowing through Nexla. You can also configure Nexla to automatically send the response received from the Invoiced API after each call to a new Nexla webhook data source.
First, select the API method that will be used for calls to the Invoiced API from the Method pulldown menu. Common methods for Invoiced destination operations include:
- POST: For creating new resources (e.g., creating a new invoice, customer, or payment)
- PATCH: For updating existing resources (e.g., updating invoice details or customer information)
- PUT: For replacing existing resources entirely
- DELETE: For removing resources (e.g., voiding a draft invoice)
Data Format
-
Select the format in which the Nexset data will be sent to the Invoiced API from the Content Format pulldown menu. The Invoiced API accepts and returns data in JSON format. Select JSON to ensure Nexla sends data in the format expected by Invoiced.
The Invoiced API expects JSON-formatted request bodies for all write operations (POST, PATCH, PUT). Ensure that the field names in your Nexset match the Invoiced API's expected parameter names for the target resource. For complete field reference, see the Invoiced API Documentation.
API Endpoint URL
-
Enter the URL of the Invoiced API endpoint to which you want to send the Nexset data in the URL field.
Common Invoiced destination endpoint patterns include:
- Create a new invoice:
https://api.invoiced.com/invoices(POST) - Update an invoice:
https://api.invoiced.com/invoices/{'{id}'}(PATCH) - Create a new customer:
https://api.invoiced.com/customers(POST) - Update a customer:
https://api.invoiced.com/customers/{'{id}'}(PATCH) - Create a payment:
https://api.invoiced.com/payments(POST) - Create a subscription:
https://api.invoiced.com/subscriptions(POST) - Create a credit note:
https://api.invoiced.com/credit_notes(POST)
For update operations (PATCH or PUT), include the numeric ID of the record to be updated at the end of the URL. For example, to update invoice with ID 2048:
https://api.invoiced.com/invoices/2048.When creating resources through the API, Invoiced validates the submitted data and returns the created resource—including the system-assigned ID—in the response. You can capture this response using the Response Webhook option described below to track created record IDs in a downstream Nexset.
- Create a new invoice:
Request Headers
-
If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g.,
header1:value1,header2:value2).You do not need to include the Authorization header or authentication details in the request headers—these are handled automatically by Nexla based on your Invoiced credential configuration.
Exclude Attributes from the Call
-
If any record attributes in the Nexset should be omitted when sending data to this Invoiced destination, select the attributes from the Exclude Attributes pulldown menu.
-
Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.
Excluding attributes is useful when your Nexset contains fields that are not valid parameters for the Invoiced API endpoint you are targeting. Sending unknown fields to the Invoiced API may result in errors or unexpected behavior, so use this option to filter out any fields not recognized by the target endpoint.
Record Batching
-
If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.
-
Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to
100. -
Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings.
Invoiced's API processes individual records for most create/update operations. Evaluate whether the specific Invoiced endpoint you are targeting supports batch payloads before enabling record batching. For endpoints that accept only a single object per request, send records individually without batching enabled.
Response Webhook
Nexla can automatically send the response received from the Invoiced API after each call to a new Nexla webhook data source. This option allows you to track the status of each API call and capture important information returned by Invoiced—such as the system-assigned ID of a newly created invoice or customer.
- To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.
Sample Request Payload
Sample request payloads containing a portion of the Nexset data that will be sent to the Invoiced API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.
-
Click on a sample request payload to expand it and view the complete payload content.
-
Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.
Endpoint Testing
After all endpoint settings have been configured, Nexla can send a test payload to the Invoiced API to ensure that the destination is configured correctly.
-
To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.
-
If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.
-
Click the Send Test Data button at the top of a sample payload to send the test payload to the Invoiced API using the current settings.
Save & Activate the Destination
-
Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Invoiced endpoint, open the destination resource menu, and select Activate.
The Nexset data will not be sent to Invoiced until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.