API Reference

Agendar Recebimento (json)

Cria agendamento de recebimento e retorna um JSON com os detalhes do agendamento criado. Além disso, é possível automatizar a emissão de boletos e notas fiscais, bem como criar agendamentos com recorrência ou parcelamento.

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:

{ "stakeholderId":"1f4d5c78-7f34-4c9f-91c3-6d53728c35a5", "description":"Recebimento de Fatura", "reference":"FAT-20240806-02", "scheduleDate":"2024-08-15", "dueDate":"2024-08-15", "accrualDate":"2024-08-15", "categories":[ { "categoryId":"a4c567a1-3b88-4a9f-b68c-e22356b34a6d", "value":500.0, "description":"Serviços de TI" } ], "costCenterValueType":1, "costCenters":[ { "costCenterId":"3e12a6b9-8f19-4e2b-a2d1-b6a4f895d823", "percent":100, "value": 100, "description":"Centro de Custo Principal" } ], "collection":{ "enabled":false, "daysBeforeScheduleDateToGenerateEntryPromise":2, "deliveryType":0 }, "instalment":[ { "installmentnumber":1, "value":200.0, "duedate":"2024-09-12", "description":"parcela 1", "accrualdate":"2019-08-12", "scheduledate":"2019-08-12", "reference":"referência parcela 1" }, { "installmentnumber":2, "value":200.0, "duedate":"2024-10-12", "description":"parcela 2", "accrualdate":"2019-08-12", "scheduledate":"2019-08-12", "reference":"referência parcela 2" } ], "recurrence": { "enabled": false, "intervaltype": 0, "interval": 1, "recurrenceendtype": 1, "maxoccurrences": 5, "enddate": "2024-08-09" }, "serviceProfileId":"D701ECCE-CBC7-4890-B197-4C15A42C45EC", "additionalRemarks":"Informações complementares", "additionalServiceDescription":"Discriminação do serviço", "stateWhereServiceWasProvided":"RJ", "cityWhereServiceWasProvided":"Niterói", "autoGenerateNFSeType":2, "daysBeforeDueDateToGenerateNFSe": 1, "isFlagged":true }

  • stakeholderId: identificador do contato(cliente).

  • reference: "FAT-20240806-02" referência para o recebimento.

  • scheduleDate: Data prevista para o recebimento.

  • dueDate: Data de vencimento do recebimento.

  • accrualDate: Data de competência.

  • description: Descrição do agendamento.

  • categories: Lista de categorias relacionada ao recebimento, com categoryId, valor e descriçã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 a receber. Se o rateio não estiver habilitado, você deve passar apenas uma categoria na lista de categories.

  • costCenterValueType: Tipo de valor do centro de custo (0 por valor, 1 para porcentagem).

  • Observações sobre o uso de Centros de Custo:
    A lista de costCenters funciona da mesma forma que a de categories. Se o rateio estiver habilitado na empresa, você poderá passar uma lista com vários centros de custo, especificando a porcentagem ou o valor para cada um, dependendo do costCenterValueType que foi definido. Se o rateio não estiver habilitado, poderá ser enviado apenas um centro de custo na lista.

    • Por porcentagem (costCenterValueType: 1): Cada centro de custo deve ter a porcentagem correspondente atribuída.

      {
          "costCenterValueType": 1, // por porcentagem
          "costCenters": [
              {
                  "costCenterId": "3e12a6b9-8f19-4e2b-a2d1-b6a4f895d823",
                  "percent-":100
              }    
          ]
      
      

    • Por valor (costCenterValueType: 0): Cada centro de custo deve ter o valor correspondente atribuído.

      {
          "costCenterValueType": 0, // por valor
          "costCenters": [
              {
                  "costCenterId": "3e12a6b9-8f19-4e2b-a2d1-b6a4f895d823",
                  "value": 500
              }    
          ]
      }
      

  • collection: Automação de boleto
    • enabled: Define se a automação do boleto está ativada ou desativada.
    • daysBeforeScheduleDateToGenerateEntryPromise: Quantidade de dias antes da data de vencimento (dueDate) para gerar o boleto.
      Exemplo: 2 indica que o boleto será gerado 2 dias antes da data de vencimento. Se o valor for 0, o boleto será enviado imediatamente.
    • deliveryType: Define o tipo de envio do boleto.
      0: Envio por e-mail do contato(cliente)
      1: Envio para a integração do contador.
  • instalment: Parcelamento
    • Permite realizar parcelamento, cada parcela será um agendamento criado.
    • Se o campo de parcelamento (instalment) for utilizado, os valores de descrição e data de vencimento e valor serão obtidos das propriedades dentro de cada objeto de parcela e não das propriedades globais do payload. Ou seja:
      • A propriedade description de cada parcela será utilizada para descrever individualmente cada parcela.
      • A propriedade duedate de cada parcela será considerada como a data de vencimento dessa parcela específica.
      • A propriedade value das categorias informadas no campo categories será substituído pelo valor correspondente à parcela atual. Isso significa que o valor da categoria será determinado pelo valor da parcela em que está sendo aplicado, ignorando o valor global das categorias.
        As propriedades description e duedate externas ao objeto instalment não serão consideradas quando o parcelamento for informado.
  • recurrence: Recorrência
    • enabled: Define se recorrência será ativada.
    • intervaltype: Intervalo da recorrência. 0 = dia, 1 = semana, 2 = mês, 3 = ano
    • interval: Define o intervalo entre as recorrências para a criação de ocorrências regulares.
    • recurrenceEndType: Define o tempo fim da recorrência. 0 = indeterminado, 1 = por ocorrência, 2 = por data.
    • maxOccurrences: Quantidade máxima da recorrência.
    • endDate: Data final da recorrência. Deve ser preenchida se recurrenceEndType for "por data"
  • Deve ser enviado apenas um objeto Parcelamento ou Recorrência
  • Automatizar Emissão de nota:
    • ServiceProfileId: Identificador do perfil de serviço. O idenficador pode ser encontrado neste endpoint Lista perfis de serviço
    • stateWhereServiceWasProvided e cityWhereServiceWasProvided devem ser preenchidos se a prestação de serviço for em outro municipio.
    • autoGenerateNFSeType: Define a automação de nota fiscal. 2=Dias antes do vencimento, 3=Quando a baixa for realizada, 4= Quando boleto for criado, 5=enviar imediatamente
    • daysBeforeDueDateToGenerateNFSe: Define a quantidade de dias antes do vencimento se autoGenerateNFSeType for 2(Dias antes do vencimento).
Body Params
string
required

Identificador de um contato do tipo: cliente.

date
required

Data prevista para o recebimento

date
required

Data de vencimento do agendamento

categories
array of objects
required

Lista de categorias

categories*
int32

Tipo de valor do centro de custo (0 para valor, 1 para percentagem).

costCenters
array of objects

Lista de centro de custo

costCenters
date

Data de competência

string

Descrição do agendamento

string

Descrição da referência

boolean

Habilitar agendamento como favorito

recurrence
object

Habilitar recorrência

instalment
array of objects

Adiciona lista de parcelas

instalment
collection
object

Automação de boleto

string

Identificador do perfil de serviço

string

Informações complementares

string

Descrição do serviço

string

Estado da prestação de serviço em outro município

string

Cidade da prestação de serviço em outro município

int32

2=Dias antes do vencimento, 3=Quando a baixa for realizada, 4= Quando boleto for criado, 5=enviar imediatamente

int32

Dias antes da data de vencimento

Responses

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