Cadastrar tipo de documento

post

https://api2.webdanca.com/v1/document-types

Cadastra um novo tipo de documento.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

Nome do tipo de documento.

type

string

enum

required

Se é um tipo de documento de recebimento ou de pagamento.
receipt: recebimento
payment: pagamento

Allowed:

fines

float

Defaults to 0

Valor da porcentagem de multa por atraso.

interest

float

Defaults to 0

Valor da porcentagem de juros.

discount_1_days

integer

Primeiro desconto por dias antes do vencimento.

discount_1_days_percentage

float

Valor da porcentagem de desconto.

discount_1_days_amount

float

Valor de desconto.

discount_2_days

integer

Segundo desconto por dias antes do vencimento.

discount_2_days_percentage

float

Porcentagem de desconto.

discount_2_days_amount

float

Valor de desconto.

financial_account_id

integer

required

ID da conta financeira.

allows_in_forward_sale

boolean

required

Se pode ser utilizado em lançamentos a prazo.

requires_document_number

boolean

required

Se exige o número do documento nos lançamentos.

allows_in_pending_installments

boolean

required

Se pode ser utilizado em lançamentos pendentes (não-recebidos).

allows_in_paid_installments

boolean

required

Se pode ser utilizado em lançamentos realizados (quitados).

allows_in_enrollments_screen

boolean

required

Se pode aparecer na tela de matrícula.

allows_in_receipt_screen

boolean

required

Se pode aparecer na tela de recebimentos.

composes_the_cash_balance

boolean

required

Se deve compor saldo.

attached_fee_percentage

float

Valor da porcentagem da taxa anexa.

attached_fee_supplier_id

integer

ID do fornecedor da taxa anexa.

attached_fee_description

string

Descrição da taxa anexa.

attached_fee_document_type_id

integer

ID do tipo de documento da taxa anexa.

attached_fee_chart_of_account_id

integer

ID do plano de contas da taxa anexa.

tax_type

string

enum

Tipo fiscal.
cash: Dinheiro
check: Cheque
credit_card: Cartão de crédito
debit_card: Cartão de Débito
store_credit: Crédito Loja
food_voucher: Vale Alimentação
meal_voucher: Vale Refeição
gift_voucher: Vale Presente
fuel_voucher: Vale Combustível
bank_slip: Boleto Bancário
bank_deposit: Depósito Bancário
pix: PIX
bank_transfer: Transferência bancária, Carteira Digital
rewards_program: Programa de fidelidade, Cashback, Crédito Virtual
no_payment: Sem pagamento
others: Outros

charging_with_bank_slip

boolean

required

Se gera fatura de cobrança (Boleto).

charging_with_pix

boolean

required

Se gera fatura de cobrança (PIX).

Response

200OK