France (CII(CDAR)): Additional Status Property

You can provide additional information for the status of a document.

The Additional Status Property Group is used to provide additional information depending on different Lifecycle scenarios:

To indicate paid and received amounts for the following Response Codes: VRBL:FR:211 and VRBL:FR:212
To report bank information in case of subrogation or factoring for the following Response Codes: VRBL:FR:225, VRBL:FR:226, VRBL:FR:227
To provide detailed error messages in case of disputes. Response Codes: VRBL:FR:207

Elements

Name (Path)	Cardinality	Description
Clarification Information (`ApplicationResponse/DocumentResponse/Response/Status`)	0..1	A group of business terms to provide clarification information regarding the status of a referenced document.
Additional Status Property Group (`ApplicationResponse/DocumentResponse/Response/Status/UBLExtensions//StatusExtension/AdditionalStatusProperty`)	0..n	Repeatable information block providing additional data necessary for the status.

It contains following elements:

Name (Path)	Cardinality	Description
Amount Status Property (`ApplicationResponse/DocumentResponse/Response/Status/UBLExtensions//StatusExtension/AdditionalStatusProperty/Amount`)	0..1	Used when an amount needs to be reported: a payment amount, an invoice approval amount, and so on.
Amount Currency Status Property (`ApplicationResponse/DocumentResponse/Response/Status/UBLExtensions//StatusExtension/AdditionalStatusProperty/Amount/@currencyID`)	1..1	Currency or the reported amount.
Description Status Property (`ApplicationResponse/DocumentResponse/Response/Status/UBLExtensions//StatusExtension/AdditionalStatusProperty/Description`)	0..1	A description element to provide additional information.
Function Code Status Property (`ApplicationResponse/DocumentResponse/Response/Status/UBLExtensions//StatusExtension/AdditionalStatusProperty/FunctionCode`)	0..1	A code used to qualify how the Additional Status Property group is used
Referenced ID Status Property (`ApplicationResponse/DocumentResponse/Response/Status/UBLExtensions//StatusExtension/AdditionalStatusProperty[ID/@schemeID='VRBL:FR:BT']/ID`)	0..1	Used to provide the ID of a Business Term of the referred document which contains data in dispute.
Modification Indicator (`ApplicationResponse/DocumentResponse/Response/Status/UBLExtensions//StatusExtension/AdditionalStatusProperty/ModificationIndicator`)	0..1	Indicator to transmit whether a value change is being proposed or requested. In case of Lifecycle scenario: Payment Transmitted (Response Codes: `VRBL:FR:211`) or Payment Received (Response Codes: `VRBL:FR:212`) set to `false`. In case of a dispute status (Response Codes:`VRBL:FR:207`) the indicator is set to `true`.
Referenced Name Status Property (`ApplicationResponse/DocumentResponse/Response/Status/UBLExtensions/StatusExtension/AdditionalStatusProperty/Name`)	0..1	Used to provide the name of a Business Term of the referred document which contains data in dispute.
Percent Status Property (`ApplicationResponse/DocumentResponse/Response/Status/UBLExtensions/StatusExtension/AdditionalStatusProperty/Percent`)	0..1	Used to provide a percentage.
Quantity Status Property (`ApplicationResponse/DocumentResponse/Response/Status/UBLExtensions/StatusExtension/AdditionalStatusProperty/Quantity`)	0..1	Used to provide a quantity.
Date Status Property (`ApplicationResponse/DocumentResponse/Response/Status/UBLExtensions/StatusExtension/AdditionalStatusProperty/ReferenceDate`)	0..1	Used to provide a date.
Measure Unit Status Property (`ApplicationResponse/DocumentResponse/Response/Status/UBLExtensions/StatusExtension/AdditionalStatusProperty/UnitOfMeasure`)	0..1	Used to provide a unit of measure.
Value Status Property (`ApplicationResponse/DocumentResponse/Response/Status/UBLExtensions/StatusExtension/AdditionalStatusProperty/Value`)	0..1	Used to provide a generic value.
Value Code Status Property (`ApplicationResponse/DocumentResponse/Response/Status/UBLExtensions/StatusExtension/AdditionalStatusProperty/ValueCode`)	0..1	Used to provide a code.
Value Numeric Status Property (`ApplicationResponse/DocumentResponse/Response/Status/UBLExtensions/StatusExtension/AdditionalStatusProperty/ValueNumeric`)	0..1	Used to provide a numeric value.
XPath Status Property (`ApplicationResponse/DocumentResponse/Response/Status/UBLExtensions/StatusExtension/AdditionalStatusProperty/XPath`)	0..1	Used to provide the XPath of a Business Term of the referred document which contains data in dispute.

