Worksheets

Register a payment on a worksheet

Mirrors the web worksheet flow: the payment attaches to the worksheet's invoice — a draft is created from the worksheet when none exists yet — and the invoice paid-state is refreshed. payment_method falls back to the customer's preferred method, then the company default, when missing or invalid.

post/v1/worksheets/{id}/payments

Request

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

Request body

amountnumber double required

Must be greater than zero.

payment_methodstring

MP01–MP23. Omitted/invalid values fall back to the customer's preferred method, then the company default.

payment_datestring date

YYYY-MM-DD between 1900-01-01 and 2100-12-31 (same window as WritableTimestamp); default today. Out of range → 422 parameter_invalid.

financial_account_idstring

Conto di saldo (Banca, Cassa, …) — one of the company's accounts from GET /v1/financial-accounts. Optional; an account belonging to another company is rejected with 422.

Response

Payment registered.

object'payment' required
idstring required
amountnumber double required
payment_methodstring required
payment_datestring date-time required
created_atstring date-time required

Changes

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