Skip to content

Formas de Pagamento

bling_erp_api.resources.payment_methods.PaymentMethodsResource 

PaymentMethodsResource(transport: Transport)

Bases: BaseResource

Operações de formas de pagamentos do Bling.

Este recurso mapeia os endpoints /formas-pagamentos. Os métodos canônicos usam português para acompanhar a documentação oficial. Aliases em inglês estão disponíveis para compatibilidade.

Source code in src/bling_erp_api/resources/base.py 
141
142
143
def __init__(self, transport: Transport) -> None:
    """Create a resource bound to a transport."""
    self._transport = transport

listar 

listar(
    *,
    pagina: int = 1,
    limite: int = 100,
    descricao: str | None = None,
    tipos_pagamentos: list[int] | None = None,
    situacao: int | None = None,
) -> FormasPagamentosGetResponse200

Obtém formas de pagamentos paginadas.

Endpoint: GET /formas-pagamentos

Obtém formas de pagamentos paginadas.

Parameters:

Name Type Description Default
pagina int

N° da página da listagem (Bling: pagina, integer, opcional)

 1
limite int

Quantidade de registros que devem ser exibidos por página (Bling: limite, integer, opcional)

 100
descricao str | None

Descrição da forma de pagamento (Bling: descricao, string, opcional)

 None
tipos_pagamentos list[int] | None

Tipos de pagamento (Bling: tiposPagamentos[], array, opcional)

 None
situacao int | None

Situação (Bling: situacao, integer, opcional)

 None

Returns:

Type Description
FormasPagamentosGetResponse200

Bling API response. Response schemas: 200: FormasPagamentosDadosBaseDTO
Source code in src/bling_erp_api/resources/payment_methods.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
def listar(
    self,
    *,
    pagina: int = 1,
    limite: int = 100,
    descricao: str | None = None,
    tipos_pagamentos: list[int] | None = None,
    situacao: int | None = None,
) -> FormasPagamentosGetResponse200:
    """Obtém formas de pagamentos paginadas.

    Endpoint: GET /formas-pagamentos

    Obtém formas de pagamentos paginadas.

    Args:
        pagina: N° da página da listagem (Bling: ``pagina``, integer, opcional)
        limite: Quantidade de registros que devem ser exibidos por página (Bling: ``limite``, integer, opcional)
        descricao: Descrição da forma de pagamento (Bling: ``descricao``, string, opcional)
        tipos_pagamentos: Tipos de pagamento (Bling: ``tiposPagamentos[]``, array, opcional)
        situacao: Situação (Bling: ``situacao``, integer, opcional)

    Returns:
        Bling API response. Response schemas: 200: FormasPagamentosDadosBaseDTO
    """
    params: QueryParams = {
        "pagina": pagina,
        "limite": limite,
        **_payment_methods_list_params(
            descricao=descricao,
            tipos_pagamentos=tipos_pagamentos,
            situacao=situacao,
        ),
    }
    raw = self._get("/formas-pagamentos", params=params)
    return self._validate_response(FormasPagamentosGetResponse200, raw)

obter 

obter(
    id_forma_pagamento: int,
) -> FormasPagamentosIdFormaPagamentoGetResponse200

Obtém uma forma de pagamento.

Endpoint: GET /formas-pagamentos/{idFormaPagamento}

Obtém uma forma de pagamento pelo ID.

Parameters:

Name Type Description Default
id_forma_pagamento int

ID da forma de pagamento (Bling: idFormaPagamento, integer, obrigatório)

 required

Returns:

Type Description
FormasPagamentosIdFormaPagamentoGetResponse200