Usage of Function Code Status Property

The Function Code Status Property qualifies how the Additional Status Property Group is used.
Depending on the Lifecycle scenario different codes apply.
See examples below.

Restrictions

Code	Description
`VRBL:FR:MPA`	Amount paid
`VRBL:FR:MEN`	Amount collected (including VAT)
`VRBL:FR:RAP`	Balance due (in case of partial payment)
`VRBL:FR:ESC`	Discount granted
`VRBL:FR:RAB`	Rebate granted
`VRBL:FR:REM`	Discount granted
`VRBL:FR:MAP`	Approved pre-tax amount
`VRBL:FR:MAPTTC`	Approved total amount including VAT
`VRBL:FR:MNA`	Unapproved pre-tax amount
`VRBL:FR:MNATTC`	Unapproved total amount including VAT
`VRBL:FR:CBB`	Beneficiary bank details to be modified
`VRBL:FR:DIV`	Invalid data
`VRBL:FR:DVA`	Valid data expected
`VRBL:FR:MAJ`	Data to be used in place of that present in the invoice for processing (Status "Completed" or "Additional")

Usage of Referenced ID Status Property and Referenced Name Status Property and XPath Status Property

In case of a dispute (Response Codes: VRBL:FR:207), these elements can be used to provide the exact ID, name, and XPath of the business term that is in dispute.
In combination with the Function Code Status Property codes VRBL:FR:DIV (invalid data) or VRBL:FR:DVA (valid data expected), and by providing the disputed value in one of the value elements, the reason for the dispute can be clearly indicated in a structured way.
See the example below.

Use following elements to provide the actual value in dispute:

Element	Description
`Amount`	Amount Status Property
`Percent`	Percent Status Property
`Quantity`	Quantity Status Property
`ReferenceDate`	Date Status Property
`UnitOfMeasure`	Measure Unit Status Property
`Value`	Value Status Property
`ValueCode`	Value Code Status Property
`ValueNumeric`	Value Numeric Status Property

Examples

Additional Status Property group used to indicate a received payment. Response Codes: VRBL:FR:211 and VRBL:FR:212
In this case, it is mandatory to provide a breakdown of the Paid Amounts by tax rate.
Therefore, multiple Additional Status Property Groups are used.
Each group contains:

The Paid Amount Amount
The corresponding Function Code FunctionCode
The Modification Indicator ModificationIndicator set to false
The Tax rate in a percentage Percent

<ubl:ApplicationResponse>
    <!-- code omitted for clarity -->
    <cac:DocumentResponse>
        <cac:Response>
            <!-- code omitted for clarity -->
            <cac:Status>
                <cec:UBLExtensions>
                    <cec:UBLExtension>
                        <cec:ExtensionContent>
                            <vrbl:StatusExtension>
                                <vrbl:AdditionalStatusProperty>
                                    <vrbl:Amount currencyID="EUR">110000.00</vrbl:Amount>
                                    <vrbl:FunctionCode>VRBL:FR:MEN</vrbl:FunctionCode>
                                    <vrbl:ModificationIndicator>false</vrbl:ModificationIndicator>
                                    <cbc:Percent>25</cbc:Percent>
                                </vrbl:AdditionalStatusProperty>
                                <vrbl:AdditionalStatusProperty>
                                    <vrbl:Amount currencyID="EUR">5000.00</vrbl:Amount>
                                    <vrbl:FunctionCode>VRBL:FR:MEN</vrbl:FunctionCode>
                                    <vrbl:ModificationIndicator>false</vrbl:ModificationIndicator>
                                    <cbc:Percent>10</cbc:Percent>
                                </vrbl:AdditionalStatusProperty>
                                <cbc:SequenceID>1</cbc:SequenceID>
                            </vrbl:StatusExtension>
                        </cec:ExtensionContent>
                    </cec:UBLExtension>
                </cec:UBLExtensions>                    
            </cac:Status>
        </cac:Response>
        <!-- code omitted for clarity -->
    </cac:DocumentResponse>
</ubl:ApplicationResponse>

Additional Status Property group used to report bank information in case of subrogation or factoring. Response Codes: VRBL:FR:225, VRBL:FR:226, VRBL:FR:227
Therefore, multiple Additional Status Property Groups are used.

Provide the corresponding Function Code FunctionCode
The Business Term ID of the Bank details.
The Value that should be contained in the Business Term Value

