Note: There is a newer version (1.0.1) of this package available. Click here to view docs for the latest version.

Modules

edifact.d03a.finance edifact.d03a.finance.mAUTHOR

edifact.d03a.finance.mBALANC

Module edifact.d03a.finance.mBALANC

ballerinax/edifact.d03a.finance.mBALANC Ballerina library

1.0.0

Functions

fromEdiString

Isolated Function

function fromEdiString(string ediText) returns EDI_BALANC_BALANC|error

Convert EDI string to Ballerina EDI_BALANC_BALANC record.

Parameters

ediText string - EDI string to be converted

Return Type

EDI_BALANC_BALANC|error - Ballerina record or error

fromEdiStringWithSchema

Isolated Function

function fromEdiStringWithSchema(string ediText, EdiSchema schema) returns EDI_BALANC_BALANC|error

Convert EDI string to Ballerina EDI_BALANC_BALANC record with schema.

Parameters

ediText string - EDI string to be converted

schema EdiSchema - EDI schema

Return Type

EDI_BALANC_BALANC|error - Ballerina record or error

getSchema

Isolated Function

function getSchema() returns EdiSchema|error

Get the EDI schema.

Return Type

EdiSchema|error - EDI schema or error

headersFromEdiString

Isolated Function

function headersFromEdiString(string ediText) returns EDI_BALANC_BALANCHeaders|error

Parse only the envelope header segments from the given EDI string.

Parameters

ediText string - EDI string to parse

Return Type

EDI_BALANC_BALANCHeaders|error - Parsed EDI_BALANC_BALANCHeaders record, or error if the headers are malformed

interchangeFromEdiString

Isolated Function

function interchangeFromEdiString(string ediText) returns EDI_BALANC_BALANCInterchange|error

Parse 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_BALANC_BALANCInterchange|error - Parsed EDI_BALANC_BALANCInterchange, or error if the envelope is malformed

interchangeToEdiString

Isolated Function

function interchangeToEdiString(EDI_BALANC_BALANCInterchange msg) returns string|error

Serialise a EDI_BALANC_BALANCInterchange 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_BALANC_BALANCInterchange - The interchange to serialise

Return Type

string|error - EDI text, or error

toEdiString

Isolated Function

function toEdiString(EDI_BALANC_BALANC data) returns string|error

Convert Ballerina EDI_BALANC_BALANC record to EDI string.

Parameters

data EDI_BALANC_BALANC - Ballerina record to be converted

Return Type

string|error - EDI string or error

toEdiStringWithSchema

Isolated Function

function toEdiStringWithSchema(EDI_BALANC_BALANC data, EdiSchema ediSchema) returns string|error

Convert Ballerina EDI_BALANC_BALANC record to EDI string with schema.

Parameters

data EDI_BALANC_BALANC - Ballerina record to be converted

ediSchema EdiSchema - EDI schema

Return Type

string|error - EDI string or error

transformFromEdiString

Isolated Function

function transformFromEdiString(string ediText) returns anydata|error

Convert EDI string to Ballerina EDI_BALANC_BALANC record.

Parameters

ediText string - EDI string to be converted

Return Type

anydata|error - Ballerina record or error

transformHeadersFromEdiString

Isolated Function

function transformHeadersFromEdiString(string ediText) returns anydata|error

Convert EDI string to the envelope headers of EDI_BALANC_BALANC. Narrow the result with ensureType.

Parameters

ediText string - EDI string to be converted

Return Type

anydata|error - EDI_BALANC_BALANCHeaders record boxed as anydata, or error

transformInterchangeFromEdiString

Isolated Function

function transformInterchangeFromEdiString(string ediText) returns any|error

Convert EDI string to a EDI_BALANC_BALANCInterchange record. Narrow the result with ensureType.

Parameters

ediText string - EDI string to be converted

Return Type

any|error - EDI_BALANC_BALANCInterchange record boxed as any, or error

transformInterchangeToEdiString

Isolated Function

function transformInterchangeToEdiString(any content) returns string|error

Convert a EDI_BALANC_BALANCInterchange record to EDI string.

Parameters

content any - EDI_BALANC_BALANCInterchange record boxed as any

Return Type

string|error - EDI string or error

transformToEdiString

Isolated Function

function transformToEdiString(anydata content) returns string|error

