API Reference

Update a credit note

put
https://api.bizyness.fr/credit_notes/

Replaces a credit note with the provided full payload. Use this endpoint to edit an existing draft or otherwise mutable credit note resource.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Credit note ID

Body Params

Generic writable fields shared by most Bizyness resources.

string

Date associated with execution_date.

tracking_numbers
array of strings

Tracking numbers associated with the resource.

tracking_numbers
tracking_carriers
array of strings

Carriers associated with the tracking numbers.

tracking_carriers
metafields
array of objects

Free-form key/value metadata attached to the resource.

metafields
string

Currency code associated with the resource.

string

Discount amount associated with the resource.

string
enum

Discount type associated with the resource.

Allowed:
string

Rebate rate associated with the resource.

string

Late penalty rate associated with the resource.

string

Identifier of the related activity resource.

string
enum

Template associated with the resource.

Allowed:
string

Shipping amount associated with the resource.

string

Shipping tax rate associated with the resource.

boolean

Whether taxes included is enabled or applicable.

boolean

Whether attachments merged is enabled or applicable.

string

Identifier of the related client resource.

shipping_address
object

Schema describing the Address resource or payload.

string

Subject associated with the resource.

lines_groups
array of objects

List of lines groups associated with the resource.

lines_groups
string

Comment associated with the resource.

boolean

Whether payment conditions included is enabled or applicable.

string
enum

Language associated with the resource.

Allowed:
string

Tax exemption text associated with the resource.

payment_methods
array of strings

List of payment methods associated with the resource.

payment_methods
document_ids
array of strings

List of document ids associated with the resource.

document_ids
lines
array of objects
required

List of lines associated with the resource.

lines*
Responses

Updated 29 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 29 days ago