| PUT | /api/creditNote/{CreditNoteId}/processed | Update credit note as customer processed, will also acknowledge credit note if not yet set. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CreditNoteId | path | Guid | No | Credit Note ID or Token |
| CustomerReference | body | string | Yes | Customer credit note reference in destination system |
| CustomerProcessedDate | body | DateTime | No | Date and Time credit note was processed in destination system |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Token | form | Guid | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /api/creditNote/{CreditNoteId}/processed HTTP/1.1
Host: stf-api-uat.data-xchange.co.za
Accept: application/json
Content-Type: application/json
Content-Length: length
{"customerReference":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{}