Convert Ballerina EDI_BALANC_BALANC record to EDI string.

Parameters

content anydata - Ballerina record to be converted

Return Type

string|error - EDI string or error

Records

edifact.d03a.finance.mBALANC: ACCOUNT_IDENTIFICATION_GType

Closed record

Fields

Account_identifier string -

Code_list_identification_code? string -

Code_list_responsible_agency_code? string -

Account_abbreviated_name? string -

Account_name? string -

Account_name_5? string -

Currency_identification_code? string -

edifact.d03a.finance.mBALANC: Account_identification_Type

Closed record

Fields

code string(default "CPT") -

ACCOUNT_TYPE_CODE_QUALIFIER? string -

ACCOUNT_IDENTIFICATION? ACCOUNT_IDENTIFICATION_GType? -

edifact.d03a.finance.mBALANC: Authentication_result_Type

Closed record

Fields

code string(default "AUT") -

VALIDATION_RESULT_TEXT? string -

VALIDATION_KEY_IDENTIFIER? string -

edifact.d03a.finance.mBALANC: Beginning_of_message_Type

Closed record

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.finance.mBALANC: Characteristic_class_id_Type

Closed record

Fields

code string(default "CCI") -

CLASS_TYPE_CODE? string -

MEASUREMENT_DETAILS? MEASUREMENT_DETAILS_GType? -

CHARACTERISTIC_DESCRIPTION? CHARACTERISTIC_DESCRIPTION_GType? -

CHARACTERISTIC_RELEVANCE_CODE? string -

edifact.d03a.finance.mBALANC: CHARACTERISTIC_DESCRIPTION_GType

Closed record

Fields

Characteristic_description_code string -

Code_list_identification_code? string -

Code_list_responsible_agency_code? string -

Characteristic_description? string -

Characteristic_description_4? string -

edifact.d03a.finance.mBALANC: CHARACTERISTIC_VALUE_GType

Closed record

Fields

Characteristic_value_description_code? string -

Code_list_identification_code? string -

Code_list_responsible_agency_code? string -

Characteristic_value_description? string -

Characteristic_value_description_4? string -

edifact.d03a.finance.mBALANC: Characteristic_value_Type

Closed record

Fields

code string(default "CAV") -

CHARACTERISTIC_VALUE? CHARACTERISTIC_VALUE_GType? -

edifact.d03a.finance.mBALANC: COMMUNICATION_CONTACT_GType

Closed record

Fields

Communication_address_identifier string -

Communication_address_code_qualifier string -

edifact.d03a.finance.mBALANC: Communication_contact_Type

Closed record

Fields

code string(default "COM") -

COMMUNICATION_CONTACT COMMUNICATION_CONTACT_GType[](default []) -

edifact.d03a.finance.mBALANC: Contact_information_Type

Closed record

Fields

code string(default "CTA") -

CONTACT_FUNCTION_CODE? string -

DEPARTMENT_OR_EMPLOYEE_DETAILS? DEPARTMENT_OR_EMPLOYEE_DETAILS_GType? -

edifact.d03a.finance.mBALANC: COUNTRY_SUB_ENTITY_DETAILS_GType

Closed record

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.finance.mBALANC: Currencies_Type

Closed record

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.finance.mBALANC: CURRENCY_DETAILS_1_GType

Closed record

Fields

Currency_usage_code_qualifier string -

Currency_identification_code? string -

Currency_type_code_qualifier? string -

Currency_rate? int? -

edifact.d03a.finance.mBALANC: CURRENCY_DETAILS_GType

Closed record

Fields

Currency_usage_code_qualifier string -

Currency_identification_code? string -

Currency_type_code_qualifier? string -

Currency_rate? int? -

edifact.d03a.finance.mBALANC: Date_and_time_GType

Closed record

Fields

date string -

time string -

edifact.d03a.finance.mBALANC: DATE_TIME_PERIOD_GType

Closed record

Fields

Date_or_time_or_period? string -

Date_or_time_or_period_text? string -

Date_or_time_or_period_format_code? string -

edifact.d03a.finance.mBALANC: Date_time_period_Type

Closed record

Fields

code string(default "DTM") -

DATE_TIME_PERIOD? DATE_TIME_PERIOD_GType? -

