Articles in this section

See more

Sale / Credit Note

Credit Note

The available APIs for credit notes are explained below.

sale/credit_note/add

This adds a credit note to the Equotix One account.

 

Path

/api/sale/credit_note/add

 

POST Parameters

Name Type Required Description
domain string Yes The domain you are assigned to authenticate your Equotix One account.
api_key string Yes The email address assigned to the user account in your Equotix One.
auth_timestamp int Yes The unix timestamp used to sign this API request.
auth_signature string Yes

The calculated signature for this API request.
customer_id string Yes The credit note customer ID. Use "0" to create a new customer.
firstname string Yes

The credit note first name.
lastname string Yes

The credit note last name.
company string Yes

The credit note company.
email string Yes

The credit note email.
telephone string Yes

The credit note telephone.
telephone_2 string Yes

The credit note telephone 2.
currency string Yes

The credit note currency code. Must be already added into the account.
currency_value string Yes

The credit note currency value.
payment_method string Yes

The credit note payment method.
comment string Yes

The credit note comment.
products object Yes

The items in the credit note.
> item_id int Yes

The item ID.
> name string Yes

The item name.
> model string Yes

The item model code.
> sku string Yes

The item sku code.
> quantity int Yes

The item quantity.
> price float Yes

The item price.
> cost float Yes

The item cost.
restock int No

"1" to restock the item back to inventory, "0" to not restock.
credit_note_status_id int No

Set the default credit note status ID.


Response Parameters

Name Type Description
success boolean True if added.
credit_note_id int The newly added credit note ID.
error object The errors relating to the API call.

 

sale/credit_note/edit

This edits a credit note in the Equotix One account.

 

Path

/api/sale/credit_note/edit

 

POST Parameters

Name Type Required Description
domain string Yes The domain you are assigned to authenticate your Equotix One account.
api_key string Yes The email address assigned to the user account in your Equotix One.
auth_timestamp int Yes The unix timestamp used to sign this API request.
auth_signature string Yes

The calculated signature for this API request.
credit_note_id int Yes

The credit note ID to edit.
customer_id string Yes The credit note customer ID. Use "0" to create a new customer.
firstname string Yes

The credit note first name.
lastname string Yes

The credit note last name.
company string Yes

The credit note company.
email string Yes

The credit note email.
telephone string Yes

The credit note telephone.
telephone_2 string Yes

The credit note telephone 2.
currency string Yes

The credit note currency code. Must be already added into the account.
currency_value string Yes

The credit note currency value.
payment_method string Yes

The credit note payment method.
comment string Yes

The credit note comment.
products object Yes

The items in the credit note.
> item_id int Yes

The item ID.
> name string Yes

The item name.
> model string Yes

The item model code.
> sku string Yes

The item sku code.
> quantity int Yes

The item quantity.
> price float Yes

The item price.
> cost float Yes

The item cost.
restock int No

"1" to restock the item back to inventory, "0" to not restock.
credit_note_status_id int No

Set the default credit note status ID.


Response Parameters

Name Type Description
success boolean True if edited.
credit_note_id int The edited credit note ID.
error object The errors relating to the API call.

 

sale/credit_note/delete

This deletes a credit note from the Equotix One account.

 

Path

/api/sale/credit_note/delete

 

POST Parameters

Name Type Required Description
domain string Yes The domain you are assigned to authenticate your Equotix One account.
api_key string Yes The email address assigned to the user account in your Equotix One.
auth_timestamp int Yes The unix timestamp used to sign this API request.
auth_signature string Yes

The calculated signature for this API request.
credit_note_id int Yes

The credit note ID to delete.


Response Parameters

Name Type Description
success boolean True if deleted.
error object The errors relating to the API call.

 

sale/credit_note/get

This gets a list of credit notes or a specific credit note from the Equotix One account.

 

Path

/api/sale/credit_note/get

 

POST Parameters

Name Type Required Description
domain string Yes The domain you are assigned to authenticate your Equotix One account.
api_key string Yes The email address assigned to the user account in your Equotix One.
auth_timestamp int Yes The unix timestamp used to sign this API request.
auth_signature string Yes

The calculated signature for this API request.
credit_note_id int No

The credit note ID to search for specifically.
filter_customer_id int No

Filter the results by customer ID.
filter_channel_id int No

Filter the results by channel ID.
filter_name string No

Filter the results by the customer name.
filter_email string No

Filter the results by the email.
filter_telephone string No

Filter the results by the telephone.
filter_credit_note_status string No

Filter the results by a list of credit note statuses, comma separated.
filter_payment_method string No

Filter the results by the credit note payment method.
filter_date_start string No

Filter the results by the date type, starting from this date. Date type and date end must be set.
filter_date_end string No

Filter the results by the date type, ending at this date. Date type and date start must be set.
filter_date_type string No

Filter the results by the date type - "date_added" or "date_modified".
page int No

Page number of the results.


Response Parameters

Name Type Description
credit_notes object The credit notes results.
> credit_note_id int The credit note ID.
> imported_order_id string The channel credit note ID.
> channel string The channel name.
> payment_method string The payment method.
> customer_id int The customer ID.
> firstname string The credit note first name.
> lastname string The credit note last name.
> email string The credit note email.
> name string The credit note first name and last name merged.
> company string The credit note company.
> telephone string The credit note telephone.
> telephone_2 string The credit note telephone 2.
> credit_note_status string The credit note status.
> credit_note_status_id int The credit note status ID.
> currency string The credit note currency code.
> currency_value float The credit note currency value.
> total float The credit note total.
> cost float The credit note cost.
> date_added string The credit note date added.
> date_modified string The credit note date modified.
> comment string The credit note comment.
> products object The credit note products.
>> credit_note_product_id float The credit note product ID.
>> item_id int The item ID.
>> thumb string The item image URL.
>> name string The item name.
>> model int The item model.
>> sku int The item SKU.
>> quantity float The item quantity.
>> price string The item price.
>> total int The item total price.
>> cost int The item cost.
>> restocked boolean The item restocked status.
total int The total number of results.

 

sale/credit_note/getHistory

This gets a list of order histories for the credit note.

 

Path

/api/sale/credit_note/getHistory

 

POST Parameters

Name Type Required Description
domain string Yes The domain you are assigned to authenticate your Equotix One account.
api_key string Yes The email address assigned to the user account in your Equotix One.
auth_timestamp int Yes The unix timestamp used to sign this API request.
auth_signature string Yes

The calculated signature for this API request.
credit_note_id string Yes

The credit note ID.


Response Parameters

Name Type Description
credit_note_id int The credit note ID.
credit_note_status_id int The credit note status ID.
total int The total number of results.
histories object The list of histories.
> credit_note_status string The credit note status.
> credit_note_status_id int The credit note status ID.
> user string The user who added this history.
> comment string The history comment.
> date_added string The date the history was added.
error object The errors relating to the API call.

 

sale/credit_note/addHistory

This adds a history to the credit note as well as update its order status.

 

Path

/api/sale/credit_note/addHistory

 

POST Parameters

Name Type Required Description
domain string Yes The domain you are assigned to authenticate your Equotix One account.
api_key string Yes The email address assigned to the user account in your Equotix One.
auth_timestamp int Yes The unix timestamp used to sign this API request.
auth_signature string Yes

The calculated signature for this API request.
credit_note_id string Yes

The credit note ID.
credit_note_status_id int Yes

The credit note status ID to update to.
comment string No

The credit note history comment.


Response Parameters

Name Type Description
success boolean True if added.
error object The errors relating to the API call.

 

Comments

0 comments

Article is closed for comments.