Pular para o conteúdo principal
PATCH
Update Cost

Autorizações

Authorization
string
header
obrigatório

Token de API gerado no painel da CentralCart.

Parâmetros de caminho

cost-id
string
obrigatório

ID do custo

Corpo

application/json
name
string
obrigatório

Nome do custo, até 64 caracteres

amount
number
obrigatório

Valor em reais, maior que zero

frequency
enum<string>
obrigatório

Frequência: mensal, semanal, anual ou avulso (ONCE)

Opções disponíveis:
MONTHLY,
WEEKLY,
YEARLY,
ONCE
starts_at
string<date>
obrigatório

Data de início, no formato AAAA-MM-DD. No custo avulso, é a data do gasto

description
string | null

Descrição opcional, até 255 caracteres

ends_at
string<date> | null

Data de fim, no formato AAAA-MM-DD, igual ou depois de starts_at. Ignorada quando frequency é ONCE

Resposta

Custo atualizado.

id
number

ID do custo

store_id
number

ID da loja

name
string

Nome do custo

description
string | null

Descrição do custo

amount
number

Valor do custo em reais, por ocorrência

frequency
enum<string>

Frequência: mensal, semanal, anual ou avulso (ONCE)

Opções disponíveis:
MONTHLY,
WEEKLY,
YEARLY,
ONCE
starts_at
string<date>

Data de início, no formato AAAA-MM-DD

ends_at
string<date> | null

Data de fim, no formato AAAA-MM-DD. Nulo quando o custo não tem fim ou é avulso

created_at
string

Data de cadastro do custo

updated_at
string

Data da última atualização do custo