DOM360
Financeiro

Alterar os parâmetros da plataforma

PATCH
/billing/platform-settings

Muda os padrões e a política. Ausente mantém. O resultado é validado inteiro contra o que está gravado, com a linha travada: duas pessoas mudando campos diferentes ao mesmo tempo não desfazem uma a outra. Um valor fora da faixa é recusado (422) no campo. Um padrão que muda exige reason e vale a partir da competência em effective_from (padrão: a em curso; uma futura fica agendada; uma passada é recusada). Ele alcança todo cliente que herda o campo e nunca um campo negociado com o cliente, mesmo que o valor negociado seja o de tabela. Com vigência na competência corrente, as pré-faturas em revisão dessa competência dos clientes alcançados são recalculadas; as aprovadas não mudam. repricing diz quantas de cada.

Autorização

bearer billing:execute
AutorizaçãoBearer <token>

Credencial da v3: o JWT da sessão (o mesmo da v2) ou um token pessoal dom_pat_…. A lista de escopos de cada operação diz o que ela exige: uma capacidade (agents:read), authenticated ou session-only. Segredo de máquina (X-Agent-Secret, X-API-Token, sdk_…) não é aceito.

Em: header

Escopo: billing:execute

Corpo da requisição

application/json

Definições TypeScript

Use o tipo request body no TypeScript.

O corpo de PATCH /billing/platform-settings. Ausente mantém; o resultado é validado inteiro contra a linha gravada.

Corpo da resposta

application/json

application/json

curl -X PATCH "https://example.com/billing/platform-settings" \  -H "Content-Type: application/json" \  -d '{}'
{  "asaas_auto_publish_customers": true,  "attachment_retention_months": 0,  "billing_type": "boleto",  "draft_text_messages_default": 0,  "draft_voice_minutes_default": 0,  "finance_alert_email": "string",  "fx_quote_stale": true,  "fx_quote_updated_at": "2019-08-24T14:15:22Z",  "fx_update_day": 0,  "ia_markup_percent": "string",  "late_fine_percent": "string",  "late_interest_percent_month": "string",  "late_issue_min_days": 0,  "notice_after_block": true,  "notice_before_block": true,  "notice_before_due_days": 0,  "notice_during_tolerance": true,  "notice_on_due": true,  "provisional_release_hours": 0,  "repricing": null,  "scheduled_terms": null,  "terms": {    "currency": "string",    "due_day": 0,    "platform_monthly_cents": 0,    "receptive_channel_unit_cents": 0,    "text_additional_cents": 0,    "text_ia_allowance_cents": 0,    "text_principal_cents": 0,    "voice_additional_cents": 0,    "voice_ia_allowance_cents": 0,    "voice_principal_cents": 0  },  "tolerance_days": 0,  "updated_at": "2019-08-24T14:15:22Z",  "updated_by": "string"}