Gestão Click is a Brazilian cloud ERP for small and mid-sized businesses. It covers sales, quotes and service orders, product and service catalogs, inventory, purchasing, Brazilian fiscal documents (NF-e, NFC-e and NFS-e), and the accounts payable and receivable ledger.

Configuring Gestão Click as a Source

In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Gestão Click option from the list of connectors. Click Next and you’ll be prompted to add your access.

1. Add account access

You’ll need an Access Token and a Secret Access Token, generated inside Gestão Click.

Open the API integration screen

In Gestão Click, go to Configurações > Integração API.

Generate the token pair

Generate the tokens and copy both values. They are shown together on the same screen.

Paste them into Nekt

Fill in the two fields below with the values you copied.

Clicking Gerar token novamente in Gestão Click issues a new pair and invalidates the previous one. If you regenerate the tokens, update them here as well or the extraction will start failing with an authentication error.

The following configurations are available:

Access Token: The Access Token generated under Configurações > Integração API.
Secret Access Token: The Secret Access Token issued alongside the Access Token on the same screen.
Start Date: The earliest document date from which records will be synced. This applies to quotes, sales, service orders, invoices, payables and receivables. Registrations and reference tables (customers, products, cities and so on) are always synced in full, regardless of this setting.
Lookback Days: (Default: 30 days) How many days before the last synced date to re-read on each run. Gestão Click can only filter records by their own document date, so this overlap window is what allows a document to be picked up again after it is edited. Increase it if documents in your operation are commonly revised more than 30 days after being issued.
Requests Per Second: (Default: 3) The maximum request rate. Gestão Click allows 3 requests per second per company. Lower this only if other integrations share the same token pair.

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. You can select entire groups of streams or pick specific ones.

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

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: you can choose between INCREMENTAL and FULL_TABLE.
- Incremental: every time the extraction happens, we’ll get only the new data - which is good if, for example, you want to keep every record ever fetched.
- Full table: every time the extraction happens, we’ll get the current state of the data - which is good if, for example, you don’t want to have deleted data in your catalog.

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, 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). 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.
Determine when to execute an Additional Full Sync. This will complement the incremental data extractions, ensuring that your data is completely synchronized with your source every once in a while.

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

5. Check your new source

You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.

For you to be able to see it on your Catalog, you need at least one successful source run.

How data is synced

Gestão Click’s API can only filter records by their own document date. It offers no “modified since” filter, which shapes how each stream is synced:

Quotes, sales, service orders and the three invoice streams sync incrementally from the document’s issue date, re-reading the last Lookback Days so that documents edited after being issued are picked up again.
Payments and receipts are synced in full on every run. Their dates are due and settlement dates, which do not move forward with time: an instalment can be due two years from now, and an overdue one can be years in the past. Reading the full ledger each run is what guarantees that overdue open entries are never missed.
Registrations and reference tables are synced in full on every run. They are small, and the API’s date filter on these endpoints matches the record’s creation date, which would permanently hide long-standing customers or products that are still in use.

Because payments, receipts and the registration streams are read in full, choosing INCREMENTAL as the sync type for them will still append the complete current state on each run. Full table is usually the more useful choice for these.

Nested fields

Fields that hold a list or a structure are delivered as JSON strings, not as nested columns. This applies to document line items (produtos, servicos), addresses (enderecos), contacts (contatos), instalments (pagamentos), attachments (anexos), product variations (variacoes) and custom field values (atributos). Query them with SQL JSON functions. Note that Gestão Click wraps each item in a single-key object, so the line items of a sale look like [{"produto": {...}}, {"produto": {...}}]:

select
    id,
    codigo,
    json_value(item, '$.produto.nome_produto') as produto,
    json_value(item, '$.produto.quantidade') as quantidade,
    json_value(item, '$.produto.valor_venda') as valor_unitario
from sales, unnest(json_query_array(produtos, '$')) as item

Rate limits

Gestão Click allows 3 requests per second and 30,000 requests per day, counted per company rather than per integration. The connector stays within the per-second limit automatically and retries with backoff if the API throttles it. Every request returns at most 100 records, so the daily limit translates to roughly 3 million records per day. If you run several integrations against the same token pair, lower Requests Per Second so they share the budget.

Streams and Fields

Available streams

The table below lists every stream, its slug (the exact identifier to pass when creating the source via API), how it replicates, and a short description.

Stream	Slug	Sync	Description
Customers	`customers`	Full table	People and companies you sell to, with their addresses, contacts and custom fields.
Suppliers	`suppliers`	Full table	People and companies you buy from, with their addresses, contacts and custom fields.
Carriers	`carriers`	Full table	Freight carriers used on sales and purchases.
Employees	`employees`	Full table	Staff records, including the commission rate used on sales.
Users	`users`	Full table	ERP user accounts.
Stores	`stores`	Full table	Stores (units) registered in the account.
Products	`products`	Full table	Products for sale, with cost and selling prices, stock on hand, tax classification and variations.
Product Groups	`product_groups`	Full table	The product category hierarchy.
Services	`services`	Full table	Services offered for sale.
Quotes	`quotes`	Incremental	Quotes (orçamentos) issued to customers, with their line items and payment terms.
Sales	`sales`	Incremental	Sales (vendas), covering product sales, service sales and counter sales.
Service Orders	`service_orders`	Incremental	Service orders (ordens de serviço), including the customer equipment attached to them.
Purchases	`purchases`	Full table	Purchase orders placed with suppliers.
Product Invoices	`product_invoices`	Incremental	NF-e (model 55) product invoices, with issuer, recipient, tax totals and line items.
Consumer Invoices	`consumer_invoices`	Incremental	NFC-e (model 65) consumer invoices, same shape as NF-e.
Service Invoices	`service_invoices`	Incremental	NFS-e service invoices, with ISS tax base and withholding details.
Payments	`payments`	Full table	Accounts payable: every payable entry, open and settled.
Receipts	`receipts`	Full table	Accounts receivable: every receivable entry, open and settled.
Payment Methods	`payment_methods`	Full table	Payment methods, including bank slip and card acquirer configuration.
Bank Accounts	`bank_accounts`	Full table	Bank accounts entries are settled into.
Chart of Accounts	`chart_of_accounts`	Full table	The chart of accounts hierarchy.
Cost Centers	`cost_centers`	Full table	Cost centres used to classify documents and ledger entries.
Quote Statuses	`quote_statuses`	Full table	Status values quotes can take.
Sale Statuses	`sale_statuses`	Full table	Status values sales can take, and whether each one posts to finance and inventory.
Service Order Statuses	`service_order_statuses`	Full table	Status values service orders can take.
Purchase Statuses	`purchase_statuses`	Full table	Status values purchases can take.
Registration Custom Fields	`registration_custom_fields`	Full table	Definitions of the user-defined fields on customers, suppliers and carriers.
Product Custom Fields	`product_custom_fields`	Full table	Definitions of the user-defined fields on products.
Quote Custom Fields	`quote_custom_fields`	Full table	Definitions of the user-defined fields on quotes.
Sale Custom Fields	`sale_custom_fields`	Full table	Definitions of the user-defined fields on sales.
Service Order Custom Fields	`service_order_custom_fields`	Full table	Definitions of the user-defined fields on service orders.
Financial Custom Fields	`financial_custom_fields`	Full table	Definitions of the user-defined fields on payable and receivable entries.
Contact Types	`contact_types`	Full table	Contact type labels used inside registration contact lists.
Address Types	`address_types`	Full table	Address type labels used inside registration address lists.
States	`states`	Full table	Brazilian states, the IBGE reference table.
Cities	`cities`	Full table	Brazilian municipalities, the IBGE reference table.

Stream details

Customers

People and companies you sell to, with their addresses, contacts and custom fields.Primary key: id
Replication: full tableFields (27):

