Inserir entidade
Permite a inserção de nova entidade.
POST https://segurosapi.libax.com/v1/{token}/Entities
Permissão requerida: escrita
|
Parâmetro
|
|
Descrição
|
|
Name *
|
string
|
Nome da entidade.
|
|
VatNumber
|
string
|
Número de contribuinte. Se não enviado será assumido 999999990.
|
|
Street
|
string
|
Morada da entidade.
|
|
City
|
string
|
Localidade da entidade. Se não enviado será assumido nd.
|
|
PostalCode
|
string
|
Código postal da entidade.
|
|
Country
|
string
|
Código oficial do país. Ex: PT para Portugal. Se não enviado será assumido PT
|
|
Email
|
string
|
E-mail da entidade.
|
|
Phone
|
string
|
Telefone fixo da entidade.
|
|
Mobile
|
string
|
Telemóvel fixo da entidade.
|
|
BirthDate
|
date
|
Data de nascimento da entidade.
|
|
IsConsentAccepted
|
bool
|
True se aceitou consentimento RGPD. False se não aceitou. Se não enviado, ficará sem registo de consentimento.
|
|
Status
|
int
|
Situação da entidade.
|
|
EntityType
|
int
|
Tipo da entitidade (enum Entity.EntityType) que pretende obter a lista.
|
|
OccupationID
|
int
|
Id da profissão.
|
|
OfficeID
|
int
|
Id do escritório.
|
|
SellerID
|
int
|
Id do primeiro parceiro que ficará associado à entidade.
|
|
Seller1ID
|
int
|
Id do segundo parceiro que ficará associado à entidade.
|
|
Seller2ID
|
int
|
Id do terceiro parceiro que ficará associado à entidade.
|
|
Seller3ID
|
int
|
Id do quarto parceiro que ficará associado à entidade.
|
|
Seller4ID
|
int
|
Id do quinto parceiro que ficará associado à entidade.
|
|
Observation
|
string
|
Observações da entidade.
|
|
SalesforceId
|
string
|
Identificação da entidade na plataforma Salesforce.
|
|
Iban
|
string
|
Iban da entidade.
|
|
PersonalCardNumber
|
string
|
Número do cartão de cidadão.
|
|
PersonalCardIssueDate
|
date
|
Data de emissão do cartão de cidadão.
|
|
PersonalCardLocation
|
string
|
Local de emissão do cartão de cidadão.
|
|
PersonalCardExpirationDate
|
date
|
Data de expiração do cartão de cidadão.
|
* obrigatório
Respostas
HTTP: 201, retorna o id e número da entidade registada
{ "EntityID": int, "Number": int }
HTTP: 400
{ "Message": "Inválid country" }
{ "Message": "Vatnumber already exists" }