0% found this document useful (0 votes)
60 views

Invoice+Presentation+Guidelines+v1 1 1

The document provides guidelines for presenting invoices consistently including column names and character limits, field mapping to payment API parameters, rules for invoice presentment, and sample invoice layouts. It aims to ensure customers have a consistent experience viewing invoices.

Uploaded by

Eslam A. Ali
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
60 views

Invoice+Presentation+Guidelines+v1 1 1

The document provides guidelines for presenting invoices consistently including column names and character limits, field mapping to payment API parameters, rules for invoice presentment, and sample invoice layouts. It aims to ensure customers have a consistent experience viewing invoices.

Uploaded by

Eslam A. Ali
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 14

Invoice Presentation Guidelines

Developer Documentation (v1.1)


Invoice Presentation Guidelines

Document / Revision History


Rev # Date Description Author
V1.0 Oct 5, 2010 Original Document Chris Glynne
V1.1 Oct 14, 2010 Added field mapping section. Updated column format and character limits Chris Glynne
V1.1.1 Oct 23, 2010 Modified formatting, Updated logo Chris Glynne

TM Trademarks  of  Rogers  Communication  Inc.  used  under  license.  

©  2010  Rogers  Communications  Inc..

v1.1 Page 2 of 14
Invoice Presentation Guidelines

v1.1 Page 3 of 14
Invoice Presentation Guidelines

Table of Contents
Document / Revision History ......................................................................................................2  
1.   Overview ............................................................................................................................5  
2.   Column Names, Values and Character Limits ...............................................................5  
Column Headers and Content Descriptions as they appear on the Invoice ...............................6  
3.   Field Mapping to Payment API ........................................................................................7  
4.   Rules for Invoice Presentment ........................................................................................8  
5.   Sample Invoice Layout Presentment ..............................................................................9  
Account Summary Page.............................................................................................................9  
Account Detail Page (new section) .........................................................................................10  
6.   Examples of Incorrect Application of Invoice Rules ...................................................10  
7.   Appendix..........................................................................................................................11  
System Supported Alpha-Numeric Characters and Symbols for the Invoice ...........................11  
Approved Captions and Abbreviations - English and French...................................................12  
8.   References.......................................................................................................................14  

v1.1 Page 4 of 14
Invoice Presentation Guidelines

1. Overview
This Invoice Presentation guide has been created to ensure there is a consistent end user experience for
customers when they are reviewing their invoice.

By following this guide you will ensure that your invoice descriptions are consistent with Rogers standards. This
will ensure descriptions and details are presented correctly on the invoice with the correct information to
minimize potential for customer confusion. These standards are designed to maintain consistency across
services that are using the Rogers Catalyst Payment API

The Payments interface allows a Web application to process payments, grant refunds and manage
subscriptions. You can find some examples of why you may want to do this in the use cases at
http://www.rogerscatalyst.com.

When using this document you will also need to refer to Common Information Guide and the Payment SOAP
API documentation.

2. Column Names, Values and Character Limits


No Column Column Format & Character Wrap Field Example
Limits Y/N
1 Date* Mon DD N Transaction Date Aug 13
Channel Seizure Date

2 Manufacturer Maximum 16 Alpha Numeric N Manufacturing Partner Name Nokia


Name Characters

3* Content Maximum 15 Alpha Numeric N Content Provider Name Mobile Radio


Provider Characters

4* Code/Service Maximum 49 Alpha Numeric Y Service Provider Name & Virgin Radio
Description Characters Description
th
– will wrap after the 35 character
Use // (2 forward slashes) to force
a line break or wrapping could
occur mid word. If a line break is
forced, the second line only has 35
characters remaining.

5* For Billing Maximum 80 Alpha Numeric Y Billing Support Info 1-XXX-XXX-XXXX


Questions Characters www.virginmobile.com/support
Contact th
– will wrap after the 40 character [email protected]
Use // (2 forward slashes) to force
a line break or wrapping could
occur mid word. If a line break is
forced, the second line only has 40
characters remaining.

6* For Maximum 80 Characters – will wrap Y Application Support Info 1-XXX-XXX-XXXX


Application th
after the 40 character www.virginmobile.com/support
Support Same wrapping rules as above [email protected]
Contact apply

v1.1 Page 5 of 14
Invoice Presentation Guidelines

7* Qty Maximum Value: 9999 N The summed up quantity of each 1