id - Unique identifier of the customer
tipo_pessoa - Entity type: PF for an individual, PJ for a company, ES for a foreign entity
nome - Display name of the customer (trade name for companies)
razao_social - Registered legal name, for companies
cnpj - Brazilian company tax ID (CNPJ), formatted
inscricao_estadual - State tax registration number
inscricao_municipal - Municipal tax registration number
tipo_contribuinte - ICMS taxpayer classification
responsavel - Name of the person responsible for the account
cpf - Brazilian individual tax ID (CPF), formatted
rg - Brazilian national ID document number
data_nascimento - Date of birth (individuals) or incorporation date (companies), as YYYY-MM-DD
sexo - Gender recorded for an individual customer
loja_virtual_ativo - Whether the customer has online-store access enabled: 1 for yes, 0 for no
email_acesso - Email the customer uses to sign in to the online store
telefone - Landline phone number
celular - Mobile phone number
fax - Fax number
email - Primary email address
ativo - Whether the customer record is active: 1 for active, 0 for inactive
vendedor_id - Identifier of the salesperson assigned to this customer
nome_vendedor - Name of the salesperson assigned to this customer
cadastrado_em - Timestamp the customer was created, as YYYY-MM-DD HH:MM:SS
modificado_em - Timestamp of the last change to the customer, as YYYY-MM-DD HH:MM:SS
contatos - Additional contact people for this record, as a JSON array of objects (each wrapped in a ‘contato’ key) holding the contact’s name, role, phone and email
enderecos - Registered addresses, as a JSON array of objects (each wrapped in an ‘endereco’ key) holding street, number, complement, district, postal code, city and state
atributos - Values of the account’s user-defined registration fields, as a JSON array of objects (each wrapped in an ‘atributo’ key); the field definitions are in the registration_custom_fields stream

Suppliers

People and companies you buy from, with their addresses, contacts and custom fields.Primary key: id
Replication: full tableFields (20):

id - Unique identifier of the supplier
tipo_pessoa - Entity type: PF for an individual, PJ for a company, ES for a foreign entity
nome - Display name of the supplier (trade name for companies)
razao_social - Registered legal name, for companies
cnpj - Brazilian company tax ID (CNPJ), formatted
inscricao_estadual - State tax registration number
inscricao_municipal - Municipal tax registration number
tipo_contribuinte - ICMS taxpayer classification
cpf - Brazilian individual tax ID (CPF), formatted
rg - Brazilian national ID document number
data_nascimento - Date of birth (individuals) or incorporation date (companies), as YYYY-MM-DD
telefone - Landline phone number
celular - Mobile phone number
email - Primary email address
ativo - Whether the supplier record is active: 1 for active, 0 for inactive
cadastrado_em - Timestamp the supplier was created, as YYYY-MM-DD HH:MM:SS
modificado_em - Timestamp of the last change to the supplier, as YYYY-MM-DD HH:MM:SS
contatos - Additional contact people for this record, as a JSON array of objects (each wrapped in a ‘contato’ key) holding the contact’s name, role, phone and email
enderecos - Registered addresses, as a JSON array of objects (each wrapped in an ‘endereco’ key) holding street, number, complement, district, postal code, city and state
atributos - Values of the account’s user-defined registration fields, as a JSON array of objects (each wrapped in an ‘atributo’ key); the field definitions are in the registration_custom_fields stream

Carriers

Freight carriers used on sales and purchases.Primary key: id
Replication: full tableFields (19):

id - Unique identifier of the carrier
tipo_pessoa - Entity type: PF for an individual, PJ for a company, ES for a foreign entity
nome - Display name of the carrier (trade name for companies)
razao_social - Registered legal name, for companies
cnpj - Brazilian company tax ID (CNPJ), formatted
inscricao_estadual - State tax registration number
inscricao_municipal - Municipal tax registration number
cpf - Brazilian individual tax ID (CPF), formatted
rg - Brazilian national ID document number
data_nascimento - Date of birth (individuals) or incorporation date (companies), as YYYY-MM-DD
telefone - Landline phone number
celular - Mobile phone number
email - Primary email address
observacoes - Free-text notes about the carrier
ativo - Whether the carrier record is active: 1 for active, 0 for inactive
cadastrado_em - Timestamp the carrier was created, as YYYY-MM-DD HH:MM:SS
modificado_em - Timestamp of the last change to the carrier, as YYYY-MM-DD HH:MM:SS
contatos - Additional contact people for this record, as a JSON array of objects (each wrapped in a ‘contato’ key) holding the contact’s name, role, phone and email
enderecos - Registered addresses, as a JSON array of objects (each wrapped in an ‘endereco’ key) holding street, number, complement, district, postal code, city and state

Employees

Staff records, including the commission rate used on sales.Primary key: id
Replication: full tableFields (19):

id - Unique identifier of the employee
nome - Full name of the employee
email_secundario - Secondary email address
cpf - Brazilian individual tax ID (CPF), formatted
rg - Brazilian national ID document number
data_nascimento - Date of birth, as YYYY-MM-DD
sexo - Gender recorded for the employee
telefone - Phone number
cep - Postal code (CEP) of the employee’s address
logradouro - Street name of the employee’s address
numero - Street number of the employee’s address
complemento - Address complement, such as apartment or suite
bairro - District or neighbourhood of the employee’s address
cidade_id - Identifier of the city, joinable to the cities stream
nome_cidade - Name of the city
estado - Two-letter Brazilian state abbreviation
comissao - Commission percentage earned by the employee on sales
ativo - Whether the employee record is active: 1 for active, 0 for inactive
atributos - Values of the account’s user-defined registration fields, as a JSON array of objects (each wrapped in an ‘atributo’ key); the field definitions are in the registration_custom_fields stream

Users

ERP user accounts.Primary key: id
Replication: full tableFields (17):

id - Unique identifier of the ERP user
nome - Full name of the user
cpf - Brazilian individual tax ID (CPF), formatted
rg - Brazilian national ID document number
data_nascimento - Date of birth, as YYYY-MM-DD
sexo - Gender recorded for the user
grupo_id - Identifier of the permission group the user belongs to
email - Email address used to sign in to the ERP
observacoes - Free-text notes about the user
telefone - Landline phone number
celular1 - Primary mobile phone number
celular2 - Secondary mobile phone number
hora_entrada - Scheduled start of the working day, as HH:MM:SS
hora_almoco_entrada - Scheduled start of the lunch break, as HH:MM:SS
hora_almoco_saida - Scheduled end of the lunch break, as HH:MM:SS
hora_saida - Scheduled end of the working day, as HH:MM:SS
ativo - Whether the user account is active: 1 for active, 0 for inactive

Stores

Stores (units) registered in the account.Primary key: id
Replication: full tableFields (2):

id - Unique identifier of the store
nome - Name of the store, for example Matriz for the head office

Products

Products for sale, with cost and selling prices, stock on hand, tax classification and variations.Primary key: id
Replication: full tableFields (25):

id - Unique identifier of the product
nome - Name of the product
codigo_interno - Internal SKU or reference code assigned by the company
codigo_barra - Barcode (EAN/GTIN) of the product
possui_variacao - Whether the product has variations such as size or colour: 1 for yes, 0 for no
possui_composicao - Whether the product is assembled from other products: 1 for yes, 0 for no
movimenta_estoque - Whether sales and purchases of this product move inventory: 1 for yes, 0 for no
peso - Weight of the product, in kilograms
largura - Width of the product, in centimetres
altura - Height of the product, in centimetres
comprimento - Length of the product, in centimetres
ativo - Whether the product is active: 1 for active, 0 for inactive
grupo_id - Identifier of the product group, joinable to the product_groups stream
nome_grupo - Name of the product group
descricao - Long description of the product
estoque - Current inventory quantity on hand
valor_custo - Cost price of the product
valor_venda - Default selling price of the product
cadastrado_em - Timestamp the product was created, as YYYY-MM-DD HH:MM:SS
modificado_em - Timestamp of the last change to the product, as YYYY-MM-DD HH:MM:SS
valores - Price tiers for the product, as a JSON array of objects holding the price-type identifier and name, the markup applied, and the resulting cost and selling prices
variacoes - Product variations, as a JSON array of objects (each wrapped in a ‘variacao’ key) holding the variation’s own code, attributes, prices and stock
fiscal - Tax classification of the product, as a JSON object holding the NCM and CEST codes, net and gross weight, and the approximate tax amount
fotos - Product images, as a JSON array of objects holding the image URLs
atributos - Values of the account’s user-defined product fields, as a JSON array of objects; the field definitions are in the product_custom_fields stream

Product Groups

The product category hierarchy.Primary key: id
Replication: full tableFields (6):

id - Unique identifier of the product group
grupo_pai_id - Identifier of the parent group, empty for a top-level group
nome - Name of the product group
url - URL slug used for the group in the online store
meta_palavras_chaves - Meta keywords used for the group in the online store
meta_descricao - Meta description used for the group in the online store

Services

Services offered for sale.Primary key: id
Replication: full tableFields (5):

