Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

items

Títulos de Cobrança do beneficiário

items.{campo do SX3}

Os campos retornados da tabela SE1:

  • e1_prefixo
  • e1_num
  • e1_parcela
  • e1_tipo
  • e1_cliente
  • e1_loja
  • e1_nomcli
  • e1_vencrea
  • e1_valor
  • e1_baixa
  • e1_saldo
  • e1_valliq
items.status

Status do título, sendo: Aberto (A), Baixado Parcial (P), Baixado (B)

Campo: E1_SALDO e E1_VALOR

items.titleid

Chave identificador do título para ser utilizado nos endpoints:

  • /totvsHealthPlans/v1/beneficiaryPosition/titles/{titleId}/compositions
  • /totvsHealthPlans/v1/beneficiaryPosition/titles/{titleId}/pdf

Campo: E1_PREFIXO+E1_NUM+E1_PARCELA+E1_TIPO

items.latedays

Image Added

Quantidade de dias em atraso do título, considerando a data de vencimento (E1_VENCREA)

totalValues

Valor total de todos os títulos encontrado

Campo: E1_VALOR

struct

Estrutura dos fields de acordo com o dicionário de dados (SX3)

hasNext

Indica se ainda existem registros a serem retornados
remainingRecords

Quantidade de registros ainda existem para retorno
Bloco de código
languagec#
themeMidnight
titleExemplo de retorno - Sucesso
linenumberstrue
collapsetrue
{
  "items": [
    {
      "e1_prefixo": "PLS",
      "e1_num": "000007042000007023",
      "e1_parcela": "",
      "e1_tipo": "DPNCC",
      "e1_cliente": "TMSWBI",
      "e1_loja": "01",
      "e1_nomcli": "VITOR MIGUEL FREITAS",
      "e1_vencrea": "20222021-101-1725",
      "e1_valor": 419200.01,
      "e1_baixa": "20222021-101-1722",
      "e1_saldo": 0,
      "e1_valliq": 419200.01,
      "status": "B",
      "latedays": 0,
      "titleid": "PLS000007042PLS000007023 DPNCC"
    },
    {
      "e1_prefixo": "PLS",
      "e1_num": "000007043000007037",
      "e1_parcela": "",
      "e1_tipo": "DPNCC",
      "e1_cliente": "TMSWBI",
      "e1_loja": "01",
      "e1_nomcli": "VITOR MIGUEL FREITAS",
      "e1_vencrea": "2022-101-1725",
      "e1_valor": 39950,
      "e1_baixa": "2022-101-1719",
      "e1_saldo": 2000,
      "e1_valliq": 19950,
      "status": "PB",
      "titleidlatedays": "PLS000007043 DP0,
      "titleid": "PLS000007037 NCC"
    },
    {
      "e1_prefixo": "PLS",
      "e1_num": "000007044000007038",
      "e1_parcela": "",
      "e1_tipo": "DP",
      "e1_cliente": "TMSWBI",
      "e1_loja": "01",
      "e1_nomcli": "VITOR MIGUEL FREITAS",
      "e1_vencrea": "2022-102-1725",
      "e1_valor": 399590,
      "e1_baixa": "2022-1-19",
      "e1_saldo": 3990,
      "e1_valliq": 0": 590,
      "status": "B",
      "latedays": 0,
      "titleid": "PLS000007038 DP"
    },
    {
      "e1_prefixo": "PLS",
      "e1_num": "000007038",
      "e1_parcela": "",
      "e1_tipo": "NCC",
      "e1_cliente": "TMSWBI",
      "e1_loja": "01",
      "e1_nomcli": "VITOR MIGUEL FREITAS",
      "e1_vencrea": "2022-2-25",
      "e1_valor": 50,
      "e1_baixa": "2022-1-19",
      "e1_saldo": 0,
      "e1_valliq": 50,
      "status": "B",
      "latedays": 0,
      "titleid": "PLS000007038 NCC"
    },
    {
      "e1_prefixo": "PLS",
      "e1_num": "000007039",
      "e1_parcela": "",
      "e1_tipo": "DP",
      "e1_cliente": "TMSWBI",
      "e1_loja": "01",
      "e1_nomcli": "VITOR MIGUEL FREITAS",
      "e1_vencrea": "2022-3-25",
      "e1_valor": 590,
      "e1_baixa": "",
      "e1_saldo": 590,
      "e1_valliq": 0,
      "status": "A",
      "latedays": 343,
      "titleid": "PLS000007039 DP"
    },
    {
      "e1_prefixo": "PLS",
      "e1_num": "000007039",
      "e1_parcela": "",
      "e1_tipo": "NCC",
      "e1_cliente": "TMSWBI",
      "e1_loja": "01",
      "e1_nomcli": "VITOR MIGUEL FREITAS",
      "e1_vencrea": "2022-3-25",
      "e1_valor": 50,
      "e1_baixa": "2022-1-19",
      "e1_saldo": 0,
      "e1_valliq": 50,
      "status": "B",
      "statuslatedays": "A"0,
      "titleid": "PLS000007044PLS000007039 DPNCC"
    },
    {
      "e1_prefixo": "PLS",
      "e1_num": "000007045000007042",
      "e1_parcela": "",
      "e1_tipo": "DP",
      "e1_cliente": "TMSWBI",
      "e1_loja": "01",
      "e1_nomcli": "VITOR MIGUEL FREITAS",
      "e1_vencrea": "2022-10-17",
      "e1_valor": 399419,
      "e1_baixa": "2022-10-17",
      "e1_saldo": 0,
      "e1_valliq": 399419,
      "status": "B",
      "latedays": 0,
      "titleid": "PLS000007045PLS000007042 DP"
    },
    {
      "e1_prefixo": "PLS",
      "e1_num": "000007046000007044",
      "e1_parcela": "",
      "e1_tipo": "DP",
      "e1_cliente": "TMSWBI",
      "e1_loja": "01",
      "e1_nomcli": "VITOR MIGUEL FREITAS",
      "e1_vencrea": "2022-10-17",
      "e1_valor": 399,
      "e1_baixa": "2022-10-17",
      "e1_saldo": 309399,
      "e1_valliq": 900,
      "status": "PA",
      "latedays": 137,
      "titleid": "PLS000007046PLS000007044 DP"
    },
    {
      "e1_prefixo": "PLS",
      "e1_num": "000007047000007045",
      "e1_parcela": "",
      "e1_tipo": "DP",
      "e1_cliente": "TMSWBI",
      "e1_loja": "01",
      "e1_nomcli": "VITOR MIGUEL FREITAS",
      "e1_vencrea": "2022-10-17",
      "e1_valor": 475399,
      "e1_baixa": "2022-1110-1617",
      "e1_saldo": 172.540,
      "e1_valliq": 252.46 399,
      "status": "B",
      "statuslatedays": "P"0,
      "titleid": "PLS000007047PLS000007045 DP"
    },
    {
      "e1_prefixo": "PLS",
      "e1_num": "000007048000007047",
      "e1_parcela": "",
      "e1_tipo": "DP",
      "e1_cliente": "TMSWBI",
      "e1_loja": "01",
      "e1_nomcli": "VITOR MIGUEL FREITAS",
      "e1_vencrea": "2022-10-17",
      "e1_valor": 475,
      "e1_baixa": "2022-10-17",
      "e1_saldo": 0475,
      "e1_valliq": 4750,
      "status": "B"A",
      "latedays": 137,
      "titleid": "PLS000007048PLS000007047 DP"
    },
    {
      "e1_prefixo": "PLS",
      "e1_num": "000007049000007048",
      "e1_parcela": "",
      "e1_tipo": "DP",
      "e1_cliente": "TMSWBI",
      "e1_loja": "01",
      "e1_nomcli": "VITOR MIGUEL FREITAS",
      "e1_vencrea": "2022-10-17",
      "e1_valor": 475,
      "e1_baixa": "2022-1110-1217",
      "e1_saldo": 2650,
      "e1_valliq": 200475,
      "status": "P""B",
      "latedays": 0,
      "titleid": "PLS000007049PLS000007048 DP"
    },
    {
      "e1_prefixo": "PLS",
      "e1_num": "000007050",
      "e1_parcela": "",
      "e1_tipo": "DP",
      "e1_cliente": "TMSWBI",
      "e1_loja": "01",
      "e1_nomcli": "VITOR MIGUEL FREITAS",
      "e1_vencrea": "2022-10-24",
      "e1_valor": 475,
      "e1_baixa": "",
      "e1_saldo": 475,
      "e1_valliq": 0,
      "status": "A",
      "latedays": 130,
      "titleid": "PLS000007050 DP"
    },
    {
      "e1_prefixo": "PLS",
      "e1_num": "000007051",
      "e1_parcela": "",
      "e1_tipo": "DP",
      "e1_cliente": "TMSWBI",
      "e1_loja": "01",
      "e1_nomcli": "VITOR MIGUEL FREITAS",
      "e1_vencrea": "2022-10-24",
      "e1_valor": 475,
      "e1_baixa": "2022-10-17",
      "e1_saldo": 0,
      "e1_valliq": 475,
      "status": "B",
      "latedays": 0,
      "titleid": "PLS000007051 DP"
    },
    {
      "e1_prefixo": "PLS",
      "e1_num": "000007052242536471",
      "e1_parcela": "",
      "e1_tipo": "DP",
      "e1_cliente": "TMSWBI",
      "e1_loja": "01",
      "e1_nomcli": "VITOR MIGUEL FREITAS",
      "e1_vencrea": "2022-11-2324",
      "e1_valor": 475200,
      "e1_baixa": "2022-11-12",
      "e1_saldo": 85200,
      "e1_valliq": 2000,
      "status": "P""A",
      "latedays": 99,
      "titleid": "PLS000007052PLS242536471 DP"
    },
    {
      "e1_prefixo": "PLS",
      "e1_num": "000007053365890285",
      "e1_parcela": "",
      "e1_tipo": "DP",
      "e1_cliente": "TMSWBI",
      "e1_loja": "01",
      "e1_nomcli": "VITOR MIGUEL FREITAS",
      "e1_vencrea": "2022-12-2312",
      "e1_valor": 475300,
      "e1_baixa": "",
      "e1_saldo": 475300,
      "e1_valliq": 0,
      "status": "A",
      "latedays": 81,
      "titleid": "PLS000007053PLS365890285 DP"
    },
    {
      "e1_prefixo": "UNIPLS",
      "e1_num": "TFC01B000007053",
      "e1_parcela": "",
      "e1_tipo": "NFDP",
      "e1_cliente": "TMSWBI",
      "e1_loja": "01",
      "e1_nomcli": "VITOR MIGUEL FREITAS",
      "e1_vencrea": "20232022-112-23",
      "e1_valor": 475,
      "e1_baixa": "",
      "e1_saldo": 475,
      "e1_valliq": 0,
      "status": "A",
      "titleidlatedays": 70,
  "UNITFC01B    NF"titleid": "PLS000007053 DP"
    }
  ],
  "hasNext": false,
  "remainingRecords": 0,
  "struct": [
    {
      "field": "E1_PREFIXO",
      "type": "C",
      "title": "Prefixo",
      "description": "Prefixo do titulo",
      "picture": "@!",
      "size": 3,
      "decimals": 0,
      "cbox": []
    },
    {
      "field": "E1_NUM",
      "type": "C",
      "title": "No. Titulo",
      "description": "Numero do Titulo",
      "picture": "@!",
      "size": 9,
      "decimals": 0,
      "cbox": []
    },
    {
      "field": "E1_PARCELA",
      "type": "C",
      "title": "Parcela",
      "description": "Parcela do Titulo",
      "picture": "@!",
      "size": 1,
      "decimals": 0,
      "cbox": []
    },
    {
      "field": "E1_TIPO",
      "type": "C",
      "title": "Tipo",
      "description": "Tipo do titulo",
      "picture": "@!",
      "size": 3,
      "decimals": 0,
      "cbox": []
    },
    {
      "field": "E1_CLIENTE",
      "type": "C",
      "title": "Cliente",
      "description": "Codigo do Cliente",
      "picture": "@!",
      "size": 6,
      "decimals": 0,
      "cbox": []
    },
    {
      "field": "E1_LOJA",
      "type": "C",
      "title": "Loja",
      "description": "Loja do Cliente",
      "picture": "@!",
      "size": 2,
      "decimals": 0,
      "cbox": []
    },
    {
      "field": "E1_NOMCLI",
      "type": "C",
      "title": "Nome Cliente",
      "description": "Nome Reduzido do Cliente",
      "picture": "@!",
      "size": 20,
      "decimals": 0,
      "cbox": []
    },
    {
      "field": "E1_VENCREA",
      "type": "D",
      "title": "Vencto real",
      "description": "Vencimento real do Titulo",
      "picture": "",
      "size": 8,
      "decimals": 0,
      "cbox": []
    },
    {
      "field": "E1_VALOR",
      "type": "N",
      "title": "Vlr.Titulo",
      "description": "Valor do Titulo",
      "picture": "@E 9,999,999,999,999.99",
      "size": 16,
      "decimals": 2,
      "cbox": []
    },
    {
      "field": "E1_BAIXA",
      "type": "D",
      "title": "DT Baixa",
      "description": "Data de Baixa do Titulo",
      "picture": "",
      "size": 8,
      "decimals": 0,
      "cbox": []
    },
    {
      "field": "E1_SALDO",
      "type": "N",
      "title": "Saldo",
      "description": "Saldo a Receber",
      "picture": "@E 9,999,999,999,999.99",
      "size": 16,
      "decimals": 2,
      "cbox": []
    },
    {
      "field": "E1_VALLIQ",
      "type": "N",
      "title": "Vlr.Liq Baix",
      "description": "Valor Liquido da Baixa",
      "picture": "@E 9,999,999,999,999.99",
      "size": 16,
      "decimals": 2,
      "cbox": []
    }
  ],
  "totalValues": 58155622.01
}


...

Dados Inválidos (404) 

code

Código identificador do erro. (Tabela de Erros)

message

Literal no idioma da requisição descrevendo o erro para o usuário.

detailedMessage

Mensagem técnica e mais detalhada do erro.

...