API Reference

Criar Pagamento (json)

Realiza um pagamento a um contato. Ao realizar o pagamento, será criado um agendamento e baixa com o valor pago.

Log in to see full request history

Exemplo do Corpo da Requisição

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

{ "accountId": "20dc5550-7cf3-4db9-9e57-c9357f83ebda", "stakeholderId": "8c29e7c8-99e0-44b6-b613-c154b7ca7680", "date": "2024-08-06", "description": "Pagamento de Consultoria", "reference": "Ref-20240806-01", "isFlag": true, "accrualDate": "2024-08-06", "categories": [ { "categoryid": "fd8441bb-a1d9-4546-bab2-fa1ad4b4812c", "value": 200.0, "description": "Serviços de Consultoria" } ], "costcenters": [ { "costcenterid": "236bd958-3aba-4a71-9e3d-443d6094a4b2", "percent": 100, "description": "Centro de Custo A" } ] }

Observação:

  • Se o rateio estiver habilitado, poderá ser passado mais de uma categoria na lista de categories. Neste caso, cada item na lista representará uma parte do valor total, com a soma dos valores correspondendo ao valor total do recebimento.
  • Se o rateio não estiver habilitado, você deve passar apenas uma categoria na lista de categories.
  • A lista de costcenters funciona da mesma forma que a de categories: se o rateio estiver habilitado, poderá ser passado uma lista com vários centros de custo, especificando a porcentagem para cada um. Caso contrário, deve-se passar apenas um centro de custo na lista.
Body Params
string
required

Identificador da conta para pagamento

string
required

Indentificador do contato(fornecedor, funcionário ou sócio) para o pagamento

date
required

Data do pagamento

categories
array of objects
required

Lista de categorias de saída

categories*
costcenters
array of objects

Lista de centros de custo

costcenters
string

Descrição do pagamento

string

Data de competência

string

Referência

boolean

Habilitar agendamento como favorito

Responses

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json