edifact.d03a.finance.mBALANC: DEPARTMENT_OR_EMPLOYEE_DETAILS_GType

Closed record

Fields

Department_or_employee_name_code? string -

Department_or_employee_name? string -

edifact.d03a.finance.mBALANC: DOCUMENT_MESSAGE_IDENTIFICATION_GType

Closed record

Fields

Document_identifier? string -

Version_identifier? string -

Revision_identifier? string -

edifact.d03a.finance.mBALANC: DOCUMENT_MESSAGE_NAME_GType

Closed record

Fields

Document_name_code? string -

Code_list_identification_code? string -

Code_list_responsible_agency_code? string -

Document_name? string -

edifact.d03a.finance.mBALANC: EDI_BALANC_BALANC

Closed record

Fields

Beginning_of_message Beginning_of_message_Type -

Date_time_period Date_time_period_Type[](default []) -

Reference Reference_Type[](default []) -

Currencies Currencies_Type[](default []) -

Free_text? Free_text_Type? -

group_1 Group_1_GType[](default []) -

group_3 Group_3_GType[](default []) -

group_4 Group_4_GType[](default []) -

group_7 Group_7_GType -

group_8? Group_8_GType? -

edifact.d03a.finance.mBALANC: EDI_BALANC_BALANCHeaders

Closed record

Envelope headers of a EDI_BALANC_BALANC interchange.

Fields

interchange EDI_BALANC_BALANCInterchangeHeader - Interchange header

'transaction EDI_BALANC_BALANCTransactionHeader - Transaction header

edifact.d03a.finance.mBALANC: EDI_BALANC_BALANCInterchange

Closed record

A parsed EDI_BALANC_BALANC interchange with its full envelope hierarchy.

Fields

interchangeHeader EDI_BALANC_BALANCInterchangeHeader - Interchange header segment

transactions EDI_BALANC_BALANCTransaction[] - Transactions in the interchange

interchangeTrailer EDI_BALANC_BALANCInterchangeTrailer - Interchange trailer segment

edifact.d03a.finance.mBALANC: EDI_BALANC_BALANCInterchangeHeader

Closed record

Fields

interchange_header Interchange_header_Type -

edifact.d03a.finance.mBALANC: EDI_BALANC_BALANCInterchangeTrailer

Closed record

Fields

interchange_trailer Interchange_trailer_Type -

edifact.d03a.finance.mBALANC: EDI_BALANC_BALANCTransaction

Closed record

A single transaction within a EDI_BALANC_BALANC interchange.

Fields

transactionHeader EDI_BALANC_BALANCTransactionHeader - Transaction header segment

body EDI_BALANC_BALANC|error - Parsed EDI_BALANC_BALANC body, or the parse error when the body is malformed

transactionTrailer EDI_BALANC_BALANCTransactionTrailer - Transaction trailer segment

edifact.d03a.finance.mBALANC: EDI_BALANC_BALANCTransactionHeader

Closed record

Fields

Message_header Message_header_Type -

edifact.d03a.finance.mBALANC: EDI_BALANC_BALANCTransactionTrailer

Closed record

Fields

Message_trailer Message_trailer_Type -

edifact.d03a.finance.mBALANC: Free_text_Type

Closed record

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.finance.mBALANC: Group_1_GType

Closed record

Fields

Name_and_address Name_and_address_Type -

Reference Reference_Type[](default []) -

group_2 Group_2_GType[](default []) -

edifact.d03a.finance.mBALANC: Group_2_GType

Closed record

Fields

Contact_information Contact_information_Type -

Communication_contact Communication_contact_Type[](default []) -

edifact.d03a.finance.mBALANC: Group_3_GType

Closed record

Fields

Characteristic_class_id Characteristic_class_id_Type -

Characteristic_value? Characteristic_value_Type? -

edifact.d03a.finance.mBALANC: Group_4_GType

Closed record

Fields

Line_item Line_item_Type -

Monetary_amount Monetary_amount_Type[](default []) -

Date_time_period? Date_time_period_Type? -

Reference? Reference_Type? -

Quantity Quantity_Type[](default []) -

group_5 Group_5_GType[](default []) -

edifact.d03a.finance.mBALANC: Group_5_GType

Closed record

Fields

Account_identification Account_identification_Type -

group_6 Group_6_GType[](default []) -