id - Unique identifier of the service
codigo - Reference code assigned to the service
nome - Name of the service
valor_venda - Default selling price of the service
observacoes - Free-text notes about the service

Quotes

Quotes (orçamentos) issued to customers, with their line items and payment terms.Primary key: id
Replication: incremental on dataFields (52):

id - Unique identifier of the quote
codigo - Sequential number shown to users for this quote
cliente_id - Identifier of the customer, joinable to the customers stream
nome_cliente - Name of the customer
vendedor_id - Identifier of the salesperson, joinable to the employees stream
nome_vendedor - Name of the salesperson
tecnico_id - Identifier of the assigned technician, joinable to the employees stream
nome_tecnico - Name of the assigned technician
situacao_id - Identifier of the quote status, joinable to the matching status stream
nome_situacao - Name of the quote status, for example Em aberto or Finalizado
cor_situacao - Hex colour the ERP uses to display the status
valor_total - Total value of the quote, after discounts and freight
valor_produtos - Subtotal of the product line items
valor_servicos - Subtotal of the service line items
valor_custo - Total cost of the line items, used to derive margin
valor_frete - Freight amount charged
desconto_valor - Discount applied as an absolute amount
desconto_porcentagem - Discount applied as a percentage
transportadora_id - Identifier of the freight carrier, joinable to the carriers stream
nome_transportadora - Name of the freight carrier
centro_custo_id - Identifier of the cost centre, joinable to the cost_centers stream
nome_centro_custo - Name of the cost centre
nome_canal_venda - Name of the sales channel the document came through
nome_loja - Name of the store that owns the document
aos_cuidados_de - Attention-to name the document is addressed to
validade - Number of days the document remains valid
introducao - Introductory text printed at the top of the document
observacoes - Notes visible to the customer
observacoes_interna - Internal notes, not shown to the customer
condicao_pagamento - Payment terms agreed for the document
forma_pagamento_id - Identifier of the payment method, joinable to the payment_methods stream
nome_forma_pagamento - Name of the payment method
data_primeira_parcela - Due date of the first instalment, as YYYY-MM-DD
numero_parcelas - Number of instalments the payment was split into
intervalo_dias - Number of days between instalments
situacao_financeiro - Whether the document has been posted to the financial ledger
situacao_estoque - Whether the document has moved inventory
nota_fiscal_id - Identifier of the product invoice issued for this document, joinable to the product_invoices stream
nota_fiscal_servico_id - Identifier of the service invoice issued for this document, joinable to the service_invoices stream
exibir_endereco - Whether the customer address is printed on the document: 1 for yes, 0 for no
hash - Opaque token used to build the document’s public share link
cadastrado_em - Timestamp the quote was created, as YYYY-MM-DD HH:MM:SS
modificado_em - Timestamp of the last change to the quote, as YYYY-MM-DD HH:MM:SS
produtos - Product line items, as a JSON array of objects (each wrapped in a ‘produto’ key) holding the product identifier, name, quantity, unit price and total
servicos - Service line items, as a JSON array of objects (each wrapped in a ‘servico’ key) holding the service identifier, name, quantity, unit price and total
equipamentos - Customer equipment attached to the document, as a JSON array of objects (each wrapped in an ‘equipamento’ key) holding the equipment description, brand, model and serial number
pagamentos - Instalments generated for the document, as a JSON array of objects (each wrapped in a ‘pagamento’ key) holding the due date, amount and payment method
enderecos - Delivery and billing addresses for the document, as a JSON array of objects (each wrapped in an ‘endereco’ key)
atributos - Values of the account’s user-defined fields for this document, as a JSON array of objects (each wrapped in an ‘atributo’ key)
anexos - Files attached to the document, as a JSON array of objects (each wrapped in an ‘anexo’ key) holding the file name and URL
data - Date the quote was issued, as YYYY-MM-DD; this is the field the API’s data_inicio filter matches and the incremental replication key
previsao_entrega - Expected delivery date, as YYYY-MM-DD

Sales

Sales (vendas), covering product sales, service sales and counter sales.Primary key: id
Replication: incremental on dataFields (52):

id - Unique identifier of the sale
codigo - Sequential number shown to users for this sale
cliente_id - Identifier of the customer, joinable to the customers stream
nome_cliente - Name of the customer
vendedor_id - Identifier of the salesperson, joinable to the employees stream
nome_vendedor - Name of the salesperson
tecnico_id - Identifier of the assigned technician, joinable to the employees stream
nome_tecnico - Name of the assigned technician
situacao_id - Identifier of the sale status, joinable to the matching status stream
nome_situacao - Name of the sale status, for example Em aberto or Finalizado
cor_situacao - Hex colour the ERP uses to display the status
valor_total - Total value of the sale, after discounts and freight
valor_produtos - Subtotal of the product line items
valor_servicos - Subtotal of the service line items
valor_custo - Total cost of the line items, used to derive margin
valor_frete - Freight amount charged
desconto_valor - Discount applied as an absolute amount
desconto_porcentagem - Discount applied as a percentage
transportadora_id - Identifier of the freight carrier, joinable to the carriers stream
nome_transportadora - Name of the freight carrier
centro_custo_id - Identifier of the cost centre, joinable to the cost_centers stream
nome_centro_custo - Name of the cost centre
nome_canal_venda - Name of the sales channel the document came through
nome_loja - Name of the store that owns the document
aos_cuidados_de - Attention-to name the document is addressed to
validade - Number of days the document remains valid
introducao - Introductory text printed at the top of the document
observacoes - Notes visible to the customer
observacoes_interna - Internal notes, not shown to the customer
condicao_pagamento - Payment terms agreed for the document
forma_pagamento_id - Identifier of the payment method, joinable to the payment_methods stream
nome_forma_pagamento - Name of the payment method
data_primeira_parcela - Due date of the first instalment, as YYYY-MM-DD
numero_parcelas - Number of instalments the payment was split into
intervalo_dias - Number of days between instalments
situacao_financeiro - Whether the document has been posted to the financial ledger
situacao_estoque - Whether the document has moved inventory
nota_fiscal_id - Identifier of the product invoice issued for this document, joinable to the product_invoices stream
nota_fiscal_servico_id - Identifier of the service invoice issued for this document, joinable to the service_invoices stream
exibir_endereco - Whether the customer address is printed on the document: 1 for yes, 0 for no
hash - Opaque token used to build the document’s public share link
cadastrado_em - Timestamp the sale was created, as YYYY-MM-DD HH:MM:SS
modificado_em - Timestamp of the last change to the sale, as YYYY-MM-DD HH:MM:SS
produtos - Product line items, as a JSON array of objects (each wrapped in a ‘produto’ key) holding the product identifier, name, quantity, unit price and total
servicos - Service line items, as a JSON array of objects (each wrapped in a ‘servico’ key) holding the service identifier, name, quantity, unit price and total
equipamentos - Customer equipment attached to the document, as a JSON array of objects (each wrapped in an ‘equipamento’ key) holding the equipment description, brand, model and serial number
pagamentos - Instalments generated for the document, as a JSON array of objects (each wrapped in a ‘pagamento’ key) holding the due date, amount and payment method
enderecos - Delivery and billing addresses for the document, as a JSON array of objects (each wrapped in an ‘endereco’ key)
atributos - Values of the account’s user-defined fields for this document, as a JSON array of objects (each wrapped in an ‘atributo’ key)
anexos - Files attached to the document, as a JSON array of objects (each wrapped in an ‘anexo’ key) holding the file name and URL
data - Date the sale was issued, as YYYY-MM-DD; this is the field the API’s data_inicio filter matches and the incremental replication key
prazo_entrega - Agreed delivery deadline, as YYYY-MM-DD

Service Orders

Service orders (ordens de serviço), including the customer equipment attached to them.Primary key: id
Replication: incremental on data_entradaFields (52):

