edifact.d03a.services.mPAYDUC
Modules
edifact.d03a.services.mPAYDUC
edifact.d03a.services.mRECLAMedifact.d03a.services.mREGENTedifact.d03a.services.mSLSFCTedifact.d03a.services.mSLSRPTedifact.d03a.services.mSOCADEedifact.d03a.services.mWKGRDCedifact.d03a.services.mWKGRREModule edifact.d03a.services.mPAYDUC
API
Definitions
ballerinax/edifact.d03a.services.mPAYDUC Ballerina library
Functions
fromEdiString
function fromEdiString(string ediText) returns EDI_PAYDUC_PAYDUC|errorConvert EDI string to Ballerina EDI_PAYDUC_PAYDUC record.
Parameters
- ediText string - EDI string to be converted
Return Type
- EDI_PAYDUC_PAYDUC|error - Ballerina record or error
fromEdiStringWithSchema
function fromEdiStringWithSchema(string ediText, EdiSchema schema) returns EDI_PAYDUC_PAYDUC|errorConvert EDI string to Ballerina EDI_PAYDUC_PAYDUC record with schema.
Return Type
- EDI_PAYDUC_PAYDUC|error - Ballerina record or error
getSchema
Get the EDI schema.
headersFromEdiString
function headersFromEdiString(string ediText) returns EDI_PAYDUC_PAYDUCHeaders|errorParse only the envelope header segments from the given EDI string.
Parameters
- ediText string - EDI string to parse
Return Type
- EDI_PAYDUC_PAYDUCHeaders|error - Parsed EDI_PAYDUC_PAYDUCHeaders record, or error if the headers are malformed
interchangeFromEdiString
function interchangeFromEdiString(string ediText) returns EDI_PAYDUC_PAYDUCInterchange|errorParse the full envelope hierarchy from the given EDI string. A malformed transaction body becomes an error in that transaction's body field.
Parameters
- ediText string - EDI string to parse
Return Type
- EDI_PAYDUC_PAYDUCInterchange|error - Parsed EDI_PAYDUC_PAYDUCInterchange, or error if the envelope is malformed
interchangeToEdiString
function interchangeToEdiString(EDI_PAYDUC_PAYDUCInterchange msg) returns string|errorSerialise a EDI_PAYDUC_PAYDUCInterchange into EDI text; the inverse of interchangeFromEdiString. A transaction whose body is an error is refused — filter or replace it before calling.
Parameters
- msg EDI_PAYDUC_PAYDUCInterchange - The interchange to serialise
toEdiString
function toEdiString(EDI_PAYDUC_PAYDUC data) returns string|errorConvert Ballerina EDI_PAYDUC_PAYDUC record to EDI string.
Parameters
- data EDI_PAYDUC_PAYDUC - Ballerina record to be converted
toEdiStringWithSchema
function toEdiStringWithSchema(EDI_PAYDUC_PAYDUC data, EdiSchema ediSchema) returns string|errorConvert Ballerina EDI_PAYDUC_PAYDUC record to EDI string with schema.
transformFromEdiString
Convert EDI string to Ballerina EDI_PAYDUC_PAYDUC record.
Parameters
- ediText string - EDI string to be converted
Return Type
- anydata|error - Ballerina record or error
transformHeadersFromEdiString
Convert EDI string to the envelope headers of EDI_PAYDUC_PAYDUC. Narrow the result with ensureType.
Parameters
- ediText string - EDI string to be converted
Return Type
- anydata|error - EDI_PAYDUC_PAYDUCHeaders record boxed as anydata, or error
transformInterchangeFromEdiString
Convert EDI string to a EDI_PAYDUC_PAYDUCInterchange record. Narrow the result with ensureType.
Parameters
- ediText string - EDI string to be converted
Return Type
- any|error - EDI_PAYDUC_PAYDUCInterchange record boxed as any, or error
transformInterchangeToEdiString
Convert a EDI_PAYDUC_PAYDUCInterchange record to EDI string.
Parameters
- content any - EDI_PAYDUC_PAYDUCInterchange record boxed as any
transformToEdiString
Convert Ballerina EDI_PAYDUC_PAYDUC record to EDI string.
Parameters
- content anydata - Ballerina record to be converted
Records
edifact.d03a.services.mPAYDUC: ACCOUNT_HOLDER_IDENTIFICATION_GType
Fields
- Account_holder_identifier? string -
- Account_holder_name? string -
- Account_holder_name_2? string -
- Currency_identification_code? string -
edifact.d03a.services.mPAYDUC: Adjustment_details_Type
Fields
- code string(default "AJT") -
- ADJUSTMENT_REASON_DESCRIPTION_CODE? string -
- LINE_ITEM_IDENTIFIER? string -
edifact.d03a.services.mPAYDUC: Anti_collision_segment_group_header_Type
Fields
- code string(default "UGH") -
- ANTI_COLLISION_SEGMENT_GROUP_IDENTIFICATION string -
edifact.d03a.services.mPAYDUC: Anti_collision_segment_group_trailer_Type
Fields
- code string(default "UGT") -
- ANTI_COLLISION_SEGMENT_GROUP_IDENTIFICATION string -
edifact.d03a.services.mPAYDUC: Authentication_result_Type
Fields
- code string(default "AUT") -
- VALIDATION_RESULT_TEXT? string -
- VALIDATION_KEY_IDENTIFIER? string -
edifact.d03a.services.mPAYDUC: BANK_OPERATION_GType
Fields
- Bank_operation_code string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
edifact.d03a.services.mPAYDUC: Beginning_of_message_Type
Fields
- code string(default "BGM") -
- DOCUMENT_MESSAGE_NAME? DOCUMENT_MESSAGE_NAME_GType? -
- DOCUMENT_MESSAGE_IDENTIFICATION? DOCUMENT_MESSAGE_IDENTIFICATION_GType? -
- MESSAGE_FUNCTION_CODE? string -
- RESPONSE_TYPE_CODE? string -
edifact.d03a.services.mPAYDUC: BUSINESS_FUNCTION_GType
Fields
- Business_function_type_code_qualifier string -
- Business_function_code string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
- Business_description? string -
edifact.d03a.services.mPAYDUC: Business_function_Type
Fields
- code string(default "BUS") -
- BUSINESS_FUNCTION? BUSINESS_FUNCTION_GType? -
- GEOGRAPHIC_AREA_CODE? string -
- FINANCIAL_TRANSACTION_TYPE_CODE? string -
- BANK_OPERATION? BANK_OPERATION_GType? -
- INTRA_COMPANY_PAYMENT_INDICATOR_CODE? string -
edifact.d03a.services.mPAYDUC: COMMUNICATION_CONTACT_GType
Fields
- Communication_address_identifier string -
- Communication_address_code_qualifier string -
edifact.d03a.services.mPAYDUC: Communication_contact_Type
Fields
- code string(default "COM") -
- COMMUNICATION_CONTACT COMMUNICATION_CONTACT_GType[](default []) -
edifact.d03a.services.mPAYDUC: Contact_information_Type
Fields
- code string(default "CTA") -
- CONTACT_FUNCTION_CODE? string -
- DEPARTMENT_OR_EMPLOYEE_DETAILS? DEPARTMENT_OR_EMPLOYEE_DETAILS_GType? -
edifact.d03a.services.mPAYDUC: CONTROL_GType
Fields
- Control_total_type_code_qualifier string -
- Control_total_quantity int -
- Measurement_unit_code? string -
edifact.d03a.services.mPAYDUC: Control_total_Type
Fields
- code string(default "CNT") -
- CONTROL? CONTROL_GType? -
edifact.d03a.services.mPAYDUC: COUNTRY_SUB_ENTITY_DETAILS_GType
Fields
- Country_sub_entity_name_code? string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
- Country_sub_entity_name? string -
edifact.d03a.services.mPAYDUC: Currencies_Type
Fields
- code string(default "CUX") -
- CURRENCY_DETAILS? CURRENCY_DETAILS_GType? -
- CURRENCY_DETAILS_1? CURRENCY_DETAILS_1_GType? -
- CURRENCY_EXCHANGE_RATE? int? -
- EXCHANGE_RATE_CURRENCY_MARKET_IDENTIFIER? string -
edifact.d03a.services.mPAYDUC: CURRENCY_DETAILS_1_GType
Fields
- Currency_usage_code_qualifier string -
- Currency_identification_code? string -
- Currency_type_code_qualifier? string -
- Currency_rate? int? -
edifact.d03a.services.mPAYDUC: CURRENCY_DETAILS_GType
Fields
- Currency_usage_code_qualifier string -
- Currency_identification_code? string -
- Currency_type_code_qualifier? string -
- Currency_rate? int? -
edifact.d03a.services.mPAYDUC: Date_and_time_GType
Fields
- date string -
- time string -
edifact.d03a.services.mPAYDUC: DATE_TIME_PERIOD_GType
Fields
- Date_or_time_or_period? string -
- Date_or_time_or_period_text? string -
- Date_or_time_or_period_format_code? string -
edifact.d03a.services.mPAYDUC: Date_time_period_Type
Fields
- code string(default "DTM") -
- DATE_TIME_PERIOD? DATE_TIME_PERIOD_GType? -
edifact.d03a.services.mPAYDUC: DEPARTMENT_OR_EMPLOYEE_DETAILS_GType
Fields
- Department_or_employee_name_code? string -
- Department_or_employee_name? string -
edifact.d03a.services.mPAYDUC: DOCUMENT_MESSAGE_IDENTIFICATION_GType
Fields
- Document_identifier? string -
- Version_identifier? string -
- Revision_identifier? string -
edifact.d03a.services.mPAYDUC: DOCUMENT_MESSAGE_NAME_GType
Fields
- Document_name_code? string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
- Document_name? string -
edifact.d03a.services.mPAYDUC: EDI_PAYDUC_PAYDUC
Fields
- Beginning_of_message Beginning_of_message_Type -
- Payment_instructions Payment_instructions_Type -
- Financial_institution_information Financial_institution_information_Type[](default []) -
- Date_time_period Date_time_period_Type[](default []) -
- Currencies? Currencies_Type? -
- Payment_terms? Payment_terms_Type? -
- Free_text Free_text_Type[](default []) -
- group_1 Group_1_GType[](default []) -
- group_2 Group_2_GType[](default []) -
- group_4 Group_4_GType[](default []) -
- Section_control Section_control_Type -
- Monetary_amount Monetary_amount_Type -
- Control_total Control_total_Type[](default []) -
- Authentication_result? Authentication_result_Type? -
edifact.d03a.services.mPAYDUC: EDI_PAYDUC_PAYDUCHeaders
Envelope headers of a EDI_PAYDUC_PAYDUC interchange.
Fields
- interchange EDI_PAYDUC_PAYDUCInterchangeHeader - Interchange header
- 'transaction EDI_PAYDUC_PAYDUCTransactionHeader - Transaction header
edifact.d03a.services.mPAYDUC: EDI_PAYDUC_PAYDUCInterchange
A parsed EDI_PAYDUC_PAYDUC interchange with its full envelope hierarchy.
Fields
- interchangeHeader EDI_PAYDUC_PAYDUCInterchangeHeader - Interchange header segment
- transactions EDI_PAYDUC_PAYDUCTransaction[] - Transactions in the interchange
- interchangeTrailer EDI_PAYDUC_PAYDUCInterchangeTrailer - Interchange trailer segment
edifact.d03a.services.mPAYDUC: EDI_PAYDUC_PAYDUCInterchangeHeader
Fields
- interchange_header Interchange_header_Type -
edifact.d03a.services.mPAYDUC: EDI_PAYDUC_PAYDUCInterchangeTrailer
Fields
- interchange_trailer Interchange_trailer_Type -
edifact.d03a.services.mPAYDUC: EDI_PAYDUC_PAYDUCTransaction
A single transaction within a EDI_PAYDUC_PAYDUC interchange.
Fields
- transactionHeader EDI_PAYDUC_PAYDUCTransactionHeader - Transaction header segment
- body EDI_PAYDUC_PAYDUC|error - Parsed EDI_PAYDUC_PAYDUC body, or the parse error when the body is malformed
- transactionTrailer EDI_PAYDUC_PAYDUCTransactionTrailer - Transaction trailer segment
edifact.d03a.services.mPAYDUC: EDI_PAYDUC_PAYDUCTransactionHeader
Fields
- Message_header Message_header_Type -
edifact.d03a.services.mPAYDUC: EDI_PAYDUC_PAYDUCTransactionTrailer
Fields
- Message_trailer Message_trailer_Type -
edifact.d03a.services.mPAYDUC: Financial_institution_information_Type
Fields
- code string(default "FII") -
- PARTY_FUNCTION_CODE_QUALIFIER? string -
- ACCOUNT_HOLDER_IDENTIFICATION? ACCOUNT_HOLDER_IDENTIFICATION_GType? -
- INSTITUTION_IDENTIFICATION? INSTITUTION_IDENTIFICATION_GType? -
- COUNTRY_NAME_CODE? string -
edifact.d03a.services.mPAYDUC: Free_text_Type
Fields
- code string(default "FTX") -
- TEXT_SUBJECT_CODE_QUALIFIER? string -
- FREE_TEXT_FUNCTION_CODE? string -
- TEXT_REFERENCE? TEXT_REFERENCE_GType? -
- TEXT_LITERAL? TEXT_LITERAL_GType? -
- LANGUAGE_NAME_CODE? string -
- FREE_TEXT_FORMAT_CODE? string -
edifact.d03a.services.mPAYDUC: Group_1_GType
Fields
- Reference Reference_Type -
- Date_time_period? Date_time_period_Type? -
edifact.d03a.services.mPAYDUC: Group_2_GType
Fields
- Name_and_address Name_and_address_Type -
- group_3 Group_3_GType[](default []) -
edifact.d03a.services.mPAYDUC: Group_3_GType
Fields
- Contact_information Contact_information_Type -
- Communication_contact? Communication_contact_Type? -
edifact.d03a.services.mPAYDUC: Group_4_GType
Fields
- Processing_information Processing_information_Type -
- Reference Reference_Type -
- Monetary_amount Monetary_amount_Type[](default []) -
- Business_function? Business_function_Type? -
- Currencies? Currencies_Type? -
- group_5 Group_5_GType[](default []) -
edifact.d03a.services.mPAYDUC: Group_5_GType
Fields
- Date_time_period Date_time_period_Type -
- group_6? Group_6_GType? -
edifact.d03a.services.mPAYDUC: Group_6_GType
Fields
- Anti_collision_segment_group_header Anti_collision_segment_group_header_Type -
- group_7 Group_7_GType[](default []) -
edifact.d03a.services.mPAYDUC: Group_7_GType
Fields
- Name_and_address Name_and_address_Type -
- Reference Reference_Type[](default []) -
- Monetary_amount Monetary_amount_Type[](default []) -
- Adjustment_details Adjustment_details_Type[](default []) -
- Payment_terms? Payment_terms_Type? -
- Free_text Free_text_Type[](default []) -
- Date_time_period Date_time_period_Type[](default []) -
- Anti_collision_segment_group_trailer Anti_collision_segment_group_trailer_Type -
edifact.d03a.services.mPAYDUC: INSTITUTION_IDENTIFICATION_GType
Fields
- Institution_name_code? string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
- Institution_branch_identifier? string -
- Code_list_identification_code_4? string -
- Code_list_responsible_agency_code_5? string -
- Institution_name? string -
- Institution_branch_location_name? string -
edifact.d03a.services.mPAYDUC: Interchange_header_Type
Fields
- code string(default "UNB") -
- syntax_identifier Syntax_identifier_GType -
- sender Sender_GType -
- recipient Recipient_GType -
- date_and_time Date_and_time_GType -
- control_reference string -
- recipient_reference_password? Recipient_reference_password_GType? -
- application_reference? string -
- processing_priority_code? string -
- acknowledgement_request? string -
- communications_agreement_id? string -
- test_indicator? string -
edifact.d03a.services.mPAYDUC: Interchange_trailer_Type
Fields
- code string(default "UNZ") -
- interchange_control_count int -
- interchange_control_reference string -
edifact.d03a.services.mPAYDUC: Message_header_Type
Fields
- code string(default "UNH") -
- message_reference_number string -
- message_identifier Message_identifier_GType -
edifact.d03a.services.mPAYDUC: Message_identifier_GType
Fields
- message_type string -
- message_version_number string -
- message_release_number string -
- controlling_agency string -
- association_assigned_code? string -
- code_list_directory_version? string -
- message_type_sub_function? string -
edifact.d03a.services.mPAYDUC: Message_trailer_Type
Fields
- code string(default "UNT") -
- number_of_segments int -
- message_reference_number string -
edifact.d03a.services.mPAYDUC: MONETARY_AMOUNT_GType
Fields
- Monetary_amount_type_code_qualifier string -
- Monetary_amount? int? -
- Currency_identification_code? string -
- Currency_type_code_qualifier? string -
- Status_description_code? string -
edifact.d03a.services.mPAYDUC: Monetary_amount_Type
Fields
- code string(default "MOA") -
- MONETARY_AMOUNT? MONETARY_AMOUNT_GType? -
edifact.d03a.services.mPAYDUC: NAME_AND_ADDRESS_GType
Fields
- Name_and_address_description string -
- Name_and_address_description_1? string -
- Name_and_address_description_2? string -
- Name_and_address_description_3? string -
- Name_and_address_description_4? string -
edifact.d03a.services.mPAYDUC: Name_and_address_Type
Fields
- code string(default "NAD") -
- PARTY_FUNCTION_CODE_QUALIFIER? string -
- PARTY_IDENTIFICATION_DETAILS? PARTY_IDENTIFICATION_DETAILS_GType? -
- NAME_AND_ADDRESS? NAME_AND_ADDRESS_GType? -
- PARTY_NAME? PARTY_NAME_GType? -
- STREET? STREET_GType? -
- CITY_NAME? string -
- COUNTRY_SUB_ENTITY_DETAILS? COUNTRY_SUB_ENTITY_DETAILS_GType? -
- POSTAL_IDENTIFICATION_CODE? string -
- COUNTRY_NAME_CODE? string -
edifact.d03a.services.mPAYDUC: PARTY_IDENTIFICATION_DETAILS_GType
Fields
- Party_identifier string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
edifact.d03a.services.mPAYDUC: PARTY_NAME_GType
Fields
- Party_name string -
- Party_name_1? string -
- Party_name_2? string -
- Party_name_3? string -
- Party_name_4? string -
- Party_name_format_code? string -
edifact.d03a.services.mPAYDUC: PAYMENT_INSTRUCTION_DETAILS_GType
Fields
- Payment_conditions_code? string -
- Payment_guarantee_means_code? string -
- Payment_means_code? string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
- Payment_channel_code? string -
edifact.d03a.services.mPAYDUC: Payment_instructions_Type
Fields
- code string(default "PAI") -
- PAYMENT_INSTRUCTION_DETAILS? PAYMENT_INSTRUCTION_DETAILS_GType? -
edifact.d03a.services.mPAYDUC: PAYMENT_TERMS_GType
Fields
- Payment_terms_description_identifier? string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
- Payment_terms_description? string -
edifact.d03a.services.mPAYDUC: Payment_terms_Type
Fields
- code string(default "PYT") -
- PAYMENT_TERMS_TYPE_CODE_QUALIFIER? string -
- PAYMENT_TERMS? PAYMENT_TERMS_GType? -
- TIME_REFERENCE_CODE? string -
- TERMS_TIME_RELATION_CODE? string -
- PERIOD_TYPE_CODE? string -
- PERIOD_COUNT_QUANTITY? int? -
edifact.d03a.services.mPAYDUC: PROCESSING_INDICATOR_GType
Fields
- Processing_indicator_description_code? string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
- Processing_indicator_description? string -
edifact.d03a.services.mPAYDUC: Processing_information_Type
Fields
- code string(default "GEI") -
- PROCESSING_INFORMATION_CODE_QUALIFIER? string -
- PROCESSING_INDICATOR? PROCESSING_INDICATOR_GType? -
- PROCESS_TYPE_DESCRIPTION_CODE? string -
edifact.d03a.services.mPAYDUC: Recipient_GType
Fields
- id string -
- qualifier? string -
- internal_id? string -
- internal_sub_id? string -
edifact.d03a.services.mPAYDUC: Recipient_reference_password_GType
Fields
- reference_password? string -
- qualifier? string -
edifact.d03a.services.mPAYDUC: REFERENCE_GType
Fields
- Reference_code_qualifier string -
- Reference_identifier? string -
- Document_line_identifier? string -
- Reference_version_identifier? string -
- Revision_identifier? string -
edifact.d03a.services.mPAYDUC: Reference_Type
Fields
- code string(default "RFF") -
- REFERENCE? REFERENCE_GType? -
edifact.d03a.services.mPAYDUC: Section_control_Type
Fields
- code string(default "UNS") -
- section_identification string -
edifact.d03a.services.mPAYDUC: Sender_GType
Fields
- id string -
- qualifier? string -
- internal_id? string -
- internal_sub_id? string -
edifact.d03a.services.mPAYDUC: STREET_GType
Fields
- Street_and_number_or_post_office_box_identifier string -
- Street_and_number_or_post_office_box_identifier_1? string -
- Street_and_number_or_post_office_box_identifier_2? string -
- Street_and_number_or_post_office_box_identifier_3? string -
edifact.d03a.services.mPAYDUC: Syntax_identifier_GType
Fields
- syntax_id string -
- syntax_version string -
- service_code_list_directory_version? string -
- character_encoding? string -
edifact.d03a.services.mPAYDUC: TEXT_LITERAL_GType
Fields
- Free_text string -
- Free_text_1? string -
- Free_text_2? string -
- Free_text_3? string -
- Free_text_4? string -
edifact.d03a.services.mPAYDUC: TEXT_REFERENCE_GType
Fields
- Free_text_description_code string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
Import
import ballerinax/edifact.d03a.services.mPAYDUC;Metadata
Released date: 3 days ago
Version: 1.0.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.12.0
GraalVM compatible: Yes
Pull count
Total: 30
Current verison: 0
Weekly downloads
Keywords
insurance
employment
healthcare
EDI
EDIFACT
D03A
B2B
Business Management/ERP
Cost/Free
Vendor/Other
Area/ERP & Business Operations
Type/Library
Name/EDIFACT D03A Services
Contributors
Dependencies