Skip to main content

Chift Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to a Chift location.
chift_api.png

Chift

Create a Chift Destination​

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

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

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

    Chift destinations can also be configured manually, allowing you to send data to Chift 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 Chift endpoints. Each template is designed specifically for the corresponding Chift endpoint, making destination setup easy and efficient.

All write endpoints below use the POST method and send each Nexset record as a JSON request body. Most endpoints are scoped to the Consumer ID configured in your credential, so the Nexset data must conform to the schema expected by the connected downstream tool for that consumer.

  • 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 a financial entry

    Creates a new financial entry in the connected accounting system, including its journal, currency, and optional items. Use this endpoint to push accounting entries from Nexla into your consumer's accounting software.

    • Map your Nexset so that each record represents one financial entry containing the journal, currency, and any line items required by the target accounting platform.
    • Each record is sent as the JSON body to the consumer's accounting financial-entries endpoint.

    The required fields for a financial entry depend on the downstream accounting tool connected for the consumer. Review the Chift accounting API reference for the exact payload schema.

    Create an invoice payment

    Creates a payment for one or more invoices with a specified date, method, and currency. Use this endpoint to record invoice payments in the connected accounting system.

    • Map your Nexset so that each record identifies the invoice or invoices being paid, along with the payment date, method, and currency.
    • Each record is sent as the JSON body to the consumer's accounting invoice-payments endpoint.

    Ensure the invoice identifiers referenced in the payment exist in the connected accounting software for the consumer.

    Create Consumer

    Creates a new consumer in Chift with the provided details. Use this endpoint to provision consumers in bulk from records managed elsewhere.

    • Map your Nexset so that each record contains the consumer details required by Chift, such as the consumer name and internal reference.
    • Each record is sent as the JSON body to the account-level consumers endpoint, so this endpoint does not require a Consumer ID scope.

    After a consumer is created, a connection to a downstream tool must still be established before per-consumer data endpoints will return data.

    Create Sync

    Creates a sync for the configured consumer and returns the resulting sync URL. Use this endpoint to initiate a synchronization for a consumer.

    • Map your Nexset so that each record contains the parameters required to create the sync for the consumer.
    • Each record is sent as the JSON body to the consumer's syncs endpoint, and the response includes the sync URL.

    To capture the returned sync URL, enable the response webhook option in the manual configuration so the API response is processed as a Nexla webhook source.

    Create Order

    Creates a new commerce order for the consumer with the specified details. Use this endpoint to push order records into the connected eCommerce or POS platform.

    • Map your Nexset so that each record represents one order, including its line items, customer, and totals as expected by the target commerce platform.
    • Each record is sent as the JSON body to the consumer's commerce orders endpoint.

    The required order fields depend on the downstream commerce tool connected for the consumer.

    Create Product

    Creates a new product in the invoicing module for the consumer account. Use this endpoint to push product catalog records into the connected invoicing software.

    • Map your Nexset so that each record represents one product, including its name, price, and any tax or category attributes required by the target tool.
    • Each record is sent as the JSON body to the consumer's invoicing products endpoint.

    This endpoint targets the invoicing module specifically. To create commerce products, use the appropriate commerce endpoint.

    Create Invoice

    Creates a new invoice in the invoicing module for the consumer account. Use this endpoint to generate invoices in the connected invoicing software from Nexla data.

    • Map your Nexset so that each record represents one invoice, including the customer, line items, currency, and dates required by the target tool.
    • Each record is sent as the JSON body to the consumer's invoicing invoices endpoint.

    The required invoice fields depend on the downstream invoicing tool connected for the consumer. Review the Chift invoicing API reference for the exact payload schema.

Configure Manually​

Chift destinations can be manually configured to send data to any valid Chift API endpoint.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Chift API after each call to a new Nexla webhook data source—useful for capturing identifiers or sync URLs returned by create operations.

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 Chift API from the Method pulldown menu. Chift write endpoints use the POST method.

Data Format​

  1. Select the format in which the Nexset data will be sent to the Chift API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call. Chift write endpoints accept application/json.

API Endpoint URL​

  1. Enter the URL of the Chift API endpoint to which you want to send the Nexset data in the URL field. Chift endpoints are hosted at https://api.chift.eu, and most write endpoints are scoped to a consumer—for example, https://api.chift.eu/consumers/{'{consumer_id}'}/invoicing/invoices. For update operations, include the ID of the object to be updated at the end of the URL.

Request Headers​

Optional

  • 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). For Chift, an optional X-Idempotency-Key header can be supplied to make repeated create requests safe to retry.

    You do not need to include any headers already present in the credentials. The Bearer token Authorization header is added automatically by Nexla.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this Chift 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.

Record Batching​

Optional

  1. 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.

  2. 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.

  3. 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. Some algorithms require additional settings—click on an algorithm listed below to view instructions for configuring these settings.

    Property Inside JSON Object

    1. Enter the name of the JSON property that should contain the batched records in the Property Name field.
    2. If any additional properties should be included in the request, enter the properties in the Other Props field in JSON format.

    Code

    1. Enter the code that will be used to create the batched request in the code editor below the Grouping Algorithm field.

Chift's create endpoints generally accept one resource per request. Confirm that the target endpoint supports batched payloads before enabling record batching.

Response Webhook​

Optional

Nexla can automatically send the response received from the Chift API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call, such as newly created object identifiers or sync URLs.

  • 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 Chift 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 (Manual Configuration)​

After all endpoint settings have been configured, Nexla can send a test payload to the Chift API to ensure that the destination is configured correctly.

  1. 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.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Chift 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 Chift endpoint, open the destination resource menu, and select Activate.

    The Nexset data will not be sent to Chift until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.