
Configuring Asaas as a Source
In the Sources tab, click the “Add source” button in the top-right corner, then select Asaas from the list of connectors. Click Next and add your access details.1. Add account access
The following configuration fields are available:- Access Token: Token used to authenticate against the Asaas API. For details, check Asaas authentication documentation.
- Start Date: The earliest record date to sync.
- Extract Full Payment Data: Controls which payments endpoint is used:
- Enabled (
true): extracts from/paymentswith the full payments schema. - Disabled (
false): extracts from/lean/paymentswith a reduced payments schema.
- Enabled (
2. Select streams
Choose which streams you want to sync. For faster extractions, select only the streams you need.Tip: You can search streams by name.Select the streams and click Next.
3. Configure data streams
Customize how data should appear in your Catalog, including layer, table naming, and sync type.- Layer: Select the destination layer where extracted tables will be created.
- Table name: Use the suggested name or customize it. You can also apply a prefix to all tables.
- Sync Type: Choose between
INCREMENTALandFULL_TABLE.
4. Configure data source
Add a clear description for this source so your team can identify it easily. To define your Trigger, choose how often data should be extracted (for example, daily, weekly, or at fixed times). Optionally, configure additional settings:- Delta Log Retention, which controls how long old table states are kept. Learn more here.
- Additional Full Sync, to periodically complement incremental runs with a complete refresh.
5. Check your new source
You can view your new source on the Sources page. If needed, trigger a run manually from the source actions.Streams and Fields
Below are the currently available streams in the Asaas connector and their main fields.Customers
Customers
Customer profile and billing identity information from the
/customers endpoint.| Field | Type | Description |
|---|---|---|
object | String | Type of object returned by the API. |
id | String | Unique identifier of the record. |
date_created | DateTime | Timestamp when the record was created. |
name | String | Name of the record. |
email | String | Email address of the customer. |
phone | String | Landline phone number of the customer. |
mobile_phone | String | Mobile phone number of the customer. |
address | String | Street address of the customer. |
address_number | String | Street number of the customer address. |
complement | String | Additional address information. |
province | String | District or neighborhood of the customer address. |
city | Integer | Numeric identifier of the customer city. |
city_name | String | Name of the customer city. |
state | String | State code of the customer address. |
country | String | Country of the customer address. |
postal_code | String | Postal code of the customer address. |
cpf_cnpj | String | Tax document number of the customer. |
person_type | String | Type classification of the record. |
deleted | Boolean | Indicates whether the record is deleted. |
additional_emails | String | Additional email addresses for the customer. |
external_reference | String | External reference identifier of the record. |
notification_disabled | Boolean | Indicates whether customer notifications are disabled. |
observations | String | Internal notes associated with the customer. |
foreign_customer | Boolean | Indicates whether the customer is foreign. |
company | String | Company name associated with the customer. |
municipal_inscription | String | Municipal registration number of the customer. |
state_inscription | String | State registration number of the customer. |
can_delete | Boolean | Indicates whether the customer can be deleted. |
cannot_be_deleted_reason | String | Reason why the customer cannot be deleted. |
can_edit | Boolean | Indicates whether the customer can be edited. |
cannot_edit_reason | String | Reason why the customer cannot be edited. |
Payments
Payments
Payment records. The stream endpoint and some fields depend on Extract Full Payment Data.Behavior by Configuration:
Short Schema (
Full Schema (
true- Uses/payments(full schema)false- Uses/lean/payments(short schema)
| Field | Type | Description |
|---|---|---|
object | String | Type of object returned by the API. |
id | String | Unique identifier of the record. |
date_created | DateTime | Timestamp when the record was created. |
value | Number | Monetary value associated with the record. |
net_value | Number | Net monetary value associated with the payment. |
original_value | Number | Original monetary value associated with the payment. |
interest_value | Number | Interest monetary value associated with the payment. |
description | String | Description of the payment. |
billing_type | String | Billing method used for the payment. |
can_be_paid_after_due_date | Boolean | Indicates whether the payment can be paid after the due date. |
status | String | Current status of the record. |
due_date | DateTime | Due date of the payment. |
original_due_date | DateTime | Original due date of the payment. |
payment_date | DateTime | Date when the payment was completed. |
installment_number | Integer | Installment sequence number of the payment. |
external_reference | String | External reference identifier of the record. |
deleted | Boolean | Indicates whether the record is deleted. |
anticipated | Boolean | Indicates whether the payment was anticipated. |
anticipable | Boolean | Indicates whether the payment can be anticipated. |
transaction_receipt_url | String | URL of the payment transaction receipt. |
discount | Object | Discount details applied to the payment. |
fine | Object | Fine details applied to the payment. |
interest | Object | Interest details applied to the payment. |
postal_service | Boolean | Indicates whether postal service is enabled for the payment. |
/lean/payments) Additional Fields:| Field | Type | Description |
|---|---|---|
customer_id | String | Identifier of the associated customer. |
subscription_id | String | Identifier of the associated subscription. |
installment_id | String | Identifier of the associated installment. |
payment_link_id | String | Identifier of the associated payment link. |
pix_transaction_id | String | Identifier of the associated PIX transaction. |
confirmed_date | DateTime | Date when the payment was confirmed. |
customer_payment_date | DateTime | Date when the customer paid the payment. |
credit_date | String | Date when the payment amount is credited. |
duplicated_payment_id | String | Identifier of the duplicated payment record. |
/payments) Additional Fields:| Field | Type | Description |
|---|---|---|
customer | String | Identifier of the associated customer. |
subscription | String | Identifier of the associated subscription. |
installment | String | Identifier of the associated installment. |
payment_link | String | Identifier of the associated payment link. |
credit_card | Object | Credit card details used for the payment. |
pix_transaction | String | Identifier of the associated PIX transaction. |
pix_qr_code_id | String | Identifier of the associated PIX QR code. |
confirmed_date | DateTime | Date when the payment was confirmed. |
client_payment_date | DateTime | Date when the client paid the payment. |
invoice_url | String | URL of the payment invoice. |
invoice_number | String | Invoice number associated with the payment. |
credit_date | DateTime | Date when the payment amount is credited. |
estimated_credit_date | DateTime | Estimated date when the payment amount is credited. |
last_invoice_viewed_date | DateTime | Date when the invoice was last viewed. |
last_bank_slip_viewed_date | DateTime | Date when the bank slip was last viewed. |
nosso_numero | String | Bank slip identifier assigned by the bank. |
bank_slip_url | String | URL of the payment bank slip. |
split | Object | Split details for the payment distribution. |
days_after_due_date_to_registration_cancellation | Integer | Number of days after due date to cancel registration. |
chargeback | Object | Chargeback details associated with the payment. |
refunds | Array | List of refunds associated with the payment. |
Subscriptions
Subscriptions
Recurring subscription contracts from the
/subscriptions endpoint.| Field | Type | Description |
|---|---|---|
object | String | Type of object returned by the API. |
id | String | Unique identifier of the record. |
date_created | DateTime | Timestamp when the record was created. |
customer | String | Identifier of the associated customer. |
payment_link | String | Identifier of the associated payment link. |
billing_type | String | Billing method used for the subscription. |
cycle | String | Recurrence cycle of the subscription. |
value | Number | Monetary value associated with the record. |
gross_value | Number | Gross monetary value associated with the subscription. |
next_due_date | DateTime | Next due date for the subscription payment. |
end_date | DateTime | Date when the subscription ends. |
description | String | Description of the subscription. |
status | String | Current status of the record. |
fine | Object | Fine details applied to the subscription. |
interest | Object | Interest details applied to the subscription. |
split | Object | Split details for the subscription distribution. |
credit_card | Object | Credit card details used for the subscription. |
discount | Object | Discount details applied to the subscription. |
deleted | Boolean | Indicates whether the record is deleted. |
max_payments | Integer | Maximum number of payments for the subscription. |
external_reference | String | External reference identifier of the record. |
send_payment_by_postal_service | String | Indicates whether payment is sent by postal service. |
Transactions
Transactions
Financial account movement records from
/financialTransactions.| Field | Type | Description |
|---|---|---|
object | String | Type of object returned by the API. |
id | String | Unique identifier of the record. |
value | Number | Monetary value associated with the record. |
balance | Number | Current account balance after the transaction. |
type | String | Type classification of the record. |
date | DateTime | Date of the financial transaction. |
description | String | Description of the financial transaction. |
payment_id | String | Identifier of the associated payment. |
split_id | String | Identifier of the associated split. |
transfer_id | String | Identifier of the associated transfer. |
anticipation_id | String | Identifier of the associated anticipation. |
bill_id | String | Identifier of the associated bill. |
invoice_id | String | Identifier of the associated invoice. |
payment_dunning_id | String | Identifier of the associated payment dunning process. |
pix_transaction_id | String | Identifier of the associated PIX transaction. |
credit_bureau_report_id | String | Identifier of the associated credit bureau report. |
Transfers
Transfers
Transfer operations and settlement details from the
/transfers endpoint.| Field | Type | Description |
|---|---|---|
id | String | Unique transfer identifier |
type | String | Transfer type |
status | String | Transfer status |
value | Number | Transfer value |
net_value | Number | Net transfer value |
transfer_fee | Number | Transfer fee |
date_created | DateTime | Timestamp when the record was created |
schedule_date | DateTime | Scheduled date |
effective_date | DateTime | Effective date |
authorized | Boolean | Whether the transfer is authorized |
fail_reason | String | Reason for failure |
external_reference | String | External reference identifier |
transaction_receipt_url | String | Transaction receipt URL |
operation_type | String | Operation type |
description | String | Description |
recurring | Boolean | Whether the transfer is recurring |
end_to_end_identifier | String | End to end identifier |
bank_account | Object | Bank account information |
Implementation Notes
Data Freshness and Sync
transactionsusesdateas replication key and is fetched in monthly windows. Missing starting timestamps gracefully fallback to the configuredstart_date.- Other streams are available for standard source sync configuration and can be run as
INCREMENTALorFULL_TABLEin Nekt.
Payments Schema Selection
- Enable Extract Full Payment Data for the complete payments payload (
/payments). - Disable it for a lighter and faster extraction using
/lean/payments.
Skills for agents
Download Asaas skills file
Asaas connector documentation as plain markdown, for use in AI agent contexts.