---
title: "Agendar recebimento"
method: POST
path: "/v1/schedules/credit"
---

# Agendar recebimento

`POST /v1/schedules/credit`

Cria agendamento de recebimento, com a possibilidade de automatizar a emissão de boletos e notas fiscais, além de permitir a criação de agendamentos com recorrência ou parcelamento.

## Request body

- object
  - `stakeholderId` string, required — Identificador do contato (cliente ou sócio)
  - `scheduleDate` string, required — Data prevista para o recebimento
  - `dueDate` string, required — Data de vencimento do agendamento
  - `categories` object[], required — Lista de categorias
    - `categoryId` string, required — Identificador da categoria
    - `value` number, double, required — Valor da categoria
    - `description` string — Descrição da categoria
  - `costCenterValueType` integer — Tipo de valor do centro de custo (0 para valor, 1 para porcentagem).
  - `costCenters` object[] — Lista de centros de custo
    - `costCenterId` string — Identificador do centro de custo
    - `percent` string — Porcentagem do centro de custo (obrigatório se costCenterValueType for 1).
    - `value` string — Valor do centro de custo, obrigatório se costCenterValueType for 0
  - `accrualDate` string — Data da competência
  - `description` string — Descrição do agendamento
  - `reference` string — Descrição da referência
  - `isFlagged` boolean — Habilitar agendamento como favorito
  - `recurrence` object
    - `enabled` boolean
    - `intervalType` integer — Intervalo da recorrência. 0 = dia, 1 = semana, 2 = mês, 3 = ano
    - `interval` integer — Define o intervalo entre as recorrências para a criação de ocorrências regulares.
    - `recurrenceEndType` string — Define o tempo fim da recorrência. 0 = indeterminado, 1 = por ocorrência, 2 = por data.
    - `maxOccurrences` integer — Quantidade máxima da recorrência
    - `endDate` string — Data final da recorrência. Deve ser preenchida se o tipo da recorrência for "por data"
  - `instalment` object[] — Adiciona lista de parcelas
    - `installmentNumber` integer, required — Identificação do numero da parcela.
    - `value` number, double, required — Valor da parcela
    - `dueDate` string, required — Data de vencimento da parcela
    - `description` string — Descrição do agendamento da parcela
    - `scheduleDate` string — Data prevista para ser realizado.
    - `accrualDate` string — Data da competência
    - `reference` string — Referência do agendamento
  - `collection` object — Automação de cobrança
    - `AutoGenerateCollectionType` integer — Tipo da automação da cobrança. Os valores possíveis são: 2(enviar x dias antes do vencimento) ou 3(enviar imediatamente)
    - `DaysBeforeDueDateToGenerateCollection` integer — Quantidade de dias antes do vencimento para gerar o cobrança. Deve ser enviado quando AutoGenerateCollectionType:2
    - `CollectionProfileId` string — Identificador do perfil de cobrança.
    - `deliveryType` integer — Tipo de envio da cobrança. Os valores possíveis são: 0(envio por email) ou 1(envio para integração do contador)
  - `serviceProfileId` string — Identificador do perfil de serviço
  - `additionalRemarks` string — Informações complementares
  - `additionalServiceDescription` string — Descrição do serviço
  - `stateWhereServiceWasProvided` string — Estado da prestação de serviço em outro município
  - `cityWhereServiceWasProvided` string — Cidade da prestação de serviço em outro município
  - `autoGenerateNFSeType` integer — 2=Dias antes do vencimento, 3=Quando a baixa for realizada, 4= Quando boleto for criado, 5=enviar imediatamente
  - `daysBeforeDueDateToGenerateNFSe` integer — Define a quantidade de dias dias antes da data de vencimento para gerar a nota fiscal.

## Response `200`

200

- object

## Other responses

- `500` — 500

---

[API](https://skmtc.net/nibo/apis/api-empresa.md) · [All operations](https://skmtc.net/nibo/apis/api-empresa/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nibo/api-empresa/revisions/9492ac98cb75/schema)