API Reference

Criar recebimento

Realiza um recebimento para um contato(cliente). Ao realizar o recebimento, será criado um agendamento e baixa com o valor recebido.

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": "a4ca5eb3-10a6-4ee1-b554-c86bd51af8d8", 
    "date": "2024-08-06",
    "description": "Recebimento de Serviço",
    "reference": "Ref-20240806-01", 
    "isFlag": false, 
    "accrualDate": "2024-08-06",
    "categories": [
        {
            "categoryid": "fd8441bb-a1d9-4546-bab2-fa1ad4b4812c",
            "value": 100.0,
            "description": "Serviços Prestados"
        },
        {
            "categoryid": "0f8012ba-4938-4982-986d-878756fb99db",
            "value": 100.0,
            "description": "Consultoria"
        }
    ],
    "costcenters": [
        {
            "costcenterid": "236bd958-3aba-4a71-9e3d-443d6094a4b2",
            "percent": 60            
        },
        {
            "costcenterid": "35e73eaf-bb6c-4e46-af92-82efa7e61a99",
            "percent": 40           
        }
    ]
}

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.
Language
Credentials
Header
Click Try It! to start a request and see the response here!