Árvore de páginas

Versões comparadas

Chave

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

...

Parâmetros do Corpo (Body Parameters)

ParâmetroTipoDescrição
Document
IdStringIdentificador da requisição
Número do documento de identificação da pessoa
versionIntegerNúmero da versão
credits[0].identificationsArray object JsonLista dos tipos de documento
credits[0].identifications[0].documentStringDocuemento
credits[0].identifications[0].documentTypeString

Tipos de docuemtnos

cdtIDInternal - Código interno;

cdtCPF - CPF;

DocumentTypeString

Tipo de documento de identificação

cdtCPF - CFP

cdtCNPJ - CNPJ;

Formatos de Requisição (Request Formats)

...

Bloco de código
languageactionscript3
{
   "id":"{E20B519258966376-1CDBD0D3-4F9244CC-99C4BA9B-BB0F8CD700DB22065EC4619E}",
   "version":1,
  "identifications":[
 "identification":   {
      "document":"12345678909",
      "documentType":"cdtCPF"
    },
    {
      "document":"1111000000020",
      "documentType":"cdtCPFcdtIDInternal"
    }
  ]
}


Informações para Resposta (Response Information)

Parâmetros do Corpo (Body Parameters)

PARÂMETROTIPOTAMANHOOBRIGATÓRIODESCRIÇÃO
idstring

Identificado único da resposta
versionInteger

Número da versão
person
documentsTipos de documento
Object Json
Sim


Objeto json dos dados do cliente
ParâmetroTipoDescrição
person.documentsArray object Json

Lista de documentos
person.documents[0].document
Document
String
Número do documento de
identificação da pessoa

SimDocumento do cliente
person.documents[0].documentType


Tipo de documento do cliente

DocumentTypeString

Tipo de documento de identificação

cdtCPF - CFP

cdtCNPJ - CNPJ

cdtIE -  Inscrição estadual

cdtRG - RG

person.NameString50SimNome
person.EmailString80NãoEmail do cliente
person.KindString
Sim

Tipo de pessoa

cktPhysical - Física 
cktLegal - Jurídica

person.TaxpayerString
Não

Contribuinte de ICMS

yntYes - Sim
yntNo - Não

person.PublicAgencyString
Não

Órgão público

yntYes - Sim
yntNo - Não

TaxRegimeInteger5NãoRegime de tributaçãoGlobalLimit
person.customerObject json

Objeto json dos dados do cliente
person.customerGlobalLimitDouble9, 2NãoValor limite global
person.customer.DeadlineInteger3NãoPrazo máximo em dias
person.customer.CreditStatusString
Não

Situação do crédito

ccsAlert - Alerta 
ccsReleased - Liberado
ccsBlocked - Bloqueado
ccsSuspended - Suspenso

person.customer.NoteString250NãoObservação
person.customer.CardNumberInteger15NãoNúmero do cartão
person.customer.BusinessSituationString
Não

Situação comercial

bstReleased - Liberado 
bstBlocked - Bloqueado

person.addressesObject json

Objeto json com os dados de endereço
person.addresses.KindAddressString
Sim

Tipo do endereço

katMain - Principal 
katCharge - Cobrança 
katDelivery - Entrega 
katCorrespondence - Correspondência 
katPickUp - Retirada

person.addresses.PublicPlaceString60SimDescrição do logradouro
person.addresses.PublicPlaceNumberString10NãoNúmero do logradouro
person.addresses.NeighbourhoodString50SimDescrição do bairro
person.addresses.ComplementString60NãoComplemento de endereço
person.addresses.CityString60SimNome da cidade
person.addresses.FederativeUnitString2SimEstado da cidade
person.addresses.ZipCodeInteger8SimCep sem formatação
person.addresses.IBGEInteger12NãoCódigo da cidade no IBGE

Formatos de Resposta (Response Formats)

...