> For the complete documentation index, see [llms.txt](https://doc.wearepatchworks.com/product-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.wearepatchworks.com/product-documentation/patchworks-services/service-systems/supported-service-systems/brightpearl-service-connector/additional-setup-notes-for-brightpearl-services.md).

# Additional setup notes for Brightpearl (services)

## Introduction

This page includes additional information and resources that may be useful when configuring Brightpearl in Patchworks:

* [Brightpearl documentation](#brightpearl-documentation)
* [Patchworks filters](#patchworks-filters)
* [Special options when pulling data from Brightpearl](#special-options-when-pulling-data-from-brightpearl)

## Brightpearl documentation

The following links to Brightpearl's own documentation may be useful if you need to dig deeper into Brightpearl fields (for example, to configure advanced mappings):

* [Brightpearl API documentation](https://api-docs.brightpearl.com/)

## Patchworks filters

When you are pulling data from Brightpearl, filters can be used to refine the data that is pulled. Available filter options vary, depending on which **entity type** is being synced (for example: orders, products, customers, etc.).

{% hint style="info" %}
For general information about working with filters in Patchworks, please see our [service filters](/product-documentation/patchworks-services/working-with-services/the-anatomy-of-a-service/service-filters.md) page.
{% endhint %}

### Time period filters

A common scenario for filters is to process records created/modified in the last x minutes/hours/days, or within a given timeframe. For Brightpearl, these filter fields are:

* Created on
* Updated on

In this scenario, we're dealing with events that have occurred in the past, so Patchworks filters are defined to work back from 'now'.

<details>

<summary>Example</summary>

Let's say that we only want to process all orders which were updated in the last 2 hours. In the Patchworks dashboard, our filters would look as follows:

![](/files/3MdaLoOIYIzPTy7dlJzv)

We can visualise this as below:

![](/files/G9SDEjpYu06MJdfM2ZJe)

</details>

{% hint style="warning" %}
Currently, it's not possible to add the same filter field twice, therefore you cannot define a start and end timeframe.
{% endhint %}

## Special options when pulling data from Brightpearl

When you choose to add Brightpearl as a **source** connector for a Patchworks service, you're prompted to provide details for a set of [standard options which are common to all source connectors](/product-documentation/patchworks-services/working-with-services/the-anatomy-of-a-service/service-source.md), irrespective of the system being used.&#x20;

In addition, depending on the entity being synced, some systems have specific options that need to be defined.&#x20;

**There are no special options to define when pulling data from Brightpearl.**


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://doc.wearepatchworks.com/product-documentation/patchworks-services/service-systems/supported-service-systems/brightpearl-service-connector/additional-setup-notes-for-brightpearl-services.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
