Models
French Invoicing CDAR to send
French invoice lifecycle status to send. The recipient electronic address is derived from the top-level Peppol recipient.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
id | string | No | The ID of the CDAR. If not provided, the ID will be autogenerated |
issueDate | string (date-time) | No | If not provided, the issue date and time will be the current local date and time. Example: "2024-03-20T14:05:09". Format: date-time |
businessProcess | REGULATED | NON_REGULATED | B2C | B2CINT | B2BINT | OUTOFSCOPE | Yes | Flow classification. | Value | Meaning | | --- | --- | | REGULATED | Regulated French domestic e-invoicing | | NON_REGULATED | Outside the regulated French e-invoicing perimeter | | B2C | B2C sales e-reporting | | B2CINT | International B2C sales e-reporting | | B2BINT | International B2B sales e-reporting | | OUTOFSCOPE | Outside the French e-invoicing and e-reporting reform |. Example: "REGULATED". Values: REGULATED, NON_REGULATED, B2C, B2CINT, B2BINT, OUTOFSCOPE |
phase | 23 | 305 | No | CDAR phase. | Value | Meaning | | --- | --- | | 23 | Processing phase | | 305 | Transmission phase | Defaults to 305 for statuses 200, 201, 202, 203, 213, and 501; otherwise defaults to 23. Example: "23". Values: 23, 305 |
senderRole | string (enum) | Yes | Role of the CDAR sender. CDAR party role code (UNCL 3035). | Value | Meaning | | --- | --- | | BY | Buyer | | AB | Buyer's agent or representative | | DL | Factor | | SE | Seller | | SR | Seller's agent | | WK | Platform or dematerialisation operator | | DFH | French public invoicing portal (PPF) | | PE | Payee | | PR | Payer | | II | Invoicer (invoice issuer) | | IV | Invoicee (party invoiced) |. Example: "WK". Values: BY, AB, DL, SE, SR, WK, DFH, PE, PR, II, IV |
issuerRole | string (enum) | Yes | Role of the party that creates and issues the invoice lifecycle status. This is independent from the CDAR sender role. CDAR party role code (UNCL 3035). | Value | Meaning | | --- | --- | | BY | Buyer | | AB | Buyer's agent or representative | | DL | Factor | | SE | Seller | | SR | Seller's agent | | WK | Platform or dematerialisation operator | | DFH | French public invoicing portal (PPF) | | PE | Payee | | PR | Payer | | II | Invoicer (invoice issuer) | | IV | Invoicee (party invoiced) |. Example: "BY". Values: BY, AB, DL, SE, SR, WK, DFH, PE, PR, II, IV |
issuerLegalId | string | No | Legal identifier of the party setting the status. Required when phase is 23; must be omitted when phase is 305 unless recipientRole is DFH. Example: "200000008" |
issuerLegalIdScheme | string | No | ISO 6523 ICD scheme of the party-setting-status legal identifier. Required together with issuerLegalId. Example: "0002" |
recipientRole | string (enum) | Yes | Role of the CDAR recipient. CDAR party role code (UNCL 3035). | Value | Meaning | | --- | --- | | BY | Buyer | | AB | Buyer's agent or representative | | DL | Factor | | SE | Seller | | SR | Seller's agent | | WK | Platform or dematerialisation operator | | DFH | French public invoicing portal (PPF) | | PE | Payee | | PR | Payer | | II | Invoicer (invoice issuer) | | IV | Invoicee (party invoiced) |. Example: "SE". Values: BY, AB, DL, SE, SR, WK, DFH, PE, PR, II, IV |
recipientLegalId | string | No | Legal identifier of the CDAR recipient. Example: "200000008" |
recipientLegalIdScheme | string | No | ISO 6523 ICD scheme of the CDAR recipient legal identifier. Required together with recipientLegalId. Example: "0002" |
statusCode | string (enum) | Yes | French invoice lifecycle status. | Value | Meaning | | --- | --- | | 200 | Submitted | | 201 | Issued | | 202 | Received | | 203 | Made available | | 204 | Taken in charge (processing started) | | 205 | Approved | | 206 | Partially approved | | 207 | In dispute | | 208 | Suspended | | 209 | Completed | | 210 | Refused | | 211 | Payment sent | | 212 | Collected (cashed) | | 213 | Rejected | | 214 | Validated or pre-validated ("Visée") | | 501 | Inadmissible file |. Example: "200". Values: 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 501 |
statusDate | string (date-time) | No | Date and time at which the status was set. If not provided, the issue date and time of the CDAR is used. Example: "2024-03-20T14:05:09". Format: date-time |
invoiceId | string | Yes | Number of the invoice this status relates to. For status 501, this is the filename of the inadmissible file |
invoiceTypeCode | string (enum) | No | Type of the referenced invoice. Type of the referenced invoice (UNTDID 1001, restricted to the values allowed by BR-FR-04). | Value | Meaning | | --- | --- | | 380 | Commercial invoice | | 389 | Self-billed invoice | | 393 | Factored invoice | | 501 | Self-billed factored invoice | | 386 | Advance payment invoice | | 500 | Self-billed advance payment invoice | | 384 | Corrective invoice | | 471 | Self-billed corrective invoice | | 472 | Factored corrective invoice | | 473 | Self-billed factored corrective invoice | | 261 | Self-billed credit note | | 262 | Global rebate credit note | | 381 | Credit note | | 396 | Factored credit note | | 502 | Self-billed factored credit note | | 503 | Credit note for an advance payment invoice |. Example: "380". Values: 380, 389, 393, 501, 386, 500, 384, 471, 472, 473, 261, 262, 381, 396, 502, 503 |
invoiceIssueDate | string (date) | No | Issue date of the referenced invoice. Required unless statusCode is 501. Example: "2024-03-15". Format: date |
sellerLegalId | string | No | Legal identifier (e.g. SIREN) of the invoice seller. Required unless statusCode is 501. Example: "123456789" |
sellerLegalIdScheme | string | No | ISO 6523 ICD scheme of the referenced invoice seller legal identifier. Required together with sellerLegalId. Example: "0002" |
reasonCode | string (enum) | No | Coded reason for the invoice lifecycle status. | Value | Meaning | | --- | --- | | JUSTIF_ABS | Supporting document missing or insufficient | | ROUTAGE_ERR | Routing error | | AUTRE | Other reason; provide an explanation in reasonNote | | COORD_BANC_ERR | Incorrect bank details | | TX_TVA_ERR | Incorrect VAT rate | | MONTANTTOTAL_ERR | Incorrect invoice total | | CALCUL_ERR | Invoice calculation error | | NON_CONFORME | Missing legal information | | DOUBLON | Duplicate invoice | | DEST_INC | Unknown recipient | | DEST_ERR | Incorrect recipient | | TRANSAC_INC | Unknown transaction | | EMMET_INC | Unknown issuer | | CONTRAT_TERM | Contract ended | | DOUBLE_FACT | Supply or service already invoiced on another invoice | | CMD_ERR | Incorrect or missing order number | | ADR_ERR | Incorrect electronic invoicing address | | SIRET_ERR | Incorrect or missing SIRET | | CODE_ROUTAGE_ERR | Incorrect or missing routing code | | REF_CT_ABSENT | Required contractual reference missing | | REF_ERR | Incorrect reference | | PU_ERR | Incorrect unit price | | REM_ERR | Incorrect discount | | QTE_ERR | Incorrect invoiced quantity | | ART_ERR | Incorrect invoiced item | | MODPAI_ERR | Incorrect payment terms | | QUALITE_ERR | Incorrect quality of delivered item | | LIVR_INCOMP | Incomplete or non-compliant delivery | | REJ_SEMAN | Rejected because of a semantic error | | REJ_UNI | Rejected by uniqueness control | | REJ_COH | Rejected by data-consistency control | | REJ_ADR | Rejected by addressing control | | REJ_CONT_B2G | Rejected by B2G business controls | | REJ_REF_PJ | Rejected because of an attachment-reference error | | REJ_ASS_PJ | Rejected because of an attachment-association error | | NON_TRANSMISE | Submitted but not transmitted because the recipient has no receiving platform |. Values: JUSTIF_ABS, ROUTAGE_ERR, AUTRE, COORD_BANC_ERR, TX_TVA_ERR, MONTANTTOTAL_ERR, CALCUL_ERR, NON_CONFORME, DOUBLON, DEST_INC, DEST_ERR, TRANSAC_INC, EMMET_INC, CONTRAT_TERM, DOUBLE_FACT, CMD_ERR, ADR_ERR, SIRET_ERR, CODE_ROUTAGE_ERR, REF_CT_ABSENT, REF_ERR, PU_ERR, REM_ERR, QTE_ERR, ART_ERR, MODPAI_ERR, QUALITE_ERR, LIVR_INCOMP, REJ_SEMAN, REJ_UNI, REJ_COH, REJ_ADR, REJ_CONT_B2G, REJ_REF_PJ, REJ_ASS_PJ, NON_TRANSMISE |
reason | string | No | Optional free-text status reason. This is distinct from the IncludedNote explanation required for reasonCode AUTRE |
reasonNote | string | No | Free-text comment in the status detail IncludedNote. Required when reasonCode is AUTRE. Example: "The invoice needs manual review." |
collectedAmounts | object[] | No | Collected amounts with VAT rates (TypeCode MEN). Required for status 212; at least one entry |
collectedAmounts properties
| Name | Type | Required | Description |
|---|---|---|---|
amount | string | Yes | Net collected amount (positive) or disbursed amount (negative), for status 212. Example: "12000.00" |
currency | string (enum) | Yes | ISO 4217 currency code of the collected amount. Example: "EUR". Values: XUA, AFN, DZD, ARS, AMD, AWG, AUD, AZN, BSD, BHD, THB, PAB, BBD, BYN, BZD, BMD, VES, VED, BOB, XBA, XBB, XBD, XBC, BRL, BND, BGN, BIF, CVE, CAD, KYD, XOF, XAF, XPF, CLP, XTS, COP, KMF, CDF, BAM, NIO, CRC, CUP, CZK, GMD, DKK, MKD, DJF, STN, DOP, VND, XCD, EGP, SVC, ETB, EUR, FKP, FJD, HUF, GHS, GIP, XAU, HTG, PYG, GNF, GYD, HKD, UAH, ISK, INR, IRR, IQD, JMD, JOD, KES, PGK, KWD, AOA, MMK, LAK, GEL, LBP, ALL, HNL, LRD, LYD, SZL, LSL, MGA, MWK, MYR, MUR, MXN, MXV, MDL, MAD, MZN, BOV, NGN, ERN, NAD, NPR, ANG, ILS, TWD, NZD, BTN, KPW, NOK, MRU, TOP, PKR, XPD, MOP, UYU, PHP, XPT, GBP, BWP, QAR, GTQ, ZAR, OMR, KHR, RON, MVR, IDR, RUB, RWF, SHP, SAR, XDR, RSD, SCR, SLE, XAG, SGD, PEN, SBD, KGS, SOS, TJS, SSP, LKR, XSU, SDG, SRD, SEK, CHF, SYP, BDT, WST, TZS, KZT, XXX, TTD, MNT, TND, TRY, TMT, AED, UGX, CLF, COU, UYW, UYI, USD, USN, UZS, VUV, CHE, CHW, KRW, YER, JPY, CNY, ZMW, ZWG, PLN |
vatPercent | string | Yes | VAT rate applicable to the collected amount. Example: "20.00" |