v1

latestOpenAPI 3.0.02026-08-068926279.2 KB

Credits

Create a credit entry

Creates a new credit entry for a client

post/credits

Request body

client_idinteger required

amountnumber required

datestring date required

notestring

sourcestring

invoice_idinteger nullable

Example request

{
  "client_id": 1,
  "amount": 100,
  "date": "2024-01-15",
  "note": "Overpayment from INV-001",
  "source": "manual",
  "invoice_id": 1
}

Response

Credit entry created

idinteger

client_idinteger

amountnumber

datestring date

notestring nullable

sourcestring nullable

invoice_idinteger nullable

phrasestring nullable

Example response

{
  "id": 1,
  "client_id": 1,
  "amount": 100,
  "date": "2024-01-15",
  "note": "Overpayment from INV-001",
  "source": "manual",
  "phrase": "Credit applied"
}