Sign in

v1

latestOpenAPI 3.0.12026-07-24373659.1 KB
Clientes

Criar novo cliente

post/api/v1/customers

Headers

Idempotency-Keystring

public.api.idempotency.key

Request body

namestring required

Nome do cliente.

cpfCnpjstring required

CPF ou CNPJ do cliente.

emailstring

Email do cliente.

phonestring

Fone fixo.

mobilePhonestring

Fone celular.

externalReferencestring

Identificador único do cliente no seu sistema.

observationsstring

Observações adicionais.

Example request

{
  "name": "John Doe",
  "cpfCnpj": "24971563792",
  "email": "john.doe@asaas.com.br",
  "phone": "4738010919",
  "mobilePhone": "4799376637",
  "billingAddress": {
    "postalCode": "01310000",
    "address": "Av. Paulista",
    "addressNumber": "150",
    "complement": "Sala 201",
    "province": "Centro",
    "cityName": "São Paulo",
    "stateAbbrev": "SP",
    "country": "Brasil"
  },
  "deliveryAddress": {
    "postalCode": "01310000",
    "address": "Av. Paulista",
    "addressNumber": "150",
    "complement": "Sala 201",
    "province": "Centro",
    "cityName": "São Paulo",
    "stateAbbrev": "SP",
    "country": "Brasil",
    "name": "John Doe",
    "cpfCnpj": "24971563792",
    "email": "john.doe@asaas.com.br",
    "phone": "4738010919"
  },
  "taxInformation": {
    "stateInscription": "991234560",
    "municipalInscription": "1234567890000",
    "typeOfTaxPayer": "CONTRIBUINTE_ICMS",
    "finalConsumer": true,
    "simpleTax": true
  },
  "externalReference": "12987382",
  "observations": "ótimo pagador, nenhum problema até o momento"
}

Response

OK

namestring required

Nome do cliente.

cpfCnpjstring required

CPF ou CNPJ do cliente.

emailstring

Email do cliente.

phonestring

Fone fixo.

mobilePhonestring

Fone celular.

externalReferencestring

Identificador único do cliente no seu sistema.

observationsstring

Observações adicionais.

idinteger

Identificador único do cliente no Base.

deletedboolean

Cliente excluido True/False

asaasIdstring

Identificador único do cliente no Asaas.

Example response

{
  "name": "John Doe",
  "cpfCnpj": "24971563792",
  "email": "john.doe@asaas.com.br",
  "phone": "4738010919",
  "mobilePhone": "4799376637",
  "billingAddress": {
    "postalCode": "01310000",
    "address": "Av. Paulista",
    "addressNumber": "150",
    "complement": "Sala 201",
    "province": "Centro",
    "cityName": "São Paulo",
    "stateAbbrev": "SP",
    "country": "Brasil"
  },
  "deliveryAddress": {
    "postalCode": "01310000",
    "address": "Av. Paulista",
    "addressNumber": "150",
    "complement": "Sala 201",
    "province": "Centro",
    "cityName": "São Paulo",
    "stateAbbrev": "SP",
    "country": "Brasil",
    "name": "John Doe",
    "cpfCnpj": "24971563792",
    "email": "john.doe@asaas.com.br",
    "phone": "4738010919"
  },
  "taxInformation": {
    "stateInscription": "991234560",
    "municipalInscription": "1234567890000",
    "typeOfTaxPayer": "CONTRIBUINTE_ICMS",
    "finalConsumer": true,
    "simpleTax": true
  },
  "externalReference": "12987382",
  "observations": "ótimo pagador, nenhum problema até o momento",
  "id": 109988777,
  "asaasId": "cus_0001919199"
}