Finance

List all Credit Notes

Returns a list of your Credit Notes.

get/admin/finance/credit-notes

Request

Base URL: https://demo.splynx.com/api/2.0
URL: https://demo.splynx.com/api/2.0/admin/finance/credit-notes
Auth: HTTP basic

Response

customer_idnumber required

Customer ID

date_createdstring

Create date. Format: YYYY-MM-DD

date_updatedstring

Update date. Format: YYYY-MM-DD

date_paymentstring

Payment date. Format: YYYY-MM-DD

statusstring required

Status. Values: 'not_refunded' for "Not refunded", 'refunded' for "Refunded" and 'deleted' for "Deleted"

numberstring required

Number

payment_idnumber

Payment ID.

resetPeriodForServiceboolean

Resets the 'invoiced until' date on an invoice item. Default: false

notestring

Note

is_sent'0' | '1'

Is sent

idnumber

Credit note ID

real_create_datetimestring

Real create date. Format: YYYY-MM-DD H:i:s

totalnumber

Total

remind_amountnumber

Remind amount

added_by'system' | 'api' | 'admin'

Added by

added_by_idnumber

Added by ID

partiallyUseboolean

When credit note is partially used. Default: false

Example response

[
  {
    "customer_id": 1,
    "date_created": "2016-01-01",
    "date_updated": "",
    "date_payment": "",
    "status": "not_refunded",
    "number": "201601010003",
    "payment_id": 0,
    "resetPeriodForService": true,
    "note": "",
    "is_sent": "0",
    "items": [
      {
        "description": "Desc of item",
        "quantity": 1,
        "unit": 0,
        "price": 123,
        "tax": 0,
        "sub_account_id": 0,
        "invoice_item_id": 0
      }
    ],
    "id": 1,
    "real_create_datetime": "2024-05-27 15:40:22",
    "total": 10,
    "remind_amount": 0,
    "added_by": "system",
    "added_by_id": 1,
    "partiallyUse": true
  }
]

Changes

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