Skip to main content
Asaas is a payment processing platform focused on billing, recurring subscriptions, and financial operations. This connector extracts customer, payment, transfer, subscription, and financial transaction data from your Asaas account into your Nekt Catalog.

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 /payments with the full payments schema.
    • Disabled (false): extracts from /lean/payments with a reduced payments schema.
After configuring access, click Next.

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 INCREMENTAL and FULL_TABLE.
When you’re done, click Next.

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.
When you are ready, click Next to finalize setup.

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.
To see data in the Catalog, at least one source run must complete successfully.

Streams and Fields

Below are the currently available streams in the Asaas connector and their main fields.
Customer profile and billing identity information from the /customers endpoint.
FieldTypeDescription
objectStringType of object returned by the API.
idStringUnique identifier of the record.
date_createdDateTimeTimestamp when the record was created.
nameStringName of the record.
emailStringEmail address of the customer.
phoneStringLandline phone number of the customer.
mobile_phoneStringMobile phone number of the customer.
addressStringStreet address of the customer.
address_numberStringStreet number of the customer address.
complementStringAdditional address information.
provinceStringDistrict or neighborhood of the customer address.
cityIntegerNumeric identifier of the customer city.
city_nameStringName of the customer city.
stateStringState code of the customer address.
countryStringCountry of the customer address.
postal_codeStringPostal code of the customer address.
cpf_cnpjStringTax document number of the customer.
person_typeStringType classification of the record.
deletedBooleanIndicates whether the record is deleted.
additional_emailsStringAdditional email addresses for the customer.
external_referenceStringExternal reference identifier of the record.
notification_disabledBooleanIndicates whether customer notifications are disabled.
observationsStringInternal notes associated with the customer.
foreign_customerBooleanIndicates whether the customer is foreign.
companyStringCompany name associated with the customer.
municipal_inscriptionStringMunicipal registration number of the customer.
state_inscriptionStringState registration number of the customer.
can_deleteBooleanIndicates whether the customer can be deleted.
cannot_be_deleted_reasonStringReason why the customer cannot be deleted.
can_editBooleanIndicates whether the customer can be edited.
cannot_edit_reasonStringReason why the customer cannot be edited.
Payment records. The stream endpoint and some fields depend on Extract Full Payment Data.Behavior by Configuration:
  • true - Uses /payments (full schema)
  • false - Uses /lean/payments (short schema)
