[MOD ELEMENT SIGNATURE]: cbc:CompanyID is highly localization specific

[oca]

[MOD ELEMENT SIGNATURE]: cbc:CompanyID is highly localization specific

[blaggacao]

Same for cbc:RegistrationName (which is not necesarily identical to res.partner.name) - res.partner.name can be used for well known commercial insignia (eg. brand).

[blaggacao]

It happens so that both have the same signature:

• http://www.datypic.com/sc/ubl21/t-cbc_CompanyIDType.html
• http://www.datypic.com/sc/ubl21/t-cbc_IDType.html

Therefore the existing localization machinery can be reused:

    @api.model
    def _ubl_get_party_identification(self, commercial_partner):
        '''This method is designed to be inherited in localisation modules
        Should return a dict with key=SchemeName, value=Identifier'''
        return {}

    @api.model
    def _ubl_add_party_identification(
            self, commercial_partner, parent_node, ns, version='2.1'):
        id_dict = self._ubl_get_party_identification(commercial_partner)
        if id_dict:
            party_identification = etree.SubElement(
                parent_node, ns['cac'] + 'PartyIdentification')
            for scheme_name, party_id_text in id_dict.items():
                party_identification_id = etree.SubElement(
                    party_identification, ns['cbc'] + 'ID',
                    schemeName=scheme_name)
                party_identification_id.text = party_id_text
        return

EDIT: This localization machinery must support all available attributes.

[blaggacao]

Proposal:

    @api.model
    def _ubl_get_party_identification(self, commercial_partner):
        '''This method is designed to be inherited in localisation modules
        Should return a list of dict reflecting the json xml notation of
            - either cbe:IDType
            - or: cbc:CompanyIDType
        which both have identical signatures.
        Example:
        {
            "IdentifierContent":"DK12345",
            "IdentificationSchemeIdentifier":"DKVAT",
            "IdentificationSchemeNameText":"DKVAT",
            "IdentificationSchemeAgencyIdentifier":"ZZZ",
            "IdentificationSchemeAgencyNameText":"ZZZ",
            "IdentificationSchemeVersionIdentifier":"ZZZ",
            "IdentificationSchemeDataUniformResourceIdentifier":"ZZZ",
            "IdentificationSchemeUniformResourceIdentifier":"ZZZ",
        }
        Full spec: http://docs.oasis-open.org/ubl/UBL-2.1-JSON/v1.0/cnd02/
                   /json-schema/common/CCTS_CCT_SchemaModule-2.1.json
        '''
        return []

    @api.model
    def _ubl_add_id_type(self, id_dict, node_name, parent_node, ns, version='2.1'):
        if "IdentifierContent" not in id_dict:
            raise UserError(_(
                "No 'IdentiferContent' provided for '%s'")
                % node_name)
        json_to_xml_attrs = {
            "IdentificationSchemeIdentifier": "schemeID",
            "IdentificationSchemeNameText": "schemeName",
            "IdentificationSchemeAgencyIdentifier": "schemeAgencyID",
            "IdentificationSchemeAgencyNameText": "schemeAgencyName",
            "IdentificationSchemeVersionIdentifier": "schemeVersionID",
            "IdentificationSchemeDataUniformResourceIdentifier": "schemeDataURI",
            "IdentificationSchemeUniformResourceIdentifier": "schemeURI",
        }
        iid = etree.SubElement(
            parent_node,
            ns['cbc'] + node_name,
            **dict(
                (json_to_xml_attrs[key], value)
                for (key, value) in id_dict.items()
                if key in json_to_xml_attrs
            )
        )
        iid.text = id_dict['IdentifierContent']

    @api.model
    def _ubl_add_party_identification(
            self, commercial_partner, parent_node, ns, version='2.1'):
        id_dicts = self._ubl_get_party_identification(commercial_partner)
        if id_dicts:
            party_identification = etree.SubElement(
                parent_node, ns['cac'] + 'PartyIdentification')
            for id_dict in id_dicts:
                self._ubl_add_id_type(
                    id_dict, 'ID', party_identification, ns, version=version)
        return

Mimicks the official JSON Alternative Representation V1.0 as python dict.
A little verbose, but well documented, standard conformant and sufficiently expressive.

[blaggacao]

/cc @Deiber

[astirpe]

@blaggacao I get the idea behind your proposal #126 (comment) and it looks good to me.

[blaggacao]

I went a little further and made "dict parsers" for UBL IdentifierType TextType and CodeType. THis way we can construe more complex TaxScheme instances. Once I've get a patch working for my case, I'll share it.

[github-actions]

There hasn't been any activity on this issue in the past 6 months, so it has been marked as stale and it will be closed automatically if no further activity occurs in the next 30 days.
If you want this issue to never become stale, please ask a PSC member to apply the "no stale" label.