DX STF Client API

<back to all web services

GetSettlement

Settlement

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using DX.STF.Application.ClientApi.Messages.Settlement;
using DX.Framework.Core.Querying;
using DX.STF.Models.Dto.GS1;

namespace DX.Framework.Core.Querying
{
    public partial class ResultItem<T>
        : IDocument
    {
        public virtual Guid Token { get; set; }
        public virtual ClaimMessage Item { get; set; }
    }

}

namespace DX.STF.Application.ClientApi.Messages.Settlement
{
    ///<summary>
    ///Settlement
    ///</summary>
    [Api(Description="Settlement")]
    [ApiResponse(Description="Settlement message", IsDefaultResponse=true, StatusCode=200)]
    [ApiResponse(Description="No Content", ResponseType=typeof(ServiceStack.IReturnVoid), StatusCode=204)]
    public partial class GetSettlement
    {
    }

}

namespace DX.STF.Models.Dto.GS1
{
    public partial class Address
    {
        public virtual string StreetAddressOne { get; set; }
        public virtual string StreetAddressTwo { get; set; }
        public virtual string StreetAddressThree { get; set; }
        public virtual string City { get; set; }
        public virtual string PostalCode { get; set; }
        public virtual string ProvinceCode { get; set; }
        public virtual string CountryCode { get; set; }
    }

    public partial class AvpList
    {
        public virtual string Code { get; set; }
        public virtual string Value { get; set; }
    }

    public partial class BaseDocument
    {
        public virtual string CurrencyCode { get; set; }
        public virtual DateTime CreationDateTime { get; set; }
        public virtual DocumentAction DocumentActionCode { get; set; }
        public virtual DocumentStatus DocumentStatusCode { get; set; }
        public virtual string DocumentStructureVersion { get; set; }
        public virtual DateTime? LastUpdateDateTime { get; set; }
        public virtual long? RevisionNumber { get; set; }
        public virtual List<AvpList> AvpList { get; set; } = [];
    }

    public partial class BillOfLading
    {
        public virtual DateTimeOffset CreationDate { get; set; }
        public virtual long RevisionNumber { get; set; }
        public virtual string EntityIdentification { get; set; }
        public virtual List<string> TagNumbers { get; set; } = [];
        public virtual long TotalBags { get; set; }
    }

    public partial class ClaimExtension
    {
        public virtual ClaimTotals ClaimTotals { get; set; }
        public virtual TransactionalParty ShipFrom { get; set; }
        public virtual TransactionalParty ShipTo { get; set; }
    }

    public partial class ClaimMessage
    {
        public virtual Header Header { get; set; }
        public virtual ClaimNotification ClaimNotification { get; set; }
    }

    public partial class ClaimNotification
        : BaseDocument
    {
        public virtual string ClaimsNotificationTypeCode { get; set; }
        public virtual bool IsManualProcessNeededForClaimsResolution { get; set; }
        public virtual bool IsSupplementalMessageBeingSent { get; set; }
        public virtual string SupplementalMessageDescription { get; set; }
        public virtual string ClaimsNotificationIdentification { get; set; }
        public virtual TransactionalParty Buyer { get; set; }
        public virtual TransactionalParty RemitTo { get; set; }
        public virtual TransactionalParty Seller { get; set; }
        public virtual BillOfLading BillOfLading { get; set; }
        public virtual DocumentReference ClaimsNotification { get; set; }
        public virtual DocumentReference DispatchAdvice { get; set; }
        public virtual DocumentReference PurchaseOrder { get; set; }
        public virtual DocumentReference Invoice { get; set; }
        public virtual List<ClaimsNotificationDiscrepancyInformation> ClaimsNotificationDiscrepancyInformation { get; set; } = [];
        public virtual ClaimExtension Extension { get; set; }
    }

    public partial class ClaimsNotificationDiscrepancyInformation
    {
        public virtual decimal ClaimAmount { get; set; }
        public virtual string ClaimReasonCode { get; set; }
        public virtual string DiscrepancyDescription { get; set; }
        public virtual ClaimsNotificationItemDiscrepancy ActualReceived { get; set; }
        public virtual ClaimsNotificationItemDiscrepancy ExpectedToReceive { get; set; }
        public virtual List<AvpList> AvpList { get; set; } = [];
    }

    public partial class ClaimsNotificationItemDiscrepancy
    {
        public virtual decimal Price { get; set; }
        public virtual Quantity Quantity { get; set; }
        public virtual TransactionalTradeItem TransactionalTradeItem { get; set; }
    }