edifact.d03a.finance.mBALANC: Group_6_GType

Closed record

Fields

Characteristic_class_id Characteristic_class_id_Type -

Characteristic_value? Characteristic_value_Type? -

edifact.d03a.finance.mBALANC: Group_7_GType

Closed record

Fields

Number_of_units Number_of_units_Type -

Monetary_amount Monetary_amount_Type[](default []) -

edifact.d03a.finance.mBALANC: Group_8_GType

Closed record

Fields

Authentication_result Authentication_result_Type -

Date_time_period? Date_time_period_Type? -

edifact.d03a.finance.mBALANC: Interchange_header_Type

Closed record

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.finance.mBALANC: Interchange_trailer_Type

Closed record

Fields

code string(default "UNZ") -

interchange_control_count int -

interchange_control_reference string -

edifact.d03a.finance.mBALANC: ITEM_NUMBER_IDENTIFICATION_GType

Closed record

Fields

Item_identifier? string -

Item_type_identification_code? string -

Code_list_identification_code? string -

Code_list_responsible_agency_code? string -

edifact.d03a.finance.mBALANC: Line_item_Type

Closed record

Fields

code string(default "LIN") -

LINE_ITEM_IDENTIFIER? string -

ITEM_NUMBER_IDENTIFICATION? ITEM_NUMBER_IDENTIFICATION_GType? -

SUB_LINE_INFORMATION? SUB_LINE_INFORMATION_GType? -

CONFIGURATION_LEVEL_NUMBER? int? -

CONFIGURATION_OPERATION_CODE? string -

edifact.d03a.finance.mBALANC: MEASUREMENT_DETAILS_GType

Closed record

Fields

Measured_attribute_code? string -

Measurement_significance_code? string -

Non_discrete_measurement_name_code? string -

Non_discrete_measurement_name? string -

edifact.d03a.finance.mBALANC: Message_header_Type

Closed record

Fields

code string(default "UNH") -

message_reference_number string -

message_identifier Message_identifier_GType -

edifact.d03a.finance.mBALANC: Message_identifier_GType

Closed record

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.finance.mBALANC: Message_trailer_Type

Closed record

Fields

code string(default "UNT") -

number_of_segments int -

message_reference_number string -

edifact.d03a.finance.mBALANC: MONETARY_AMOUNT_GType

Closed record

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.finance.mBALANC: Monetary_amount_Type

Closed record

Fields

code string(default "MOA") -

MONETARY_AMOUNT? MONETARY_AMOUNT_GType? -

edifact.d03a.finance.mBALANC: NAME_AND_ADDRESS_GType

Closed record

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.finance.mBALANC: Name_and_address_Type

Closed record

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.finance.mBALANC: NUMBER_OF_UNIT_DETAILS_GType

Closed record

Fields

Units_quantity? int? -

Unit_type_code_qualifier? string -

edifact.d03a.finance.mBALANC: Number_of_units_Type

Closed record

Fields

code string(default "EQN") -

NUMBER_OF_UNIT_DETAILS? NUMBER_OF_UNIT_DETAILS_GType? -

edifact.d03a.finance.mBALANC: PARTY_IDENTIFICATION_DETAILS_GType

Closed record

Fields

Party_identifier string -

Code_list_identification_code? string -

Code_list_responsible_agency_code? string -

edifact.d03a.finance.mBALANC: PARTY_NAME_GType

Closed record

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.finance.mBALANC: QUANTITY_DETAILS_GType

Closed record

Fields

Quantity_type_code_qualifier string -

Quantity string -

Measurement_unit_code? string -

edifact.d03a.finance.mBALANC: Quantity_Type

Closed record

Fields

code string(default "QTY") -

QUANTITY_DETAILS? QUANTITY_DETAILS_GType? -

edifact.d03a.finance.mBALANC: Recipient_GType

Closed record

Fields

id string -

qualifier? string -

internal_id? string -

internal_sub_id? string -

edifact.d03a.finance.mBALANC: Recipient_reference_password_GType

Closed record

Fields

reference_password? string -

qualifier? string -

edifact.d03a.finance.mBALANC: REFERENCE_GType

Closed record

Fields

Reference_code_qualifier string -

Reference_identifier? string -

Document_line_identifier? string -

Reference_version_identifier? string -

Revision_identifier? string -

