Retenções

Os valores retidos na fonte pelo cliente, que podem ser convertidos em crédito.

Comando	HTTP	Descrição
withholdings list	GET /v1/withholdings	Listar retenções
withholdings get	GET /v1/withholdings/{id}	Obter retenção
withholdings convert-to-credit	POST /v1/withholdings/{id}/convert-to-credit	Converter retenção em crédito
withholdings convert-to-credits create	POST /v1/withholdings/convert-to-credits	Converter retenções pendentes em créditos (em lote)

Exemplos

--params carrega parâmetros de query e de caminho (id, página, filtros); --json carrega o corpo da requisição; --fields limita os campos que voltam — vale a pena em todo list/get, para economizar contexto. Veja Flags globais para a referência completa.

# Listar retenções
kobana billing withholdings list \
  --fields "id,public_id,external_id,organization_id,invoice_id"

# Obter retenção
kobana billing withholdings get --params '{"id": "WITHHOLDING_ID"}'

# Converter retenções pendentes em créditos (em lote)
kobana billing withholdings convert-to-credits create \
  --json '{"tax_type": "iss", "competence_year": 0, "competence_month": 0}'

# Converter retenção em crédito
kobana billing withholdings convert-to-credit \
  --params '{"id": "WITHHOLDING_ID"}' \
  --json '{"amount_cents": 100}'

Próximos passos

• Cupons
• Introspecção de schema — todos os parâmetros que este recurso aceita.