> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nekt.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Omie as a data source
> Bring data from Omie to Nekt.
Omie is a comprehensive business management platform designed for Brazilian companies. It provides integrated tools for ERP, CRM, financial management, and business operations to help companies streamline their processes and improve efficiency.
## Configuring Omie as a Source
In the [Sources](https://app.nekt.ai/sources) tab, click on the "Add source" button located on the top right of your screen. Then, select the Omie option from the list of connectors.
Click **Next** and you'll be prompted to add your access.
### 1. Add account access
You'll need your Omie App Key and App Secret for this connection. You can find these credentials in your Omie integrations settings. Check [Omie's documentation](https://ajuda.omie.com.br/pt-BR/articles/499061-obtendo-a-chave-de-acesso-para-integracoes-de-api) to discover where you can find the App Key and App Secret for the connection.
* **App Key**: Your application key for the Omie API.
* **App Secret**: Your application secret for the Omie API.
* **Start Date**: The earliest record date to sync.
### 2. Select streams
Choose which data streams you want to sync - you can select all streams or pick specific ones that matter most to you. Omie provides comprehensive business data including clients, finances, projects, and more.
> 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 a name for each table (which will contain the fetched data) and the type of sync.
* **Table name**: we suggest a name, but feel free to customize it. You have the option to add a **prefix** 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.
* Full table: every time the extraction happens, we'll get the current state of the data.
Once you are done configuring, click **Next**.
### 4. Configure data source
Describe your data source for easy identification within your organization, not exceeding 140 characters.
To define your [Trigger](https://docs.nekt.com/runs/scheduling-and-triggers), consider how often you want data to be extracted from this source.
Optionally, you can determine when to execute a [full sync](https://docs.nekt.com/get-started/core-concepts/types-of-sync#additional-full-sync).
Once you are ready, click **Next** to finalize the setup.
### 5. Check your new source
You can view your new source on the [Sources](https://app.nekt.ai/sources) page. If needed, manually trigger the source extraction by clicking on the arrow button.
For you to be able to see it on your [Catalog](https://app.nekt.ai/catalog), you need at least one successful source run.
# Streams and Fields
Below you'll find all available data streams from Omie, their corresponding endpoints and fields:
## Stream to Endpoint Mapping
| Stream | Omie Endpoint | Sync Type |
| :---------------------------- | :-------------------------- | :---------- |
| activity\_types | ListarTipoAtiv | Full Table |
| attachment\_types | ListarTiposAnexos | Full Table |
| banks | ListarBancos | Full Table |
| bills | ListarContasPagar | Incremental |
| bills\_attachments | ListarAnexo | Incremental |
| card\_brands | ListarBandeiras | Full Table |
| categories | ListarCategorias | Full Table |
| checking\_account\_types | ListarTiposCC | Full Table |
| checking\_accounts | ListarContasCorrentes | Incremental |
| checking\_accounts\_balance | ListarExtrato | Incremental |
| checking\_accounts\_summary | ListarResumoContasCorrentes | Full Table |
| checking\_accounts\_transfers | ListarLancCC | Incremental |
| clients | ListarClientes | Incremental |
| cnae | ListarCNAE | Full Table |
| companies | ListarEmpresas | Full Table |
| countries | ListarPaises | Full Table |
| deleted\_titles | PesquisarExcluidos | Incremental |
| departments | ListarDepartamentos | Full Table |
| document\_types | PesquisarTipoDocumento | Full Table |
| dre | ListarCadastroDRE | Full Table |
| finances | ListarMovimentos | Incremental |
| finances\_summary | ObterResumoFinancas | Incremental |
| general\_users | ListarUsuarios | Full Table |
| installments | ListarParcelas | Full Table |
| nfe | ListarNF | Incremental |
| nfse | ListarNFSEs | Incremental |
| nfse\_documents | ObterNFSe | Incremental |
| order\_services | ListarOS | Incremental |
| orders | ListarPedidos | Incremental |
| os\_documents | ObterOS | Incremental |
| pix | ListarPix | Incremental |
| products\_summary | ListarProdutosResumido | Full Table |
| projects | ListarProjetos | Incremental |
| purchase\_orders | PesquisarPedCompra | Incremental |
| quotes | ListarOrcamentos | Incremental |
| receipt\_documents | ObterRecibo | Full Table |
| receivables | ListarContasReceber | Incremental |
| rps\_documents | ObterRPS | Full Table |
| sellers | ListarVendedores | Full Table |
| services | ListarCadastroServico | Incremental |
| subscriber\_types | ListarTipoAssinante | Full Table |
| supplier\_products | ListarProdutoFornecedor | Full Table |
| task\_types | ObterTiposTarefa | Full Table |
| tasks | ListarTarefas | Incremental |
| titles | PesquisarLancamentos | Incremental |
| transaction\_origins | ListarOrigem | Full Table |
| transfer\_purposes | ListarFinalTransf | Full Table |
| users | ListarUsuarios | Full Table |
## Available Streams and Fields
### Reference Tables
Reference table containing activity types (Tipos de Atividade).
| Field | Type | Description |
| :----------- | :----- | :------------------------ |
| \_id | string | Unique identifier |
| c\_codigo | string | Activity type code |
| c\_descricao | string | Activity type description |
Reference table containing attachment file types (Tipos de Anexo).
| Field | Type | Description |
| :-------- | :----- | :-------------------------- |
| \_id | string | Unique identifier |
| codigo | string | Attachment type code |
| descricao | string | Attachment type description |
Reference table containing bank information and configurations.
| Field | Type | Description |
| :---------- | :------ | :------------------------------ |
| codigo | string | Bank code |
| nome | string | Bank name |
| tipo | string | Bank type |
| cod\_compen | string | Compensation code |
| cod\_ispb | string | ISPB code |
| entf\_cnpj | string | Entity CNPJ |
| cnab\_cob | string | Collection CNAB |
| cnab\_pag | string | Payment CNAB |
| cnab\_altve | string | CNAB alternative version |
| cnab\_altvl | string | CNAB alternative layout |
| crawler\_sn | string | Whether crawler is enabled |
| cwr\_cobrem | string | Collection remittance crawler |
| cwr\_cobret | string | Collection return crawler |
| cwr\_pagrem | string | Payment remittance crawler |
| cwr\_pagret | string | Payment return crawler |
| cwr\_extr | string | Extract crawler |
| obank\_sn | string | Whether Open Banking is enabled |
| obank\_cobr | string | Open Banking collection |
| obank\_extr | string | Open Banking extract |
| obank\_pagt | string | Open Banking payment |
| obank\_pix | string | Open Banking PIX |
| descond\_sn | string | Whether discount is conditional |
| descond\_qt | integer | Discount quantity |
Reference table containing card brands (Bandeiras de Cartao).
| Field | Type | Description |
| :----------- | :----- | :--------------------- |
| \_id | string | Unique identifier |
| c\_codigo | string | Card brand code |
| c\_descricao | string | Card brand description |
Reference table containing financial and operational categories.
| Field | Type | Description |
| :-------------------------- | :------ | :-------------------------- |
| codigo | string | Category code |
| descricao | string | Category description |
| descricao\_padrao | string | Default description |
| categoria\_superior | string | Parent category |
| natureza | string | Category nature |
| tipo\_categoria | string | Category type |
| codigo\_dre | string | DRE code |
| conta\_receita | string | Revenue account |
| conta\_despesa | string | Expense account |
| conta\_inativa | string | Whether account is inactive |
| id\_conta\_contabil | string | Accounting account ID |
| tag\_conta\_contabil | string | Accounting account tag |
| definida\_pelo\_usuario | string | Whether defined by user |
| nao\_exibir | string | Whether to hide |
| totalizadora | string | Whether it's a totalizer |
| transferencia | string | Whether it's a transfer |
| dados\_dre.codigo\_dre | string | DRE code |
| dados\_dre.descricao\_dre | string | DRE description |
| dados\_dre.nao\_exibir\_dre | string | Whether to hide in DRE |
| dados\_dre.nivel\_dre | integer | DRE level |
| dados\_dre.sinal\_dre | string | DRE signal |
| dados\_dre.totaliza\_dre | string | Whether it totalizes in DRE |
Reference table containing checking account types (Tipos de Conta Corrente).
| Field | Type | Description |
| :----------- | :----- | :----------------------- |
| \_id | string | Unique identifier |
| c\_codigo | string | Account type code |
| c\_descricao | string | Account type description |
| c\_grupo | string | Account type group |
Reference table containing CNAE codes (Codigo Nacional de Atividades Economicas).
| Field | Type | Description |
| :----------- | :----- | :---------------- |
| \_id | string | Unique identifier |
| n\_codigo | string | CNAE code |
| c\_descricao | string | CNAE description |
| c\_estrutura | string | CNAE structure |
Reference table containing countries (Paises).
| Field | Type | Description |
| :------------- | :----- | :---------------- |
| \_id | string | Unique identifier |
| c\_codigo | string | Country code |
| c\_descricao | string | Country name |
| c\_codigo\_iso | string | ISO country code |
Reference table containing departmental organization structure.
| Field | Type | Description |
| :-------- | :----- | :--------------------------------- |
| codigo | string | Department code |
| descricao | string | Department description |
| estrutura | string | Department structure |
| inativo | string | Whether the department is inactive |
Reference table containing document types (Tipos de Documento).
| Field | Type | Description |
| :-------- | :----- | :------------------------ |
| \_id | string | Unique identifier |
| codigo | string | Document type code |
| descricao | string | Document type description |
Reference table containing DRE structure (Demonstracao do Resultado do Exercicio).
| Field | Type | Description |
| :--------------- | :------ | :----------------------------- |
| \_id | string | Unique identifier |
| codigo\_dre | string | DRE code |
| descricao\_dre | string | DRE description |
| nivel\_dre | integer | DRE level in hierarchy |
| sinal\_dre | string | DRE signal (positive/negative) |
| totaliza\_dre | string | Whether it totalizes in DRE |
| nao\_exibir\_dre | string | Whether to hide in DRE |
Reference table containing installment configurations (Parcelas).
| Field | Type | Description |
| :----------- | :------ | :---------------------- |
| \_id | string | Unique identifier |
| n\_codigo | string | Installment code |
| c\_descricao | string | Installment description |
| n\_parcelas | integer | Number of installments |
Reference table containing subscriber types (Tipos de Assinante).
| Field | Type | Description |
| :----------- | :----- | :-------------------------- |
| \_id | string | Unique identifier |
| c\_codigo | string | Subscriber type code |
| c\_descricao | string | Subscriber type description |
Reference table containing task types (Tipos de Tarefa).
| Field | Type | Description |
| :------------------- | :------ | :-------------------- |
| \_id | integer | Unique identifier |
| n\_cod\_tipo\_tarefa | integer | Task type code |
| c\_descricao | string | Task type description |
| c\_origem | string | Task type origin |
Reference table containing transaction origins (Origem de Lancamento).
| Field | Type | Description |
| :-------- | :----- | :----------------------------- |
| \_id | string | Unique identifier |
| codigo | string | Transaction origin code |
| descricao | string | Transaction origin description |
Reference table containing transfer purposes by bank (Finalidades de Transferencia).
| Field | Type | Description |
| :-------- | :----- | :----------------------------------------- |
| \_id | string | Unique identifier (bank\_code combination) |
| banco | string | Bank code |
| codigo | string | Transfer purpose code |
| descricao | string | Transfer purpose description |
### Users and Personnel
Stream containing general system users (Usuarios - Modulo Geral).
| Field | Type | Description |
| :-------------- | :------ | :---------------- |
| \_id | integer | Unique identifier |
| n\_cod\_usuario | integer | User code |
| c\_nome | string | User name |
| c\_nome\_compl | string | Full name |
| c\_email | string | User email |
Stream containing CRM user information.
| Field | Type | Description |
| :------------- | :------ | :------------ |
| n\_codigo | integer | User code |
| c\_nome | string | User name |
| c\_email | string | User email |
| n\_meta\_anual | number | Annual goal |
| c\_telefone | string | Phone number |
| c\_celular | string | Mobile number |
Stream containing seller/salesperson information.
| Field | Type | Description |
| :---------------- | :------ | :----------------------------- |
| codigo | integer | Seller code |
| cod\_int | string | Integration code |
| nome | string | Seller name |
| inativo | string | Whether the seller is inactive |
| email | string | Seller email |
| fatura\_pedido | string | Can invoice orders |
| visualiza\_pedido | string | Can view orders |
| comissao | number | Commission percentage |
### Clients and Companies
Stream containing customer and client information from your Omie account.
| Field | Type | Description |
| :------------------------------- | :------- | :------------------------- |
| codigo\_cliente\_omie | integer | Unique identifier in Omie |
| codigo\_cliente\_integracao | string | Integration identifier |
| razao\_social | string | Company name |
| nome\_fantasia | string | Trade name |
| cnpj\_cpf | string | Tax identification number |
| cnae | string | Economic activity code |
| email | string | Client email address |
| telefone1\_ddd | string | Primary phone DDD |
| telefone1\_numero | string | Primary phone number |
| telefone2\_ddd | string | Secondary phone DDD |
| telefone2\_numero | string | Secondary phone number |
| endereco | string | Street address |
| endereco\_numero | string | Street number |
| complemento | string | Address complement |
| bairro | string | Neighborhood |
| cidade | string | City |
| estado | string | State |
| cep | string | Postal code |
| codigo\_pais | string | Country code |
| pessoa\_fisica | string | Whether it's an individual |
| inativo | string | Whether inactive |
| exterior | string | Whether foreign |
| bloquear\_faturamento | string | Whether billing is blocked |
| inscricao\_estadual | string | State registration |
| inscricao\_municipal | string | Municipal registration |
| last\_updated\_at | datetime | Last update timestamp |
| dados\_bancarios.agencia | string | Bank branch |
| dados\_bancarios.cChavePix | string | PIX key |
| dados\_bancarios.codigo\_banco | string | Bank code |
| dados\_bancarios.conta\_corrente | string | Account number |
| dados\_bancarios.doc\_titular | string | Account holder document |
| dados\_bancarios.nome\_titular | string | Account holder name |
| dados\_bancarios.transf\_padrao | string | Default transfer flag |
| info.cImpAPI | string | API import flag |
| info.dAlt | string | Last modification date |
| info.hAlt | string | Last modification time |
| info.uAlt | string | Last modification user |
| info.dInc | string | Creation date |
| info.hInc | string | Creation time |
| info.uInc | string | Creation user |
| tags\[] | array | Client tags |
| recomendacoes.gerar\_boletos | string | Generate bank slips flag |
Stream containing company and organization information.
| Field | Type | Description |
| :-------------------------------------------- | :----- | :---------------------------------- |
| codigo\_empresa | string | Unique identifier |
| cnpj | string | Company tax ID |
| razao\_social | string | Legal name |
| nome\_fantasia | string | Trade name |
| endereco | string | Street address |
| endereco\_numero | string | Street number |
| complemento | string | Address complement |
| logradouro | string | Street type |
| bairro | string | Neighborhood |
| cidade | string | City |
| estado | string | State |
| cep | string | Postal code |
| codigo\_pais | string | Country code |
| email | string | Company email |
| website | string | Company website |
| telefone1\_ddd | string | Primary phone DDD |
| telefone1\_numero | string | Primary phone number |
| telefone2\_ddd | string | Secondary phone DDD |
| telefone2\_numero | string | Secondary phone number |
| fax\_ddd | string | Fax DDD |
| fax\_numero | string | Fax number |
| cnae | string | Economic activity code |
| cnae\_municipal | string | Municipal activity code |
| inscricao\_estadual | string | State registration |
| inscricao\_municipal | string | Municipal registration |
| inscricao\_suframa | string | SUFRAMA registration |
| inativa | string | Whether inactive |
| gera\_nfse | string | Whether generates NFSE |
| regime\_tributario | string | Tax regime |
| optante\_simples\_nacional | string | Simples Nacional flag |
| pdv\_sincr\_analitica | string | PDV analytical sync |
| csc\_homologacao | string | CSC homologation |
| csc\_id\_homologacao | string | CSC ID homologation |
| csc\_id\_producao | string | CSC ID production |
| csc\_producao | string | CSC production |
| ecd\_codigo\_cadastral | string | ECD cadastral code |
| ecd\_codigo\_instituicao\_responsavel | string | ECD responsible institution code |
| efd\_atividade\_industrial | string | EFD industrial activity |
| efd\_perfil\_arquivo\_fiscal | string | EFD fiscal file profile |
| sped\_codigo\_criterio\_escrituracao | string | SPED bookkeeping criteria code |
| sped\_codigo\_incidencia\_tributaria | string | SPED tax incidence code |
| sped\_codigo\_indicador\_apropriacao\_credito | string | SPED credit appropriation indicator |
| sped\_codigo\_tipo\_atividade | string | SPED activity type code |
| sped\_codigo\_tipo\_contribuicao | string | SPED contribution type code |
| sped\_cpf\_contador | string | SPED accountant CPF |
| sped\_crc\_contador | string | SPED accountant CRC |
| sped\_email\_contador | string | SPED accountant email |
| sped\_junta\_comercial | string | SPED commercial board |
| sped\_matriz | string | SPED headquarters |
| sped\_natureza\_pessoa\_juridica | string | SPED legal entity nature |
| sped\_nome\_contador | string | SPED accountant name |
| sped\_registro\_junta\_comercial | string | SPED commercial board registration |
| sped\_usa\_contabilidade\_terceirizada | string | SPED outsourced accounting |
Stream containing project information for tracking and management.
| Field | Type | Description |
| :---------------- | :------- | :--------------------- |
| codigo | integer | Unique identifier |
| cod\_int | string | Integration code |
| nome | string | Project name |
| inativo | string | Whether inactive |
| last\_updated\_at | datetime | Last update timestamp |
| info.data\_alt | string | Last modification date |
| info.hora\_alt | string | Last modification time |
| info.user\_alt | string | Last modification user |
| info.data\_inc | string | Creation date |
| info.hora\_inc | string | Creation time |
| info.user\_inc | string | Creation user |
### Financial Management
Stream containing bank account information and configurations.
| Field | Type | Description |
| :---------------------- | :------- | :--------------------------- |
| n\_cod\_cc | integer | Unique identifier |
| c\_cod\_cc\_int | string | Integration code |
| descricao | string | Account description |
| codigo\_banco | string | Bank code |
| codigo\_agencia | string | Branch code |
| numero\_conta\_corrente | string | Account number |
| numero | string | Account number (alternative) |
| tipo | string | Account type |
| tipo\_conta\_corrente | string | Checking account type |
| modalidade | string | Account modality |
| bloqueado | string | Whether blocked |
| inativo | string | Whether inactive |
| saldo\_inicial | number | Initial balance |
| saldo\_data | string | Balance date |
| valor\_limite | number | Credit limit |
| endereco | string | Address |
| complemento | string | Complement |
| bairro | string | Neighborhood |
| cidade | string | City |
| estado | string | State |
| cep | string | Postal code |
| codigo\_pais | string | Country code |
| email | string | Account email |
| ddd | string | Phone DDD |
| telefone | string | Phone number |
| nome\_gerente | string | Manager name |
| observacao | string | Observations |
| nao\_fluxo | string | Exclude from cash flow |
| nao\_resumo | string | Exclude from summary |
| importado\_api | string | Imported via API |
| data\_alt | string | Last modification date |
| hora\_alt | string | Last modification time |
| user\_alt | string | Last modification user |
| data\_inc | string | Creation date |
| hora\_inc | string | Creation time |
| user\_inc | string | Creation user |
| bol\_sn | string | Whether generates bank slips |
| bol\_instr1 | string | Bank slip instruction 1 |
| bol\_instr2 | string | Bank slip instruction 2 |
| bol\_instr3 | string | Bank slip instruction 3 |
| bol\_instr4 | string | Bank slip instruction 4 |
| cancinstr | string | Cancellation instructions |
| cobr\_sn | string | Whether generates collection |
| cobr\_esp | string | Collection specification |
| cnab\_esp | string | CNAB specification |
| dias\_rcomp | integer | Days for recomposition |
| per\_juros | number | Interest percentage |
| per\_multa | number | Fine percentage |
| pix\_sn | string | Whether PIX is enabled |
| c\_estabelecimento | string | Establishment |
| pdv\_bandeira | string | PDV card brand |
| pdv\_categoria | string | PDV category |
| pdv\_cod\_adm | integer | PDV admin code |
| pdv\_dias\_venc | integer | PDV days to due |
| pdv\_enviar | string | PDV send flag |
| pdv\_limite\_pacelas | integer | PDV installment limit |
| pdv\_num\_parcelas | integer | PDV number of installments |
| pdv\_sincr\_analitica | string | PDV analytical sync |
| pdv\_taxa\_adm | number | PDV admin fee |
| pdv\_taxa\_loja | number | PDV store fee |
| pdv\_tipo\_tef | integer | PDV TEF type |
| last\_updated\_at | datetime | Last update timestamp |
Stream containing account balance information and statements.
| Field | Type | Description |
| :---------------------------------------- | :------- | :----------------------- |
| account\_id | integer | Parent account ID |
| n\_cod\_cc | integer | Checking account code |
| c\_cod\_int\_cc | string | Integration account code |
| n\_cod\_agencia | string | Branch code |
| n\_cod\_banco | string | Bank code |
| n\_num\_conta | string | Account number |
| c\_descricao | string | Account description |
| c\_cod\_tipo | string | Account type code |
| c\_des\_tipo | string | Account type description |
| c\_fluxo\_caixa | string | Cash flow flag |
| c\_resumo\_executivo | string | Executive summary flag |
| d\_periodo\_inicial | datetime | Start date of the period |
| d\_periodo\_final | datetime | End date of the period |
| n\_saldo\_anterior | number | Previous balance |
| n\_saldo\_atual | number | Current balance |
| n\_saldo\_conciliado | number | Reconciled balance |
| n\_saldo\_provisorio | number | Provisional balance |
| n\_limite\_credito\_total | number | Total credit limit |
| n\_saldo\_disponivel | number | Available balance |
| lista\_movimentos\[].n\_cod\_lancamento | integer | Transaction code |
| lista\_movimentos\[].n\_cod\_lanc\_relac | integer | Related transaction code |
| lista\_movimentos\[].c\_situacao | string | Situation |
| lista\_movimentos\[].d\_data\_lancamento | string | Transaction date |
| lista\_movimentos\[].c\_des\_cliente | string | Client description |
| lista\_movimentos\[].c\_tipo\_documento | string | Document type |
| lista\_movimentos\[].c\_numero | string | Document number |
| lista\_movimentos\[].n\_valor\_documento | number | Document value |
| lista\_movimentos\[].n\_saldo | number | Balance |
| lista\_movimentos\[].c\_cod\_categoria | string | Category code |
| lista\_movimentos\[].c\_des\_categoria | string | Category description |
| lista\_movimentos\[].c\_documento\_fiscal | string | Fiscal document |
| lista\_movimentos\[].c\_parcela | string | Installment |
| lista\_movimentos\[].c\_nosso\_numero | string | Our number |
| lista\_movimentos\[].c\_origem | string | Origin |
| lista\_movimentos\[].c\_vendedor | string | Salesperson |
| lista\_movimentos\[].c\_projeto | string | Project |
| lista\_movimentos\[].n\_cod\_cliente | integer | Client code |
| lista\_movimentos\[].c\_raz\_cliente | string | Client name |
| lista\_movimentos\[].c\_doc\_cliente | string | Client document |
| lista\_movimentos\[].c\_observacoes | string | Observations |
| lista\_movimentos\[].c\_data\_inclusao | string | Creation date |
| lista\_movimentos\[].c\_hora\_inclusao | string | Creation time |
| lista\_movimentos\[].c\_natureza | string | Nature (R/P) |
| lista\_movimentos\[].c\_bloqueado | string | Whether blocked |
| lista\_movimentos\[].d\_data\_conciliacao | string | Reconciliation date |
Stream containing a summary list of checking accounts (ListarResumoContasCorrentes).
| Field | Type | Description |
| :------------------ | :------ | :---------------------------------- |
| \_id | string | Unique identifier (from n\_cod\_cc) |
| n\_cod\_cc | integer | Checking account code |
| c\_cod\_cc\_int | string | Integration code |
| descricao | string | Account description |
| codigo\_banco | string | Bank code |
| codigo\_agencia | string | Branch code |
| conta\_corrente | string | Account number |
| nome\_gerente | string | Manager name |
| tipo | string | Account type |
| tipo\_comunicacao | string | Communication type |
| c\_sincr\_analitica | string | Analytical sync flag |
| n\_tp\_tef | integer | TEF type |
| n\_taxa\_adm | number | Admin fee |
| n\_dias\_venc | integer | Days to due |
| n\_num\_parc | integer | Number of installments |
| n\_cod\_adm | integer | Admin code |
| c\_util\_pdv | string | PDV usage flag |
| c\_categoria | string | Category |
| c\_modalidade | string | Modality |
| saldo\_inicial | number | Initial balance |
| saldo\_data | string | Balance date |
| valor\_limite | number | Credit limit |
| c\_tipo\_cartao | string | Card type |
Stream containing account transfer and transaction information.
| Field | Type | Description |
| :-------------------------------- | :------- | :-------------------------- |
| n\_cod\_lanc | integer | Unique identifier |
| c\_cod\_int\_lanc | string | Integration code |
| n\_cod\_agrup | integer | Group code |
| last\_updated\_at | datetime | Last update timestamp |
| cabecalho.d\_dt\_lanc | string | Transaction date |
| cabecalho.n\_cod\_cc | integer | Checking account code |
| cabecalho.n\_valor\_lanc | number | Transaction value |
| departamentos\[].c\_cod\_dep | string | Department code |
| departamentos\[].n\_per\_dep | number | Department percentage |
| departamentos\[].n\_val\_dep | number | Department value |
| detalhes.a\_cod\_categ\[] | array | Category distribution |
| detalhes.c\_cod\_categ | string | Category code |
| detalhes.c\_num\_doc | string | Document number |
| detalhes.c\_obs | string | Observations |
| detalhes.c\_tipo | string | Transaction type |
| detalhes.n\_cod\_cliente | integer | Client code |
| detalhes.n\_cod\_projeto | integer | Project code |
| diversos.c\_hr\_conc | string | Reconciliation time |
| diversos.c\_ident\_lanc | string | Transaction identifier |
| diversos.c\_natureza | string | Transaction nature |
| diversos.c\_origem | string | Origin |
| diversos.c\_us\_conc | string | Reconciliation user |
| diversos.d\_dt\_conc | string | Reconciliation date |
| diversos.n\_cod\_comprador | integer | Buyer code |
| diversos.n\_cod\_vendedor | integer | Seller code |
| diversos.n\_cod\_lanc\_cr | integer | Receivable transaction code |
| diversos.n\_cod\_lanc\_cp | integer | Payable transaction code |
| info.c\_imp\_api | string | API import flag |
| info.d\_alt | string | Last modification date |
| info.h\_alt | string | Last modification time |
| info.u\_alt | string | Last modification user |
| info.d\_inc | string | Creation date |
| info.h\_inc | string | Creation time |
| info.u\_inc | string | Creation user |
| transferencia.n\_cod\_cc\_destino | integer | Destination account code |
Stream containing accounts payable and bill information.
| Field | Type | Description |
| :-------------------------------------------------------- | :------- | :---------------------------- |
| codigo\_lancamento\_omie | integer | Unique identifier |
| codigo\_lancamento\_integracao | string | Integration code |
| codigo\_cliente\_fornecedor | integer | Supplier code |
| codigo\_cliente\_fornecedor\_integracao | string | Supplier integration code |
| data\_vencimento | string | Due date |
| data\_previsao | string | Forecast date |
| data\_emissao | string | Issue date |
| data\_entrada | string | Entry date |
| valor\_documento | number | Document value |
| codigo\_categoria | string | Category code |
| id\_conta\_corrente | integer | Checking account ID |
| id\_conta\_corrente\_integracao | string | Account integration code |
| numero\_documento\_fiscal | string | Fiscal document number |
| numero\_documento | string | Document number |
| numero\_parcela | string | Installment number |
| numero\_pedido | string | Order number |
| codigo\_projeto | integer | Project code |
| codigo\_vendedor | integer | Seller code |
| codigo\_tipo\_documento | string | Document type code |
| chave\_nfe | string | NFe key |
| codigo\_barras\_ficha\_compensacao | string | Compensation slip barcode |
| codigo\_cmc7\_cheque | string | Check CMC7 code |
| observacao | string | Observations |
| operacao | string | Operation |
| status\_titulo | string | Title status |
| nsu | string | NSU |
| acao | string | Action |
| bloqueado | string | Whether blocked |
| baixa\_bloqueada | string | Whether settlement is blocked |
| importado\_api | string | Imported via API |
| bloquear\_exclusao | string | Block deletion |
| id\_origem | string | Origin ID |
| valor\_pag | number | Payment value |
| aprendizado\_rateio | string | Apportionment learning |
| data\_alt | string | Last modification date |
| hora\_alt | string | Last modification time |
| valor\_pis | number | PIS value |
| retem\_pis | string | PIS retention |
| valor\_cofins | number | COFINS value |
| retem\_cofins | string | COFINS retention |
| valor\_csll | number | CSLL value |
| retem\_csll | string | CSLL retention |
| valor\_ir | number | IR value |
| retem\_ir | string | IR retention |
| valor\_iss | number | ISS value |
| retem\_iss | string | ISS retention |
| valor\_inss | number | INSS value |
| retem\_inss | string | INSS retention |
| last\_updated\_at | datetime | Last update timestamp |
| categorias\[] | array | Category breakdown |
| distribuicao\[] | array | Department distribution |
| info.d\_inc | string | Creation date |
| info.h\_inc | string | Creation time |
| info.u\_inc | string | Creation user |
| info.d\_alt | string | Last modification date |
| info.h\_alt | string | Last modification time |
| info.u\_alt | string | Last modification user |
| info.c\_imp\_api | string | API import flag |
| cnab\_integracao\_bancaria.codigo\_forma\_pagamento | string | Payment method code |
| cnab\_integracao\_bancaria.banco\_transferencia | string | Transfer bank |
| cnab\_integracao\_bancaria.agencia\_transferencia | string | Transfer branch |
| cnab\_integracao\_bancaria.conta\_corrente\_transferencia | string | Transfer account |
| cnab\_integracao\_bancaria.finalidade\_transferencia | string | Transfer purpose |
| cnab\_integracao\_bancaria.cpf\_cnpj\_transferencia | string | Transfer CPF/CNPJ |
| cnab\_integracao\_bancaria.nome\_transferencia | string | Transfer name |
| cnab\_integracao\_bancaria.codigo\_barras\_boleto | string | Boleto barcode |
| cnab\_integracao\_bancaria.juros\_boleto | number | Boleto interest |
| cnab\_integracao\_bancaria.multa\_boleto | number | Boleto fine |
| cnab\_integracao\_bancaria.pix\_qrcode | string | PIX QR code |
| servico\_tomado.numero\_nf | string | Invoice number |
| servico\_tomado.serie\_nf | string | Invoice series |
| servico\_tomado.codigo\_servico | string | Service code |
| servico\_tomado.valor\_nf | number | Invoice value |
Child stream of Bills containing file attachments associated with accounts payable.
| Field | Type | Description |
| :----------------- | :------- | :--------------------- |
| n\_id\_anexo | integer | Unique identifier |
| c\_cod\_int\_anexo | string | Integration code |
| c\_tipo\_arquivo | string | File type |
| n\_id | string | Parent bill ID |
| c\_nome\_arquivo | string | File name |
| c\_tabela | string | Source table reference |
| last\_updated\_at | datetime | Last update timestamp |
| info.d\_inc | string | Creation date |
| info.h\_inc | string | Creation time |
| info.u\_inc | string | Creation user |
| info.d\_alt | string | Last modification date |
| info.h\_alt | string | Last modification time |
| info.u\_alt | string | Last modification user |
| info.c\_imp\_api | string | API import flag |
Stream containing accounts receivable information.
| Field | Type | Description |
| :-------------------------------------- | :------- | :--------------------------------- |
| codigo\_lancamento\_omie | integer | Unique identifier |
| codigo\_lancamento\_integracao | string | Integration code |
| codigo\_cliente\_fornecedor | integer | Client code |
| codigo\_cliente\_fornecedor\_integracao | string | Client integration code |
| data\_vencimento | string | Due date |
| valor\_documento | number | Document value |
| codigo\_categoria | string | Category code |
| data\_previsao | string | Forecast date |
| data\_emissao | string | Issue date |
| data\_registro | string | Registration date |
| id\_conta\_corrente | integer | Checking account ID |
| numero\_documento | string | Document number |
| numero\_parcela | string | Installment number |
| codigo\_tipo\_documento | string | Document type code |
| numero\_documento\_fiscal | string | Fiscal document number |
| numero\_pedido | string | Order number |
| chave\_nfe | string | NFe key |
| codigo\_barras\_ficha\_compensacao | string | Compensation slip barcode |
| codigo\_cmc7\_cheque | string | Check CMC7 code |
| observacao | string | Observations |
| id\_origem | string | Origin ID |
| operacao | string | Operation |
| codigo\_vendedor | integer | Seller code |
| codigo\_projeto | integer | Project code |
| codigo\_pedido | integer | Order code |
| codigo\_os | integer | Service order code |
| pedido\_cliente | string | Client order |
| numero\_contrato | string | Contract number |
| nsu | string | NSU |
| status\_titulo | string | Title status |
| tipo\_agrupamento | string | Grouping type |
| bloqueado | string | Whether blocked |
| bloquear\_baixa | string | Block settlement |
| importado\_api | string | Imported via API |
| baixar\_documento | string | Settle document |
| conciliar\_documento | string | Reconcile document |
| bloquear\_exclusao | string | Block deletion |
| acao | string | Action |
| aprendizado\_rateio | string | Apportionment learning |
| last\_updated\_at | datetime | Last update timestamp |
| valor\_pis | number | PIS value |
| retem\_pis | string | PIS retention |
| valor\_cofins | number | COFINS value |
| retem\_cofins | string | COFINS retention |
| valor\_csll | number | CSLL value |
| retem\_csll | string | CSLL retention |
| valor\_ir | number | IR value |
| retem\_ir | string | IR retention |
| valor\_iss | number | ISS value |
| retem\_iss | string | ISS retention |
| valor\_inss | number | INSS value |
| retem\_inss | string | INSS retention |
| categorias\[] | array | Category breakdown |
| lancamento\_detalhe\[] | array | Transaction details |
| distribuicao\[] | array | Department distribution |
| info | object | Creation and modification metadata |
| boleto | object | Bank slip information |
| recebimento | object | Payment information |
| repeticao | object | Recurrence settings |
Stream containing financial titles with detailed payment information.
| Field | Type | Description |
| :---------------------------------- | :------- | :--------------------------------- |
| \_id | integer | Unique identifier (n\_cod\_titulo) |
| last\_updated\_at | datetime | Last update timestamp |
| cabec\_titulo.n\_cod\_titulo | integer | Title code |
| cabec\_titulo.c\_cod\_int\_titulo | string | Integration title code |
| cabec\_titulo.c\_num\_titulo | string | Title number |
| cabec\_titulo.d\_dt\_emissao | string | Issue date |
| cabec\_titulo.d\_dt\_venc | string | Due date |
| cabec\_titulo.d\_dt\_previsao | string | Forecast date |
| cabec\_titulo.d\_dt\_pagamento | string | Payment date |
| cabec\_titulo.d\_dt\_canc | string | Cancellation date |
| cabec\_titulo.n\_cod\_cliente | integer | Client code |
| cabec\_titulo.c\_cpfcnpj\_cliente | string | Client tax ID |
| cabec\_titulo.n\_cod\_ctr | integer | Contract code |
| cabec\_titulo.c\_num\_ctr | string | Contract number |
| cabec\_titulo.n\_cod\_os | integer | Service order code |
| cabec\_titulo.c\_num\_os | string | Service order number |
| cabec\_titulo.n\_cod\_cc | integer | Checking account code |
| cabec\_titulo.c\_cod\_int\_cc | string | Integration account code |
| cabec\_titulo.n\_cod\_banco | integer | Bank code |
| cabec\_titulo.c\_cod\_agencia | string | Branch code |
| cabec\_titulo.c\_num\_conta | string | Account number |
| cabec\_titulo.c\_num\_titulo\_banco | string | Bank title number |
| cabec\_titulo.c\_num\_boleto | string | Bank slip number |
| cabec\_titulo.n\_cod\_nf | integer | Invoice code |
| cabec\_titulo.n\_valor\_titulo | number | Title value |
| cabec\_titulo.n\_saldo | number | Balance |
| cabec\_titulo.n\_percentual | number | Percentage |
| cabec\_titulo.n\_valor\_fixo | string | Fixed value flag |
| cabec\_titulo.n\_cod\_projeto | integer | Project code |
| cabec\_titulo.n\_cod\_vendedor | integer | Seller code |
| cabec\_titulo.n\_cod\_comprador | integer | Buyer code |
| cabec\_titulo.c\_cod\_categ | string | Category code |
| cabec\_titulo.c\_tipo | string | Type |
| cabec\_titulo.c\_status | string | Status |
| cabec\_titulo.c\_natureza | string | Nature (R=Receivable, P=Payable) |
| cabec\_titulo.c\_operacao | string | Operation |
| cabec\_titulo.c\_num\_doc\_fiscal | string | Fiscal document number |
| cabec\_titulo.c\_codigo\_barras | string | Barcode |
| cabec\_titulo.c\_chave\_nfe | string | NFe key |
| cabec\_titulo.c\_obs | string | Observations |
| cabec\_titulo.c\_cod\_venc | string | Due code |
| cabec\_titulo.n\_parcela | integer | Installment number |
| cabec\_titulo.n\_tot\_parc | integer | Total installments |
| cabec\_titulo.c\_origem | string | Origin |
| cabec\_titulo.c\_ret\_cofins | string | COFINS retention |
| cabec\_titulo.c\_ret\_csll | string | CSLL retention |
| cabec\_titulo.c\_ret\_inss | string | INSS retention |
| cabec\_titulo.c\_ret\_ir | string | IR retention |
| cabec\_titulo.c\_ret\_iss | string | ISS retention |
| cabec\_titulo.c\_ret\_pis | string | PIS retention |
| cabec\_titulo.n\_valor\_cofins | number | COFINS value |
| cabec\_titulo.n\_valor\_csll | number | CSLL value |
| cabec\_titulo.n\_valor\_inss | number | INSS value |
| cabec\_titulo.n\_valor\_ir | number | IR value |
| cabec\_titulo.n\_valor\_iss | number | ISS value |
| cabec\_titulo.n\_valor\_pis | number | PIS value |
| lancamentos\[] | array | Payment entries |
| resumo.c\_liquidado | string | Whether settled |
| resumo.n\_val\_pago | number | Paid amount |
| resumo.n\_val\_aberto | number | Open amount |
| resumo.n\_desconto | number | Discount |
| resumo.n\_juros | number | Interest |
| resumo.n\_multa | number | Fine |
| resumo.n\_val\_liquido | number | Net value |
| departamentos\[] | array | Department distribution |
| categorias\[] | array | Category distribution |
Stream containing deleted financial titles (PesquisarExcluidos).
| Field | Type | Description |
| :-------------- | :------- | :------------------------------------ |
| deleted\_at | datetime | Timestamp when the title was deleted. |
| n\_cod\_titulo | integer | Internal code of the deleted title. |
| d\_data\_exc | string | Deletion date (DD/MM/YYYY). |
| c\_hora\_exc | string | Deletion time (HH:mm:ss). |
| c\_usuario\_exc | string | User who deleted the title. |
| c\_acao | string | Action type (e.g. 'E' for excluded). |
Stream containing comprehensive financial movement data.
| Field | Type | Description |
| :---------------------------- | :------- | :------------------------------- |
| detalhes\_n\_cod\_titulo | integer | Financial title ID |
| detalhes\_c\_grupo | string | Financial group |
| detalhes\_c\_cpfcnpj\_cliente | string | Client tax ID |
| detalhes\_c\_cod\_categ | string | Category code |
| detalhes\_c\_natureza | string | Nature (R=Receivable, P=Payable) |
| detalhes\_c\_operacao | string | Operation type |
| detalhes\_c\_status | string | Status |
| detalhes\_c\_tipo | string | Transaction type |
| detalhes\_c\_origem | string | Origin |
| detalhes\_n\_valor\_titulo | number | Value |
| detalhes\_d\_dt\_venc | string | Due date |
| detalhes\_d\_dt\_emissao | string | Issue date |
| detalhes\_d\_dt\_previsao | string | Forecast date |
| detalhes\_d\_dt\_pagamento | string | Payment date |
| detalhes\_d\_dt\_registro | string | Registration date |
| detalhes\_d\_dt\_credito | string | Credit date |
| detalhes\_n\_cod\_cc | integer | Checking account code |
| detalhes\_n\_cod\_cliente | integer | Client code |
| detalhes\_n\_cod\_titulo | integer | Title code |
| detalhes\_c\_num\_titulo | string | Title number |
| detalhes\_c\_num\_boleto | string | Bank slip number |
| detalhes\_c\_num\_doc\_fiscal | string | Fiscal document number |
| detalhes\_c\_codigo\_barras | string | Barcode |
| detalhes\_c\_num\_parcela | string | Installment number |
| detalhes\_c\_num\_ctr | string | Contract number |
| detalhes\_n\_cod\_ctr | integer | Contract code |
| detalhes\_c\_num\_os | string | Service order number |
| detalhes\_n\_cod\_os | integer | Service order code |
| detalhes\_n\_cod\_nf | integer | Invoice code |
| detalhes\_c\_cod\_projeto | integer | Project code |
| detalhes\_observacao | string | Observations |
| detalhes\_c\_ret\_ir | string | IR retention |
| detalhes\_c\_ret\_iss | string | ISS retention |
| detalhes\_c\_ret\_inss | string | INSS retention |
| detalhes\_c\_ret\_pis | string | PIS retention |
| detalhes\_c\_ret\_cofins | string | COFINS retention |
| detalhes\_c\_ret\_csll | string | CSLL retention |
| detalhes\_n\_valor\_ir | number | IR value |
| detalhes\_n\_valor\_iss | number | ISS value |
| detalhes\_n\_valor\_inss | number | INSS value |
| detalhes\_n\_valor\_pis | number | PIS value |
| detalhes\_n\_valor\_cofins | number | COFINS value |
| detalhes\_n\_valor\_csll | number | CSLL value |
| detalhes\_n\_desconto | number | Discount |
| detalhes\_n\_multa | number | Fine |
| detalhes\_n\_juros | number | Interest |
| detalhes\_n\_valor\_mov\_cc | number | Account movement value |
| resumo\_c\_liquidado | string | Whether settled |
| resumo\_n\_val\_aberto | number | Open amount |
| resumo\_n\_val\_liquido | number | Net amount |
| resumo\_n\_val\_pago | number | Paid amount |
| resumo\_n\_desconto | number | Total discount |
| resumo\_n\_juros | number | Total interest |
| resumo\_n\_multa | number | Total fine |
| departamentos\[] | array | Department distribution |
| categorias\[] | array | Category distribution |
| last\_updated\_at | datetime | Last update timestamp |
Stream containing financial summary by day.
| Field | Type | Description |
| :--------------------------------- | :------- | :--------------------- |
| d\_dia | datetime | Date |
| conta\_corrente.c\_cor | string | Color |
| conta\_corrente.c\_icone | string | Icon |
| conta\_corrente.v\_limite\_credito | number | Credit limit |
| conta\_corrente.v\_total | number | Total value |
| conta\_pagar.c\_cor | string | Color |
| conta\_pagar.c\_icone | string | Icon |
| conta\_pagar.n\_total | number | Total count |
| conta\_pagar.v\_atraso | number | Overdue amount |
| conta\_pagar.v\_total | number | Total amount |
| conta\_receber.c\_cor | string | Color |
| conta\_receber.c\_icone | string | Icon |
| conta\_receber.n\_total | number | Total count |
| conta\_receber.v\_atraso | number | Overdue amount |
| conta\_receber.v\_total | number | Total amount |
| conta\_pagar\_categoria\[] | array | Payable by category |
| conta\_receber\_categoria\[] | array | Receivable by category |
| conta\_pagar\_atraso\[] | array | Overdue payables |
| conta\_receber\_atraso\[] | array | Overdue receivables |
| fluxo\_caixa\[].d\_dia | string | Date |
| fluxo\_caixa\[].v\_pagar | number | Amount to pay |
| fluxo\_caixa\[].v\_receber | number | Amount to receive |
| fluxo\_caixa\[].v\_saldo | number | Balance |
Stream containing quote and budget information by month.
| Field | Type | Description |
| :--------------------------------------- | :------- | :------------------- |
| n\_ano | integer | Year |
| n\_mes | integer | Month |
| n\_mes\_ano | datetime | Month-year date |
| lista\_orcamentos\[].c\_cod\_categ | string | Category code |
| lista\_orcamentos\[].c\_des\_categ | string | Category description |
| lista\_orcamentos\[].n\_valor\_previsto | number | Forecasted value |
| lista\_orcamentos\[].n\_valor\_realizado | number | Realized value |
Stream containing PIX payment information.
| Field | Type | Description |
| :---------------- | :------- | :-------------------- |
| \_id | integer | Unique identifier |
| n\_id\_pix | integer | PIX ID |
| c\_cod\_int\_pix | string | Integration code |
| c\_cliente | integer | Client code |
| n\_cod\_titulo | integer | Title code |
| v\_valor | number | Value |
| d\_emissao | string | Issue date |
| d\_vencimento | string | Due date |
| c\_url\_pix | string | PIX URL |
| c\_copia\_cola | string | PIX copy-paste code |
| c\_status | string | Status |
| last\_updated\_at | datetime | Last update timestamp |
| c\_info.d\_inc | string | Creation date |
| c\_info.h\_inc | string | Creation time |
| c\_info.u\_inc | string | Creation user |
| c\_info.d\_alt | string | Modification date |
| c\_info.h\_alt | string | Modification time |
| c\_info.u\_alt | string | Modification user |
### Tasks
Stream containing tasks (Tarefas).
| Field | Type | Description |
| :-------------------- | :------- | :----------------------- |
| \_id | integer | Unique identifier |
| n\_cod\_tarefa | integer | Task code |
| c\_cod\_int\_tarefa | string | Integration code |
| c\_origem | string | Task origin |
| n\_cod\_doc | integer | Document code |
| c\_desc\_doc | string | Document description |
| c\_descricao | string | Task description |
| d\_data | string | Task date |
| h\_hora | string | Task time |
| c\_importante | string | Whether important |
| c\_urgente | string | Whether urgent |
| n\_cod\_situacao | integer | Situation code |
| c\_situacao | string | Situation description |
| n\_cod\_tipo\_tarefa | integer | Task type code |
| c\_desc\_tipo\_tarefa | string | Task type description |
| n\_cod\_notif | integer | Notification code |
| c\_desc\_notif | string | Notification description |
| n\_cod\_user\_atb | integer | Assigned user code |
| c\_nome\_user\_atb | string | Assigned user name |
| c\_desc\_origem | string | Origin description |
| last\_updated\_at | datetime | Last update timestamp |
### Products and suppliers
Stream containing a summary list of registered products (ListarProdutosResumido).
| Field | Type | Description |
| :-------------------------- | :------ | :--------------------------------------- |
| \_id | string | Unique identifier (from codigo\_produto) |
| codigo\_produto | integer | Product code |
| codigo\_produto\_integracao | string | Integration code |
| codigo | string | Product reference code |
| descricao | string | Product description |
| valor\_unitario | number | Unit price |
Stream containing products per supplier (ListarProdutoFornecedor — produtos por fornecedor).
| Field | Type | Description |
| :---------------- | :------ | :-------------------------------------------------------------------------- |
| \_id | string | Unique identifier (from n\_cod\_forn) |
| n\_cod\_forn | integer | Supplier code |
| c\_cod\_int\_forn | string | Supplier integration code |
| c\_cpf\_cnpj | string | Supplier tax ID (CPF/CNPJ) |
| c\_razao\_social | string | Supplier legal name |
| c\_nome\_fantasia | string | Supplier trade name |
| produtos | array | List of products (n\_cod\_prod, c\_cod\_int\_prod, c\_codigo, c\_descricao) |
### Orders and Services
Stream containing sales orders (Pedidos de Venda).
| Field | Type | Description |
| :----------------------------------- | :------- | :--------------------------------- |
| \_id | integer | Unique identifier (codigo\_pedido) |
| last\_updated\_at | datetime | Last update timestamp |
| **cabecalho** | object | Order header |
| cabecalho.codigo\_pedido | integer | Order code |
| cabecalho.codigo\_pedido\_integracao | string | Integration order code |
| cabecalho.codigo\_cliente | integer | Client code |
| cabecalho.numero\_pedido | string | Order number |
| cabecalho.data\_previsao | string | Delivery forecast date |
| cabecalho.etapa | string | Order stage |
| cabecalho.quantidade\_itens | integer | Number of items |
| cabecalho.codigo\_parcela | string | Installment code |
| cabecalho.codigo\_cenario\_impostos | string | Tax scenario code |
| cabecalho.codigo\_empresa | integer | Company code |
| cabecalho.sequencial | string | Sequential number |
| cabecalho.bloqueado | string | Whether blocked |
| cabecalho.importado\_api | string | Imported via API |
| cabecalho.origem\_pedido | string | Order origin |
| cabecalho.qtde\_parcelas | integer | Number of installments |
| cabecalho.encerrado | string | Whether closed |
| cabecalho.enc\_data | string | Closing date |
| cabecalho.enc\_hora | string | Closing time |
| cabecalho.enc\_motivo | string | Closing reason |
| cabecalho.enc\_user | string | Closing user |
| **det\[]** | array | Order item details |
| det\[].ide.codigo\_item | integer | Item code |
| det\[].ide.codigo\_item\_integracao | string | Integration item code |
| det\[].ide.simples\_nacional | string | Simples Nacional flag |
| det\[].produto.codigo\_produto | integer | Product code |
| det\[].produto.codigo | string | Product reference code |
| det\[].produto.descricao | string | Product description |
| det\[].produto.cfop | string | CFOP code |
| det\[].produto.ncm | string | NCM code |
| det\[].produto.ean | string | EAN code |