Skip to content

Contas a Pagar

bling_erp_api.resources.contas_pagar.ContasPagarResource 

ContasPagarResource(transport: Transport)

Bases: BaseResource

Operações de contas a pagar do Bling.

Este recurso mapeia os endpoints /contas/pagar. 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 
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,
    data_emissao_inicial: str | None = None,
    data_emissao_final: str | None = None,
    data_vencimento_inicial: str | None = None,
    data_vencimento_final: str | None = None,
    data_pagamento_inicial: str | None = None,
    data_pagamento_final: str | None = None,
    situacao: int | None = None,
    id_contato: int | None = None,
) -> ContasPagarGetResponse200

Lista contas a pagar.

Endpoint: GET /contas/pagar

Obtém lista paginada de contas a pagar.

Parameters:

Name Type Description Default
pagina int

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

 1
limite int

Registros por página (Bling: limite, integer, opcional)

 100
data_emissao_inicial str | None

Data de emissão inicial (Bling: dataEmissaoInicial, string, opcional)

 None
data_emissao_final str | None

Data de emissão final (Bling: dataEmissaoFinal, string, opcional)

 None
data_vencimento_inicial str | None

Data de vencimento inicial (Bling: dataVencimentoInicial, string, opcional)

 None
data_vencimento_final str | None

Data de vencimento final (Bling: dataVencimentoFinal, string, opcional)

 None
data_pagamento_inicial str | None

Data de pagamento inicial (Bling: dataPagamentoInicial, string, opcional)

 None
data_pagamento_final str | None

Data de pagamento final (Bling: dataPagamentoFinal, string, opcional)

 None
situacao int | None

1=Em aberto, 2=Pago, 3=Parcial, 4=Devolvido, 5=Cancelado (Bling: situacao, integer, opcional)

 None
id_contato int | None

ID do contato (Bling: idContato, integer, opcional)

 None

Returns:

Type Description
ContasPagarGetResponse200

Bling API response. Response schemas: 200: ContasDadosBaseDTO
Source code in src/bling_erp_api/resources/contas_pagar.py 
 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
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
def listar(  # noqa: PLR0913
    self,
    *,
    pagina: int = 1,
    limite: int = 100,
    data_emissao_inicial: str | None = None,
    data_emissao_final: str | None = None,
    data_vencimento_inicial: str | None = None,
    data_vencimento_final: str | None = None,
    data_pagamento_inicial: str | None = None,
    data_pagamento_final: str | None = None,
    situacao: int | None = None,
    id_contato: int | None = None,
) -> ContasPagarGetResponse200:
    """Lista contas a pagar.

    Endpoint: GET /contas/pagar

    Obtém lista paginada de contas a pagar.

    Args:
        pagina: N° da página (Bling: ``pagina``, integer, opcional)
        limite: Registros por página (Bling: ``limite``, integer, opcional)
        data_emissao_inicial: Data de emissão inicial (Bling: ``dataEmissaoInicial``, string, opcional)
        data_emissao_final: Data de emissão final (Bling: ``dataEmissaoFinal``, string, opcional)
        data_vencimento_inicial: Data de vencimento inicial (Bling: ``dataVencimentoInicial``, string, opcional)
        data_vencimento_final: Data de vencimento final (Bling: ``dataVencimentoFinal``, string, opcional)
        data_pagamento_inicial: Data de pagamento inicial (Bling: ``dataPagamentoInicial``, string, opcional)
        data_pagamento_final: Data de pagamento final (Bling: ``dataPagamentoFinal``, string, opcional)
        situacao: 1=Em aberto, 2=Pago, 3=Parcial, 4=Devolvido, 5=Cancelado (Bling: ``situacao``, integer, opcional)
        id_contato: ID do contato (Bling: ``idContato``, integer, opcional)

    Returns:
        Bling API response. Response schemas: 200: ContasDadosBaseDTO
    """
    params: QueryParams = {
        "pagina": pagina,
        "limite": limite,
        **_contas_pagar_list_params(
            data_emissao_inicial=data_emissao_inicial,
            data_emissao_final=data_emissao_final,
            data_vencimento_inicial=data_vencimento_inicial,
            data_vencimento_final=data_vencimento_final,
            data_pagamento_inicial=data_pagamento_inicial,
            data_pagamento_final=data_pagamento_final,
            situacao=situacao,
            id_contato=id_contato,
        ),
    }
    raw = self._get("/contas/pagar", params=params)
    return self._validate_response(ContasPagarGetResponse200, raw)

obter 

obter(id_conta_pagar: int) -> ContasPagarIdContaPagarGetResponse200

Obtém uma conta a pagar.

Endpoint: GET /contas/pagar/{idContaPagar}

Obtém uma conta a pagar pelo ID.

Parameters:

Name Type Description Default
id_conta_pagar int

ID da conta a pagar (Bling: idContaPagar, integer, obrigatório)

 required

Returns:

Type Description
ContasPagarIdContaPagarGetResponse200

Bling API response. Response schemas: 200: ContasPagarDadosDTO; 404: ErrorResponse
Source code in src/bling_erp_api/resources/contas_pagar.py 
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
def obter(self, id_conta_pagar: int) -> ContasPagarIdContaPagarGetResponse200:
    """Obtém uma conta a pagar.

    Endpoint: GET /contas/pagar/{idContaPagar}

    Obtém uma conta a pagar pelo ID.

    Args:
        id_conta_pagar: ID da conta a pagar (Bling: ``idContaPagar``, integer, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: ContasPagarDadosDTO; 404: ErrorResponse
    """
    raw = self._get(f"/contas/pagar/{id_conta_pagar}")
    return self._validate_response(ContasPagarIdContaPagarGetResponse200, raw)