    public partial class ClaimTotals
    {
        public virtual decimal? BaseAmount { get; set; }
        public virtual decimal? TotalTaxAmount { get; set; }
        public virtual decimal? TotalClaimAmount { get; set; }
    }

    public partial class Colour
    {
        public virtual string ColourCode { get; set; }
        public virtual string ColourDescription { get; set; }
    }

    public partial class CommunicationChannel
    {
        public virtual string CommunicationChannelCode { get; set; }
        public virtual string CommunicationChannelName { get; set; }
        public virtual string CommunicationValue { get; set; }
    }

    public partial class Contact
    {
        public virtual string ContactTypeCode { get; set; }
        public virtual string PersonName { get; set; }
        public virtual string DepartmentName { get; set; }
        public virtual string JobTitle { get; set; }
        public virtual string Responsibility { get; set; }
        public virtual List<CommunicationChannel> CommunicationChannel { get; set; } = [];
    }

    [DataContract]
    public partial class ContactInformation
    {
    }

    public enum DocumentAction
    {
        ADD,
        CHANGE_BY_REFRESH,
        DELETE,
        REJECTED,
    }

    [DataContract]
    public partial class DocumentIdentification
    {
        [DataMember(Name="identifier")]
        public virtual string Identifier { get; set; }

        [DataMember(Name="type")]
        public virtual string Type { get; set; }

        [DataMember(Name="creationDateAndTime")]
        public virtual DateTime CreationDateAndTime { get; set; }
    }

    public partial class DocumentReference
    {
        public virtual DateTime? CreationDateTime { get; set; }
        public virtual long? RevisionNumber { get; set; }
        public virtual long? LineItemNumber { get; set; }
        public virtual string EntityIdentification { get; set; }
    }

    public enum DocumentStatus
    {
        ADDITIONAL_TRANSMISSION,
        COPY,
        ORIGINAL,
    }

    public partial class Ecom_PartyIdentificationType
    {
        public virtual string Gln { get; set; }
        public virtual string Name { get; set; }
        public virtual List<AvpList> AdditionalPartyIdentification { get; set; } = [];
    }

    public partial class FinancialAccount
    {
        public virtual string Number { get; set; }
        public virtual string NumberTypeCode { get; set; }
        public virtual string Name { get; set; }
    }

    public partial class FinancialInstitutionInformation
    {
        public virtual string FinancialInstitutionBranchName { get; set; }
        public virtual string FinancialInstitutionName { get; set; }
        public virtual FinancialRoutingNumber FinancialRoutingNumber { get; set; }
        public virtual FinancialAccount FinancialAccount { get; set; }
        public virtual string SwiftCode { get; set; }
        public virtual string ExportersCode { get; set; }
    }

    public partial class FinancialRoutingNumber
    {
        public virtual string Number { get; set; }
        public virtual string NumberTypeCode { get; set; }
    }

    [DataContract]
    public partial class Header
    {
        [DataMember(Name="documentIdentification")]
        public virtual DocumentIdentification DocumentIdentification { get; set; }

        [DataMember(Name="sender")]
        public virtual Partner Sender { get; set; }

        [DataMember(Name="receiver")]
        public virtual Partner Receiver { get; set; }
    }

    [DataContract]
    public partial class Identifier
    {
        [DataMember(Name="authority")]
        public virtual string Authority { get; set; }

        [DataMember(Name="text")]
        public virtual string Text { get; set; }
    }

    [DataContract]
    public partial class Partner
    {
        [DataMember(Name="identifier")]
        public virtual Identifier Identifier { get; set; }

        [DataMember(Name="contactInformation")]
        public virtual List<ContactInformation> ContactInformation { get; set; } = [];
    }

    public partial class Quantity
    {
        public virtual decimal? Value { get; set; }
        public virtual string MeasurementUnitCode { get; set; }
        public virtual string CodeListVersion { get; set; }
    }

    public partial class SerialNumberRange
    {
        public virtual string MaximumValue { get; set; }
        public virtual string MinimumValue { get; set; }
    }

    public partial class Size
    {
        public virtual string DescriptiveSize { get; set; }
        public virtual string SizeCode { get; set; }
    }

    public partial class TradeItemClassification
    {
        public virtual string GpcCategoryCode { get; set; }
        public virtual List<AvpList> AdditionalTradeItemClassificationCode { get; set; } = [];
        public virtual string GpcCategoryName { get; set; }
        public virtual List<AvpList> GpcAttribute { get; set; } = [];
    }

    public partial class TradeItemWaste
    {
        public virtual string WasteIdentification { get; set; }
        public virtual List<AvpList> TypeOfWaste { get; set; } = [];
    }

