POST api/Favorecido/Incluir

Request Information

URI Parameters

None.

Body Parameters

FavorecidoVM
NameDescriptionTypeAdditional information
IdContaAcesso

integer

None.
Token

string

None.
IdUnidade

integer

None.
ID

integer

None.
Nome

string

None.
Codigo

string

None.
RazaoSocial

string

None.
CPF_CNPJ

string

None.
Endereco

string

None.
NumeroEnd

string

None.
Complemento

string

None.
Bairro

string

None.
Cidade

string

None.
CodigoCidade

string

None.
UF

string

None.
Cep

string

None.
Fone1

string

None.
Fone2

string

None.
Email

string

None.
Email2

string

None.
IDTipoFavorecido

integer

None.
IDTipoPessoa

integer

None.
IDSituacao

integer

None.
UltimaVenda

date

None.
DataCad

date

None.
Contato

string

None.
Estrangeiro

boolean

None.
IDPais

integer

None.
NumeroPassaporte

string

None.
ValidadePassaporte

date

None.
IDUsuario

integer

None.
IDTabelaPreco

integer

None.
SaldoAberto

decimal number

None.
Parcelas

Collection of TituloVM

None.
UrlLogo

string

None.
Tema

string

None.
DataNasc

date

None.
CarteiraHabNumero

string

None.
CarteiraHabValidade

date

None.
CarteiraHabOrgao

string

None.
CarteiraHabCategoria

string

None.
IDFavorecidoPai

integer

None.
CarteiraHabDataEmissao

date

None.
CarteiraHabCNH

string

None.
CarteiraHabSeguranca

string

None.
CarteiraHabUF

string

None.
RG

string

None.
Obs

string

None.
IDVendedor

integer

None.
MetaMensal

decimal number

None.
IDPlanoPagamento

integer

None.
Anexos

Collection of DocVM

None.
OutrosAnexos

Collection of LVDocVM

None.
PercDescontoMax

decimal number

None.
Credito

decimal number

None.
IDSegmento

integer

None.
NomeSegmento

string

None.
NomeVendedor

string

None.
PagQtdeRegistros

integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "IdContaAcesso": 1,
  "Token": "sample string 2",
  "IdUnidade": 3,
  "ID": 4,
  "Nome": "sample string 5",
  "Codigo": "sample string 6",
  "RazaoSocial": "sample string 7",
  "CPF_CNPJ": "sample string 8",
  "Endereco": "sample string 9",
  "NumeroEnd": "sample string 10",
  "Complemento": "sample string 11",
  "Bairro": "sample string 12",
  "Cidade": "sample string 13",
  "CodigoCidade": "sample string 14",
  "UF": "sample string 15",
  "Cep": "sample string 16",
  "Fone1": "sample string 17",
  "Fone2": "sample string 18",
  "Email": "sample string 19",
  "Email2": "sample string 20",
  "IDTipoFavorecido": 1,
  "IDTipoPessoa": 21,
  "IDSituacao": 1,
  "UltimaVenda": "2026-03-03T21:34:39.973352-03:00",
  "DataCad": "2026-03-03T21:34:39.973352-03:00",
  "Contato": "sample string 22",
  "Estrangeiro": true,
  "IDPais": 1,
  "NumeroPassaporte": "sample string 24",
  "ValidadePassaporte": "2026-03-03T21:34:39.973352-03:00",
  "IDUsuario": 25,
  "IDTabelaPreco": 26,
  "SaldoAberto": 1.0,
  "Parcelas": [
    {
      "ID": 1,
      "Data": "2026-03-03T21:34:39.973352-03:00",
      "RefDoc": "sample string 3",
      "IdFavorecido": 4,
      "Nome": "sample string 5",
      "IdCategoria": 6,
      "NomeCategoria": "sample string 7",
      "Valor": 8.0,
      "ValorPago": 9.0,
      "ValorDesconto": 10.0,
      "Saldo": 0.0,
      "Vencimento": "2026-03-03T21:34:39.973352-03:00",
      "Obs": "sample string 12",
      "IDMenuOrigem": 13,
      "IDTipoMovPadrao": 1,
      "IdUnidade": 1,
      "IdGerador": 1
    },
    {
      "ID": 1,
      "Data": "2026-03-03T21:34:39.973352-03:00",
      "RefDoc": "sample string 3",
      "IdFavorecido": 4,
      "Nome": "sample string 5",
      "IdCategoria": 6,
      "NomeCategoria": "sample string 7",
      "Valor": 8.0,
      "ValorPago": 9.0,
      "ValorDesconto": 10.0,
      "Saldo": 0.0,
      "Vencimento": "2026-03-03T21:34:39.973352-03:00",
      "Obs": "sample string 12",
      "IDMenuOrigem": 13,
      "IDTipoMovPadrao": 1,
      "IdUnidade": 1,
      "IdGerador": 1
    }
  ],
  "UrlLogo": "sample string 27",
  "Tema": "sample string 28",
  "DataNasc": "2026-03-03T21:34:39.973352-03:00",
  "CarteiraHabNumero": "sample string 29",
  "CarteiraHabValidade": "2026-03-03T21:34:39.973352-03:00",
  "CarteiraHabOrgao": "sample string 30",
  "CarteiraHabCategoria": "sample string 31",
  "IDFavorecidoPai": 1,
  "CarteiraHabDataEmissao": "2026-03-03T21:34:39.973352-03:00",
  "CarteiraHabCNH": "sample string 32",
  "CarteiraHabSeguranca": "sample string 33",
  "CarteiraHabUF": "sample string 34",
  "RG": "sample string 35",
  "Obs": "sample string 36",
  "IDVendedor": 1,
  "MetaMensal": 1.0,
  "IDPlanoPagamento": 1,
  "Anexos": [
    {
      "IdContaAcesso": 1,
      "IdUsuario": 2,
      "Token": "sample string 3",
      "ID": 4,
      "Arquivo": "sample string 5"
    },
    {
      "IdContaAcesso": 1,
      "IdUsuario": 2,
      "Token": "sample string 3",
      "ID": 4,
      "Arquivo": "sample string 5"
    }
  ],
  "OutrosAnexos": [
    {
      "ID": 1,
      "Data": "2026-03-03T21:34:39.973352-03:00",
      "IDTipoDoc": 3,
      "Arquivo": "sample string 4",
      "IdCa": 5,
      "NomeTipo": "sample string 6",
      "Url": "sample string 7"
    },
    {
      "ID": 1,
      "Data": "2026-03-03T21:34:39.973352-03:00",
      "IDTipoDoc": 3,
      "Arquivo": "sample string 4",
      "IdCa": 5,
      "NomeTipo": "sample string 6",
      "Url": "sample string 7"
    }
  ],
  "PercDescontoMax": 1.0,
  "Credito": 1.0,
  "IDSegmento": 1,
  "NomeSegmento": "sample string 37",
  "NomeVendedor": "sample string 38",
  "PagQtdeRegistros": 39
}

Response Information

Resource Description

integer

Response Formats

application/json, text/json

Sample: 
1