Namespace NuvTools.Payment.Omie.ApiClient.DTOs.Responses
Classes
- ChangeOSStageResponse
Response of TrocarEtapaOS.
- ConsultContractItem
A single service line of the contract. VERIFY (Omie test app): ConsultarContrato nests item fields under an "itemCabecalho" object — confirm the exact key names for the service code and negotiated unit price.
- ConsultContractResponse
Response of ConsultarContrato — the negotiated Service Contract of a client. The caller reads the negotiated unit price per service (item) to price the OS for clients that have a contract (nCodCtr). The contract is a price registry only and must never be billed through.
- ConsultOSResponse
Response of ConsultarOS — the current state of a Service Order. Used to resolve OS stage before an upsert: the caller compares Stage (cEtapa) against the stages returned by ListarEtapasFaturamento to decide create / update / blocked-because-invoiced.
- ConsultServiceRegistrationResponse
Response of ConsultarCadastroServico — modeled from the actual Omie payload. The unit price (
nPrecoUnit) lives in the Header block; there is no separate "valores" block.
- GetBilletResponse
Response of ObterBoleto — fetches the billet link, identifiers and bank-side details after GerarBoleto. Note Omie uses "cDesStatus" (without the second "c") in the billet endpoints.
- ListBillingStagesResponse
Response of ListarEtapasFaturamento (servicos/osetapas/) — the Kanban stage catalog. Used to discover the early stage to use on create and the billing/invoicing stage(s) that mark an OS as no longer editable. VERIFY (Omie test app): confirm the list key ("cadastros") and the stage field names ("cCodigo"/"cDescricao").
- ListCategoryRegistrationResponse
Response of ListarCategorias (geral/categorias) — paged list of registered categories. Used to resolve a service's cCodCateg to its category name (
descricao). This endpoint pages with the generic pagina/total_de_paginas keys.
- ListContractsHeader
The
cabecalhoof a contract in the listing: who it belongs to, the number the user recognises, the validity period and the negotiated monthly value.
- ListContractsItem
One contract of the listing: the header and the negotiated price of each service in it.
- ListContractsResponse
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.
- ListContractsServiceItem
One service line of a contract in the listing.
- ListContractsServiceItemHeader
The
itemCabecalhoof a contract line: which service, and at what price.
- ListServiceRegistrationResponse
Response of ListarCadastroServico (servicos/servico) — paged list of registered services. Used to resolve a service's unit price/description by its nCodServ. The servicos/servico endpoint pages with the n-prefixed keys (nPagina/nTotPaginas/nRegistros/nTotRegistros), not the generic pagina/total_de_paginas.
- OmieCategory
A usable account of the Omie chart of accounts (
ListarCategorias).
- OmieCheckingAccount
A usable checking account of Omie (
ListarContasCorrentes).
- OmieContractInfo
A Service Contract of Omie as callers consume it: the number the user knows, the validity period and the negotiated value, with the dates already parsed. Projected from the listing so no caller has to deal with Omie's dd/MM/yyyy strings or with which key carries what.
- OmieInvoiceRpsStatus
RPS and batch status codes in Omie (
cStatusRps/cStatusLote), as documented by the API. Both fields use the same three digits.
- OmieServiceDetail
The full registration of a service (
ConsultarCadastroServico). The listing does not carry these fields and including a service order requires them on every item: LC 116 service code, municipal service code and tax classification. None of them can be invented — when they are missing from the Omie registration, the caller should stop and say which service to fix.
- OmieServiceInfo
A service of the Omie catalog, as
ListarCadastroServicoreturns it.The two codes exist and are not interchangeable: Code is the business code (
cCodigo, e.g. "SRV00016"), the one applications store in their own configuration, while ServiceCode is Omie's internal identifier (nCodServico), the only one accepted when building service order items. Translating one into the other is the reason the whole catalog is read.
- OmieServiceInvoiceStatus
The service invoice (NFS-e) of a service order and the progress of the RPS it came from. Issuing is a process, not an instant: Omie transmits the RPS and the city hall authorizes it later, so there is a window in which the invoice exists as a request and has no number yet.
- OmieServiceOrderStatus
Fiscal state of a service order in Omie, as
StatusOSreturns it: which stage it sits in, whether it was cancelled, whether it was already invoiced and — when it was — the NFS-e that came out of it.
Interfaces
- IOmieBusinessStatus
Marker for Omie response DTOs that carry a business-level status code in the body. Omie returns HTTP 200 even when the operation didn't succeed at the business level — the body's status code is the real outcome.