Worksheets

Preview the waste-disposal charge

Reports whether the "smaltimento rifiuti" charge can be applied and its net amount, computed from the company's waste_disposal_* settings: rate% of the net of the goods lines (base: articles) or of every line (base: total), rounded to cents.

reason (null when applicable): disabled — off or no rate; already_applied — a line already carries the configured or the default description; nothing_to_charge — the amount rounds to 0. frozen: the worksheet is behind an issued fiscal document (POST answers 409 conflict); fully_paid: the worksheet is already paid in full (partially paid and unpaid ones can take the charge).

get/v1/worksheets/{id}/waste-disposal

Request

  • Base URL: https://api.officina.it
  • URL: https://api.officina.it/v1/worksheets/{id}/waste-disposal
  • Auth: HTTP bearer

Response

success

objectstring required

always "waste_disposal_preview"

applicableboolean required
reason'disabled' | 'frozen' | 'fully_paid' | 'already_applied' | 'nothing_to_charge' | 'null' nullable required

Null when applicable. frozen (POST answers 409 conflict) and fully_paid only on worksheets.

ratenumber required

Percentage, 1.2 = 1,2%.

base'articles' | 'total' required
descriptionstring required

The line description that would be added.

amountnumber required

Net line amount (before VAT) the charge would add; 0 when not applicable.

Changes

No recorded changes to this operation across all 1 revision of this API.