or
purchase. If there is a
return/credit, a minus sign -1
displays in front of the quantity.

8* Cost Per Unit Maximum Value: (-)9999.99 N The cost/charge per unit of each 5.95
($) individual transaction

9 Charges ($) Maximum Value: (-)9999.99 N The summed up cost/charge of 5.95


each purchase. If there is a or
return/credit, a minus sign -5.95
displays in front of the charge
amount.

*Data in rows 3,4,5,6,7 and 8 are provided by the third party in each API call.

See the table in section 3 for appropriate Field Mappings to the API parameters and additional formatting rules.

Column Headers and Content Descriptions as they appear on the Invoice


The following diagram illustrates how the fields above map to Invoice presentation.

1 2 3 4 5 6 7 8 9

v1.1 Page 6 of 14
Invoice Presentation Guidelines

3. Field Mapping to Payment API


Please see the table below for a clear definition of the data and the format that you are expected to provide in
billing API calls.

Please use this information in conjunction with the Payment SOAP API guide when constructing your API calls.

No Column API parameter name Description Example


1 Date* (provided by system) n/a n/a
2 Manufacturer Developer Name System automatically assigns this value n/a
Name based on Developer name created in
Rogers Catalyst
3 Content Provider onBehalfOf (xsd:string) English and French Name of company that “Mobile Radio~Radio Mobile”
is the provider of the sale item. (see
formatting rules in Payment API guide. Total length must not exceed 32
“en~fr”) characters with no more than 16
characters allocated to either name.
4 Code/Service Ns1:LineItem.description English and French description of the sale “Virgin Mobile Radio
Description (xsd:string) item. (see additional formatting rules in Service~Service Mobile Virgin
Payment API guide. “en~fr”) Radio”
5 For Billing Ns1:CallContext.TagValuePair Billing support contact information (see “1-555-555-1212”
Questions Contact (billingInfo) additional formatting rules in Payment API “www.virginradio.com/billing”
guide)
6 For Application Ns1:CallContext.TagValuePair Application support contact information “1-555-555-1212”
Support Contact (applicationInfo) (see additional formatting rules in Payment “www.virginradio.com/techsupport”
API guide)
7 Qty Ns1:LineItem.quantity Always ‘1’ “1”
8 Cost Per Unit ($) Ns1:LineItem.grossCost Base Price of sale item before tax “CAD2.00”
Translates to $2.00 Canadian
9 Charges ($) Value is calculated by the back n/a n/a
end system during invoice
generation.

v1.1 Page 7 of 14
Invoice Presentation Guidelines

4. Rules for Invoice Presentment


# PORTAL RULES FOR INVOICE PRESENTMENT EXAMPLE
1 Always include the leading “www.” in all urls
www.rogers.com instead of rogers.com

2 Always start the contact phone numbers with a 1 and always use 1-800-123-4567
hyphens in the contact phone numbers. 1-905-123-4567
For International calls from Canada: 1-416-123-4567
011 - (COUNTRY CODE) - AREA/CITY CODE - LOCAL
NUMBER. 011-XXX-XXX-XXXXX (Use hyphen between each code
For example, to call England, you must dial 011 + 44 (country required)
code) + AREA/CITY code + local number
Do not list phone number as 18001253456 without hyphens

3 If desired, use 2 forward slashes "//" to force a line break onto a www.greatestmusicstore.com/applicationsupport and/or call 1-
second line. XXX-XXX-XXXX formatted as:
If the 2 forward slashes are not used, the line break will
automatically occur after 35 or 40 characters (depending on www.greatestmusicstore.com/application//support and/or call 1-
column). XXX-XXX-XXXX
Using the 2 forward slashes allows for more control over where
the line break occurs. will display on 2 lines with the second sentence starting after
the 2 forward slashes.

www.greatestmusicstore.com/application
support and/or call 1-XXX-XXX-XXXX

If the 2 forward slashes are not used, the second sentence will
start after the 40th character and display as:

www.theworldsgreatestmusicstore.com/applica
tionsupport and/or call 1-XXX-XXX-XXXX

4 If any of the contact phone numbers are alpha characters (spell For example: 1-888-SAMPLE1 (726-7531)
out a word/phrase), include the numeric values of the word.
Use // formatting to force a line break and move a second
number to the next line
For example: The following contact information
1-888-SAMPLE1 or 1-XXX-XXX-XXXX