In this example: IBAN, Business Account Name, and BIC

<ubl:ApplicationResponse>
    <!-- code omitted for clarity -->
    <cac:DocumentResponse>
        <cac:Response>
            <!-- code omitted for clarity -->
            <cac:Status>
                <cec:UBLExtensions>
                    <cec:UBLExtension>
                        <cec:ExtensionContent>
                            <vrbl:StatusExtension>
                                <vrbl:AdditionalStatusProperty>
                                    <vrbl:FunctionCode>VRBL:FR:CBB</vrbl:FunctionCode>
                                    <cbc:ID schemeID="VRBL:FR:BT">BT-84</cbc:ID>
                                    <cbc:Value>FR20 1111 2222 3333 4444 5555 666</cbc:Value>
                                </vrbl:AdditionalStatusProperty>
                                <vrbl:AdditionalStatusProperty>
                                    <vrbl:FunctionCode>VRBL:FR:CBB</vrbl:FunctionCode>
                                    <cbc:ID schemeID="VRBL:FR:BT">BT-85</cbc:ID>
                                    <cbc:Value>MON COMPTE BUSINESS</cbc:Value>
                                </vrbl:AdditionalStatusProperty>
                                <vrbl:AdditionalStatusProperty>
                                    <vrbl:FunctionCode>VRBL:FR:CBB</vrbl:FunctionCode>
                                    <cbc:ID schemeID="VRBL:FR:BT">BT-86</cbc:ID>
                                    <cbc:Value>BIC_NEWBIC</cbc:Value>
                                </vrbl:AdditionalStatusProperty>
                                <!-- code omitted for clarity -->
                            </vrbl:StatusExtension>
                        </cec:ExtensionContent>
                    </cec:UBLExtension>
                </cec:UBLExtensions>
            </cac:Status>
        </cac:Response>
        <!-- code omitted for clarity -->
    </cac:DocumentResponse>
</ubl:ApplicationResponse>

Additional Status Property group used to provide detailed error messages in case of disputes. Response Codes: VRBL:FR:207
Therefore multiple Additional Status Property Groups can be used.
The level of detail depends on the issuer.
All elements are optional.

In this case, the first Additional Status Property group indicates that the value in BT-152 of the invoice, which was 10%, was wrong.
The second Additional Status Property group indicates that the expected correct value would have been 20%.

The Requested Action Code RequestedActionCode indicates that a new invoice should be created by the invoice issuer.

<ubl:ApplicationResponse>
    <!-- code omitted for clarity -->
    <cac:DocumentResponse>
        <cac:Response>
            <!-- code omitted for clarity -->
            <cac:Status>
                <cec:UBLExtensions>
                    <cec:UBLExtension>
                        <cec:ExtensionContent>
                            <vrbl:StatusExtension>
                                <vrbl:AdditionalStatusProperty>
                                    <vrbl:FunctionCode>VRBL:FR:DIV</vrbl:FunctionCode>
                                    <cbc:ID schemeID="VRBL:FR:BT">BT-152</cbc:ID>
                                    <vrbl:ModificationIndicator>true</vrbl:ModificationIndicator>
                                    <cbc:Name>Taux TVA</cbc:Name>
                                    <cbc:Percent>10</cbc:Percent>
                                </vrbl:AdditionalStatusProperty>
                                <vrbl:AdditionalStatusProperty>
                                    <vrbl:FunctionCode>VRBL:FR:DVA</vrbl:FunctionCode>
                                    <cbc:ID schemeID="VRBL:FR:BT">BT-152</cbc:ID>
                                    <vrbl:ModificationIndicator>true</vrbl:ModificationIndicator>
                                    <cbc:Name>Taux TVA</cbc:Name>
                                    <cbc:Percent>20</cbc:Percent>
                                </vrbl:AdditionalStatusProperty>
                                <vrbl:RequestedAction>Créer une Facture Rectificative</vrbl:RequestedAction>
                                <vrbl:RequestedActionCode>NIN</vrbl:RequestedActionCode>
                                <cbc:SequenceID>1</cbc:SequenceID>
                                <!-- code omitted for clarity -->
                            </vrbl:StatusExtension>
                        </cec:ExtensionContent>
                    </cec:UBLExtension>
                </cec:UBLExtensions>
            </cac:Status>
        </cac:Response>
        <!-- code omitted for clarity -->
    </cac:DocumentResponse>
</ubl:ApplicationResponse>

Updated about 4 hours ago