riverty logo

Docs

#Add Goodwill

Path

POST /businesses/{businessCode}/customers/{customerNumber}/orders/{orderReference}/goodwills

Request Parameters

businessCode
required
string
The business in the context of which this request is to be executed, e.g. 1000
customerNumber
required
string
The customer in the context of which this request is to be executed, e.g. TFI2021072801
orderReference
required
string
The order in the context of which this request is to be executed, e.g. TFI2021072801_03
X-Request-ID
string
The unique ID of this particular request/transaction. Subsequent requests with the same request ID might get ignored.

Request Body

application/json

object
creditDate
string
yyyy-MM-dd
Format(yyyy-MM-dd)
Date the goodwill is credited
goodwillDate
required
string
yyyy-MM-dd
Format(yyyy-MM-dd)
Date the goodwill is created
goodwillReason
string
Enum:

CUSTOMER_COMPLAINT

DELIVERY_DELAYED

ARTICLE_PARCEL_MISSING

CORRECTION_VOUCHER

ARTICLE_DEFECTIVE

CORRECTION_PRICE

LOSS_OF_RETURN_POST

LOSS_OF_RETURN_WAREHOUSE

LOSS_OF_DELIVERY

CONTRADICTION_OF_SIGNATURE

FRAUD

ISSUE_IN_STORE

REFUND_EXPRESS_COSTS

OTHER

LOSS_OF_DELIVERY_WARENPOST

WRONG_DELIVERY

Reason for the goodwill: * CUSTOMER_COMPLAINT = customer complaint * DELIVERY_DELAYED = delivery delayed * ARTICLE_PARCEL_MISSING = article/parcel missing * CORRECTION_VOUCHER = correction voucher * ARTICLE_DEFECTIVE = article defective * CORRECTION_PRICE = correction price * LOSS_OF_RETURN_POST = loss of return post * LOSS_OF_RETURN_WAREHOUSE = loss of return warehouse * LOSS_OF_DELIVERY = loss of delivery * CONTRADICTION_OF_SIGNATURE = contradiction of signature * FRAUD = fraud * ISSUE_IN_STORE = issue in store * REFUND_EXPRESS_COSTS = refund express costs * OTHER = other
goodwillReference
required
string
Max length: 30
maxLength(30)
External goodwill number
invoiceReference
string
Max length: 30
maxLength(30)
Invoice number of referenced invoice
required
array

Responses

Request Example

    
        {
 "items": [
  {
   "vatType": "NORMAL",
   "quantity": 2.5,
   "vatAmount": 19.02,
   "vatPercent": 19,
   "grossUnitPrice": 119.12,
   "orderItemReference": 3
  }
 ],
 "creditDate": "2018-03-21",
 "bankDetails": {
  "bic": "GENODEM1MSC",
  "iban": "DE51100100501234567890",
  "accountOwner": "Max Mustermann"
 },
 "goodwillDate": "2018-03-21",
 "goodwillReason": "CUSTOMER_COMPLAINT",
 "invoiceReference": "IDE12345678901",
 "goodwillReference": "GDE12345678901"
}

Response Example

    
        {
 "internalRequestId": "23c9579b-baaf-468f-a529-f876226e183c"
}