Contatos
bling_erp_api.resources.contacts.ContactsResource
Bases: BaseResource
Operações de contatos do Bling.
Este recurso mapeia os endpoints /contatos. Os métodos canônicos usam
português para acompanhar a documentação oficial; os métodos em inglês
continuam disponíveis como aliases de compatibilidade.
Source code in src/bling_erp_api/resources/base.py
listar
listar(
*,
pagina: int = 1,
limite: int = 100,
pesquisa: str | None = None,
criterio: ContactListCriterion | None = None,
data_inclusao_inicial: DateFilter | None = None,
data_inclusao_final: DateFilter | None = None,
data_alteracao_inicial: DateFilter | None = None,
data_alteracao_final: DateFilter | None = None,
id_tipo_contato: int | None = None,
id_vendedor: int | None = None,
uf: str | None = None,
telefone: str | None = None,
ids_contatos: Sequence[int] | None = None,
numero_documento: str | None = None,
tipo_pessoa: ContactPersonKind | None = None,
) -> ContatosGetResponse200
Lista contatos.
Endpoint: GET /contatos
Obtém lista paginada de contatos.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
pagina
|
int
|
N° da página da listagem (Bling: |
1
|
limite
|
int
|
Quantidade de registros por página (Bling: |
100
|
pesquisa
|
str | None
|
Termo de pesquisa (Bling: |
None
|
criterio
|
ContactListCriterion | None
|
Critério de listagem: 1=Todos, 2=Ativos, 3=Inativos, 4=Excluídos (Bling: |
None
|
data_inclusao_inicial
|
DateFilter | None
|
Data de inclusão inicial (Bling: |
None
|
data_inclusao_final
|
DateFilter | None
|
Data de inclusão final (Bling: |
None
|
data_alteracao_inicial
|
DateFilter | None
|
Data de alteração inicial (Bling: |
None
|
data_alteracao_final
|
DateFilter | None
|
Data de alteração final (Bling: |
None
|
id_tipo_contato
|
int | None
|
ID do tipo de contato (Bling: |
None
|
id_vendedor
|
int | None
|
ID do vendedor (Bling: |
None
|
uf
|
str | None
|
Sigla da UF (Bling: |
None
|
telefone
|
str | None
|
Telefone do contato (Bling: |
None
|
ids_contatos
|
Sequence[int] | None
|
IDs dos contatos (Bling: |
None
|
numero_documento
|
str | None
|
N° do documento (Bling: |
None
|
tipo_pessoa
|
ContactPersonKind | None
|
Tipo de pessoa: 1=Pessoa Física, 2=Pessoa Jurídica, 3=Outros (Bling: |
None
|
Returns:
| Type | Description |
|---|---|
ContatosGetResponse200
|
Bling API response. Response schemas: 200: ContatosDadosBaseDTO; 404: ErrorResponse |
Source code in src/bling_erp_api/resources/contacts.py
iterar
iterar(
*,
pagina: int = 1,
limite: int = 100,
pesquisa: str | None = None,
criterio: ContactListCriterion | None = None,
data_inclusao_inicial: DateFilter | None = None,
data_inclusao_final: DateFilter | None = None,
data_alteracao_inicial: DateFilter | None = None,
data_alteracao_final: DateFilter | None = None,
id_tipo_contato: int | None = None,
id_vendedor: int | None = None,
uf: str | None = None,
telefone: str | None = None,
ids_contatos: Sequence[int] | None = None,
numero_documento: str | None = None,
tipo_pessoa: ContactPersonKind | None = None,
) -> Iterator[JsonObject]
Itera pelos contatos página a página.
Endpoint: GET /contatos (via paginação automática)
Aceita os mesmos filtros de listar() e busca novas páginas enquanto
o Bling retornar registros no envelope data.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
pagina
|
int
|
N° da página da listagem (Bling: |
1
|
limite
|
int
|
Quantidade de registros por página (Bling: |
100
|
pesquisa
|
str | None
|
Termo de pesquisa (Bling: |
None
|
criterio
|
ContactListCriterion | None
|
Critério de listagem: 1=Todos, 2=Ativos, 3=Inativos, 4=Excluídos (Bling: |
None
|
data_inclusao_inicial
|
DateFilter | None
|
Data de inclusão inicial (Bling: |
None
|
data_inclusao_final
|
DateFilter | None
|
Data de inclusão final (Bling: |
None
|
data_alteracao_inicial
|
DateFilter | None
|
Data de alteração inicial (Bling: |
None
|
data_alteracao_final
|
DateFilter | None
|
Data de alteração final (Bling: |
None
|
id_tipo_contato
|
int | None
|
ID do tipo de contato (Bling: |
None
|
id_vendedor
|
int | None
|
ID do vendedor (Bling: |
None
|
uf
|
str | None
|
Sigla da UF (Bling: |
None
|
telefone
|
str | None
|
Telefone do contato (Bling: |
None
|
ids_contatos
|
Sequence[int] | None
|
IDs dos contatos (Bling: |
None
|
numero_documento
|
str | None
|
N° do documento (Bling: |
None
|
tipo_pessoa
|
ContactPersonKind | None
|
Tipo de pessoa: 1=Pessoa Física, 2=Pessoa Jurídica, 3=Outros (Bling: |
None
|
Returns:
| Type | Description |
|---|---|
Iterator[JsonObject]
|
Iterator sobre os itens da resposta. |
Source code in src/bling_erp_api/resources/contacts.py
obter
Obtém um contato.
Endpoint: GET /contatos/{idContato}
Obtém um contato pelo ID.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id_contato
|
int
|
ID do contato (Bling: |
required |
Returns:
| Type | Description |
|---|---|
ContatosIdContatoGetResponse200
|
Bling API response. Response schemas: 200: ContatosDadosBaseDTO; 404: ErrorResponse |
Source code in src/bling_erp_api/resources/contacts.py
obter_consumidor_final
Obtém o contato Consumidor Final.
Endpoint: GET /contatos/consumidor-final
Obtém os dados do contato Consumidor Final pré-definido.
Returns:
| Type | Description |
|---|---|
ContatosConsumidorFinalGetResponse200
|
Bling API response. Response schemas: 200: ContatosDadosBaseDTO |
Source code in src/bling_erp_api/resources/contacts.py
criar
Cria um contato.
Endpoint: POST /contatos
Cria um novo contato.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dados
|
ContatosPostRequest
|
Dados do contato. Request body schema: ContatosDadosDTO |
required |
Returns:
| Type | Description |
|---|---|
ContatosPostResponse201
|
Bling API response. Response schemas: 201: BasePostResponse; 400: ErrorResponse |
Source code in src/bling_erp_api/resources/contacts.py
alterar
Altera um contato.
Endpoint: PUT /contatos/{idContato}
Altera um contato pelo ID.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id_contato
|
int
|
ID do contato (Bling: |
required |
dados
|
ContatosIdContatoPutRequest
|
Dados do contato para atualização. Request body schema: ContatosDadosDTO |
required |
Returns:
| Type | Description |
|---|---|
JsonObject
|
Bling API response. Response schemas: 204: NoContent; 400: ErrorResponse; 404: ErrorResponse |
Source code in src/bling_erp_api/resources/contacts.py
remover
Remove um contato.
Endpoint: DELETE /contatos/{idContato}
Remove um contato pelo ID.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id_contato
|
int
|
ID do contato (Bling: |
required |
Returns:
| Type | Description |
|---|---|
JsonObject
|
Bling API response. Response schemas: 204: NoContent; 400: ErrorResponse; 404: ErrorResponse |
Source code in src/bling_erp_api/resources/contacts.py
remover_varios
Remove múltiplos contatos.
Endpoint: DELETE /contatos
Remove múltiplos contatos pelos IDs.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
ids_contatos
|
Sequence[int]
|
IDs dos contatos (Bling: |
required |
Returns:
| Type | Description |
|---|---|
ContatosDeleteResponse200
|
Bling API response. Response schemas: 200: ContatosAlertasResponse; 204: NoContent; 400: ErrorResponse |
Source code in src/bling_erp_api/resources/contacts.py
obter_tipo_contato
Obtém os tipos de contato de um contato.
Endpoint: GET /contatos/{idContato}/tipos
Obtém os tipos de contato associados a um contato.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id_contato
|
int
|
ID do contato (Bling: |
required |
Returns:
| Type | Description |
|---|---|
ContatosIdContatoTiposGetResponse200
|
Bling API response. Response schemas: 200: ContatosTipoContatoDTO; 404: ErrorResponse |
Source code in src/bling_erp_api/resources/contacts.py
listar_tipos
Lista tipos de contato.
Endpoint: GET /contatos/tipos
Obtém todos os tipos de contato disponíveis.
Returns:
| Type | Description |
|---|---|
ContatosTiposGetResponse200
|
Bling API response. Response schemas: 200: ContatosTipoContatoDTO |
Source code in src/bling_erp_api/resources/contacts.py
alterar_situacao
Altera a situação de um contato.
Endpoint: PATCH /contatos/{idContato}/situacoes
Altera a situação de um contato pelo ID.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id_contato
|
int
|
ID do contato (Bling: |
required |
situacao
|
ContactStatus
|
Situação do contato: A=Ativo, I=Inativo, E=Excluído, S=Sem cobrança (Bling: |
required |
Returns:
| Type | Description |
|---|---|
JsonObject
|
Bling API response. Response schemas: 204: NoContent; 400: ErrorResponse; 404: ErrorResponse |
Source code in src/bling_erp_api/resources/contacts.py
alterar_situacao_varios
alterar_situacao_varios(
ids_contatos: Sequence[int], situacao: ContactStatus
) -> ContatosSituacoesPostResponse200
Altera a situação de múltiplos contatos.
Endpoint: POST /contatos/situacoes
Altera a situação de múltiplos contatos pelos IDs.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
ids_contatos
|
Sequence[int]
|
IDs dos contatos (Bling: |
required |
situacao
|
ContactStatus
|
Situação: A=Ativo, I=Inativo, E=Excluído, S=Sem cobrança (Bling: |
required |
Returns:
| Type | Description |
|---|---|
ContatosSituacoesPostResponse200
|
Bling API response. Response schemas: 200: ContatosAlertasResponse; 204: NoContent; 400: ErrorResponse |