France
Credit Note
Changes to generic fields
type CreditNote {
// ...all generic credit note fields
dueDate: string;
salesOrderRef?: string;
purchaseOrderRef?: string;
lines: [
{
// ...other line item fields
unit: UnitsOfMeasure;
vat:{
code: VatCodeUNTDID;
exemptReason?: string;
}
}
];
sender?: {
// ...other sender fields
taxRepresentative?:{
name:string;
taxId: string;
address: {
country: string;
}
}
};
recipient:{
peppolId: {
endpointId: string;
};
taxRepresentative?:{
name:string;
taxId: string;
address: {
country: string;
}
}
};
shipToParty?:{
name: string;
taxId: string;
address:{
line1: string;
line2: string;
city: string;
state: string;
country: string;
postalCode: string;
}
};
paymentMeans?: [{
ref: string;
code: string;
account: {
iban?: string;
number?: string;
name: string;
branch: string;
};
card: {
pan: string;
network: string;
holderName: string;
};
other: {};
}];
}
Field information
| Name | Type | Required | Description |
|---|---|---|---|
dueDate | string (ISO 8601 date) | Yes | Due date of credit note |
lines[].unit | string | Yes | A value from an enumerated list as outlined on Units of Measure |
lines[].vat.code | string | Yes | A value from an enumerated list as outlined on VAT code classification (UNTDID 5305) |
lines[].vat.exemptReason | string | Conditional | If the line VAT amount is 0, an exemption reason is required. |
recipient.address.line1 | string | Yes | Address line 1 (Street address/PO Box/Company name). |
recipient.address.line2 | string | Yes | Address line 2 (Apartment/Suite/Unit/Building). |
recipient.address.city | string | Yes | City/District/Suburb/Town/Village. |
recipient.address.state | string | Yes | State/County/Province/Region. |
recipient.address.country | string | Yes | Three-letter country code (ISO 3166-1 alpha-3) |
recipient.address.postalCode | string | Yes | ZIP or postal code |
recipient.peppolId.endpointId | string | Yes | Peppol ID of the recipient |
recipient.taxRepresentative | Object | No | For instances where a third-party tax representative is used. |
recipient.taxRepresentative.name | string | Yes | Name of Tax Representative |
recipient.taxRepresentative.taxId | string | Yes | Tax ID of Tax Representative |
recipient.taxRepresentative.address.country | string | Yes | Country of Tax Representative |
salesOrderRef | string | No | Sales order reference. An identifier of a referenced sales order, issued by the Seller. |
purchaseOrderRef | string | No | Purchase order reference. An identifier of a referenced purchase order, issued by the Buyer. |
shipToParty | Object | No | For instances where the ship-to party details differ and need to be explicitly stated. |
shipToParty.name | string | No | The name of the party to which the goods and services are delivered. |
shipToParty.taxId | string | No | TIN of the shipping recipient assigned by IRBM |
shipToParty.address.line1 | string | No | Deliver to address line 1. The main address line in an address. |
shipToParty.address.line2 | string | No | Deliver to address line 2. An additional address line in an address that can be used to give further details supplementing the main line. |
shipToParty.address.city | string | No | Deliver to city. The common name of the city, town or village, where the deliver to address is located. |
shipToParty.address.state | string | No | Deliver to country subdivision. The subdivision of a country. |
shipToParty.address.country | string | No | Deliver to country code. A code that identifies the country. |
shipToParty.address.postalCode | string | No | Deliver to post code. The identifier for an addressable group of properties according to the relevant postal service. |
paymentMeans | Object Array | No | For instances where the payment means need to be explicitly stated. |
paymentMeans.ref | string | No | Remittance information A textual value used to establish a link between the payment and the Invoice, issued by the Seller. Used for creditor's critical reconciliation information. This information element helps the Seller to assign an incoming payment to the relevant payment process. |
paymentMeans.code | string | No | Payment means type code The means, expressed as code, for how a payment is expected to be or has been settled. |
notes | string | No | Any applicable or additional note |
Lifecycle Status
type LifeCycleStatus {
status: string;
issued?: string;
amount?: number;
rejectReason?: string;
rejectCode?: string;
customInfo?:{
fra?:{
notes?: string
}
}
}
Field information
| Name | Type | Required | Description |
|---|---|---|---|
status | string | Yes | Valid values: paid, rejected |
issued | string | string (ISO 8601 date) | Date of payment. |
amount | number | Optional | Amount that has been paid. Mandatory when status = paid |
rejectReason | string | Conditional | Textual field for reason of rejection. |
rejectCode | string | Conditional | A value from an enumerated list Refusal Reason Codes |
customInfo.fra.notes | string | Optional | Any additional comments |