> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nekt.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Appmax as a data source

> Bring data from Appmax to your Lakehouse.

Appmax is a Brazilian payment platform that combines gateway, anti-fraud and acquiring for digital businesses, processing credit card, Pix and boleto payments through its checkout. The connector extracts every order registered in your Appmax account — amounts, status, payment method, boleto and Pix details — with the buyer's data carried inside each order, so you can analyse your sales in your Lakehouse and join them with your marketing and product data.

## Configuring Appmax as a Source

In the [Sources](https://app.nekt.ai/sources) tab, click on the "Add source" button located on the top right of your screen. Then, select the Appmax option from the list of connectors.

Click **Next** and you'll be prompted to add your access.

### 1. Add account access

Appmax authenticates with an **API key** issued for your account. In the Appmax admin panel, go to **Integrations** and open the **API** section to generate or copy the key.

<Warning>The key reaches every order in the account it belongs to. Treat it as a credential: generate it from your own Appmax account and avoid reusing a key shared with other integrations, so it can be revoked independently.</Warning>

The following configurations are available:

* **API key**: the key copied from the Appmax panel, under Integrations. Required.

* **Orders per page**: how many orders are requested per page during the extraction. The default of 100 suits most accounts — lower it only if Appmax rejects the value.

Once you're done, click **Next**.

### 2. Select streams

Choose which data streams you want to sync. For faster extractions, select only the streams that are relevant to your analysis.

> Tip: The stream can be found more easily by typing its name.

<Note>The buyer's data — name, email, phone and document number — arrives inside each order, in the **customer** field, as a JSON object. Appmax has no endpoint that lists customers on their own, so there is no separate Customers stream.</Note>

Select the streams and click **Next**.

### 3. Configure data streams

Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.

* **Layer**: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
* **Folder**: a folder can be created inside the selected layer to group all tables being created from this new data source.
* **Table name**: we suggest a name, but feel free to customize it. You have the option to add a **prefix** to all tables at once and make this process faster!
* **Sync Type**: the Appmax orders endpoint accepts no date filter, so Orders is replicated as full table — every run reads the complete order history and refreshes the table. Read more about Sync Types [here](https://docs.nekt.com/get-started/core-concepts/types-of-sync).

Once you are done configuring, click **Next**.

### 4. Configure data source

Describe your data source for easy identification within your organization, not exceeding 140 characters.

To define your [Trigger](https://docs.nekt.com/get-started/core-concepts/triggers), consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times).

<Info>Because every run reads the full order history, an account with a large volume of orders takes longer as it grows. Daily extractions are usually enough for sales analysis.</Info>

Optionally, you can define some additional settings:

* Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource [here](https://docs.nekt.com/get-started/core-concepts/resource-control).
* Determine when to execute an **Additional [Full Sync](https://docs.nekt.com/get-started/core-concepts/types-of-sync#additional-full-sync)**.

Once you are ready, click **Next** to finalize the setup.

### 5. Check your new source

You can view your new source on the [Sources](https://app.nekt.ai/sources) page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.

<Warning>For you to be able to see it on your [Catalog](https://app.nekt.ai/catalog), you need at least one successful source run.</Warning>

# Streams and Fields

Below you'll find all available data streams from Appmax and their corresponding fields.

<AccordionGroup>
  <Accordion title="Orders">
    Every order registered in the Appmax account, with its amounts, payment method, current status and the buyer who placed it. Payment-specific fields are filled according to the method used — boleto orders carry the boleto link and dates, Pix orders carry the Pix payload and its expiration.

    Primary key: `id`

    | Field                    | Type     | Description                                                                                                                                                                                                                                                                                           |
    | :----------------------- | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
    | `id`                     | Integer  | Unique identifier of the order in Appmax, used as the primary key.                                                                                                                                                                                                                                    |
    | `customer_id`            | Integer  | Identifier of the customer who placed the order.                                                                                                                                                                                                                                                      |
    | `status`                 | String   | Current status of the order, in Portuguese, as Appmax spells it: 'pendente', 'autorizado', 'aprovado', 'integrado', 'cancelado', 'estornado', 'recusado\_por\_risco', 'pendente\_integracao', 'chargeback\_em\_tratativa', 'chargeback\_em\_disputa', 'chargeback\_perdido' or 'chargeback\_vencido'. |
    | `payment_type`           | String   | Payment method used on the order, as returned by Appmax — for example 'CreditCard', 'Pix' or 'Billet'.                                                                                                                                                                                                |
    | `total`                  | Number   | Total amount of the order in reais, including shipping and installment interest and net of discounts.                                                                                                                                                                                                 |
    | `total_products`         | Number   | Sum of the products in the order, in reais, before discounts and shipping.                                                                                                                                                                                                                            |
    | `discount`               | Number   | Discount applied to the order, in reais.                                                                                                                                                                                                                                                              |
    | `freight_value`          | Number   | Shipping amount charged on the order, in reais.                                                                                                                                                                                                                                                       |
    | `full_payment_amount`    | Number   | Amount effectively charged to the buyer in reais, including installment interest when the order was paid in installments.                                                                                                                                                                             |
    | `company_name`           | String   | Name of the store the order belongs to.                                                                                                                                                                                                                                                               |
    | `issuer_message`         | String   | Message returned by the card issuer or the payment provider, explaining why a payment was declined or is pending.                                                                                                                                                                                     |
    | `billet_url`             | String   | Link to the boleto PDF, for orders paid by boleto.                                                                                                                                                                                                                                                    |
    | `billet_expiration_date` | Datetime | Date the boleto expires, for orders paid by boleto.                                                                                                                                                                                                                                                   |
    | `billet_date_overdue`    | Datetime | Date the boleto went overdue without being paid.                                                                                                                                                                                                                                                      |
    | `pix_code`               | String   | Pix copy-and-paste payload generated for the order.                                                                                                                                                                                                                                                   |
    | `pix_expiration_date`    | Datetime | Moment the Pix charge expires, for orders paid by Pix.                                                                                                                                                                                                                                                |
    | `created_at`             | Datetime | Moment the order was created, converted from Appmax's Brasilia local time to UTC.                                                                                                                                                                                                                     |
    | `updated_at`             | Datetime | Moment the order was last updated — a status change, a payment or a refund — converted from Appmax's Brasilia local time to UTC.                                                                                                                                                                      |
    | `customer`               | String   | Buyer of the order as a JSON object, carrying at least id, firstname, lastname, email, telephone and document number (CPF).                                                                                                                                                                           |
  </Accordion>
</AccordionGroup>