    public partial class TransactionalItem
    {
        public virtual string MeasurementUnitCode { get; set; }
        public virtual string MeasurementType { get; set; }
        public virtual string MeasurementValue { get; set; }
    }

    public partial class TransactionalItemData
    {
        public virtual DateTime? AvailableForSaleDate { get; set; }
        public virtual string BatchNumber { get; set; }
        public virtual DateTime? BestBeforeDate { get; set; }
        public virtual string CountryOfOrigin { get; set; }
        public virtual DateTime? ItemExpirationDate { get; set; }
        public virtual string LotNumber { get; set; }
        public virtual DateTime? PackagingDate { get; set; }
        public virtual DateTime? ProductionDate { get; set; }
        public virtual string ProductQualityIndication { get; set; }
        public virtual DateTime? SellByDate { get; set; }
        public virtual List<string> SerialNumber { get; set; } = [];
        public virtual string ShelfLife { get; set; }
        public virtual long? TradeItemQuantity { get; set; }
        public virtual bool? ItemInContactWithFoodProduct { get; set; }
        public virtual List<TransactionalItem> TransactionalItemWeight { get; set; } = [];
        public virtual List<TransactionalItem> TransactionalItemVolume { get; set; } = [];
        public virtual List<SerialNumberRange> SerialNumberRange { get; set; } = [];
        public virtual List<TransactionalItemDimension> TransactionalItemDimensions { get; set; } = [];
        public virtual TransactionalItemLogisticUnitInformation TransactionalItemLogisticUnitInformation { get; set; }
        public virtual TransactionalItemDataCarrierAndIdentification TransactionalItemDataCarrierAndIdentification { get; set; }
        public virtual List<TradeItemWaste> TradeItemWaste { get; set; } = [];
        public virtual TransactionalItemOrganicInformation TransactionalItemOrganicInformation { get; set; }
        public virtual List<AvpList> AvpList { get; set; } = [];
    }

    public partial class TransactionalItemDataCarrierAndIdentification
    {
        public virtual string Gs1TransactionalItemIdentificationKey { get; set; }
        public virtual string DataCarrier { get; set; }
    }

    public partial class TransactionalItemDimension
    {
        public virtual string MeasurementUnitCode { get; set; }
        public virtual string Depth { get; set; }
        public virtual string Height { get; set; }
        public virtual string Width { get; set; }
    }

    public partial class TransactionalItemLogisticUnitInformation
    {
        public virtual long? NumberOfLayers { get; set; }
        public virtual long? NumberOfUnitsPerLayer { get; set; }
        public virtual long? NumberOfUnitsPerPallet { get; set; }
        public virtual string PackagingTerms { get; set; }
        public virtual string PackageTypeCode { get; set; }
        public virtual long? MaximumStackingFactor { get; set; }
        public virtual string ReturnablePackageTransportCostPayment { get; set; }
        public virtual List<TransactionalItemDimension> DimensionsOfLogisticUnit { get; set; } = [];
    }

    public partial class TransactionalItemOrganicInformation
    {
        public virtual bool? IsTradeItemOrganic { get; set; }
        public virtual string OrganicCertification { get; set; }
    }

    public partial class TransactionalParty
        : Ecom_PartyIdentificationType
    {
        public virtual List<Contact> Contact { get; set; } = [];
        public virtual Address Address { get; set; }
        public virtual List<AvpList> CommunicationChannel { get; set; } = [];
        public virtual FinancialInstitutionInformation FinancialInstitutionInformation { get; set; }
        public virtual string DutyFeeTaxRegistration { get; set; }
        public virtual string EntityIdentification { get; set; }
    }

    public partial class TransactionalTradeItem
    {
        public virtual string Gtin { get; set; }
        public virtual List<AvpList> AdditionalTradeItemIdentification { get; set; } = [];
        public virtual decimal? TradeItemQuantity { get; set; }
        public virtual string TradeItemDescription { get; set; }
        public virtual string ProductVariantIdentifier { get; set; }
        public virtual string ItemTypeCode { get; set; }
        public virtual string TradeItemDataOwner { get; set; }
        public virtual string ButterFatReference { get; set; }
        public virtual List<TransactionalItemData> TransactionalItemData { get; set; } = [];
        public virtual List<Colour> Colour { get; set; } = [];
        public virtual Size Size { get; set; }
        public virtual TradeItemClassification TradeItemClassification { get; set; }
        public virtual List<AvpList> AvpList { get; set; } = [];
    }

}

C# GetSettlement DTOs

GET /api/settlement HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: text/jsonl