THthredfi
Customer Credits

Create Customer Credit

Create a customer credit note with line items and optional allocations.

post/v1/platform/businesses/{business_id}/customer-credits/

Request

  • Base URL
    https://docs.thredfi.com (the document declares no server; this is the origin it was published from)
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or HTTP basic
    • or HTTP bearer
    • or HTTP bearer

Path parameters

business_idstring uuid required

Business UUID provided by Thred (unique identifier for the business)

Request body

external_idstring required

External system identifier for this customer credit

customer_idstring uuid

Existing customer ID to assign credit to

customer_external_idstring

External customer ID. Will create customer if not found

source_invoice_idstring uuid nullable

Optional invoice ID this credit note was created from (origin tracking, not allocation)

sent_atstring date-time

When the credit was sent (ISO 8601 format). Defaults to now

tagsobject[]

Transaction tags for the credit

Response

idstring uuid required

Unique customer credit identifier

external_idstring

Your external system identifier for this credit

status'draft' | 'sent' | 'applied' | 'partially_applied' | 'void' required

Credit status: draft, sent, partially_applied, applied, void (computed from allocations)

sent_atstring date-time required

When the credit was sent

customerobject required

Customer receiving this credit (inline details)

source_invoice_idstring uuid nullable required

Invoice ID this credit was created from (origin tracking, not allocation)

tagsobject[] required

Transaction tags for the credit

total_amountinteger required

Total credit amount in cents

applied_amountinteger required

Applied credit amount in cents

currency'EUR' | 'GBP' | 'USD' | 'SEK' | 'NOK' | 'DKK' | 'ISK' | 'MYR' | 'SGD'

Credit currency (e.g., GBP, EUR, USD)

  • EUR - Euro
  • GBP - British Pound
  • USD - US Dollar
  • SEK - Swedish Krona
  • NOK - Norwegian Krone
  • DKK - Danish Krone
  • ISK - Icelandic Króna
  • MYR - Malaysian Ringgit
  • SGD - Singapore Dollar
created_atstring date-time required

Credit creation timestamp

updated_atstring date-time required

Last update timestamp

Changes

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