Skip to main content
POST
cURL
Credit notes are normally created against a finalized invoice via Create Credit Note on the invoice.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

reason
enum<string>
required
  • duplicated_charge - Duplicated Charge
  • billing_error - Billing Error
  • dispute - Dispute
  • goodwill - Goodwill
  • other - Other
Available options:
duplicated_charge,
billing_error,
dispute,
goodwill,
other
notes
string

Response

201 - application/json
id
integer
required
read-only
invoice
integer
required
read-only
credit_note_number
string
required
read-only
driver
object
required
fleet
integer
required
read-only
reason
enum<string>
required
  • duplicated_charge - Duplicated Charge
  • billing_error - Billing Error
  • dispute - Dispute
  • goodwill - Goodwill
  • other - Other
Available options:
duplicated_charge,
billing_error,
dispute,
goodwill,
other
status
enum<string>
required
  • FINALIZED - Finalized
  • VOID - Void
Available options:
FINALIZED,
VOID
total
string<decimal>
required
read-only
Pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
created_at
string<date-time>
required
read-only
voided_at
string<date-time> | null
required
read-only
pdf_status
required
  • PENDING - Pending
  • IN_PROGRESS - In Progress
  • COMPLETE - Complete
Available options:
PENDING,
IN_PROGRESS,
COMPLETE
items
object[]
required
read-only
attachments
object[]
required
read-only
notes
string