can be formatted as:


1-888-SAMPLE1//1-XXX-XXX-XXXX
which will display on 2 lines as:

1-888-SAMPLE1
1-XXX-XXX-XXXX
5 Capitalize the first letter of Code/Service descriptions unless a For example:
caption is marketed with a lower case letter such as iPhone. CBC news channel should be CBC News Channel
Guitar tool kit should be Guitar Tool Kit

6 Avoid leaving any columns blank, but if a column must be left “N/A” not “n/a”
blank please insert N/A in upper case.
7 Avoid using periods when abbreviating words “Info” not “Info.” (note the incorrect use of a period)

8 Always refer to the approved list of captions and abbreviation Refer to approved list of captions in the appendix
when shortening words.

v1.1 Page 8 of 14
Invoice Presentation Guidelines

9 When displaying a "clock/time" format, always refer to Eastern For example: Please call 1-XXX-XXX-XXXX
Standard Time and note it. Use lower case and do not use between 9am to 6:30pm EST (instead of 9:00 A.M. to 8:00
periods. P.M.)
10 Refrain from using additional statements like “for additional www.greatestmusicstore.com/application
information, please call” for every transaction. Only list contact support and/or call 1-XXX-XXX-XXXX
info such as website, phone #, email address.
1-888-XXX-XXXX

[email protected]
11 Use only alpha numeric characters for English and alpha Refer to approved list of characters in the appendix
numeric and French characters for any French captions.

5. Sample Invoice Layout Presentment

Account Summary Page

v1.1 Page 9 of 14
Invoice Presentation Guidelines

Account Detail Page (new section)

6. Examples of Incorrect Application of Invoice Rules

In the examples called out above, proper capitalization was not used for the Code/Service descriptions, no
hyphens were used in the Billing Questions Contact phone number and formatting using the 2 forward slashes
was not used causing the wrapping to occur in the middle of a word. (Examples in previous section illustrate
appropriate formatting).

v1.1 Page 10 of 14
Invoice Presentation Guidelines

7. Appendix

System Supported Alpha-Numeric Characters and Symbols for the Invoice


Char Description Char Description Special Characters
Space Ç
! Exclamation mark ü
" Quotation mark é
# Cross hatch (number sign) â
$ Dollar sign ä
% Percent sign à
& Ampersand å
` Closing single quote (apostrophe) ç
( Opening parentheses ê
) Closing parentheses ë
* Asterisk (star, multiply) è
+ Plus ï
, Comma î
- Hyphen, dash, minus ì
. Period Ä
/ Slant (forward slash, divide) Å
0 Zero É
1 One ø
2 Two Æ
3 Three ô
4 Four ö
5 Five ò
6 Six û
7 Seven ù
8 Eight ÿ
9 Nine Ö
: Colon Ü
; Semicolon ø
< Less than sign £
= Equals sign Ø
> Greater than sign ×
? Question mark ƒ
@ At-sign á
A Uppercase A a Lowercase a í
B Uppercase B b Lowercase b ó
C Uppercase C c Lowercase c ú
D Uppercase D d Lowercase d ñ
E Uppercase E e Lowercase e Ñ
F Uppercase F f Lowercase f ª
G Uppercase G g Lowercase g º
H Uppercase H h Lowercase h ¿
I Uppercase I i Lowercase i ®
J Uppercase J j Lowercase j ¬

v1.1 Page 11 of 14
Invoice Presentation Guidelines

K Uppercase K k Lowercase k ½
L Uppercase L l Lowercase l ¼
M Uppercase M m Lowercase m ¡
N Uppercase N n Lowercase n «
O Uppercase O o Lowercase o »
P Uppercase P p Lowercase p ß
Q Uppercase Q q Lowercase q Ô
R Uppercase R r Lowercase r Ò
S Uppercase S s Lowercase s õ
T Uppercase T t Lowercase t Õ
U Uppercase U u Lowercase u µ
V Uppercase V v Lowercase v þ
W Uppercase W w Lowercase w Þ
X Uppercase X x Lowercase x Ú
Y Uppercase Y y Lowercase y Û
Z Uppercase Z z Lowercase z Ù
[ Opening square bracket { Opening curly brace ý
\ Reverse slant (Backslash) | Vertical line Ý
] Closing square bracket } Closing curly brace ¯
^ Caret (Circumflex) ~ Tilde (approximate) ´
_ Underscore -
` Opening single quote ±
=
¾