edifact.d03a.finance.mBALANC: Reference_Type

Closed record

Fields

code string(default "RFF") -

REFERENCE? REFERENCE_GType? -

edifact.d03a.finance.mBALANC: Sender_GType

Closed record

Fields

id string -

qualifier? string -

internal_id? string -

internal_sub_id? string -

edifact.d03a.finance.mBALANC: STREET_GType

Closed record

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.finance.mBALANC: SUB_LINE_INFORMATION_GType

Closed record

Fields

Sub_line_indicator_code? string -

Line_item_identifier? string -

edifact.d03a.finance.mBALANC: Syntax_identifier_GType

Closed record

Fields

syntax_id string -

syntax_version string -

service_code_list_directory_version? string -

character_encoding? string -

edifact.d03a.finance.mBALANC: TEXT_LITERAL_GType

Closed record

Fields

Free_text string -

Free_text_1? string -

Free_text_2? string -

Free_text_3? string -

Free_text_4? string -

edifact.d03a.finance.mBALANC: TEXT_REFERENCE_GType

Closed record

Fields

Free_text_description_code string -

Code_list_identification_code? string -

Code_list_responsible_agency_code? string -

Import

import ballerinax/edifact.d03a.finance.mBALANC;

Other versions

1.0.1

1.0.0

0.9.0

Metadata

Released date: 5 days ago

Version: 1.0.0

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.12.0

GraalVM compatible: Yes

Pull count

Total: 35

Current verison: 1

Weekly downloads

Source repository

Keywords

finance

payments

banking

EDI

EDIFACT

D03A

B2B

Business Management/ERP

Cost/Free

Vendor/Other

Area/ERP & Business Operations

Type/Library

Name/EDIFACT D03A Finance

Contributors

Dependencies

ballerina/edi/1.6.0

Cookie policy

Delete policy

functions

records

ballerinax/edifact.d03a.finance.mBALANC Ballerina library

Functions

fromEdiString

Parameters

Return Type

fromEdiStringWithSchema

Parameters

Return Type

getSchema

Return Type

headersFromEdiString

Parameters

Return Type

interchangeFromEdiString

Parameters

Return Type

interchangeToEdiString

Parameters

Return Type

toEdiString

Parameters

Return Type

toEdiStringWithSchema

Parameters

Return Type

transformFromEdiString

Parameters

Return Type

transformHeadersFromEdiString

Parameters

Return Type

transformInterchangeFromEdiString

Parameters

Return Type

transformInterchangeToEdiString

Parameters

Return Type

transformToEdiString

Parameters

Return Type

Records

edifact.d03a.finance.mBALANC: ACCOUNT_IDENTIFICATION_GType

Fields

edifact.d03a.finance.mBALANC: Account_identification_Type

Fields

edifact.d03a.finance.mBALANC: Authentication_result_Type

Fields

edifact.d03a.finance.mBALANC: Beginning_of_message_Type

Fields

edifact.d03a.finance.mBALANC: Characteristic_class_id_Type

Fields

edifact.d03a.finance.mBALANC: CHARACTERISTIC_DESCRIPTION_GType

Fields

edifact.d03a.finance.mBALANC: CHARACTERISTIC_VALUE_GType

Fields

edifact.d03a.finance.mBALANC: Characteristic_value_Type

Fields

edifact.d03a.finance.mBALANC: COMMUNICATION_CONTACT_GType

Fields

edifact.d03a.finance.mBALANC: Communication_contact_Type

Fields

edifact.d03a.finance.mBALANC: Contact_information_Type

Fields

edifact.d03a.finance.mBALANC: COUNTRY_SUB_ENTITY_DETAILS_GType

Fields

edifact.d03a.finance.mBALANC: Currencies_Type

Fields

edifact.d03a.finance.mBALANC: CURRENCY_DETAILS_1_GType

Fields

edifact.d03a.finance.mBALANC: CURRENCY_DETAILS_GType

Fields

edifact.d03a.finance.mBALANC: Date_and_time_GType

Fields

edifact.d03a.finance.mBALANC: DATE_TIME_PERIOD_GType

Fields

edifact.d03a.finance.mBALANC: Date_time_period_Type

Fields

edifact.d03a.finance.mBALANC: DEPARTMENT_OR_EMPLOYEE_DETAILS_GType