id - Unique identifier of the service order
codigo - Sequential number shown to users for this service order
cliente_id - Identifier of the customer, joinable to the customers stream
nome_cliente - Name of the customer
vendedor_id - Identifier of the salesperson, joinable to the employees stream
nome_vendedor - Name of the salesperson
tecnico_id - Identifier of the assigned technician, joinable to the employees stream
nome_tecnico - Name of the assigned technician
situacao_id - Identifier of the service order status, joinable to the matching status stream
nome_situacao - Name of the service order status, for example Em aberto or Finalizado
cor_situacao - Hex colour the ERP uses to display the status
valor_total - Total value of the service order, after discounts and freight
valor_produtos - Subtotal of the product line items
valor_servicos - Subtotal of the service line items
valor_custo - Total cost of the line items, used to derive margin
valor_frete - Freight amount charged
desconto_valor - Discount applied as an absolute amount
desconto_porcentagem - Discount applied as a percentage
transportadora_id - Identifier of the freight carrier, joinable to the carriers stream
nome_transportadora - Name of the freight carrier
centro_custo_id - Identifier of the cost centre, joinable to the cost_centers stream
nome_centro_custo - Name of the cost centre
nome_canal_venda - Name of the sales channel the document came through
nome_loja - Name of the store that owns the document
aos_cuidados_de - Attention-to name the document is addressed to
validade - Number of days the document remains valid
introducao - Introductory text printed at the top of the document
observacoes - Notes visible to the customer
observacoes_interna - Internal notes, not shown to the customer
condicao_pagamento - Payment terms agreed for the document
forma_pagamento_id - Identifier of the payment method, joinable to the payment_methods stream
nome_forma_pagamento - Name of the payment method
data_primeira_parcela - Due date of the first instalment, as YYYY-MM-DD
numero_parcelas - Number of instalments the payment was split into
intervalo_dias - Number of days between instalments
situacao_financeiro - Whether the document has been posted to the financial ledger
situacao_estoque - Whether the document has moved inventory
nota_fiscal_id - Identifier of the product invoice issued for this document, joinable to the product_invoices stream
nota_fiscal_servico_id - Identifier of the service invoice issued for this document, joinable to the service_invoices stream
exibir_endereco - Whether the customer address is printed on the document: 1 for yes, 0 for no
hash - Opaque token used to build the document’s public share link
cadastrado_em - Timestamp the service order was created, as YYYY-MM-DD HH:MM:SS
modificado_em - Timestamp of the last change to the service order, as YYYY-MM-DD HH:MM:SS
produtos - Product line items, as a JSON array of objects (each wrapped in a ‘produto’ key) holding the product identifier, name, quantity, unit price and total
servicos - Service line items, as a JSON array of objects (each wrapped in a ‘servico’ key) holding the service identifier, name, quantity, unit price and total
equipamentos - Customer equipment attached to the document, as a JSON array of objects (each wrapped in an ‘equipamento’ key) holding the equipment description, brand, model and serial number
pagamentos - Instalments generated for the document, as a JSON array of objects (each wrapped in a ‘pagamento’ key) holding the due date, amount and payment method
enderecos - Delivery and billing addresses for the document, as a JSON array of objects (each wrapped in an ‘endereco’ key)
atributos - Values of the account’s user-defined fields for this document, as a JSON array of objects (each wrapped in an ‘atributo’ key)
anexos - Files attached to the document, as a JSON array of objects (each wrapped in an ‘anexo’ key) holding the file name and URL
data_entrada - Date the service order was opened, as YYYY-MM-DD; this is the field the API’s data_inicio filter matches and the incremental replication key
data_saida - Date the service order was closed and the item returned, as YYYY-MM-DD; empty while the order is still open

Purchases

Purchase orders placed with suppliers.Primary key: id
Replication: full tableFields (31):

id - Unique identifier of the purchase
codigo - Sequential number shown to users for this purchase
fornecedor_id - Identifier of the supplier, joinable to the suppliers stream
nome_fornecedor - Name of the supplier
data_emissao - Date the purchase was issued, as YYYY-MM-DD
situacao_id - Identifier of the purchase status, joinable to the purchase_statuses stream
nome_situacao - Name of the purchase status
centro_custo_id - Identifier of the cost centre, joinable to the cost_centers stream
nome_centro_custo - Name of the cost centre
numero_nfe - Number of the supplier’s product invoice (NF-e) covering this purchase
transportadora_id - Identifier of the freight carrier, joinable to the carriers stream
nome_transportadora - Name of the freight carrier
valor_frete - Freight amount on the purchase
pagar_frete - Whether the freight is paid by the buyer: 1 for yes, 0 for no
valor_produtos - Subtotal of the purchased product line items
valor_impostos - Total taxes on the purchase
desconto_valor - Discount applied as an absolute amount
desconto_porcentagem - Discount applied as a percentage
valor_total - Total value of the purchase, after taxes, freight and discounts
forma_pagamento - Name of the payment method agreed with the supplier
forma_pagamento_id - Identifier of the payment method, joinable to the payment_methods stream
numero_parcelas - Number of instalments the payment was split into
intervalo_dias - Number of days between instalments
data_primeira_parcela - Due date of the first instalment, as YYYY-MM-DD
observacoes - Notes visible to the supplier
observacoes_interna - Internal notes, not shared with the supplier
cadastrado_em - Timestamp the purchase was created, as YYYY-MM-DD HH:MM:SS
pagamentos - Instalments generated for the purchase, as a JSON array of objects (each wrapped in a ‘pagamento’ key) holding the due date, amount and payment method
situacoes - Status history of the purchase, as a JSON array of objects (each wrapped in a ‘situacao’ key) holding the status and when it was applied
produtos - Purchased product line items, as a JSON array of objects (each wrapped in a ‘produto’ key) holding the product identifier, name, quantity, unit cost and total
campos_extras - Values of the account’s user-defined purchase fields, as a JSON array of objects

Product Invoices

NF-e (model 55) product invoices, with issuer, recipient, tax totals and line items.Primary key: id
Replication: incremental on data_emissaoFields (97):

