Permitir que o parceiro envie dados cliente para o PDV.
Esta operação ocorre nos eventos 'Identificar o cliente', 'Cadastrar pessoa' e também no pagamento por convênio, caso o cliente não tenha sido identificado durante a compra.
POST {url}| Parâmetro | Tipo | Descrição |
| Document | String | Número do documento de identificação da pessoa |
| DocumentType | String | Tipo de documento de identificação cdtIDInternal - Código interno cdtCPF - CFP cdtCNPJ - CNPJ cdtIDForeign - Identificador único |
Exemplo (Sample)
{
"id":"{E20B5192-1CDB-4F92-99C4-BB0F8CD700DB}",
"version":1,
"identification":{
"document":"111",
"documentType":"cdtCPF"
}
} |
| PARÂMETRO | TIPO | TAMANHO | OBRIGATÓRIO | DESCRIÇÃO | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Identification | Object Json | true | Informações do tipo de identificação do cliente
| ||||||||||
| Name | String | 50 | true | Nome / Razão social | |||||||||
| Kind | String | true | Tipo de pessoa cktPhysical - Física | ||||||||||
| Taxpayer | String | False | Contribuinte de ICMS yntYes - Sim | ||||||||||
| PublicAgency | String | False | Órgão público yntYes - Sim | ||||||||||
| TaxRegime | Integer | 5 | False | Regime de tributação | |||||||||
| GlobalLimit | Double | 9, 2 | False | Valor limite global | |||||||||
| Deadline | Integer | 3 | False | Prazo máximo em dias | |||||||||
| CreditStatus | String | False | Situação do crédito ccsAlert - Alerta | ||||||||||
| Note | String | 250 | False | Observação | |||||||||
| CardNumber | Integer | 15 | False | Número do cartão | |||||||||
| BusinessSituation | String | False | Situação comercial bstReleased - Liberado | ||||||||||
| KindAddress | String | true | Tipo do endereço katMain - Principal | ||||||||||
| PublicPlace | String | 60 | true | Descrição do logradouro | |||||||||
| PublicPlaceNumber | String | 10 | false | Número do logradouro | |||||||||
| Neighbourhood | String | 50 | true | Descrição do bairro | |||||||||
| Complement | String | 60 | false | Complemento de endereço | |||||||||
| City | String | 60 | true | Nome da cidade | |||||||||
| FederativeUnit | String | 2 | true | Estado da cidade | |||||||||
| ZipCode | Integer | 8 | true | Cep | |||||||||
| IBGE | Integer | 12 | false | Código da cidade no IBGE |
{
"id":"{E20B5192-1CDB-4F92-99C4-BB0F8CD700DB}",
"version":1,
"identification":{
"document":"11111111111",
"documentType":"cdtCPF"
}
}
{
"id":"{B0DAC044-3540-4EBF-988F-18BE345A9609}",
"version":1,
"person":{
"identification":{
"document":"11111111111",
"personCode":0,
"documentType":"cdtCPF",
"identificationType":"citInternal"
},
"corporateName":"Razao social",
"fantasyName":"Nome fantasia",
"kind":"cktPhysical",
"taxpayer":"yntYes",
"publicAgency":"yntNo",
"customer":{
"taxRegime":1,
"globalLimit":1000.5,
"deadline":30,
"lastConstraintDateTime":"2022-09-21T10:00:00.000Z",
"creditStatus":"cstReleased",
"note":"Observacao do cliente",
"cardNumber":12345,
"businessSituation":"bstReleased"
},
"customerSegments":[
{
"idSegment":1,
},
{
"idSegment":2,
}
],
"addresses":[
{
"publicPlaceCode":1000,
"kindAddress":"katMain",
"publicPlace":"Rua nova uniao",
"publicPlaceNumber":"100",
"neighbourhood":"Santa Monica",
"complement":"Cond Novo, bl 50 apto 400",
"city":"Uberlandia",
"federativeUnit":"MG",
"zipCode":38411108,
"iBGE":10
},
{
"publicPlaceCode":500,
"kindAddress":"katDelivery",
"publicPlace":"Rua Araguari",
"publicPlaceNumber":"95",
"neighbourhood":"Centro",
"complement":"Edif Plaza, 10 andar",
"city":"Uberlandia",
"federativeUnit":"MG",
"zipCode":38411108,
"iBGE":10
},
{
"publicPlaceCode":71,
"kindAddress":"katCorrespondence",
"publicPlace":"Av Sebastiao Salgado",
"publicPlaceNumber":"32",
"neighbourhood":"Centro",
"complement":"Edif Central, 15 andar",
"city":"Uberlandia",
"federativeUnit":"MG",
"zipCode":38411108,
"iBGE":10
}
]
}
}