Adding Remit-to address to a report data source

A remit address is used as a unique destination address to receive payment (e.g. a check) for a bill or invoice. This is used so payments can be processed more quickly than if it were sent to the general mail address of the company.

In Dynamics 365 for Finance and Operations remit address can be added to a legal entity on the Organization administration -> Organizations -> Legal entities form:

If you need to add a remit address of the current company to your report data source in order to print it on the report (e.g. on Customer invoice) then the best practice when using Docentric is to add it directly to the GeneralData data section of the report data source.

What is the GeneralData data section of a report data source?

When you print a report using any Docentric DSP class (including the default, i.e. base class) you will get in your report data source three data sections: Report Parameters, Main Data and one section more: so called General Data. This GeneralData section includes various data for the current company and worker. However, there is no Remit-to address in the GeneralData section provided by default, but we can easily add it by overriding the addGeneralDataSectionBaseCompanyInfo() method of your report DSP class.

protected void addGeneralDataSectionBaseCompanyInfo(
    DocXmlRecord _currentCompanyDataRecord, CompanyInfo _currentCompanyInfo)
{
    // Add the CurrentCompany node to the GeneralData data section.
    super(_currentCompanyDataRecord, _currentCompanyInfo);

    // Add the default RemitTo address of the current company as a child data record to the CurrentCompany node
    LogisticsLocationDefault logisticsLocationDefault = LogisticsLocationDefault::construct(_currentCompanyInfo);
    LogisticsLocation location = logisticsLocationDefault.getDefaultActiveLocation(LogisticsLocationRole::findBytype(LogisticsLocationRoleType::RemitTo));
    DirPartyPostalAddressView remitAddressView = DirPartyPostalAddressView::find(_currentCompanyInfo.RecId, location.RecId);

    // Add RemitTo Postal Address.
    DocXmlRecord dataRecord = _currentCompanyDataRecord.addChildRecord(remitAddressView, literalStr("@GlobalAddressBook:RemitTo"));
    dataRecord.setRecordName('RemitToPostalAddress');

    dataRecord.addField(fieldStr(DirPartyPostalAddressView, LocationName));
    dataRecord.addField(fieldStr(DirPartyPostalAddressView, Address));
    dataRecord.addField(fieldStr(DirPartyPostalAddressView, Street));
    dataRecord.addField(fieldStr(DirPartyPostalAddressView, StreetNumber));
    dataRecord.addField(fieldStr(DirPartyPostalAddressView, City));
    dataRecord.addField(fieldStr(DirPartyPostalAddressView, ZipCode));
    dataRecord.addField(fieldStr(DirPartyPostalAddressView, State));
    dataRecord.addField(fieldStr(DirPartyPostalAddressView, County));
    dataRecord.addField(fieldStr(DirPartyPostalAddressView, CountryRegionId));
}

protected void addGeneralDataSectionBaseCompanyInfo(

DocXmlRecord _currentCompanyDataRecord, CompanyInfo _currentCompanyInfo)

{

// Add the CurrentCompany node to the GeneralData data section.

super(_currentCompanyDataRecord, _currentCompanyInfo);

// Add the default RemitTo address of the current company as a child data record to the CurrentCompany node

LogisticsLocationDefault logisticsLocationDefault = LogisticsLocationDefault::construct(_currentCompanyInfo);

LogisticsLocation location = logisticsLocationDefault.getDefaultActiveLocation(LogisticsLocationRole::findBytype(LogisticsLocationRoleType::RemitTo));

DirPartyPostalAddressView remitAddressView = DirPartyPostalAddressView::find(_currentCompanyInfo.RecId, location.RecId);

// Add RemitTo Postal Address.

DocXmlRecord dataRecord = _currentCompanyDataRecord.addChildRecord(remitAddressView, literalStr("@GlobalAddressBook:RemitTo"));

dataRecord.setRecordName('RemitToPostalAddress');

dataRecord.addField(fieldStr(DirPartyPostalAddressView, LocationName));

dataRecord.addField(fieldStr(DirPartyPostalAddressView, Address));

dataRecord.addField(fieldStr(DirPartyPostalAddressView, Street));

dataRecord.addField(fieldStr(DirPartyPostalAddressView, StreetNumber));

dataRecord.addField(fieldStr(DirPartyPostalAddressView, City));

dataRecord.addField(fieldStr(DirPartyPostalAddressView, ZipCode));

dataRecord.addField(fieldStr(DirPartyPostalAddressView, State));

dataRecord.addField(fieldStr(DirPartyPostalAddressView, County));

dataRecord.addField(fieldStr(DirPartyPostalAddressView, CountryRegionId));

}

When you re-generate the report data source you will get a new node RemitToPostalAddress in the CurrentCompany data record in the GeneralData data section: