sale/credit_note/edit
POST/sale/credit_note/editThis edits a credit note in the Equotix One account.
Request
The domain you are assigned to authenticate your Equotix One account.
The email address assigned to the user account in your Equotix One.
The unix timestamp used to sign this API request.
The calculated signature for this API request.
The credit note ID to be edited.
The credit note customer ID. Use "0" to create a new customer.
The credit note first name.
The credit note last name.
The credit note company.
The credit note email.
The credit note telephone.
The credit note telephone 2.
The credit note currency code. Must be already added into the account.
The credit note currency value. Enter 0 for auto value.
The credit note payment method.
The credit note total amount.
The credit note comment.
The items in the credit note.
The item ID.
The item name.
The item model code.
The item sku code.
The item quantity.
The item price.
The item cost. Only if API has view cost permission.
Set the default credit note status ID.
{
"domain": "string",
"api_key": "string",
"auth_timestamp": 0,
"auth_signature": "string",
"credit_note_id": 0,
"customer_id": 0,
"firstname": "string",
"lastname": "string",
"company": "string",
"email": "string",
"telephone": "string",
"telephone_2": "string",
"currency": "string",
"currency_value": 0,
"payment_method": "string",
"total": 0,
"comment": "string",
"products": [
{
"item_id": 0,
"name": "string",
"model": "string",
"sku": "string",
"quantity": 0,
"price": 0,
"cost": 0
}
],
"credit_note_status_id": 0
}Responses
Returns only if there is an error.
Returns only if there is no error.
The credit note edited.
The credit note ID.
The related order ID.
The channel credit note ID.
The location ID.
The channel ID.
The channel name.
The payment method.
The customer ID.
The credit note first name.
The credit note last name.
The credit note email.
The credit note first name and last name merged.
The credit note company.
The credit note telephone.
The credit note telephone 2.
The credit note status.
The credit note status ID.
The credit note currency code.
The credit note currency value.
The credit note total.
The credit note cost if user has view permission.
The credit note date time added.
The credit note date time modified.
The credit note comment.
Indicates if the credit note is locked from editing.
The credit note products.
{
"error": [
"string"
],
"success": true,
"credit_note": {
"credit_note_id": 0,
"order_id": 0,
"imported_order_id": "string",
"location_id": 0,
"channel_id": 0,
"channel": "string",
"payment_method": "string",
"customer_id": 0,
"firstname": "string",
"lastname": "string",
"email": "string",
"name": "string",
"company": "string",
"telephone": "string",
"telephone_2": "string",
"credit_note_status": "string",
"credit_note_status_id": 0,
"currency": "string",
"currency_value": 0,
"total": 0,
"cost": 0,
"date_added": "string",
"date_modified": "string",
"comment": "string",
"locked": true,
"products": [
{
"credit_note_product_id": 0,
"imported_order_product_id": "string",
"item_id": 0,
"thumb": "string",
"name": "string",
"model": "string",
"sku": "string",
"quantity": 0,
"price": 0,
"total": 0,
"cost": 0,
"restocked": true
}
]
}
}