§
÷
¸
°
¨
·
¹
³
²

Approved Captions and Abbreviations - English and French


English French
Word or Phrase Abbreviation, Acronym or Rule Mot ou phrase Acronyme
a.m. or p.m. am or pm 24 Heure 24h
Account Acct Compte Cpt
Accounts Accts Comptes Cpts
Activation Act Mise en service Mise en serv
Additional Add Additionnel Add
Administration Admin Administration Admin
Agreement Agmt Entente Ent
Application App Application Appl
April Apr Avril Avr

v1.1 Page 12 of 14
Invoice Presentation Guidelines

August Aug Août Août


Automatic Auto Automatique Auto
Average Avg Moyenne Moy
Bundle Bndl Offre groupée Off gr
Business Biz Entreprise Entr
Business to Business B2B Entreprise à entreprise Entr à entr
Canada or Canadian CDN Canada ou Canadien CND
Charge or Charges Chrg Frais Fr
Commercial Com Commercial Com
Communicate Com Communiquer Comm
Corporate Corp Affaires Aff
Credit Cr Crédit Cr
Customer Cust Client Client
December Dec Décembre Déc
Department Dept Service Serv
Digital Dig Numérique Num
Discount Disc Escompte Esc
Download Dwnld Télécharger Téléch
E-mail Email Courriel Courr
Edition Ed Édition Éd
Employee Purchase Plan EPP Programme d’achat pour employés PAE
Enhanced Enh Rehaussé Rehaus
Entertainment Ent Divertissement Divert
Equipment Equip Équipement Équip
Evening(s) Eve Soir Sr
Exclusive Excl Exclusif Excl
February Feb Février Fév
General Gen Général Gén
Government Govt Gourvernement Gouv
Group Grp Groupe Gr
Hardware Hrdware or Hrdwr Appareil App
Hour or Hours Hr or Hrs Heure H
Important Impt Important Imp
Incoming Inc Entrant Entr
Information Info Information Info
Installation Install Installation Install
Instant Messaging IM Messagerie instantanée Mess inst
International Intl International Internl
Internet Intrnt or Net Internet Internet
January Jan Janvier Janv
July Jul Juillet Juill
June Jun Juin Juin
Local Number Portability LNP Transférabilité des numéros locaux TNL
Long Distance LD Interurbain Interurb
Management Mgmt Gestion Gest
March Mar Mars Mars
May May Mai Mai
Message or Messaging Msg Message ou Messagerie Mess
Messages Msgs Messages Mess
Minute or Minutes Min or Mins Minute ou Minutes Min

v1.1 Page 13 of 14
Invoice Presentation Guidelines

Month or Months Mth or Mths Mois M


Monthly Service Fee MSF or Monthly Fee Frais mensuels Fr mens
Multimedia Messaging MMS Messagerie multimédia MMS
North America NA Amérique du Nord A du N
November Nov Novembre Nov
Number No or # Numéro No ou #
October Oct Octobre Oct
Organization Org Organisation Org
Package Pkg Trousse Tr
Picture or Pictures Pic or Pics Photo Photo
Premium Prem Supérieur Sup
Price Plan Plan Forfait Forf
Program Prgrm Programme Prog
Promotion Promo Promotion Promo
Received Rcvd Reçu Reçu
Roaming Roam Itinérance Itin
Special Spec Spécial Spéc
Subscription Subscrip Abonnement Abonn
Talk Tlk Parler Parler
Technology Tech Technologie Tech
Text Txt Texte Txt
Text Messaging Txt Msg (do not use SMS) Messagerie texte Mess txt
Second or Seconds Sec or Secs Seconde Sec
September Sept Septembre Sept
Service Svc Service Serv
Small and Medium Business SMB Petites et moyennes entreprises PME
United States US États-Unis É-U
Unlimited Unltd Illimité Ill
Weekday Wkday Jour de semaine Jr
Weekend Wknd Week-end W-e
With w/ Avec A/
Worldwide Wrldwd Partout dans le monde Monde
Year or Years Yr Année ou Années Année

8. References
Please see http://www.rogerscatalyst.com for WSDLs, SSL certificate, API documentation and code examples.

TM Trademarks  of  Rogers  Communication  Inc.  used  under  license.  

©  2010  Rogers  Communications  Inc..

v1.1 Page 14 of 14

You might also like