Bling API response. Response schemas: 200: FormasPagamentosDadosBaseDTO, FormasPagamentosDadosDTO; 404: ErrorResponse
Source code in src/bling_erp_api/resources/payment_methods.py 
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
def obter(self, id_forma_pagamento: int) -> FormasPagamentosIdFormaPagamentoGetResponse200:
    """Obtém uma forma de pagamento.

    Endpoint: GET /formas-pagamentos/{idFormaPagamento}

    Obtém uma forma de pagamento pelo ID.

    Args:
        id_forma_pagamento: ID da forma de pagamento (Bling: ``idFormaPagamento``, integer, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: FormasPagamentosDadosBaseDTO, FormasPagamentosDadosDTO; 404: ErrorResponse
    """
    raw = self._get(f"/formas-pagamentos/{id_forma_pagamento}")
    return self._validate_response(FormasPagamentosIdFormaPagamentoGetResponse200, raw)

criar 

criar(dados: FormasPagamentosPostRequest) -> FormasPagamentosPostResponse201

Cria uma forma de pagamento.

Endpoint: POST /formas-pagamentos

Cria uma forma de pagamento.

Parameters:

Name Type Description Default
dados FormasPagamentosPostRequest

Dados da forma de pagamento (Bling: request body)

 required

Returns:

Type Description
FormasPagamentosPostResponse201

Bling API response. Response schemas: 201: BasePostResponse; 400: ErrorResponse
Source code in src/bling_erp_api/resources/payment_methods.py 
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
def criar(self, dados: FormasPagamentosPostRequest) -> FormasPagamentosPostResponse201:
    """Cria uma forma de pagamento.

    Endpoint: POST /formas-pagamentos

    Cria uma forma de pagamento.

    Args:
        dados: Dados da forma de pagamento (Bling: request body)

    Returns:
        Bling API response. Response schemas: 201: BasePostResponse; 400: ErrorResponse
    """
    raw = self._post("/formas-pagamentos", json=to_json_object(dados))
    return self._validate_response(FormasPagamentosPostResponse201, raw)

alterar 

alterar(
    id_forma_pagamento: int, dados: FormasPagamentosIdFormaPagamentoPutRequest
) -> FormasPagamentosIdFormaPagamentoPutResponse200

Altera uma forma de pagamento.

Endpoint: PUT /formas-pagamentos/{idFormaPagamento}

Altera uma forma de pagamento pelo ID.

Parameters:

Name Type Description Default
id_forma_pagamento int

ID da forma de pagamento (Bling: idFormaPagamento, integer, obrigatório)

 required
dados FormasPagamentosIdFormaPagamentoPutRequest

Dados da forma de pagamento (Bling: request body)

 required

Returns:

Type Description
FormasPagamentosIdFormaPagamentoPutResponse200

Bling API response. Response schemas: 200: BasePostResponse; 400: ErrorResponse; 404: ErrorResponse
Source code in src/bling_erp_api/resources/payment_methods.py 
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
def alterar(
    self, id_forma_pagamento: int, dados: FormasPagamentosIdFormaPagamentoPutRequest
) -> FormasPagamentosIdFormaPagamentoPutResponse200:
    """Altera uma forma de pagamento.

    Endpoint: PUT /formas-pagamentos/{idFormaPagamento}

    Altera uma forma de pagamento pelo ID.

    Args:
        id_forma_pagamento: ID da forma de pagamento (Bling: ``idFormaPagamento``, integer, obrigatório)
        dados: Dados da forma de pagamento (Bling: request body)

    Returns:
        Bling API response. Response schemas: 200: BasePostResponse; 400: ErrorResponse; 404: ErrorResponse
    """
    raw = self._put(
        f"/formas-pagamentos/{id_forma_pagamento}",
        json=to_json_object(dados),
    )
    return self._validate_response(FormasPagamentosIdFormaPagamentoPutResponse200, raw)

remover 

remover(id_forma_pagamento: int) -> JsonObject

Remove uma forma de pagamento.

Endpoint: DELETE /formas-pagamentos/{idFormaPagamento}

Remove uma forma de pagamento pelo ID.

Parameters:

Name Type Description Default
id_forma_pagamento int

ID da forma de pagamento (Bling: idFormaPagamento, integer, obrigatório)

 required

Returns:

Type Description
JsonObject

