Billing

Update an existing invoice, e.g. status or metadata

post/api/v1/billing.invoices.update

Request

  • Base URL: https://api.partly.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.partly.com/api/v1/billing.invoices.update
  • Auth: none declared. Required headers: authorization

Headers

authorizationstring required

UTF-8 encoded string

Request body

due_datestring date-time nullable

DateTime at a given timezone (RFC3339 format)

invoice_idstring uuid required

UUID value type

metadataSerdeJsonValue

JSON value type

Response

200 OK

created_atstring date-time required

DateTime at a given timezone (RFC3339 format)

currency_idstring uuid required

UUID value type

customer_idstring uuid required

UUID value type

due_datestring date-time nullable

DateTime at a given timezone (RFC3339 format)

external_idsobject nullable

Key-value map type

idstring uuid required

UUID value type

invoice_period_endstring date-time nullable

DateTime at a given timezone (RFC3339 format)

invoice_period_startstring date-time nullable

DateTime at a given timezone (RFC3339 format)

metadataSerdeJsonValue required

JSON value type

original_invoice_idstring uuid

UUID value type

payment_urlstring

UTF-8 encoded string

reference_numberstring required

UTF-8 encoded string

subscription_idstring uuid

UUID value type

subscription_period_idstring uuid

UUID value type

subtotal_amountstring required

UTF-8 encoded string

tax_amountstring required

UTF-8 encoded string

tax_ratestring required

UTF-8 encoded string

total_amountstring required

UTF-8 encoded string

updated_atstring date-time required

DateTime at a given timezone (RFC3339 format)

Changes

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