id - Unique identifier of the product invoice
empresa_id - Identifier of the company that issued the document
loja_id - Identifier of the issuing store, joinable to the stores stream
nome_loja - Name of the issuing store
pedido_id - Identifier of the sale this document was issued for, joinable to the sales stream
compra_id - Identifier of the purchase this document was issued for, joinable to the purchases stream
chave - 44-digit access key assigned to the document by SEFAZ
protocolo - SEFAZ protocol number returned when the document was authorized
cfop_id - Internal identifier of the CFOP operation code
codigo_cfop - CFOP code classifying the fiscal operation
descricao_cfop - Description of the CFOP operation code
natureza_operacao - Nature of the operation, for example Venda de mercadoria
indicador_pagamento - Payment indicator: 0 for cash, 1 for instalments
modelo - Fiscal document model number, 55 for NF-e and 65 for NFC-e
serie - Series of the fiscal document
numero_nf - Sequential number of the fiscal document within its series
data_emissao - Date the document was issued, as YYYY-MM-DD; this is the field the API’s data_inicio filter matches and the incremental replication key
hora_emissao - Time the document was issued, as HH:MM:SS
tipo_nf - Direction of the document: 0 for inbound, 1 for outbound
indicador_destinatario - Recipient’s ICMS taxpayer status
cidade_id - Identifier of the city where the operation took place, joinable to the cities stream
cidade_nome - Name of the city where the operation took place
codigo_uf - IBGE numeric code of the state where the operation took place
tipo_emissao - Issuance mode: 1 for normal, other values for contingency
tipo_ambiente - SEFAZ environment: 1 for production, 2 for homologation
finalidade_nf - Purpose of the document: 1 normal, 2 complementary, 3 adjustment, 4 return
consumidor_final - Whether the recipient is the final consumer: 1 for yes, 0 for no
tipo_atendimento - How the sale was served, for example on premises or delivery
tipo_documento_emitente - Whether the issuer is identified by CNPJ or CPF
cnpj_emitente - Issuer’s company tax ID (CNPJ)
cpf_emitente - Issuer’s individual tax ID (CPF)
nome_emitente - Issuer’s registered legal name
fantasia_emitente - Issuer’s trade name
logradouro_emitente - Street name of the issuer’s address
numero_emitente - Street number of the issuer’s address
complemento_emitente - Address complement of the issuer’s address
bairro_emitente - District of the issuer’s address
codigo_municipio_emitente - IBGE code of the issuer’s municipality
municipio_emitente - Name of the issuer’s municipality
uf_emitente - Two-letter state abbreviation of the issuer’s address
cep_emitente - Postal code (CEP) of the issuer’s address
codigo_pais_emitente - Country code of the issuer’s address, 1058 for Brazil
pais_emitente - Country name of the issuer’s address
telefone_emitente - Issuer’s phone number
ie_emitente - Issuer’s state tax registration (inscrição estadual)
iest_emitente - Issuer’s substitute-taxpayer state registration
im_emitente - Issuer’s municipal tax registration
destinatario_id - Identifier of the recipient customer, joinable to the customers stream
destinatario_nome - Name of the recipient customer
destinatario_fornecedor_id - Identifier of the recipient supplier, joinable to the suppliers stream
destinatario_fornecedor_nome - Name of the recipient supplier
destinatario_tipo_documento - Whether the recipient is identified by CNPJ or CPF
destinatario_cnpj - Recipient’s company tax ID (CNPJ)
destinatario_cpf - Recipient’s individual tax ID (CPF)
destinatario_id_estrangeiro - Recipient’s foreign identification number, for exports
destinatario_logradouro - Street name of the recipient’s address
destinatario_numero - Street number of the recipient’s address
destinatario_complemento - Address complement of the recipient’s address
destinatario_bairro - District of the recipient’s address
destinatario_cidade_id - Identifier of the recipient’s city, joinable to the cities stream
destinatario_municipio_codigo - IBGE code of the recipient’s municipality
destinatario_municipio_nome - Name of the recipient’s municipality
destinatario_uf - Two-letter state abbreviation of the recipient’s address
destinatario_cep - Postal code (CEP) of the recipient’s address
destinatario_pais_codigo - Country code of the recipient’s address, 1058 for Brazil
destinatario_pais_nome - Country name of the recipient’s address
destinatario_telefone - Recipient’s phone number
destinatario_ie - Recipient’s state tax registration (inscrição estadual)
destinatario_im - Recipient’s municipal tax registration
destinatario_email - Recipient’s email address the document was sent to
valor_total_nf - Total value of the fiscal document
valor_produtos - Sum of the product line item values, before freight and discounts
valor_frete - Freight amount on the document
valor_seguro - Insurance amount on the document
valor_desconto - Discount amount on the document
valor_outros - Other accessory expenses on the document
base_icms - ICMS tax base
valor_icms - ICMS tax amount
valor_fcp - Poverty-reduction fund (FCP) amount
base_icms_st - Tax base for ICMS under tax substitution
valor_icms_st - ICMS amount under tax substitution
valor_fcp_st - FCP amount under tax substitution
valor_fcp_st_retido - FCP amount previously withheld under tax substitution
valor_imposto_importacao - Import duty amount
valor_ipi - IPI tax amount
valor_ipi_devolvido - IPI amount refunded on returned goods
valor_pis - PIS contribution amount
valor_cofins - COFINS contribution amount
valor_icms_desonerado - ICMS amount exempted
valor_fcp_uf_destino - FCP amount due to the destination state, on interstate sales
valor_icms_uf_remetente - ICMS amount due to the origin state, on interstate sales
informacoes_complementares - Additional information printed on the document
situacao_nf - Status of the document, for example authorized, cancelled or pending
cadastrado_em - Timestamp the product invoice was created, as YYYY-MM-DD HH:MM:SS
modificado_em - Timestamp of the last change to the product invoice, as YYYY-MM-DD HH:MM:SS
produtos - Product line items, as a JSON array of objects holding the product identifier and code, name, CFOP, unit, quantity, unit price, NCM and barcode
pagamento - Payment details, as a JSON array of objects holding the instalment number, payment method, due date, amount, card brand, acquirer CNPJ and authorization code

Consumer Invoices

NFC-e (model 65) consumer invoices, same shape as NF-e.Primary key: id
Replication: incremental on data_emissaoFields (97):

id - Unique identifier of the consumer invoice
empresa_id - Identifier of the company that issued the document
loja_id - Identifier of the issuing store, joinable to the stores stream
nome_loja - Name of the issuing store
pedido_id - Identifier of the sale this document was issued for, joinable to the sales stream
compra_id - Identifier of the purchase this document was issued for, joinable to the purchases stream
chave - 44-digit access key assigned to the document by SEFAZ
protocolo - SEFAZ protocol number returned when the document was authorized
cfop_id - Internal identifier of the CFOP operation code
codigo_cfop - CFOP code classifying the fiscal operation
descricao_cfop - Description of the CFOP operation code
natureza_operacao - Nature of the operation, for example Venda de mercadoria
indicador_pagamento - Payment indicator: 0 for cash, 1 for instalments
modelo - Fiscal document model number, 55 for NF-e and 65 for NFC-e
serie - Series of the fiscal document
numero_nf - Sequential number of the fiscal document within its series
data_emissao - Date the document was issued, as YYYY-MM-DD; this is the field the API’s data_inicio filter matches and the incremental replication key
hora_emissao - Time the document was issued, as HH:MM:SS
tipo_nf - Direction of the document: 0 for inbound, 1 for outbound
indicador_destinatario - Recipient’s ICMS taxpayer status
cidade_id - Identifier of the city where the operation took place, joinable to the cities stream
cidade_nome - Name of the city where the operation took place
codigo_uf - IBGE numeric code of the state where the operation took place
tipo_emissao - Issuance mode: 1 for normal, other values for contingency
tipo_ambiente - SEFAZ environment: 1 for production, 2 for homologation
finalidade_nf - Purpose of the document: 1 normal, 2 complementary, 3 adjustment, 4 return
consumidor_final - Whether the recipient is the final consumer: 1 for yes, 0 for no
tipo_atendimento - How the sale was served, for example on premises or delivery
tipo_documento_emitente - Whether the issuer is identified by CNPJ or CPF
cnpj_emitente - Issuer’s company tax ID (CNPJ)
cpf_emitente - Issuer’s individual tax ID (CPF)
nome_emitente - Issuer’s registered legal name
fantasia_emitente - Issuer’s trade name
logradouro_emitente - Street name of the issuer’s address
numero_emitente - Street number of the issuer’s address
complemento_emitente - Address complement of the issuer’s address
bairro_emitente - District of the issuer’s address
codigo_municipio_emitente - IBGE code of the issuer’s municipality
municipio_emitente - Name of the issuer’s municipality
uf_emitente - Two-letter state abbreviation of the issuer’s address
cep_emitente - Postal code (CEP) of the issuer’s address
codigo_pais_emitente - Country code of the issuer’s address, 1058 for Brazil
pais_emitente - Country name of the issuer’s address
telefone_emitente - Issuer’s phone number
ie_emitente - Issuer’s state tax registration (inscrição estadual)
iest_emitente - Issuer’s substitute-taxpayer state registration
im_emitente - Issuer’s municipal tax registration
destinatario_id - Identifier of the recipient customer, joinable to the customers stream
destinatario_nome - Name of the recipient customer
destinatario_fornecedor_id - Identifier of the recipient supplier, joinable to the suppliers stream
destinatario_fornecedor_nome - Name of the recipient supplier
destinatario_tipo_documento - Whether the recipient is identified by CNPJ or CPF
destinatario_cnpj - Recipient’s company tax ID (CNPJ)
destinatario_cpf - Recipient’s individual tax ID (CPF)
destinatario_id_estrangeiro - Recipient’s foreign identification number, for exports
destinatario_logradouro - Street name of the recipient’s address
destinatario_numero - Street number of the recipient’s address
destinatario_complemento - Address complement of the recipient’s address
destinatario_bairro - District of the recipient’s address
destinatario_cidade_id - Identifier of the recipient’s city, joinable to the cities stream
destinatario_municipio_codigo - IBGE code of the recipient’s municipality
destinatario_municipio_nome - Name of the recipient’s municipality
destinatario_uf - Two-letter state abbreviation of the recipient’s address
destinatario_cep - Postal code (CEP) of the recipient’s address
destinatario_pais_codigo - Country code of the recipient’s address, 1058 for Brazil
destinatario_pais_nome - Country name of the recipient’s address
destinatario_telefone - Recipient’s phone number
destinatario_ie - Recipient’s state tax registration (inscrição estadual)
destinatario_im - Recipient’s municipal tax registration
destinatario_email - Recipient’s email address the document was sent to
valor_total_nf - Total value of the fiscal document
valor_produtos - Sum of the product line item values, before freight and discounts
valor_frete - Freight amount on the document
valor_seguro - Insurance amount on the document
valor_desconto - Discount amount on the document
valor_outros - Other accessory expenses on the document
base_icms - ICMS tax base
valor_icms - ICMS tax amount
valor_fcp - Poverty-reduction fund (FCP) amount
base_icms_st - Tax base for ICMS under tax substitution
valor_icms_st - ICMS amount under tax substitution
valor_fcp_st - FCP amount under tax substitution
valor_fcp_st_retido - FCP amount previously withheld under tax substitution
valor_imposto_importacao - Import duty amount
valor_ipi - IPI tax amount
valor_ipi_devolvido - IPI amount refunded on returned goods
valor_pis - PIS contribution amount
valor_cofins - COFINS contribution amount
valor_icms_desonerado - ICMS amount exempted
valor_fcp_uf_destino - FCP amount due to the destination state, on interstate sales
valor_icms_uf_remetente - ICMS amount due to the origin state, on interstate sales
informacoes_complementares - Additional information printed on the document
situacao_nf - Status of the document, for example authorized, cancelled or pending
cadastrado_em - Timestamp the consumer invoice was created, as YYYY-MM-DD HH:MM:SS
modificado_em - Timestamp of the last change to the consumer invoice, as YYYY-MM-DD HH:MM:SS
produtos - Product line items, as a JSON array of objects holding the product identifier and code, name, CFOP, unit, quantity, unit price, NCM and barcode
pagamento - Payment details, as a JSON array of objects holding the instalment number, payment method, due date, amount, card brand, acquirer CNPJ and authorization code

