Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

Método de consulta que retorna informações de notas fiscais de fornecedores.

Chamada

GET [URLAPI]/NotaFiscalAPI/api/v1/NotaFiscal/Fornecedor/recebimentos-e-devolucoes

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
NumeroNotaFiscalNúmero de nota fiscalintegerNão há.
SerieNotaFiscal

Série de nota fiscal

StringNão há.
TipoNotaFiscal

Tipo de nota fiscal

StringD ou R - Se o campo for vazio, retonar os dois.
NumeroEmpresaNúmero da EmpresaintegerNão há.
SeqFornecedorCódigo sequencial de fornecedorintegerNão há.
CnpjFornecedorCNPJ de fornecedorStringNão há.
SeqProdutoCódigo sequencial de produtointegerNão há.
DataLancamentoInicioData de lançamento InicioStringNão há.
DataLancamentoFimData de lançamento FimStringNão há.
DataEmissaoData de emissãoStringNão há.
DataEntradaData de entradaStringNão há.

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

  • OK (200)
  • BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - SUCCESS


[
  {
    "nroNotaFiscal": 0,
    "serieNotaFiscal": "string",
    "tipNotaFiscal": "string",
    "seqFornecedor": 0,
    "nroCnpjFornecedor": 0,
    "digCnpjFornecedor": 0,
    "nroEmpresa": 0,
    "dtaLancamento": "2023-03-22T19:16:07.970Z",
    "dtaEmissao": "2023-03-22T19:16:07.970Z",
    "dtaEntrada": "2023-03-22T19:16:07.970Z",
    "itens": [
      {
        "seqProduto": 0,
        "produto": "string",
        "embalagem": "string",
        "qdtUnitaria": 0,
        "vlrUnitario": 0,
        "vlrBrutoTotal": 0,
        "vlrDesconto": 0,
        "vlrDespesas": 0,
        "vlrIpi": 0,
        "vlrIcms": 0,
        "vlrIcmsSt": 0,
        "vlrPis": 0,
        "vlrCofins": 0
      }
    ]
  }
]


application/json, text/json

CODE 400 - BAD

{
  "code": "string",
  "message": "string",
  "detailedMessage": "string",
  "helpUrl": "string",
  "details": [
    {
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "notificationType": 0,
      "code": "string",
      "message": "string",
      "detailedMessage": "string",
      "status": 0
    }
  ]
}