DX STF Client API

<back to all web services

AcknowledgeCreditNote

Credit Note Requests

Credit Note

Requires Authentication
The following routes are available for this service:
PUT/api/creditNote/{CreditNoteId}/acknowledgeAcknowledge credit note as received
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')


# @Api(Description="Credit Note")
# @ApiResponse(Description="Updated", IsDefaultResponse=true, StatusCode=204)
# @ApiResponse(Description="GLN does not have required access", StatusCode=403)
# @ApiResponse(Description="Document not found", StatusCode=404)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AcknowledgeCreditNote:
    """
    Credit Note
    """

    # @ApiMember(ExcludeInSchema=true, ParameterType="path")
    credit_note_id: Optional[str] = None

Python AcknowledgeCreditNote DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /api/creditNote/{CreditNoteId}/acknowledge HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AcknowledgeCreditNote xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Application.ClientApi.Messages.CreditNote">
  <CreditNoteId>00000000-0000-0000-0000-000000000000</CreditNoteId>
</AcknowledgeCreditNote>