Table of Contents

Class ListContractsResponse

Namespace
NuvTools.Payment.Omie.ApiClient.DTOs.Responses
Assembly
NuvTools.Payment.Omie.ApiClient.dll

Response of ListarContratos (servicos/contrato) — the page of Service Contracts registered in Omie. A contract is a price registry: it holds the negotiated value and the validity period agreed with one client, and must never be billed through.

The listing exists so callers can resolve a contract by the number the user knows (cNumCtr) without asking Omie one call per contract: Omie exposes no search by contract number, and repeated single consults are what trips its "Consumo redundante" gate. List once, index in memory — the same approach as the service catalog.

public class ListContractsResponse : IOmieBusinessStatus
Inheritance
ListContractsResponse
Implements
Inherited Members

Properties

Contracts

[JsonPropertyName("contratoCadastro")]
public ListContractsItem[]? Contracts { get; set; }

Property Value

ListContractsItem[]

Page

[JsonPropertyName("pagina")]
public int Page { get; set; }

Property Value

int

Records

[JsonPropertyName("registros")]
public int Records { get; set; }

Property Value

int

StatusCode

[JsonPropertyName("cCodStatus")]
public string? StatusCode { get; set; }

Property Value

string

StatusDescription

[JsonPropertyName("cDescStatus")]
public string? StatusDescription { get; set; }

Property Value

string

TotalPages

[JsonPropertyName("total_de_paginas")]
public int TotalPages { get; set; }

Property Value

int

TotalRecords

[JsonPropertyName("total_de_registros")]
public int TotalRecords { get; set; }

Property Value

int