criar 

criar(dados: JsonObject) -> ContasPagarPostResponse201

Cria uma conta a pagar.

Endpoint: POST /contas/pagar

Cria uma nova conta a pagar.

Parameters:

Name Type Description Default
dados JsonObject

Dados da conta. Request body: ContasPagarSalvarDTO

 required

Returns:

Type Description
ContasPagarPostResponse201

Bling API response. Response schemas: 201: ContasPagarPostResponse201; 400: ErrorResponse
Source code in src/bling_erp_api/resources/contas_pagar.py 
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
def criar(self, dados: JsonObject) -> ContasPagarPostResponse201:
    """Cria uma conta a pagar.

    Endpoint: POST /contas/pagar

    Cria uma nova conta a pagar.

    Args:
        dados: Dados da conta. Request body: ContasPagarSalvarDTO

    Returns:
        Bling API response. Response schemas: 201: ContasPagarPostResponse201; 400: ErrorResponse
    """
    raw = self._post("/contas/pagar", json=to_json_object(dados))
    return self._validate_response(ContasPagarPostResponse201, raw)

alterar 

alterar(
    id_conta_pagar: int, dados: JsonObject
) -> ContasPagarIdContaPagarPutResponse200

Altera uma conta a pagar.

Endpoint: PUT /contas/pagar/{idContaPagar}

Parameters:

Name Type Description Default
id_conta_pagar int

ID da conta a pagar (Bling: idContaPagar, integer, obrigatório)

 required
dados JsonObject

Dados da conta para atualização

 required

Returns:

Type Description
ContasPagarIdContaPagarPutResponse200

Bling API response. Response schemas: 200: ContasPagarIdContaPagarPutResponse200; 400: ErrorResponse; 404: ErrorResponse
Source code in src/bling_erp_api/resources/contas_pagar.py 
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
def alterar(
    self, id_conta_pagar: int, dados: JsonObject
) -> ContasPagarIdContaPagarPutResponse200:
    """Altera uma conta a pagar.

    Endpoint: PUT /contas/pagar/{idContaPagar}

    Args:
        id_conta_pagar: ID da conta a pagar (Bling: ``idContaPagar``, integer, obrigatório)
        dados: Dados da conta para atualização

    Returns:
        Bling API response. Response schemas: 200: ContasPagarIdContaPagarPutResponse200; 400: ErrorResponse; 404: ErrorResponse
    """
    raw = self._put(f"/contas/pagar/{id_conta_pagar}", json=to_json_object(dados))
    return self._validate_response(ContasPagarIdContaPagarPutResponse200, raw)

remover 

remover(id_conta_pagar: int) -> JsonObject

Remove uma conta a pagar.

Endpoint: DELETE /contas/pagar/{idContaPagar}

Parameters:

Name Type Description Default
id_conta_pagar int

ID da conta a pagar (Bling: idContaPagar, integer, obrigatório)

 required

Returns:

Type Description
JsonObject

Bling API response. Response schemas: 204: NoContent; 400: ErrorResponse; 404: ErrorResponse
Source code in src/bling_erp_api/resources/contas_pagar.py 
256
257
258
259
260
261
262
263
264
265
266
267
def remover(self, id_conta_pagar: int) -> JsonObject:
    """Remove uma conta a pagar.

    Endpoint: DELETE /contas/pagar/{idContaPagar}

    Args:
        id_conta_pagar: ID da conta a pagar (Bling: ``idContaPagar``, integer, obrigatório)

    Returns:
        Bling API response. Response schemas: 204: NoContent; 400: ErrorResponse; 404: ErrorResponse
    """
    return self._delete(f"/contas/pagar/{id_conta_pagar}")

baixar 

baixar(
    id_conta_pagar: int, dados: ContasBaixarContaDTO
) -> ContasPagarIdContaPagarBaixarPostResponse200

Baixa uma conta a pagar (registra o pagamento).

Endpoint: POST /contas/pagar/{idContaPagar}/baixar

Cria o pagamento de uma conta a pagar.

Parameters:

Name Type Description Default
id_conta_pagar int

ID da conta a pagar (Bling: idContaPagar, integer, obrigatório)

 required
dados ContasBaixarContaDTO

Dados da baixa. Request body: ContasBaixarContaDTO

 required

Returns:

Type Description
ContasPagarIdContaPagarBaixarPostResponse200

Bling API response. Response schemas: 200: bordero; 400: ErrorResponse
Source code in src/bling_erp_api/resources/contas_pagar.py 
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
def baixar(
    self,
    id_conta_pagar: int,
    dados: ContasBaixarContaDTO,
) -> ContasPagarIdContaPagarBaixarPostResponse200:
    """Baixa uma conta a pagar (registra o pagamento).

    Endpoint: POST /contas/pagar/{idContaPagar}/baixar

    Cria o pagamento de uma conta a pagar.

    Args:
        id_conta_pagar: ID da conta a pagar (Bling: ``idContaPagar``, integer, obrigatório)
        dados: Dados da baixa. Request body: ContasBaixarContaDTO

    Returns:
        Bling API response. Response schemas: 200: bordero; 400: ErrorResponse
    """
    raw = self._post(f"/contas/pagar/{id_conta_pagar}/baixar", json=to_json_object(dados))
    return self._validate_response(ContasPagarIdContaPagarBaixarPostResponse200, raw)