Sign in
latestOpenAPI 3.0.0Apache 2.02026-08-201250995.7 KB

bd9694db5fce

Credit Notes

Create a new Credit Note

Create a Credit Note

post/api/v1/credit-notes

Request body

clinic_idinteger required
sale_idinteger
customer_idinteger required
amountnumber float required
reasonstring required
datestring date-time required

Creation date and time in UTC as Zulu ISO8601

descriptionstring

Credit note description

Example request

{
  "clinic_id": 1,
  "sale_id": 1,
  "customer_id": 1,
  "amount": 100,
  "reason": "Reason for CreditNote",
  "date": "2021-01-30T08:30:00Z",
  "description": "Short description"
}

Response

Successful operation

Example response

{
  "data": {
    "id": 1,
    "clinic_id": 1,
    "vet_id": 1,
    "sale_id": 1,
    "customer_id": 1,
    "status": "opened",
    "type": "product_return",
    "series": "DGT",
    "number": "1",
    "tax_amount": "250.00",
    "subtotal": "250.00",
    "total": "250.00",
    "description": "Short description",
    "made_at": "2021-01-30T08:30:00Z",
    "voided_at": "2021-01-30T08:30:00Z",
    "created_at": "2022-07-18T08:58:36.000000Z",
    "updated_at": "2022-07-18T08:58:36.000000Z"
  }
}