| PUT | /api/creditNote/{CreditNoteId}/processed | Update credit note as customer processed, will also acknowledge credit note if not yet set. |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
Object = TypeVar('Object')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TokenDto(ICommandResponse):
token: Optional[str] = None
# @Api(Description="Credit Note")
# @ApiResponse(Description="Command received", IsDefaultResponse=true, ResponseType=typeof(TokenDto), StatusCode=202)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateCreditNoteClientProcessed:
"""
Credit Note
"""
# @ApiMember(Description="Credit Note ID or Token", ParameterType="path")
credit_note_id: Optional[str] = None
"""
Credit Note ID or Token
"""
# @ApiMember(Description="Customer credit note reference in destination system")
customer_reference: Optional[str] = None
"""
Customer credit note reference in destination system
"""
# @ApiMember(Description="Date and Time credit note was processed in destination system")
customer_processed_date: datetime.datetime = datetime.datetime(1, 1, 1)
"""
Date and Time credit note was processed in destination system
"""
Python UpdateCreditNoteClientProcessed DTOs
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
{}