Service Invoices

NFS-e service invoices, with ISS tax base and withholding details.Primary key: id
Replication: incremental on data_emissaoFields (121):

id - Unique identifier of the service invoice
empresa_id - Identifier of the company that issued the invoice
loja_id - Identifier of the issuing store, joinable to the stores stream
nome_loja - Name of the issuing store
contrato_id - Identifier of the contract the invoice was issued against
pedido_id - Identifier of the sale or service order the invoice was issued for
codigo - Internal sequential code of the invoice
rps - Number of the provisional service receipt (RPS) the invoice replaced
numero - Number assigned to the invoice by the municipality
codigo_verificacao - Verification code used to validate the invoice on the municipal portal
serie - Series of the invoice
data_emissao - Date the invoice was issued, as YYYY-MM-DD; this is the field the API’s data_inicio filter matches and the incremental replication key
data_emissao_ano - Year the invoice was issued
data_emissao_mes - Month the invoice was issued
hora_emissao - Time the invoice was issued, as HH:MM:SS
codigo_natureza_operacao - Code for the nature of the operation
nome_natureza_operacao - Description of the nature of the operation
natureza_operacao - Nature of the operation, as returned on records using the short field spelling
codigo_incidencia_issqn - Code of the municipality where ISSQN is levied
cidade_incidencia_issqn - Name of the municipality where ISSQN is levied
emitente_cnpj - Issuer’s company tax ID (CNPJ)
emitente_inscricao_municipal - Issuer’s municipal tax registration
emit_cnpj - Issuer’s company tax ID (CNPJ), as returned on records using the short field spelling
emit_inscricao_municipal - Issuer’s municipal tax registration, as returned on records using the short field spelling
destinatario_id_cliente - Identifier of the recipient customer, joinable to the customers stream
destinatario_nome_cliente - Name of the recipient customer
destinatario_tipo_pessoa - Recipient entity type: PF for an individual, PJ for a company
destinatario_razao_social - Recipient’s registered legal name
destinatario_cnpj - Recipient’s company tax ID (CNPJ)
destinatario_cpf - Recipient’s individual tax ID (CPF)
destinatario_inscricao_municipal - Recipient’s municipal tax registration
destinatario_cep - Postal code (CEP) of the recipient’s address
destinatario_logradouro_endereco - Street name of the recipient’s address
destinatario_numero_endereco - Street number of the recipient’s address
destinatario_complemento_endereco - Address complement of the recipient’s address
destinatario_bairro_endereco - District of the recipient’s address
destinatario_cidade_id_endereco - Identifier of the recipient’s city, joinable to the cities stream
destinatario_nome_cidade_endereco - Name of the recipient’s city
destinatario_codigo_cidade_endereco - IBGE code of the recipient’s city
destinatario_estado_endereco - Two-letter state abbreviation of the recipient’s address
dest_codigo_siafi - SIAFI code of the recipient’s municipality
destinatario_telefone - Recipient’s phone number
destinatario_email - Recipient’s email address
dest_cliente_id - Identifier of the recipient customer, as returned on records using the short field spelling
dest_nome_cliente - Name of the recipient customer, as returned on records using the short field spelling
dest_tipo_pessoa - Recipient entity type, as returned on records using the short field spelling
dest_razao_social - Recipient’s registered legal name, as returned on records using the short field spelling
dest_cnpj - Recipient’s CNPJ, as returned on records using the short field spelling
dest_cpf - Recipient’s CPF, as returned on records using the short field spelling
dest_inscricao_municipal - Recipient’s municipal tax registration, as returned on records using the short field spelling
dest_cep - Recipient’s postal code, as returned on records using the short field spelling
dest_logradouro - Recipient’s street name, as returned on records using the short field spelling
dest_numero - Recipient’s street number, as returned on records using the short field spelling
dest_complemento - Recipient’s address complement, as returned on records using the short field spelling
dest_bairro - Recipient’s district, as returned on records using the short field spelling
dest_cidade_id - Recipient’s city identifier, as returned on records using the short field spelling
dest_nome_cidade - Recipient’s city name, as returned on records using the short field spelling
dest_codigo_cidade - Recipient’s IBGE city code, as returned on records using the short field spelling
dest_estado - Recipient’s state abbreviation, as returned on records using the short field spelling
dest_telefone - Recipient’s phone number, as returned on records using the short field spelling
dest_email - Recipient’s email address, as returned on records using the short field spelling
prestador_cep - Postal code (CEP) of the service provider’s address
prestador_logradouro - Street name of the service provider’s address
prestador_numero - Street number of the service provider’s address
prestador_complemento - Address complement of the service provider’s address
prestador_bairro - District of the service provider’s address
prestador_cidade_id - Identifier of the service provider’s city, joinable to the cities stream
prestador_nome_cidade - Name of the service provider’s city
prestador_codigo_cidade - IBGE code of the service provider’s city
prestador_estado - Two-letter state abbreviation of the service provider’s address
prest_cep - Provider’s postal code, as returned on records using the short field spelling
prest_logradouro - Provider’s street name, as returned on records using the short field spelling
prest_numero - Provider’s street number, as returned on records using the short field spelling
prest_complemento - Provider’s address complement, as returned on records using the short field spelling
prest_bairro - Provider’s district, as returned on records using the short field spelling
prest_cidade_id - Provider’s city identifier, as returned on records using the short field spelling
prest_nome_cidade - Provider’s city name, as returned on records using the short field spelling
prest_codigo_cidade - Provider’s IBGE city code, as returned on records using the short field spelling
prest_estado - Provider’s state abbreviation, as returned on records using the short field spelling
descricao - Description of the service rendered, as printed on the invoice
atividade_id - Internal identifier of the service activity
codigo_atividade - Municipal service code for the activity
atividade_descricao - Description of the service activity
atividade_codigo_tributacao - Municipal taxation code for the activity
atividade_cnae - CNAE code for the activity
descricao_atividade - Description of the service activity, as returned on records using the short field spelling
codigo_tributacao_atividade - Municipal taxation code, as returned on records using the short field spelling
cnae_atividade - CNAE code, as returned on records using the short field spelling
valor_servico - Gross value of the service rendered
valor_base_calculo - ISS tax base
valor_iss - ISS tax amount
iss_retido - Whether ISS was withheld by the recipient: 1 for yes, 0 for no
valor_deducoes - Deductions applied before the ISS tax base
valor_aliquota - ISS rate applied, as a percentage
descontos - Discounts applied to the invoice
valor_total - Net total of the invoice after taxes and discounts
construcao_civil - Whether the service is civil construction: 1 for yes, 0 for no
codigo_obra - Construction site registration code (CNO), for civil construction
codigo_art - Technical responsibility note (ART) code, for civil construction
aliquota_cofins - COFINS rate applied, as a percentage
aliquota_pis - PIS rate applied, as a percentage
aliquota_csll - CSLL rate applied, as a percentage
aliquota_ir - Income tax rate applied, as a percentage
aliquota_inss - INSS rate applied, as a percentage
valor_cofins - COFINS amount
valor_pis - PIS amount
valor_csll - CSLL amount
valor_ir - Income tax amount
valor_inss - INSS amount
cofins_retido - Whether COFINS was withheld: 1 for yes, 0 for no
pis_retido - Whether PIS was withheld: 1 for yes, 0 for no
csll_retido - Whether CSLL was withheld: 1 for yes, 0 for no
ir_retido - Whether income tax was withheld: 1 for yes, 0 for no
inss_retido - Whether INSS was withheld: 1 for yes, 0 for no
outras_informacoes - Additional information printed on the invoice
situacao - Status of the invoice, for example issued or cancelled
hash - Opaque token used to build the invoice’s public link
usuario_id - Identifier of the ERP user who issued the invoice, joinable to the users stream
nome_usuario - Name of the ERP user who issued the invoice
cadastrado_em - Timestamp the invoice was created, as YYYY-MM-DD HH:MM:SS
modificado_em - Timestamp of the last change to the invoice, as YYYY-MM-DD HH:MM:SS

