Module edifact.d03a.supplychain.mDOCAMI
ballerinax/edifact.d03a.supplychain.mDOCAMI Ballerina library
1.0.1
Functions
fromEdiString
Isolated Function
function fromEdiString(string ediText) returns EDI_DOCAMI_DOCAMI|errorConvert EDI string to Ballerina EDI_DOCAMI_DOCAMI record.
Parameters
- ediText string - EDI string to be converted
Return Type
- EDI_DOCAMI_DOCAMI|error - Ballerina record or error
fromEdiStringWithSchema
Isolated Function
function fromEdiStringWithSchema(string ediText, EdiSchema schema) returns EDI_DOCAMI_DOCAMI|errorConvert EDI string to Ballerina EDI_DOCAMI_DOCAMI record with schema.
Return Type
- EDI_DOCAMI_DOCAMI|error - Ballerina record or error
getSchema
Isolated Function
Get the EDI schema.
headersFromEdiString
Isolated Function
function headersFromEdiString(string ediText) returns EDI_DOCAMI_DOCAMIHeaders|errorParse only the envelope header segments from the given EDI string.
Parameters
- ediText string - EDI string to parse
Return Type
- EDI_DOCAMI_DOCAMIHeaders|error - Parsed EDI_DOCAMI_DOCAMIHeaders record, or error if the headers are malformed
interchangeFromEdiString
Isolated Function
function interchangeFromEdiString(string ediText) returns EDI_DOCAMI_DOCAMIInterchange|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_DOCAMI_DOCAMIInterchange|error - Parsed EDI_DOCAMI_DOCAMIInterchange, or error if the envelope is malformed
interchangeToEdiString
Isolated Function
function interchangeToEdiString(EDI_DOCAMI_DOCAMIInterchange msg) returns string|errorSerialise a EDI_DOCAMI_DOCAMIInterchange 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_DOCAMI_DOCAMIInterchange - The interchange to serialise
toEdiString
Isolated Function
function toEdiString(EDI_DOCAMI_DOCAMI data) returns string|errorConvert Ballerina EDI_DOCAMI_DOCAMI record to EDI string.
Parameters
- data EDI_DOCAMI_DOCAMI - Ballerina record to be converted
toEdiStringWithSchema
Isolated Function
function toEdiStringWithSchema(EDI_DOCAMI_DOCAMI data, EdiSchema ediSchema) returns string|errorConvert Ballerina EDI_DOCAMI_DOCAMI record to EDI string with schema.
transformFromEdiString
Isolated Function
Convert EDI string to Ballerina EDI_DOCAMI_DOCAMI record.
Parameters
- ediText string - EDI string to be converted
Return Type
- anydata|error - Ballerina record or error
transformHeadersFromEdiString
Isolated Function
Convert EDI string to the envelope headers of EDI_DOCAMI_DOCAMI. Narrow the result with ensureType.
Parameters
- ediText string - EDI string to be converted
Return Type
- anydata|error - EDI_DOCAMI_DOCAMIHeaders record boxed as anydata, or error
transformInterchangeFromEdiString
Isolated Function
Convert EDI string to a EDI_DOCAMI_DOCAMIInterchange record. Narrow the result with ensureType.
Parameters
- ediText string - EDI string to be converted
Return Type
- any|error - EDI_DOCAMI_DOCAMIInterchange record boxed as any, or error
transformInterchangeToEdiString
Isolated Function
Convert a EDI_DOCAMI_DOCAMIInterchange record to EDI string.
Parameters
- content any - EDI_DOCAMI_DOCAMIInterchange record boxed as any
transformToEdiString
Isolated Function
Convert Ballerina EDI_DOCAMI_DOCAMI record to EDI string.
Parameters
- content anydata - Ballerina record to be converted
Records
edifact.d03a.supplychain.mDOCAMI: ACCOUNT_HOLDER_IDENTIFICATION_GType
Closed record
Fields
- Account_holder_identifier? string -
- Account_holder_name? string -
- Account_holder_name_2? string -
- Currency_identification_code? string -
edifact.d03a.supplychain.mDOCAMI: Authentication_result_Type
Closed record
Fields
- code string(default "AUT") -
- VALIDATION_RESULT_TEXT? string -
- VALIDATION_KEY_IDENTIFIER? string -
edifact.d03a.supplychain.mDOCAMI: 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.supplychain.mDOCAMI: CHARGE_ALLOWANCE_ACCOUNT_GType
Closed record
Fields
- Institution_branch_identifier string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
- Account_holder_identifier? string -
- Currency_identification_code? string -
edifact.d03a.supplychain.mDOCAMI: COMMUNICATION_CONTACT_GType
Closed record
Fields
- Communication_address_identifier string -
- Communication_address_code_qualifier string -
edifact.d03a.supplychain.mDOCAMI: Communication_contact_Type
Closed record
Fields
- code string(default "COM") -
- COMMUNICATION_CONTACT COMMUNICATION_CONTACT_GType[](default []) -
edifact.d03a.supplychain.mDOCAMI: 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.supplychain.mDOCAMI: CONTRACT_AND_CARRIAGE_CONDITION_GType
Closed record
Fields
- Contract_and_carriage_condition_code string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
edifact.d03a.supplychain.mDOCAMI: 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.supplychain.mDOCAMI: Date_and_time_GType
Closed record
Fields
- date string -
- time string -
edifact.d03a.supplychain.mDOCAMI: 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.supplychain.mDOCAMI: Date_time_period_Type
Closed record
Fields
- code string(default "DTM") -
- DATE_TIME_PERIOD? DATE_TIME_PERIOD_GType? -
edifact.d03a.supplychain.mDOCAMI: DEPARTMENT_OR_EMPLOYEE_DETAILS_GType
Closed record
Fields
- Department_or_employee_name_code? string -
- Department_or_employee_name? string -
edifact.d03a.supplychain.mDOCAMI: DOCUMENT_MESSAGE_IDENTIFICATION_GType
Closed record
Fields
- Document_identifier? string -
- Version_identifier? string -
- Revision_identifier? string -
edifact.d03a.supplychain.mDOCAMI: 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.supplychain.mDOCAMI: EDI_DOCAMI_DOCAMI
Closed record
Fields
- Beginning_of_message Beginning_of_message_Type -
- Reference Reference_Type[](default []) -
- Financial_charges_allocation? Financial_charges_allocation_Type? -
- Date_time_period Date_time_period_Type[](default []) -
- Monetary_amount Monetary_amount_Type[](default []) -
- Place_location_identification Place_location_identification_Type[](default []) -
- Transport_service_requirements? Transport_service_requirements_Type? -
- Free_text Free_text_Type[](default []) -
- group_1 Group_1_GType[](default []) -
- group_2 Group_2_GType[](default []) -
- group_3? Group_3_GType? -
edifact.d03a.supplychain.mDOCAMI: EDI_DOCAMI_DOCAMIHeaders
Closed record
Envelope headers of a EDI_DOCAMI_DOCAMI interchange.
Fields
- interchange EDI_DOCAMI_DOCAMIInterchangeHeader - Interchange header
- 'transaction EDI_DOCAMI_DOCAMITransactionHeader - Transaction header
edifact.d03a.supplychain.mDOCAMI: EDI_DOCAMI_DOCAMIInterchange
Closed record
A parsed EDI_DOCAMI_DOCAMI interchange with its full envelope hierarchy.
Fields
- interchangeHeader EDI_DOCAMI_DOCAMIInterchangeHeader - Interchange header segment
- transactions EDI_DOCAMI_DOCAMITransaction[] - Transactions in the interchange
- interchangeTrailer EDI_DOCAMI_DOCAMIInterchangeTrailer - Interchange trailer segment
edifact.d03a.supplychain.mDOCAMI: EDI_DOCAMI_DOCAMIInterchangeHeader
Closed record
Fields
- interchange_header Interchange_header_Type -
edifact.d03a.supplychain.mDOCAMI: EDI_DOCAMI_DOCAMIInterchangeTrailer
Closed record
Fields
- interchange_trailer Interchange_trailer_Type -
edifact.d03a.supplychain.mDOCAMI: EDI_DOCAMI_DOCAMITransaction
Closed record
A single transaction within a EDI_DOCAMI_DOCAMI interchange.
Fields
- transactionHeader EDI_DOCAMI_DOCAMITransactionHeader - Transaction header segment
- body EDI_DOCAMI_DOCAMI|error - Parsed EDI_DOCAMI_DOCAMI body, or the parse error when the body is malformed
- transactionTrailer EDI_DOCAMI_DOCAMITransactionTrailer - Transaction trailer segment
edifact.d03a.supplychain.mDOCAMI: EDI_DOCAMI_DOCAMITransactionHeader
Closed record
Fields
- Message_header Message_header_Type -
edifact.d03a.supplychain.mDOCAMI: EDI_DOCAMI_DOCAMITransactionTrailer
Closed record
Fields
- Message_trailer Message_trailer_Type -
edifact.d03a.supplychain.mDOCAMI: Financial_charges_allocation_Type
Closed record
Fields
- code string(default "FCA") -
- SETTLEMENT_MEANS_CODE? string -
- CHARGE_ALLOWANCE_ACCOUNT? CHARGE_ALLOWANCE_ACCOUNT_GType? -
edifact.d03a.supplychain.mDOCAMI: Financial_institution_information_Type
Closed record
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.supplychain.mDOCAMI: 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.supplychain.mDOCAMI: Group_1_GType
Closed record
Fields
- Financial_institution_information Financial_institution_information_Type -
- Reference Reference_Type[](default []) -
- Contact_information? Contact_information_Type? -
- Communication_contact Communication_contact_Type[](default []) -
edifact.d03a.supplychain.mDOCAMI: Group_2_GType
Closed record
Fields
- Name_and_address Name_and_address_Type -
- Reference? Reference_Type? -
- Contact_information? Contact_information_Type? -
- Communication_contact Communication_contact_Type[](default []) -
edifact.d03a.supplychain.mDOCAMI: Group_3_GType
Closed record
Fields
- Authentication_result Authentication_result_Type -
- Date_time_period? Date_time_period_Type? -
edifact.d03a.supplychain.mDOCAMI: INSTITUTION_IDENTIFICATION_GType
Closed record
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.supplychain.mDOCAMI: 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.supplychain.mDOCAMI: Interchange_trailer_Type
Closed record
Fields
- code string(default "UNZ") -
- interchange_control_count int -
- interchange_control_reference string -
edifact.d03a.supplychain.mDOCAMI: LOCATION_IDENTIFICATION_GType
Closed record
Fields
- Location_name_code? string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
- Location_name? string -
edifact.d03a.supplychain.mDOCAMI: Message_header_Type
Closed record
Fields
- code string(default "UNH") -
- message_reference_number string -
- message_identifier Message_identifier_GType -
edifact.d03a.supplychain.mDOCAMI: 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.supplychain.mDOCAMI: Message_trailer_Type
Closed record
Fields
- code string(default "UNT") -
- number_of_segments int -
- message_reference_number string -
edifact.d03a.supplychain.mDOCAMI: 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.supplychain.mDOCAMI: Monetary_amount_Type
Closed record
Fields
- code string(default "MOA") -
- MONETARY_AMOUNT? MONETARY_AMOUNT_GType? -
edifact.d03a.supplychain.mDOCAMI: 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.supplychain.mDOCAMI: 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.supplychain.mDOCAMI: NATURE_OF_CARGO_GType
Closed record
Fields
- Cargo_type_classification_code string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
edifact.d03a.supplychain.mDOCAMI: PARTY_IDENTIFICATION_DETAILS_GType
Closed record
Fields
- Party_identifier string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
edifact.d03a.supplychain.mDOCAMI: 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.supplychain.mDOCAMI: Place_location_identification_Type
Closed record
Fields
- code string(default "LOC") -
- LOCATION_FUNCTION_CODE_QUALIFIER? string -
- LOCATION_IDENTIFICATION? LOCATION_IDENTIFICATION_GType? -
- RELATED_LOCATION_ONE_IDENTIFICATION? RELATED_LOCATION_ONE_IDENTIFICATION_GType? -
- RELATED_LOCATION_TWO_IDENTIFICATION? RELATED_LOCATION_TWO_IDENTIFICATION_GType? -
- RELATION_CODE? string -
edifact.d03a.supplychain.mDOCAMI: Recipient_GType
Closed record
Fields
- id string -
- qualifier? string -
- internal_id? string -
- internal_sub_id? string -
edifact.d03a.supplychain.mDOCAMI: Recipient_reference_password_GType
Closed record
Fields
- reference_password? string -
- qualifier? string -
edifact.d03a.supplychain.mDOCAMI: 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.supplychain.mDOCAMI: Reference_Type
Closed record
Fields
- code string(default "RFF") -
- REFERENCE? REFERENCE_GType? -
edifact.d03a.supplychain.mDOCAMI: RELATED_LOCATION_ONE_IDENTIFICATION_GType
Closed record
Fields
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
edifact.d03a.supplychain.mDOCAMI: RELATED_LOCATION_TWO_IDENTIFICATION_GType
Closed record
Fields
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
edifact.d03a.supplychain.mDOCAMI: Sender_GType
Closed record
Fields
- id string -
- qualifier? string -
- internal_id? string -
- internal_sub_id? string -
edifact.d03a.supplychain.mDOCAMI: SERVICE_GType
Closed record
Fields
- Service_requirement_code string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
- Service_requirement_code_3? string -
- Code_list_identification_code_4? string -
- Code_list_responsible_agency_code_5? string -
edifact.d03a.supplychain.mDOCAMI: 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.supplychain.mDOCAMI: Syntax_identifier_GType
Closed record
Fields
- syntax_id string -
- syntax_version string -
- service_code_list_directory_version? string -
- character_encoding? string -
edifact.d03a.supplychain.mDOCAMI: 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.supplychain.mDOCAMI: TEXT_REFERENCE_GType
Closed record
Fields
- Free_text_description_code string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
edifact.d03a.supplychain.mDOCAMI: TRANSPORT_PRIORITY_GType
Closed record
Fields
- Transport_service_priority_code string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
edifact.d03a.supplychain.mDOCAMI: Transport_service_requirements_Type
Closed record
Fields
- code string(default "TSR") -
- CONTRACT_AND_CARRIAGE_CONDITION? CONTRACT_AND_CARRIAGE_CONDITION_GType? -
- SERVICE? SERVICE_GType? -
- TRANSPORT_PRIORITY? TRANSPORT_PRIORITY_GType? -
- NATURE_OF_CARGO? NATURE_OF_CARGO_GType? -