API Reference

Criar um fornecedor (json)

Permite a criação de um fornecedor e retorna um JSON com os detalhes do fornecedor criado.

Exemplo do Corpo da Requisição

A requisição deve incluir um JSON no corpo (body) com os seguintes campos:

{
    "name": "João da Silva",
    "document": {
        "number": "12345678901",
        "type": "CPF"
    },
    "communication": {
        "contactName": "João Silva",
        "email": "[email protected]",
        "phone": "1122334455",
        "cellPhone": "11987654321",
        "webSite": "www.joaosilva.com"
    },
    "address": {
        "line1": "Rua das Flores",
        "line2": "Apto 101",
        "number": 123,
        "district": "Centro",
        "city": "São Paulo",
        "state": "SP",
        "zipCode": "01001000",
        "country": "Brasil"
    },
    "bankAccountInformation": {        
        "bankNumber":"1",
        "agency": "1234-5",
        "accountNumber": "987654-3",
      	"bankAccountType": 1, //1=conta corrente, 2=conta poupança
        "pixKey":"12345678901",
        "pixKeyType":3 //1=telefone | 2=email | 3=cpf/cnpj | 4-chave aleatória
    },
    "companyInformation": {
        "companyName": "João Silva ME",
        "municipalInscription": "123456789"
    }
}

O identificador do banco(bankNumber) pode ser encontrado na lista de bancos

Language
Credentials
Header
Click Try It! to start a request and see the response here!