Payments

Accounts payable: every payable entry, open and settled.Primary key: id
Replication: full tableFields (37):

id - Unique identifier of the payable entry
codigo - Sequential number shown to users for this payable entry
descricao - Description of what the payable entry is for
valor - Face amount of the entry, before interest, discounts and fees
juros - Interest or late-payment charges added to the entry
desconto - Discount granted on the entry
taxa_banco - Bank fee charged on the entry
taxa_operadora - Card acquirer fee charged on the entry
valor_total - Net settled amount, after interest, discounts and fees
liquidado - Settlement state of the entry: 1 when confirmed, 0 while still open
data_vencimento - Due date of the entry, as YYYY-MM-DD
data_liquidacao - Date the entry was actually settled, as YYYY-MM-DD; empty while it is still open. This is the date the API’s data_inicio filter matches, falling back to the due date for entries that are still open
data_competencia - Accrual date used for accounting purposes, as YYYY-MM-DD
plano_contas_id - Identifier of the chart-of-accounts entry, joinable to the chart_of_accounts stream
nome_plano_conta - Name of the chart-of-accounts entry
centro_custo_id - Identifier of the cost centre, joinable to the cost_centers stream
nome_centro_custo - Name of the cost centre
conta_bancaria_id - Identifier of the bank account, joinable to the bank_accounts stream
nome_conta_bancaria - Name of the bank account
forma_pagamento_id - Identifier of the payment method, joinable to the payment_methods stream
nome_forma_pagamento - Name of the payment method
entidade - Which kind of payee the entry is settled with, telling you which of the party identifier fields below is populated
cliente_id - Identifier of the customer, when the entry is settled with a customer
nome_cliente - Name of the customer, when the entry is settled with a customer
fornecedor_id - Identifier of the supplier, when the entry is settled with a supplier
nome_fornecedor - Name of the supplier, when the entry is settled with a supplier
transportadora_id - Identifier of the carrier, when the entry is settled with a carrier
nome_transportadora - Name of the carrier, when the entry is settled with a carrier
funcionario_id - Identifier of the employee, when the entry is settled with an employee
nome_funcionario - Name of the employee, when the entry is settled with an employee
usuario_id - Identifier of the ERP user who recorded the entry, joinable to the users stream
nome_usuario - Name of the ERP user who recorded the entry
loja_id - Identifier of the store the entry belongs to, joinable to the stores stream
nome_loja - Name of the store the entry belongs to
cadastrado_em - Timestamp the payable entry was created, as YYYY-MM-DD HH:MM:SS
modificado_em - Timestamp of the last change to the payable entry, as YYYY-MM-DD HH:MM:SS
atributos - Values of the account’s user-defined financial fields, as a JSON array of objects (each wrapped in an ‘atributo’ key); the field definitions are in the financial_custom_fields stream

Receipts

Accounts receivable: every receivable entry, open and settled.Primary key: id
Replication: full tableFields (37):

id - Unique identifier of the receivable entry
codigo - Sequential number shown to users for this receivable entry
descricao - Description of what the receivable entry is for
valor - Face amount of the entry, before interest, discounts and fees
juros - Interest or late-payment charges added to the entry
desconto - Discount granted on the entry
taxa_banco - Bank fee charged on the entry
taxa_operadora - Card acquirer fee charged on the entry
valor_total - Net settled amount, after interest, discounts and fees
liquidado - Settlement state of the entry: 1 when confirmed, 0 while still open
data_vencimento - Due date of the entry, as YYYY-MM-DD
data_liquidacao - Date the entry was actually settled, as YYYY-MM-DD; empty while it is still open. This is the date the API’s data_inicio filter matches, falling back to the due date for entries that are still open
data_competencia - Accrual date used for accounting purposes, as YYYY-MM-DD
plano_contas_id - Identifier of the chart-of-accounts entry, joinable to the chart_of_accounts stream
nome_plano_conta - Name of the chart-of-accounts entry
centro_custo_id - Identifier of the cost centre, joinable to the cost_centers stream
nome_centro_custo - Name of the cost centre
conta_bancaria_id - Identifier of the bank account, joinable to the bank_accounts stream
nome_conta_bancaria - Name of the bank account
forma_pagamento_id - Identifier of the payment method, joinable to the payment_methods stream
nome_forma_pagamento - Name of the payment method
entidade - Which kind of payer the entry is settled with, telling you which of the party identifier fields below is populated
cliente_id - Identifier of the customer, when the entry is settled with a customer
nome_cliente - Name of the customer, when the entry is settled with a customer
fornecedor_id - Identifier of the supplier, when the entry is settled with a supplier
nome_fornecedor - Name of the supplier, when the entry is settled with a supplier
transportadora_id - Identifier of the carrier, when the entry is settled with a carrier
nome_transportadora - Name of the carrier, when the entry is settled with a carrier
funcionario_id - Identifier of the employee, when the entry is settled with an employee
nome_funcionario - Name of the employee, when the entry is settled with an employee
usuario_id - Identifier of the ERP user who recorded the entry, joinable to the users stream
nome_usuario - Name of the ERP user who recorded the entry
loja_id - Identifier of the store the entry belongs to, joinable to the stores stream
nome_loja - Name of the store the entry belongs to
cadastrado_em - Timestamp the receivable entry was created, as YYYY-MM-DD HH:MM:SS
modificado_em - Timestamp of the last change to the receivable entry, as YYYY-MM-DD HH:MM:SS
atributos - Values of the account’s user-defined financial fields, as a JSON array of objects (each wrapped in an ‘atributo’ key); the field definitions are in the financial_custom_fields stream

Payment Methods

Payment methods, including bank slip and card acquirer configuration.Primary key: id
Replication: full tableFields (44):

id - Unique identifier of the payment method
nome - Name of the payment method, for example Dinheiro or Cartão de crédito
tipo - Type of the payment method, for example cash, card or bank slip
conta_bancaria_id - Identifier of the bank account entries settle into, joinable to the bank_accounts stream
nome_conta_bancaria - Name of the bank account entries settle into
movimentacao - Whether using this method moves the bank account balance: 1 for yes, 0 for no
confirmar_financeiro - Whether entries are settled automatically when created: 1 for yes, 0 for no
maximo_parcelas - Maximum number of instalments allowed
intervalo_parcelas - Number of days between instalments
intervalo_primeira_parcela - Number of days until the first instalment falls due
disponivel_pdv - Whether the method is offered at the point of sale: 1 for yes, 0 for no
bandeira_cartao - Card brand, for card payment methods
cnpj_credenciadora - Company tax ID (CNPJ) of the card acquirer
taxa_banco - Bank fee charged per transaction, as a percentage
taxa_operadora - Card acquirer fee charged per transaction, as a percentage
boleto - Whether the method issues a bank slip (boleto): 1 for yes, 0 for no
banco - Bank code used for bank slip issuance
cnab - CNAB layout used for the bank remittance file
carteira - Bank portfolio (carteira) code used for bank slips
agencia - Bank branch number
agencia_dv - Check digit of the bank branch number
conta - Bank account number
conta_dv - Check digit of the bank account number
codigo_cliente - Account holder code assigned by the bank
codigo_cliente_dv - Check digit of the account holder code
taxa_multa_atraso - Late-payment penalty rate applied on bank slips, as a percentage
taxa_mora_atraso - Daily late-payment interest rate applied on bank slips, as a percentage
dias_juros - Number of days after the due date before interest starts accruing
aceite - Acceptance indicator printed on the bank slip
especie_doc - Document kind code printed on the bank slip
protestar - Whether unpaid bank slips are sent for protest: 1 for yes, 0 for no
dias_protesto - Number of days after the due date before an unpaid slip is protested
ultimo_boleto - Sequential number of the last bank slip issued
ultima_remessa - Sequential number of the last remittance file generated
versao_layout_header - CNAB file header layout version
versao_layout_header_lote - CNAB batch header layout version
ambiente - Bank integration environment: production or homologation
instrucao1 - First instruction line printed on the bank slip
instrucao2 - Second instruction line printed on the bank slip
instrucao3 - Third instruction line printed on the bank slip
instrucao4 - Fourth instruction line printed on the bank slip
local_pagamento1 - Place-of-payment text printed on the bank slip
demonstrativo1 - First statement line printed on the bank slip
demonstrativo2 - Second statement line printed on the bank slip