Common Fields (both modes):
FieldTypeDescription
objectStringType of object returned by the API.
idStringUnique identifier of the record.
date_createdDateTimeTimestamp when the record was created.
valueNumberMonetary value associated with the record.
net_valueNumberNet monetary value associated with the payment.
original_valueNumberOriginal monetary value associated with the payment.
interest_valueNumberInterest monetary value associated with the payment.
descriptionStringDescription of the payment.
billing_typeStringBilling method used for the payment.
can_be_paid_after_due_dateBooleanIndicates whether the payment can be paid after the due date.
statusStringCurrent status of the record.
due_dateDateTimeDue date of the payment.
original_due_dateDateTimeOriginal due date of the payment.
payment_dateDateTimeDate when the payment was completed.
installment_numberIntegerInstallment sequence number of the payment.
external_referenceStringExternal reference identifier of the record.
deletedBooleanIndicates whether the record is deleted.
anticipatedBooleanIndicates whether the payment was anticipated.
anticipableBooleanIndicates whether the payment can be anticipated.
transaction_receipt_urlStringURL of the payment transaction receipt.
discountObjectDiscount details applied to the payment.
fineObjectFine details applied to the payment.
interestObjectInterest details applied to the payment.
postal_serviceBooleanIndicates whether postal service is enabled for the payment.
Short Schema (/lean/payments) Additional Fields:
FieldTypeDescription
customer_idStringIdentifier of the associated customer.
subscription_idStringIdentifier of the associated subscription.
installment_idStringIdentifier of the associated installment.
payment_link_idStringIdentifier of the associated payment link.
pix_transaction_idStringIdentifier of the associated PIX transaction.
confirmed_dateDateTimeDate when the payment was confirmed.
customer_payment_dateDateTimeDate when the customer paid the payment.
credit_dateStringDate when the payment amount is credited.
duplicated_payment_idStringIdentifier of the duplicated payment record.
Full Schema (/payments) Additional Fields:
FieldTypeDescription
customerStringIdentifier of the associated customer.
subscriptionStringIdentifier of the associated subscription.
installmentStringIdentifier of the associated installment.
payment_linkStringIdentifier of the associated payment link.
credit_cardObjectCredit card details used for the payment.
pix_transactionStringIdentifier of the associated PIX transaction.
pix_qr_code_idStringIdentifier of the associated PIX QR code.
confirmed_dateDateTimeDate when the payment was confirmed.
client_payment_dateDateTimeDate when the client paid the payment.
invoice_urlStringURL of the payment invoice.
invoice_numberStringInvoice number associated with the payment.
credit_dateDateTimeDate when the payment amount is credited.
estimated_credit_dateDateTimeEstimated date when the payment amount is credited.
last_invoice_viewed_dateDateTimeDate when the invoice was last viewed.
last_bank_slip_viewed_dateDateTimeDate when the bank slip was last viewed.
nosso_numeroStringBank slip identifier assigned by the bank.
bank_slip_urlStringURL of the payment bank slip.
splitObjectSplit details for the payment distribution.
days_after_due_date_to_registration_cancellationIntegerNumber of days after due date to cancel registration.
chargebackObjectChargeback details associated with the payment.
refundsArrayList of refunds associated with the payment.
Recurring subscription contracts from the /subscriptions endpoint.
FieldTypeDescription
objectStringType of object returned by the API.
idStringUnique identifier of the record.
date_createdDateTimeTimestamp when the record was created.
customerStringIdentifier of the associated customer.
payment_linkStringIdentifier of the associated payment link.
billing_typeStringBilling method used for the subscription.
cycleStringRecurrence cycle of the subscription.
valueNumberMonetary value associated with the record.
gross_valueNumberGross monetary value associated with the subscription.
next_due_dateDateTimeNext due date for the subscription payment.
end_dateDateTimeDate when the subscription ends.
descriptionStringDescription of the subscription.
statusStringCurrent status of the record.
fineObjectFine details applied to the subscription.
interestObjectInterest details applied to the subscription.
splitObjectSplit details for the subscription distribution.
credit_cardObjectCredit card details used for the subscription.
discountObjectDiscount details applied to the subscription.
deletedBooleanIndicates whether the record is deleted.
max_paymentsIntegerMaximum number of payments for the subscription.
external_referenceStringExternal reference identifier of the record.
send_payment_by_postal_serviceStringIndicates whether payment is sent by postal service.
Financial account movement records from /financialTransactions.
FieldTypeDescription
objectStringType of object returned by the API.
idStringUnique identifier of the record.
valueNumberMonetary value associated with the record.
balanceNumberCurrent account balance after the transaction.
typeStringType classification of the record.
dateDateTimeDate of the financial transaction.
descriptionStringDescription of the financial transaction.
payment_idStringIdentifier of the associated payment.
split_idStringIdentifier of the associated split.
transfer_idStringIdentifier of the associated transfer.
anticipation_idStringIdentifier of the associated anticipation.
bill_idStringIdentifier of the associated bill.
invoice_idStringIdentifier of the associated invoice.
payment_dunning_idStringIdentifier of the associated payment dunning process.
pix_transaction_idStringIdentifier of the associated PIX transaction.
credit_bureau_report_idStringIdentifier of the associated credit bureau report.
Transfer operations and settlement details from the /transfers endpoint.
FieldTypeDescription
idStringUnique transfer identifier
typeStringTransfer type
statusStringTransfer status
valueNumberTransfer value
net_valueNumberNet transfer value
transfer_feeNumberTransfer fee
date_createdDateTimeTimestamp when the record was created
schedule_dateDateTimeScheduled date
effective_dateDateTimeEffective date
authorizedBooleanWhether the transfer is authorized
fail_reasonStringReason for failure
external_referenceStringExternal reference identifier
transaction_receipt_urlStringTransaction receipt URL
operation_typeStringOperation type
descriptionStringDescription
recurringBooleanWhether the transfer is recurring
end_to_end_identifierStringEnd to end identifier
bank_accountObjectBank account information

Implementation Notes

Data Freshness and Sync

  • transactions uses date as replication key and is fetched in monthly windows. Missing starting timestamps gracefully fallback to the configured start_date.
  • Other streams are available for standard source sync configuration and can be run as INCREMENTAL or FULL_TABLE in 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.