Bill

FarPay Bill format

The bill format is a reduced format to express an instruction of a payment. The minimum expression holds clear and unambiguous information relating to invoice details, customer information, and payment instructions.

Bill Structure Dictionary

Root Elements

NameDescriptionTypeRequiredNotes
FarPayXmlRoot element containing the entire bill structureComplex TypeYesContainer for delivery info and bills
DeliveryDelivery metadataComplex TypeNoOptional delivery information
BillsContainer for one or more billsComplex TypeYesContain at least one Bill element

Delivery Section

NameDescriptionTypeRequiredExample
CountNumber of bills in the deliveryunsignedLongYes1

Bill Section - Invoice Information

NameDescriptionTypeRequiredExample
InvoiceTypeCodeType of invoiceEnumerationYesPIE, PCM
InvoiceNumberUnique invoice identifierstringYesINV-2023-001
EncodedDocumentBase64 encoded invoice documentstringYesJVBERi0xLjQKMSA...
PaymentDueDateFuture payment due datedateYes2023-12-31
CurrencyCurrency codestringYesDKK
ToBePayedAmountAmount to be paiddecimalYes125.75
TextLinesAdditional invoice text/descriptionstringYesMonthly subscription fee

Bill Section > Customer Information

NameDescriptionTypeRequiredExample
CustomerNumberCustomer numberstringYesABCDE0123456789
NameCustomer namestringYesJohn Doe
StreetStreet addressstringYesMain Street
HouseNumberHouse/building numberstringYes123A
PostalZonePostal/ZIP codeunsignedShortYes1234
CityNameCity namestringYesCopenhagen
CountryCountry namestringYesDenmark
EmailAddressCustomer email addressstringYes[email protected]
SmsPhoneNumberSMS phone numberstringYes+4512345678

Bill Section > Payment Means

NameDescriptionTypeRequiredExample
PaymentMeansContainer for payment informationComplex TypeYesContains payment channel details
PaymentChannelCodePayment channel typeEnumerationYesIBAN, DK:BANK, DK:FIK, OVERFØRSELSSERVICE, KONTOOVERFØRSEL
TypeCodeIDType code for FI payment slipsstringYes71, 93
PaymentIDFirst part of FI payment slipstringYes123456789
JointPaymentIDSecond part of FI payment slipstringYes987654321
ExtensibleContentExtended content for additional dataComplex TypeNoCustom extensions

Invoice Type Codes

CodeDescription
PIEPayment Instruction for Electronic invoice
PCMPayment Correction Memo

Payment Channel Codes

CodeDescription
IBANInternational Bank Account Number
DK:BANKDanish bank transfer
DK:FIKDanish FIK payment system
OVERFØRSELSSERVICETransfer service
KONTOOVERFØRSELAccount transfer

Data Type Specifications

  • string: Text data with no specified maximum length
  • decimal: Decimal number with up to 2 decimal places for amounts
  • date: Date in ISO 8601 format (YYYY-MM-DD)
  • unsignedLong: Positive integer (0 or greater)
  • unsignedShort: Positive integer (0-65535)

Usage Notes

  • All bills must be contained within the Bills element
  • Multiple Bill elements are allowed within a single Bills container
  • The EncodedDocument field should contain the base64-encoded PDF or other document format
  • Payment means are required and must specify a valid payment channel
  • Customer information is mandatory for all bills
  • The ExtensibleContent element allows for custom extensions to the format