GET api/Faturas/Obter?idFatura={idFatura}

Retorna uma Fatura

Informações de Requisição

URL

https://apipsj.mlgomes.com.br/api/Faturas/Obter?idFatura={idFatura}

Parâmetros de URL

Nome	Descrição	Type	Informação Adicional
idFatura	ID Fatura	string	Required

Parâmetros do Corpo

Nenhum.

Informação de Resposta

Descrição do Recurso

Dados da Fatura

FaturaModel

Nome	Descrição	Type	Informação Adicional
CodFatura	Código da Fatura	integer	Nenhum.
CodEmpresa	Código da Empresa/Cliente	integer	Nenhum.
CodFornecedor	Código do Fornecedor	integer	Nenhum.
Valor	Valor da Fatura	decimal number	Nenhum.
QtdeSolicitacoes	Quantidade de Solicitações	integer	Nenhum.
DataFatura	Data da Fatura	date	Nenhum.
NumNF	Número da Nota Fiscal	integer	Nenhum.
DataNF	Data da Nota Fiscal	date	Nenhum.
IdStatus	ID do Status da Fatura	integer	Nenhum.
ID	ID da Fatura	string	Nenhum.
Empresa	Empresa/Cliente	string	Nenhum.
Status	Status da Fatura	string	Nenhum.
Mensagens	Mensagens da Fatura	Coleção de FaturaMensagemModel	Nenhum.
Documentos	Documentos da Fatura	Coleção de FaturaDocumentoModel	Nenhum.

Formatos de Resposta

application/json, text/json

Exemplo:

{
  "CodFatura": 1,
  "CodEmpresa": 2,
  "CodFornecedor": 3,
  "Valor": 4.1,
  "QtdeSolicitacoes": 5,
  "DataFatura": "2025-12-06T01:27:04.9597144-03:00",
  "NumNF": 1,
  "DataNF": "2025-12-06T01:27:04.9597144-03:00",
  "IdStatus": 7,
  "ID": "sample string 8",
  "Empresa": "sample string 9",
  "Status": "sample string 10",
  "Mensagens": [
    {
      "ID": 1,
      "CodFatura": 2,
      "CodFornecedor": 1,
      "CodEmpresa": 1,
      "Nome": "sample string 3",
      "Mensagem": "sample string 4",
      "DataEnvio": "2025-12-06T01:27:04.9597144-03:00",
      "DataLeitura": "2025-12-06T01:27:04.9597144-03:00"
    },
    {
      "ID": 1,
      "CodFatura": 2,
      "CodFornecedor": 1,
      "CodEmpresa": 1,
      "Nome": "sample string 3",
      "Mensagem": "sample string 4",
      "DataEnvio": "2025-12-06T01:27:04.9597144-03:00",
      "DataLeitura": "2025-12-06T01:27:04.9597144-03:00"
    }
  ],
  "Documentos": [
    {
      "ID": 1,
      "IdFatura": "sample string 2",
      "CodEmpresa": 3,
      "CodFornecedor": 1,
      "Responsavel": "sample string 4",
      "NomeArquivo": "sample string 5",
      "Tamanho": 6.1,
      "Local": "sample string 7",
      "LocalHtml": "sample%20string%207",
      "Formato": "sample string 8",
      "Data": "2025-12-06T01:27:04.9597144-03:00"
    },
    {
      "ID": 1,
      "IdFatura": "sample string 2",
      "CodEmpresa": 3,
      "CodFornecedor": 1,
      "Responsavel": "sample string 4",
      "NomeArquivo": "sample string 5",
      "Tamanho": 6.1,
      "Local": "sample string 7",
      "LocalHtml": "sample%20string%207",
      "Formato": "sample string 8",
      "Data": "2025-12-06T01:27:04.9597144-03:00"
    }
  ]
}

application/xml, text/xml

Exemplo:

<FaturaModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MLGomes.PortalServicos.API.Models.ViewModels">
  <CodEmpresa>2</CodEmpresa>
  <CodFatura>1</CodFatura>
  <CodFornecedor>3</CodFornecedor>
  <DataFatura>2025-12-06T01:27:04.9597144-03:00</DataFatura>
  <DataNF>2025-12-06T01:27:04.9597144-03:00</DataNF>
  <Documentos>
    <FaturaDocumentoModel>
      <CodEmpresa>3</CodEmpresa>
      <CodFornecedor>1</CodFornecedor>
      <Data>2025-12-06T01:27:04.9597144-03:00</Data>
      <Formato>sample string 8</Formato>
      <ID>1</ID>
      <IdFatura>sample string 2</IdFatura>
      <Local>sample string 7</Local>
      <NomeArquivo>sample string 5</NomeArquivo>
      <Responsavel>sample string 4</Responsavel>
      <Tamanho>6.1</Tamanho>
    </FaturaDocumentoModel>
    <FaturaDocumentoModel>
      <CodEmpresa>3</CodEmpresa>
      <CodFornecedor>1</CodFornecedor>
      <Data>2025-12-06T01:27:04.9597144-03:00</Data>
      <Formato>sample string 8</Formato>
      <ID>1</ID>
      <IdFatura>sample string 2</IdFatura>
      <Local>sample string 7</Local>
      <NomeArquivo>sample string 5</NomeArquivo>
      <Responsavel>sample string 4</Responsavel>
      <Tamanho>6.1</Tamanho>
    </FaturaDocumentoModel>
  </Documentos>
  <Empresa>sample string 9</Empresa>
  <ID>sample string 8</ID>
  <IdStatus>7</IdStatus>
  <Mensagens>
    <FaturaMensagemModel>
      <CodEmpresa>1</CodEmpresa>
      <CodFatura>2</CodFatura>
      <CodFornecedor>1</CodFornecedor>
      <DataEnvio>2025-12-06T01:27:04.9597144-03:00</DataEnvio>
      <DataLeitura>2025-12-06T01:27:04.9597144-03:00</DataLeitura>
      <ID>1</ID>
      <Mensagem>sample string 4</Mensagem>
      <Nome>sample string 3</Nome>
    </FaturaMensagemModel>
    <FaturaMensagemModel>
      <CodEmpresa>1</CodEmpresa>
      <CodFatura>2</CodFatura>
      <CodFornecedor>1</CodFornecedor>
      <DataEnvio>2025-12-06T01:27:04.9597144-03:00</DataEnvio>
      <DataLeitura>2025-12-06T01:27:04.9597144-03:00</DataLeitura>
      <ID>1</ID>
      <Mensagem>sample string 4</Mensagem>
      <Nome>sample string 3</Nome>
    </FaturaMensagemModel>
  </Mensagens>
  <NumNF>1</NumNF>
  <QtdeSolicitacoes>5</QtdeSolicitacoes>
  <Status>sample string 10</Status>
  <Valor>4.1</Valor>
</FaturaModel>