Oobj Knowledge Base

https://oobj.com.br/bc
Admin
Oobj Knowledge Base is a comprehensive documentation platform for Brazil's electronic fiscal...
Tokens:3,991,786
Snippets:43,566
Trust Score:9.1
Update:6 months ago
Show doc for...
Tokens:
Raw
### Oobj DF-e Client - Installation

Source: https://oobj.com.br/bc/servico-postgresql-suspenso-como-resolver

Instructions for installing the Oobj DF-e Client on Windows servers.

```APIDOC
## POST /oobj/dfe/client/install

### Description
Initiates the installation process for the Oobj DF-e Client on a Windows server.

### Method
POST

### Endpoint
/oobj/dfe/client/install

### Parameters
#### Request Body
- **serverPath** (string) - Required - The target directory path for installation on the Windows server.
- **logLevel** (string) - Optional - Sets the logging level for the installation process (e.g., 'INFO', 'DEBUG').

### Request Example
```json
{
  "serverPath": "C:\\Oobj\\DFEClient",
  "logLevel": "INFO"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the installation process has started.
- **installationId** (string) - A unique identifier for the installation task.

#### Response Example
```json
{
  "message": "Oobj DF-e Client installation initiated successfully.",
  "installationId": "inst-12345abcde"
}
```
```

--------------------------------

### Oobj DF-e Client - Integration Setup

Source: https://oobj.com.br/bc/servico-postgresql-suspenso-como-resolver

Documentation for setting up different integration methods for the Oobj DF-e Client.

```APIDOC
## POST /oobj/dfe/client/integration/setup

### Description
Configures a specific integration method for the Oobj DF-e Client.

### Method
POST

### Endpoint
/oobj/dfe/client/integration/setup

### Parameters
#### Request Body
- **integrationType** (string) - Required - The type of integration to set up (e.g., 'DLL', 'HTTP', 'File').
- **configurationDetails** (object) - Required - An object containing specific details for the chosen integration type.

### Request Example
```json
{
  "integrationType": "HTTP",
  "configurationDetails": {
    "url": "https://api.oobj.com.br/v1/emit",
    "apiKey": "YOUR_API_KEY"
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the integration setup is complete.

#### Response Example
```json
{
  "message": "HTTP integration configured successfully."
}
```
```

--------------------------------

### Simplified Tax Regime Configuration Example

Source: https://oobj.com.br/bc/simples-nacional-modelos-hibridos

This snippet demonstrates a JSON structure for configuring tax entities, specifying the tax regime as 'simplified' and detailing tax settings for CBS and IBS credits.

```json
"entity": {
  "taxRegime": "simplified",
  "taxesSettings": {
    "pCredCBSSN": 3.0,
    "pCredIBSSN": 2.1
  }
}
```

--------------------------------

### Oobj DF-e Client - Configuration

Source: https://oobj.com.br/bc/servico-postgresql-suspenso-como-resolver

Guides on configuring various aspects of the Oobj DF-e Client, including integrations and settings.

```APIDOC
## PUT /oobj/dfe/client/configure

### Description
Updates the configuration settings for the Oobj DF-e Client.

### Method
PUT

### Endpoint
/oobj/dfe/client/configure

### Parameters
#### Request Body
- **settingName** (string) - Required - The name of the configuration setting to update.
- **settingValue** (string) - Required - The new value for the configuration setting.

### Request Example
```json
{
  "settingName": "logomarcaPath",
  "settingValue": "C:\\Oobj\\Images\\logo.png"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the setting has been updated.

#### Response Example
```json
{
  "message": "Configuration setting 'logomarcaPath' updated successfully."
}
```
```

--------------------------------

### Oobj DF-e Client - Installation and Setup

Source: https://oobj.com.br/bc/rejeicao-557-como-resolver

Guides for installing and configuring the Oobj DF-e Client and its related components.

```APIDOC
## Oobj DF-e Client Installation and Configuration

### Description
This section covers the installation and initial setup of the Oobj DF-e Client, including essential components and configurations.

### Installation Guides

#### How to install the Oobj DF-e Client on a Windows server
- **Endpoint**: N/A
- **Method**: Installation Guide
- **Description**: Step-by-step instructions for installing the Oobj DF-e Client on a Windows server environment.

#### How to install and configure the Oobj Printing Engine
- **Endpoint**: N/A
- **Method**: Installation Guide
- **Description**: Details on installing and setting up the Oobj Printing Engine, used for automatic document printing.

#### How to configure the Oobj Services Engine
- **Endpoint**: N/A
- **Method**: Configuration Guide
- **Description**: Configuration steps for the Oobj Services Engine, which manages various Oobj DF-e services.

#### How to install and configure the Oobj BD Extractor
- **Endpoint**: N/A
- **Method**: Installation Guide
- **Description**: Instructions for installing and configuring the Oobj BD Extractor for database integration.

#### How to define specific Java for an Oobj DF-e service
- **Endpoint**: N/A
- **Method**: Configuration Guide
- **Description**: Guide on specifying a particular Java version for an Oobj DF-e service.

#### How to configure Database for Oobj Monitor
- **Endpoint**: N/A
- **Method**: Configuration Guide
- **Description**: Steps to set up the database connection for the Oobj Monitor component.

#### How to install and configure Import DF-e
- **Endpoint**: N/A
- **Method**: Installation Guide
- **Description**: Installation and configuration instructions for the Import DF-e tool.

#### How to install and configure Oobj Post Processing
- **Endpoint**: N/A
- **Method**: Installation Guide
- **Description**: Guides for installing and configuring the Oobj Post Processor.

#### How to update Oobj DF-e ActiveMQ
- **Endpoint**: N/A
- **Method**: Update Guide
- **Description**: Instructions on how to update the ActiveMQ component used by Oobj DF-e.

#### How to configure Monitor and MF-e Integrator Ceará
- **Endpoint**: N/A
- **Method**: Configuration Guide
- **Description**: Configuration details for the Monitor and MF-e Integrator specific to Ceará.

#### How to configure a printer for automatic printing in InHouse mode
- **Endpoint**: N/A
- **Method**: Configuration Guide
- **Description**: Setting up printers for automatic document printing using the InHouse mode.

#### How to add a specific user to start an Oobj service on Windows
- **Endpoint**: N/A
- **Method**: Configuration Guide
- **Description**: Steps to configure Windows services to run under a specific user account.

#### How to restart an Oobj service on Windows
- **Endpoint**: N/A
- **Method**: Operation Guide
- **Description**: Instructions for restarting Oobj services running on a Windows system.

#### Configure Oobj services to access Certificate A3
- **Endpoint**: N/A
- **Method**: Configuration Guide
- **Description**: How to configure Oobj services to properly access and use A3 digital certificates.

#### How to configure Oobj Data Migration
- **Endpoint**: N/A
- **Method**: Configuration Guide
- **Description**: Configuration steps for the Oobj Data Migration tool.

```

--------------------------------

### Oobj DFe Client Installation and Configuration

Source: https://oobj.com.br/bc/rejeicao-859-como-resolver

Guides on installing and configuring the Oobj DFe Client for various functionalities.

```APIDOC
## Oobj DFe Client Installation and Configuration

### Description
This section covers the installation and initial setup of the Oobj DFe Client, essential for managing electronic fiscal documents.

### Installation Guides

#### Installing the Oobj DF-e Client on Windows Server

- **Endpoint**: N/A
- **Method**: Installation Guide

#### Migrating to the DF-e Client

- **Endpoint**: N/A
- **Method**: Migration Guide

### Configuration Guides

#### Configuring a Test Environment for NF-e Emission

- **Endpoint**: N/A
- **Method**: Configuration Guide

#### Configuring Logomark in DF-e Client

- **Endpoint**: N/A
- **Method**: Configuration Guide

#### Manual Update of DF-e Client

- **Endpoint**: N/A
- **Method**: Update Guide

#### Configuring Digital Certificate (A1 or A3)

- **Endpoint**: N/A
- **Method**: Configuration Guide

#### Adding Token (CSC) for NFC-e

- **Endpoint**: N/A
- **Method**: Configuration Guide

#### Activating Contingency Mode

- **Endpoint**: N/A
- **Method**: Configuration Guide

#### Configuring Automatic Printing

- **Endpoint**: N/A
- **Method**: Configuration Guide

#### Enabling XML Proc Saving for Issued Documents

- **Endpoint**: N/A
- **Method**: Configuration Guide

#### Configuring Companies/Units

- **Endpoint**: N/A
- **Method**: Configuration Guide

#### Configuring DLL Integration

- **Endpoint**: N/A
- **Method**: Configuration Guide

#### Configuring SAT DIMEP for Tests

- **Endpoint**: N/A
- **Method**: Configuration Guide

#### Configuring DF-e Client for SAT Emission

- **Endpoint**: N/A
- **Method**: Configuration Guide

#### Automatic Contingency Triggering Scenarios

- **Endpoint**: N/A
- **Method**: Information Guide

#### Registering Companies for NFC-e Emission

- **Endpoint**: N/A
- **Method**: Configuration Guide

#### Enabling Auto-fill of Technical Responsible's Fixed Data

- **Endpoint**: N/A
- **Method**: Configuration Guide

#### Relation between DF-e Client Series and Micros Terminals

- **Endpoint**: N/A
- **Method**: Information Guide

#### Testing HTTP Oobj Integration

- **Endpoint**: N/A
- **Method**: Testing Guide

#### Emission Flow with Cielopos Integration

- **Endpoint**: N/A
- **Method**: Integration Guide

#### Adding a New Company

- **Endpoint**: N/A
- **Method**: Configuration Guide

#### Configuring Fixed Company Data

- **Endpoint**: N/A
- **Method**: Configuration Guide

#### Configuring File Integration for DF-e Emission

- **Endpoint**: N/A
- **Method**: Configuration Guide

#### Configuring Fiscal Document Storage

- **Endpoint**: N/A
- **Method**: Configuration Guide

#### Configuring DF-e Receipt

- **Endpoint**: N/A
- **Method**: Configuration Guide

#### Configuring SAT/MF-e Tab

- **Endpoint**: N/A
- **Method**: Configuration Guide

#### Configuring HTTP Integration

- **Endpoint**: N/A
- **Method**: Configuration Guide

#### Configuring SAT/MFE Linkage in Company Registration

- **Endpoint**: N/A
- **Method**: Configuration Guide

#### Activating/Deactivating Technical Responsible Field

- **Endpoint**: N/A
- **Method**: Configuration Guide

#### Configuring Printing via obsCont

- **Endpoint**: N/A
- **Method**: Configuration Guide

#### Updating Java Version for Oobj DF-e Client Service

- **Endpoint**: N/A
- **Method**: Update Guide

#### Activating HTTPS Connection

- **Endpoint**: N/A
- **Method**: Configuration Guide

#### Changing DF-e Sequence via DF-e Client

- **Endpoint**: N/A
- **Method**: Configuration Guide

### Response Example
N/A (This is a documentation guide, not an API endpoint)

```

--------------------------------

### Oobj DF-e Client Installation and Configuration

Source: https://oobj.com.br/bc/cat/legislacao-fiscal/rejeicoes/page/13

Guides on installing and configuring the Oobj DF-e Client for different operational needs.

```APIDOC
## Oobj DF-e Client Installation and Configuration

### Description
This section covers the installation and initial setup of the Oobj DF-e Client, including server installations and specific component configurations.

### Installation Guides

#### How to make the installation of the DF-e Client?
- **Description**: Step-by-step guide for installing the Oobj DF-e Client.
- **Endpoint**: N/A
- **Method**: N/A

#### How to make the installation of the Oobj DF-e on Windows server?
- **Description**: Specific instructions for installing the Oobj DF-e Client on a Windows server environment.
- **Endpoint**: N/A
- **Method**: N/A

### Component Configuration

#### How to install and configure the Oobj Printing Engine?
- **Description**: Details on setting up the Oobj Printing Engine, a component of the DF-e Client.
- **Endpoint**: N/A
- **Method**: N/A

#### How to configure the Oobj Services Engine?
- **Description**: Configuration guide for the Oobj Services Engine.
- **Endpoint**: N/A
- **Method**: N/A

#### How to install and configure the Oobj BD Extractor?
- **Description**: Instructions for installing and configuring the Oobj BD Extractor.
- **Endpoint**: N/A
- **Method**: N/A

#### How to define specific Java for an Oobj DF-e service?
- **Description**: Guide on specifying a particular Java version for Oobj DF-e services.
- **Endpoint**: N/A
- **Method**: N/A

#### How to configure Database for Oobj Monitor?
- **Description**: Steps to configure the database connection for the Oobj Monitor.
- **Endpoint**: N/A
- **Method**: N/A

#### How to install and configure the Importa DF-e?
- **Description**: Installation and configuration guide for the Importa DF-e tool.
- **Endpoint**: N/A
- **Method**: N/A

#### How to install and configure the Oobj Post Processor?
- **Description**: Instructions for setting up the Oobj Post Processor.
- **Endpoint**: N/A
- **Method**: N/A

#### How to update the Oobj DF-e ActiveMQ?
- **Description**: Guide on updating the ActiveMQ component used by Oobj DF-e.
- **Endpoint**: N/A
- **Method**: N/A

#### How to configure the Monitor and Ceará MF-e Integrator?
- **Description**: Configuration details for the Monitor and Integrator for MF-e in Ceará.
- **Endpoint**: N/A
- **Method**: N/A

#### How to configure a printer for automatic printing in InHouse mode?
- **Description**: Setting up printers for automatic document printing using the InHouse mode.
- **Endpoint**: N/A
- **Method**: N/A

#### How to add a specific user to start an Oobj service in Windows?
- **Description**: Guide on creating and configuring a Windows user for running Oobj services.
- **Endpoint**: N/A
- **Method**: N/A

#### How to restart an Oobj service in Windows?
- **Description**: Steps to restart Oobj services managed by Windows.
- **Endpoint**: N/A
- **Method**: N/A

#### Configure Oobj services to access Certificate A3
- **Description**: Configuration steps to enable Oobj services to access A3 type digital certificates.
- **Endpoint**: N/A
- **Method**: N/A

#### How to configure Oobj Data Migration?
- **Description**: Guide for configuring the Oobj Data Migration tool.
- **Endpoint**: N/A
- **Method**: N/A

### General Configuration

#### How to know the Java version used by an Oobj DF-e Service?
- **Description**: Method to identify the Java version utilized by Oobj DF-e services.
- **Endpoint**: N/A
- **Method**: N/A

#### How to activate HTTPS connection in DF-e Client for secure connection with Oobj Data Center?
- **Description**: Steps to enable secure HTTPS connections from the DF-e Client to the Oobj Data Center.
- **Endpoint**: N/A
- **Method**: N/A

#### How to change the DF-e Sequence through the DF-e Client?
- **Description**: Instructions on modifying the DF-e Sequence using the DF-e Client interface.
- **Endpoint**: N/A
- **Method**: N/A

```
Tokens:
Raw