Criar Pagamento Programado

date

required

Data do pagamento

description

string

required

Contexto do pagamento.

amount

int32

required

Valores positivos em centavos. Exemplo: Para representar um valor de R$ 10,20 utilize o valor inteiro como 1020.

account_id

string

required

Identificador único da conta bancária.

relevant_date

date

Mês de competência representado por uma data no primeiro dia do mês. Portanto, mesmo passando 2023-10-12, a data será armazenada como 2023-10-01 para representar outubro/2023.

observations

string

Pode ser usado livremente para comentários ou adição de contexto.

category_id

string

Identificador único da categoria.

contact_id

string

Identificador único do contato/fornecedor.

external_id

string

Identificador único utilizado pelo cliente.

approval_type

string

enum

Critério utilizado no fluxo de aprovação. Ao selecionar all, significa que todos os aprovadores precisam necessariamente autorizar o pagamento. Ao selecionar any, significa que pelo menos um aprovador precisa autorizar o pagamento.

Allowed:

due_date

date

Data de vencimento

nota_fiscal_number

string

Número da nota fiscal

nota_fiscal_issue_date

date

Data de emissão da nota fiscal

assignees_ids

array of strings

Lista de identificadores dos usuários selecionados como responsáveis pela a aprovação desse pagamento.

assignees_ids

classifications

array of objects

Lista de classificações contendo etiquetas que contextualizam o pagamento utilizando a linguagem de negócio da emprasa. Para visualizar a lista de etiquetas, dentro da plataforma, digite ctrl + k + etiquetas (no linux ou windows) ou cmd + k + etiquetas (no mac)

classifications

payment_method

object

Configuração do método de pagamento e informações do destinatário. Para configurar o método de pagamento, escolha entre pix, boleto, credit_card, direct_debit, pix_qr_codee wire_transfer. Depois, insira as informações de pagamento do destinatário relacionado ao método escolhido. Exemplo: pix_key e pix_type para o método pix e digitable_line para boleto

attachments_ids

array of strings

Lista de identificadores únicos de anexos.

attachments_ids

201201

400400

401401

422422