Retorna cliente com o seu financeiro

curl --request GET \
  --url https://api-integracoes.agulhao.com.br/pessoas/financeiro \
  --header 'x-api-key: <api-key>'

[
  {
    "id": "1",
    "razaoSocial": "RAZÃO SOCIAL DA EMPRESA",
    "documento": "00000000000000",
    "fantasia": "FANTASIA DA EMPRESA",
    "email": "[email protected]",
    "telefone": "1112345678",
    "celular": "11912345678",
    "ultimaAtualizacao": "2025-01-01T00:00:00",
    "endereco": {
      "cidadeId": "1",
      "cidadeNome": "São Paulo",
      "uf": "SP",
      "cep": "01000000",
      "logradouro": "Avenida Paulista",
      "numero": "1000",
      "complemento": "Apto 101",
      "bairro": "Bela Vista"
    },
    "duplicatas": [
      {
        "id": "1",
        "filialId": "1",
        "filialNome": "Filial 1",
        "emissao": "2025-01-01T00:00:00",
        "vencimento": "2025-02-01T00:00:00",
        "numero": "123456",
        "localCobrancaId": "1",
        "valor": 1000,
        "saldo": 500,
        "diasAtrasado": 10,
        "diasVencer": 5
      }
    ]
  }
]

GET

pessoas

financeiro

Retorna cliente com o seu financeiro

curl --request GET \
  --url https://api-integracoes.agulhao.com.br/pessoas/financeiro \
  --header 'x-api-key: <api-key>'

[
  {
    "id": "1",
    "razaoSocial": "RAZÃO SOCIAL DA EMPRESA",
    "documento": "00000000000000",
    "fantasia": "FANTASIA DA EMPRESA",
    "email": "[email protected]",
    "telefone": "1112345678",
    "celular": "11912345678",
    "ultimaAtualizacao": "2025-01-01T00:00:00",
    "endereco": {
      "cidadeId": "1",
      "cidadeNome": "São Paulo",
      "uf": "SP",
      "cep": "01000000",
      "logradouro": "Avenida Paulista",
      "numero": "1000",
      "complemento": "Apto 101",
      "bairro": "Bela Vista"
    },
    "duplicatas": [
      {
        "id": "1",
        "filialId": "1",
        "filialNome": "Filial 1",
        "emissao": "2025-01-01T00:00:00",
        "vencimento": "2025-02-01T00:00:00",
        "numero": "123456",
        "localCobrancaId": "1",
        "valor": 1000,
        "saldo": 500,
        "diasAtrasado": 10,
        "diasVencer": 5
      }
    ]
  }
]

Authorizations

x-api-key

string

header

required

Chave da API gerada no agulhão

Query Parameters

string

Identificador único do usuário

Example:

"1"

duplicataId

string

Identificador único da duplicata

Example:

"1"

pedidoId

string

Identificador único do pedido

Example:

"1"

Response

Sucesso

string

Identificador único do usuário

Example:

"1"

Razão social do usuário

Example:

"RAZÃO SOCIAL DA EMPRESA"

documento

string

CNPJ ou CPF do usuário

Example:

"00000000000000"

fantasia

string

Nome fantasia do usuário

Example:

"FANTASIA DA EMPRESA"

string

E-mail do usuário

Example:

"[email protected]"

telefone

string

Telefone do usuário

Example:

"1112345678"

celular

string

Celular do usuário

Example:

"11912345678"

ultimaAtualizacao

string<date-time>

Data da última atualização do usuário

Example:

"2025-01-01T00:00:00"

endereco

object

Show child attributes

endereco.cidadeId

string

Identificador da cidade do endereço (Código IBGE)

Example:

"1"

endereco.cidadeNome

string

Nome da cidade do endereço

Example:

"São Paulo"

endereco.uf

string

Sigla da unidade federativa do endereço

Example:

"SP"

endereco.cep

string

CEP do endereço

Example:

"01000000"

endereco.logradouro

string

Logradouro do endereço

Example:

"Avenida Paulista"

endereco.numero

string

Número do endereço

Example:

"1000"

endereco.complemento

string

Complemento do endereço

Example:

"Apto 101"

endereco.bairro

string

Bairro do endereço

Example:

"Bela Vista"

duplicatas

object[]

Show child attributes

duplicatas.id

string

Identificador único da duplicata

Example:

"1"

duplicatas.filialId

string

Identificador da filial da duplicata

Example:

"1"

duplicatas.filialNome

string

Nome da filial da duplicata

Example:

"Filial 1"

duplicatas.emissao

string<date-time>

Data de emissão da duplicata

Example:

"2025-01-01T00:00:00"

duplicatas.vencimento

string<date-time>

Data de vencimento da duplicata

Example:

"2025-02-01T00:00:00"

duplicatas.numero

string

Número da duplicata

Example:

"123456"

duplicatas.localCobrancaId

string

Identificador do local de cobrança da duplicata

Example:

"1"

duplicatas.valor

number<float>

Valor da duplicata

Example:

1000

duplicatas.saldo

number<float>

Saldo da duplicata

Example:

500

duplicatas.diasAtrasado

integer

Dias de atraso da duplicata

Example:

10

duplicatas.diasVencer

integer

Dias para vencer da duplicata

Example:

5

Atualiza um pedido existente Retorna duplicatas em aberto

⌘I

produtos-bt

pedidos-bt

pessoas-bt

tipos-lancamento-bt

filiais-bt

Retorna cliente com o seu financeiro

Authorizations

Query Parameters

Response