Bling API response. Response schemas: 400: ErrorResponse; 404: ErrorResponse
Source code in src/bling_erp_api/resources/payment_methods.py 
226
227
228
229
230
231
232
233
234
235
236
237
238
239
def remover(self, id_forma_pagamento: int) -> JsonObject:
    """Remove uma forma de pagamento.

    Endpoint: DELETE /formas-pagamentos/{idFormaPagamento}

    Remove uma forma de pagamento pelo ID.

    Args:
        id_forma_pagamento: ID da forma de pagamento (Bling: ``idFormaPagamento``, integer, obrigatório)

    Returns:
        Bling API response. Response schemas: 400: ErrorResponse; 404: ErrorResponse
    """
    return self._delete(f"/formas-pagamentos/{id_forma_pagamento}")

alterar_padrao 

alterar_padrao(id_forma_pagamento: int, padrao: int) -> JsonObject

Altera o padrão de uma forma de pagamento.

Endpoint: PATCH /formas-pagamentos/{idFormaPagamento}/padrao

Altera o padrão de uma forma de pagamento pelo ID.

Parameters:

Name Type Description Default
id_forma_pagamento int

ID da forma de pagamento (Bling: idFormaPagamento, integer, obrigatório)

 required
padrao int

1=Pagamento, 2=Devolução, 3=Fiado (Bling: padrao, integer, obrigatório)

 required

Returns:

Type Description
JsonObject

Bling API response. Response schemas: 400: ErrorResponse; 404: ErrorResponse
Source code in src/bling_erp_api/resources/payment_methods.py 
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
def alterar_padrao(self, id_forma_pagamento: int, padrao: int) -> JsonObject:
    """Altera o padrão de uma forma de pagamento.

    Endpoint: PATCH /formas-pagamentos/{idFormaPagamento}/padrao

    Altera o padrão de uma forma de pagamento pelo ID.

    Args:
        id_forma_pagamento: ID da forma de pagamento (Bling: ``idFormaPagamento``, integer, obrigatório)
        padrao: 1=Pagamento, 2=Devolução, 3=Fiado (Bling: padrao, integer, obrigatório)

    Returns:
        Bling API response. Response schemas: 400: ErrorResponse; 404: ErrorResponse
    """
    return self._patch(
        f"/formas-pagamentos/{id_forma_pagamento}/padrao",
        json=to_json_object({"padrao": padrao}),
    )

alterar_situacao 

alterar_situacao(id_forma_pagamento: int, situacao: int) -> JsonObject

Altera a situação de uma forma de pagamento.

Endpoint: PATCH /formas-pagamentos/{idFormaPagamento}/situacao

Altera a situação de uma forma de pagamento pelo ID.

Parameters:

Name Type Description Default
id_forma_pagamento int

ID da forma de pagamento (Bling: idFormaPagamento, integer, obrigatório)

 required
situacao int

1=Ativa, 0=Inativa (Bling: situacao, integer, obrigatório)

 required

Returns:

Type Description
JsonObject

Bling API response. Response schemas: 400: ErrorResponse; 404: ErrorResponse
Source code in src/bling_erp_api/resources/payment_methods.py 
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
def alterar_situacao(self, id_forma_pagamento: int, situacao: int) -> JsonObject:
    """Altera a situação de uma forma de pagamento.

    Endpoint: PATCH /formas-pagamentos/{idFormaPagamento}/situacao

    Altera a situação de uma forma de pagamento pelo ID.

    Args:
        id_forma_pagamento: ID da forma de pagamento (Bling: ``idFormaPagamento``, integer, obrigatório)
        situacao: 1=Ativa, 0=Inativa (Bling: situacao, integer, obrigatório)

    Returns:
        Bling API response. Response schemas: 400: ErrorResponse; 404: ErrorResponse
    """
    return self._patch(
        f"/formas-pagamentos/{id_forma_pagamento}/situacao",
        json=to_json_object({"situacao": situacao}),
    )