Class OmieApiClientConfig

Namespace

NuvTools.Payment.Omie.ApiClient.Configuration

Assembly

NuvTools.Payment.Omie.ApiClient.dll

Configuration for the Omie API client.

public class OmieApiClientConfig

Inheritance

object

OmieApiClientConfig

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Fields

SectionName

Configuration section name.

public const string SectionName = "Omie"

Field Value

string

Properties

AppHash

Optional Marketplace app hash. When the Omie app is registered as a marketplace integration, Omie requires this hash on every request envelope alongside app_key and app_secret. Leave null/empty for non-marketplace apps.

public string? AppHash { get; set; }

Property Value

string

AppKey

public required string AppKey { get; set; }

Property Value

string

AppSecret

public required string AppSecret { get; set; }

Property Value

string

BaseUrl

Base URL shared by every Omie endpoint (e.g. https://app.omie.com.br/api/v1/). The Endpoint* paths below are relative to it and concatenated onto it at call time.

public required string BaseUrl { get; set; }

Property Value

string

CategoriesPerPage

Page size when listing categories. Default 500.

public int CategoriesPerPage { get; set; }

Property Value

int

ClientsPerPage

Page size when listing clients — ListarClientes accepts up to 500. Default 500.

public int ClientsPerPage { get; set; }

Property Value

int

EndpointBilletReceivable

financas/contareceberboleto/ — receivable billets.

public string EndpointBilletReceivable { get; set; }

Property Value

string

EndpointCategory

geral/categorias/ — ListarCategorias (resolve a service's cCodCateg to its category name).

public string EndpointCategory { get; set; }

Property Value

string

EndpointCheckingAccount

geral/contacorrente/ — ListarContasCorrentes (checking accounts a receivable can land on).

public string EndpointCheckingAccount { get; set; }

Property Value

string

EndpointClient

geral/clientes/ — cliente registration.

public string EndpointClient { get; set; }

Property Value

string

EndpointContract

servicos/contrato/ — ConsultarContrato (negotiated unit price per service item).

public string EndpointContract { get; set; }

Property Value

string

EndpointOrderBilling

servicos/osetapas/ — OS billing stages.

public string EndpointOrderBilling { get; set; }

Property Value

string

EndpointOrderService

servicos/os/ — Service Order (OS) upsert/consult.

public string EndpointOrderService { get; set; }

Property Value

string

EndpointOrderServiceBilling

servicos/osp/ — ValidarOS and FaturarOS, which invoice a single service order. Not to be confused with servicos/oslote/, which invoices every OS of a Kanban stage at once, nor with servicos/osetapas/, which only lists stages.

public string EndpointOrderServiceBilling { get; set; }

Property Value

string

EndpointOrderStages

servicos/osetapas/ — ListarEtapasFaturamento (Kanban stage discovery).

public string EndpointOrderStages { get; set; }

Property Value

string

EndpointReceivable

financas/contareceber/ — receivables.

public string EndpointReceivable { get; set; }

Property Value

string

EndpointService

servicos/servico/ — service registration/catalog.

public string EndpointService { get; set; }

Property Value

string

MaxConcurrentRequests

Max concurrent in-flight Omie requests (throttle for batch runs). Default 1 (sequential).

public int MaxConcurrentRequests { get; set; }

Property Value

int

MaxRetryAttempts

Max retry attempts on transient network/5xx failures. Default 2. 0 disables retries.

public int MaxRetryAttempts { get; set; }

Property Value

int

RetryDelayMilliseconds

Base delay (ms) between retries; grows linearly with the attempt number. Default 500.

public int RetryDelayMilliseconds { get; set; }

Property Value

int

Methods

ResolveUrl(string)

Combines BaseUrl with a relative endpoint path, normalizing the slash between them.

public string ResolveUrl(string endpoint)

Parameters

endpoint string

Returns

string