Bank Accounts

Bank accounts entries are settled into.Primary key: id
Replication: full tableFields (2):

id - Unique identifier of the bank account
nome - Name of the bank account as shown in the ERP

Chart of Accounts

The chart of accounts hierarchy.Primary key: id
Replication: full tableFields (7):

id - Unique identifier of the chart-of-accounts entry
conta_mae_id - Identifier of the parent account, empty for a top-level account
nome_conta_mae - Name of the parent account
classificacao - Hierarchical classification code of the account, for example 1.1.02
tipo - Account direction: D for debit (expense), C for credit (revenue)
nome_tipo - Human-readable account direction, for example Débito or Crédito
nome - Name of the account

Cost Centers

Cost centres used to classify documents and ledger entries.Primary key: id
Replication: full tableFields (3):

id - Unique identifier of the cost centre
nome - Name of the cost centre
cadastrado_em - Timestamp the cost centre was created, as YYYY-MM-DD HH:MM:SS

Quote Statuses

Status values quotes can take.Primary key: id
Replication: full tableFields (3):

id - Unique identifier of the status, referenced by situacao_id on quotes
nome - Name of the status as shown in the ERP
padrao - Whether this is the default status for new records: 1 for yes, 0 for no

Sale Statuses

Status values sales can take, and whether each one posts to finance and inventory.Primary key: id
Replication: full tableFields (6):

id - Unique identifier of the status, referenced by situacao_id on sales
nome - Name of the status as shown in the ERP
padrao - Whether this is the default status for new records: 1 for yes, 0 for no
cor - Hex colour the ERP uses to display this status
lancar - Whether reaching this status posts the sale to the financial ledger and inventory: 1 for yes, 0 for no
editar - Whether a sale in this status can still be edited: 1 for yes, 0 for no

Service Order Statuses

Status values service orders can take.Primary key: id
Replication: full tableFields (3):

id - Unique identifier of the status, referenced by situacao_id on service orders
nome - Name of the status as shown in the ERP
padrao - Whether this is the default status for new records: 1 for yes, 0 for no

Purchase Statuses

Status values purchases can take.Primary key: id
Replication: full tableFields (4):

id - Unique identifier of the status, referenced by situacao_id on purchases
nome - Name of the status as shown in the ERP
padrao - Whether this is the default status for new records: 1 for yes, 0 for no
tipo_lancamento - What reaching this status posts, for example inventory, financial entries or both

Registration Custom Fields

Definitions of the user-defined fields on customers, suppliers and carriers.Primary key: id
Replication: full tableFields (6):

id - Unique identifier of the user-defined field, referenced by atributo_id inside the atributos array on customers, suppliers and carriers
nome - Label of the user-defined field
tipo - Input type of the field, for example texto, data, check_list or select
obrigatorio - Whether filling the field is mandatory: 1 for yes, 0 for no
cadastrado_em - Timestamp the field was created, as YYYY-MM-DD HH:MM:SS
modificado_em - Timestamp of the last change to the field, as YYYY-MM-DD HH:MM:SS

Product Custom Fields

Definitions of the user-defined fields on products.Primary key: id
Replication: full tableFields (6):

id - Unique identifier of the user-defined field, referenced by atributo_id inside the atributos array on products
nome - Label of the user-defined field
tipo - Input type of the field, for example texto, data, check_list or select
obrigatorio - Whether filling the field is mandatory: 1 for yes, 0 for no
cadastrado_em - Timestamp the field was created, as YYYY-MM-DD HH:MM:SS
modificado_em - Timestamp of the last change to the field, as YYYY-MM-DD HH:MM:SS

Quote Custom Fields

Definitions of the user-defined fields on quotes.Primary key: id
Replication: full tableFields (7):

id - Unique identifier of the user-defined field, referenced by atributo_id inside the atributos array on quotes
nome - Label of the user-defined field
tipo - Input type of the field, for example texto, data, check_list or select
obrigatorio - Whether filling the field is mandatory: 1 for yes, 0 for no
cadastrado_em - Timestamp the field was created, as YYYY-MM-DD HH:MM:SS
modificado_em - Timestamp of the last change to the field, as YYYY-MM-DD HH:MM:SS
exibir_impressao - Whether the field is printed on the document: 1 for yes, 0 for no

Sale Custom Fields

Definitions of the user-defined fields on sales.Primary key: id
Replication: full tableFields (7):

id - Unique identifier of the user-defined field, referenced by atributo_id inside the atributos array on sales
nome - Label of the user-defined field
tipo - Input type of the field, for example texto, data, check_list or select
obrigatorio - Whether filling the field is mandatory: 1 for yes, 0 for no
cadastrado_em - Timestamp the field was created, as YYYY-MM-DD HH:MM:SS
modificado_em - Timestamp of the last change to the field, as YYYY-MM-DD HH:MM:SS
exibir_impressao - Whether the field is printed on the document: 1 for yes, 0 for no

Service Order Custom Fields

Definitions of the user-defined fields on service orders.Primary key: id
Replication: full tableFields (7):

id - Unique identifier of the user-defined field, referenced by atributo_id inside the atributos array on service orders
nome - Label of the user-defined field
tipo - Input type of the field, for example texto, data, check_list or select
obrigatorio - Whether filling the field is mandatory: 1 for yes, 0 for no
cadastrado_em - Timestamp the field was created, as YYYY-MM-DD HH:MM:SS
modificado_em - Timestamp of the last change to the field, as YYYY-MM-DD HH:MM:SS
exibir_impressao - Whether the field is printed on the document: 1 for yes, 0 for no

Financial Custom Fields

Definitions of the user-defined fields on payable and receivable entries.Primary key: id
Replication: full tableFields (6):

id - Unique identifier of the user-defined field, referenced by atributo_id inside the atributos array on payable and receivable entries
nome - Label of the user-defined field
tipo - Input type of the field, for example texto, data, check_list or select
obrigatorio - Whether filling the field is mandatory: 1 for yes, 0 for no
cadastrado_em - Timestamp the field was created, as YYYY-MM-DD HH:MM:SS
modificado_em - Timestamp of the last change to the field, as YYYY-MM-DD HH:MM:SS

Contact Types

Contact type labels used inside registration contact lists.Primary key: id
Replication: full tableFields (2):

id - Unique identifier of the contact type, referenced by tipo_id inside the contatos array on party records
nome - Name of the contact type, for example Financeiro or Comercial

Address Types

Address type labels used inside registration address lists.Primary key: id
Replication: full tableFields (2):

id - Unique identifier of the address type, referenced by tipo_id inside the enderecos array on party records
nome - Name of the address type, for example Cobrança or Entrega

States

Brazilian states, the IBGE reference table.Primary key: id
Replication: full tableFields (4):

id - Unique identifier of the state in Gestão Click
codigo - IBGE numeric code of the state
nome - Full name of the state
sigla - Two-letter abbreviation of the state, for example SP or MG

Cities

Brazilian municipalities, the IBGE reference table.Primary key: id
Replication: full tableFields (3):

id - Unique identifier of the city in Gestão Click, referenced by cidade_id across the other streams
codigo - IBGE numeric code of the municipality
nome - Name of the municipality

Documentation

Get started

Context

Activate

Workspace

Resources

Gestão Click as a data source

Configuring Gestão Click as a Source

1. Add account access

2. Select streams

3. Configure data streams

4. Configure data source

5. Check your new source

How data is synced

Nested fields

Rate limits

Streams and Fields

Available streams

Stream details

​Configuring Gestão Click as a Source

​1. Add account access

​2. Select streams

​3. Configure data streams

​4. Configure data source

​5. Check your new source

​How data is synced

​Nested fields

​Rate limits

​Streams and Fields

​Available streams

​Stream details

Configuring Gestão Click as a Source

1. Add account access

2. Select streams

3. Configure data streams

4. Configure data source

5. Check your new source

How data is synced

Nested fields

Rate limits

Streams and Fields

Available streams

Stream details