Class ListContractsHeader

Namespace

NuvTools.Payment.Omie.ApiClient.DTOs.Responses

Assembly

NuvTools.Payment.Omie.ApiClient.dll

The cabecalho of a contract in the listing: who it belongs to, the number the user recognises, the validity period and the negotiated monthly value.

public class ListContractsHeader

Inheritance

object

ListContractsHeader

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ClientCode

Client the contract belongs to (nCodCli).

[JsonPropertyName("nCodCli")]
public long ClientCode { get; set; }

Property Value

long

ContractCode

Omie's internal identifier of the contract — the one ConsultarContrato takes.

[JsonPropertyName("nCodCtr")]
public long ContractCode { get; set; }

Property Value

long

ContractNumber

The contract number as the user reads it in Omie — how a caller's own configuration refers to it.

[JsonPropertyName("cNumCtr")]
public string? ContractNumber { get; set; }

Property Value

string

IntegrationCode

Integration code, when the contract was created through the API.

[JsonPropertyName("cCodIntCtr")]
public string? IntegrationCode { get; set; }

Property Value

string

MonthlyValue

Negotiated monthly value of the contract.

[JsonPropertyName("nValTotMes")]
public decimal? MonthlyValue { get; set; }

Property Value

decimal?

SituationCode

Situation code of the contract in Omie.

[JsonPropertyName("cCodSit")]
public string? SituationCode { get; set; }

Property Value

string

ValidFrom

Start of the validity period, as Omie writes dates: dd/MM/yyyy.

[JsonPropertyName("dVigInicial")]
public string? ValidFrom { get; set; }

Property Value

string

ValidTo

End of the validity period (dd/MM/yyyy). Empty on contracts with no end date.

[JsonPropertyName("dVigFinal")]
public string? ValidTo { get; set; }

Property Value

string