ReferredDocumentTypeProprietary

EPC API for calling Electrum (18.1.0)

The Electrum EPC API for calling Electrum is an asynchronous API that allows Corporate Clients to participate in various nationally regulated payment schemes This document describes the operations exposed by Electrum for partners to consume in order to initiate outbound or respond to inbound payments.

URL

https://electrum.co.za

Electrum Support

support@electrum.co.za

License

proprietary

ReferredDocumentTypeCode

Specifies the type of referred document

issuerstring<= 35 characters

Identification of the issuer of the reference document type.

schemastringrequired

Identifies the value as being either proprietary (PROPRIETARY) or as being a pre-defined code (CODE).

Enum"CODE""PROPRIETARY"

Discriminator

valuestringrequired

AROI : AccountReceivableOpenItem
BOLD : BillOfLading
CINV : CommercialInvoice
CMCN : CommercialContract
CNFA : CreditNoteRelatedToFinancialAdjustment
CREN : CreditNote
DEBN : DebitNote
DISP : DispatchAdvice
DNFA : DebitNoteRelatedToFinancialAdjustment
HIRI : HireInvoice
MSIN : MeteredServiceInvoice
PUOR : PurchaseOrder
SBIN : SelfBilledInvoice
SOAC : StatementOfAccount
TSUT : TradeServicesUtilityTransaction
VCHR : Voucher

Enum"AROI""BOLD""CINV""CMCN""CNFA""CREN""DEBN""DISP""DNFA""HIRI"

{
  "issuer": "string",
  "schema": "CODE",
  "value": "AROI"
}

ReferredDocumentTypeProprietary

issuerstring<= 35 characters

Identification of the issuer of the reference document type.

schemastringrequired

Identifies the value as being either proprietary (PROPRIETARY) or as being a pre-defined code (CODE).

Enum"CODE""PROPRIETARY"

Discriminator

valuestringrequired

AROI : AccountReceivableOpenItem
BOLD : BillOfLading
CINV : CommercialInvoice
CMCN : CommercialContract
CNFA : CreditNoteRelatedToFinancialAdjustment
CREN : CreditNote
DEBN : DebitNote
DISP : DispatchAdvice
DNFA : DebitNoteRelatedToFinancialAdjustment
HIRI : HireInvoice
MSIN : MeteredServiceInvoice
PUOR : PurchaseOrder
SBIN : SelfBilledInvoice
SOAC : StatementOfAccount
TSUT : TradeServicesUtilityTransaction
VCHR : Voucher

Enum"AROI""BOLD""CINV""CMCN""CNFA""CREN""DEBN""DISP""DNFA""HIRI"

{
  "issuer": "string",
  "schema": "CODE",
  "value": "AROI"
}

ReferredDocument

documentIdentifierstring<= 35 characters

Unique and unambiguous identification of the referred document.

relatedDatestring(date)

The date associated with the referred document.

typeobject(ReferredDocumentType)

{
  "documentIdentifier": "string",
  "relatedDate": "2019-08-24",
  "type": {
    "issuer": "string",
    "schema": "CODE"
  }
}

EPC API for calling Electrum (18.1.0)

credit-transfer

scheme-inquiry

request-to-pay

Schema

ReferredDocumentTypeCode

ReferredDocumentTypeProprietary

ReferredDocument

transactional

financial

identifier-determination

bulk

refund