3.1 Invoice element

The <Invoice> element contains information about one single invoice. Each <Invoice> consists of:

  • 1 <Header> element

  • 1 <Sender> element

  • 1 <Receiver> element

  • 1 <Customers> element containing  1 or more <Customer> elements

  • 1 <Totals> element consisting of sub elements depending on in which xml it is stored.

3.1.1 Header element

The <Header> element contains basic information about the <Invoice>. It has the following child-elements:

<InvoiceID> The identifying number of the invoice
<Date> Invoice date
<ExpirationDate> Due date of the invoice
<Currency> Currency
<TermsOfPaymentDays> Terms of payment days agreed upon

<Type> Invoice or credit
<TypeIdentifier> Code corresponding to the type
<LanguageCode> Language code used by Copaco to create the printed version of the invoice
<Language> The language used by Copaco to create the printed version of the invoice

3.1.2 Sender element

This <Sender> element has information about the Sender. It has the following child-elements:

<AccountID>                                  Sender Account ID as shown in the 2tCloud Portal

<CompanyName>                       Name of the Sender

<Address>                                      Street the Sender is registered at the chamber of commerce

<PostalCode>                                Postal code of the Sender

<City>                                             City the Sender is registered in Chamber of Commerce

<CountryCode>                            Specific code for the country of the Sender

<Country>                                      Country the Sender is  registered at the chamber of commerce

<Telephone>                                 Sender contact telephone number

<ChamberOfCommerce>          Number of the Sender as registered in Chamber of Commerce

<BankAccount>                             Number of Sender’s Bank account

<IBAN>                                          IBAN Number of the Sender    

<BIC>                                             Bank Identifier Code of the Sender’s bank account

<VATNumber>                              VAT number of the Sender

<Website>                                      Sender’s website

<Logo>                                          url to place the company logo on the print version of the invoice 

3.1.3 Receiver element

The  <Receiver> element in an Invoice contains info about the receiving Partner and has the following child-elements:

<AccountID>                               Receiver Account ID corresponding to that in the 2tCloud Portal

<CustomerNumber>                  Corresponds with the Copaco customer account number

<CompanyName>                       Name of the Partner

<VATNumber>                             VAT number of the Partner

<ContactFirstName>                   Billing contact first name

<ContactMiddleName>              Billing contact middle name

<ContactLastName>                   Billing contact last name

<Address>                                   Street the partner is registered at the chamber of commerce

<Zip>                                           Zip code the partner is registered at the chamber of commerce

<City>                                          City the partner is registered at the chamber of commerce

<CountryCode>                           Specific code for the country of the Receiver

<Country>                                   Corresponding country the partner registered at the chamber of

commerce

<Telephone>                               Billing contact telephone number

<Email>                                       Email Address the invoice is send to

<Type>                                      Relates to the Account and specifies whether it is a Reseller (Type=2) or a EndCustomer (Type=3).

3.2 Customer element

Image 8.

An <Invoice> normally has a <Customers> child element. This contains 1 or more <Customer> elements. The child elements of <Customer> are:

<AccountID>                               Corresponding to the ID in the 2tCloud Portal

<CustomerNumber>                  Can be used by the Partner for reference to own ERP system. This number is set in the Control Panel at the additional information tab in the billing section

<CostCenter>

<CompanyName>                      Name of the Customer

<Subscriptions>                          Element that consists of 1 or more < Subscription> elements

3.3 Subscription element

The <Subscription> contains basic information about a customer’s subscription as well as several <LineItem> elements with detailed info.

 <SubscriptionID>                       Corresponds to the subscription in the Platform

<SubscriptionName>                  Name of the subscription

<BillingModel>                           An integer number

<PlanName>                               Contains a list of names given to the service plan in different languages.

<PlanCategoryName>                Internal identifier for the product category for the service plan

<StartDate>                                 Initial start date of the subscription

<SubscriptionPONumber>        PO Number of the Subscription (can be filled in by the Reseller)

<LineItems>                                Element containing a collection of 1 or more <LineItem> elements

3.4 LineItem element

A <LineItem> contains detailed information about it’s parent, in this case about a Subscription. Below are the child elements of <LineItem> further explained:

<LineId>                                    Identification number as stored in the 2tCloud portal

<UID>                                        The first UID is corresponding to the identifying number configured in

the plan starting with a P form ‘plan’. The second and every UID after

until the next subscription starts with a R from ‘resource’. A resource is

an addition to the initial subscription

<Description>                           First line item contains the subscription # and description. Successive line

items contain the resource name of the line item belonging to the

subscription

<Quantity>                                First quantity contains the amount of in the subscription included

resources. Successive line items contain number of resources of the line

item belonging to the subscription

<QuantityType>                        Specifies the type of the Quantity (e.g. item,

<UnitPrice>                               Price of the line item the Customer can order the item for

<Discount>                               The total discount of all included resources

<ExtendedPrice>                       The amount to be paid for the line item

<VAT>                                        Amount of VAT applicable for the line item

<TaxZoneID>                             Corresponds to the ID configured in the Platform at subscription level

<TaxPercentage>                       Percentage applicable to the line item

<StartDate>                               Start date of the subscription period

<EndDate>                                End date of the subscription period

<Duration>                                Duration of one subscription period

<DurationType>                        Duration type e.g. Month(s), Year

<SKU>                                       By the Partner configured SKU number

<ConsumerCompanyName>   Name of the Customer

<SubPONumber/>                    PO Number at LineItem level (currently same as on subscription level)

 <RatePeriodId>                        Internal Identifier of the resource rate period in the platform, unique per

reseller (in v4)

3.5 Totals element

An <Invoice> normally ends with a <Totals> element where the accumulated price data of all the prior elements is stored. As result it displays information about the total amount the Partner has to pay over all <Customers>. The <Totals> generally consists of:

<TotalExcludingVAT>                Total amount in Euro excluding VAT

<TotalVAT>                                Total VAT in Euro, exclusive of telecommunication services

<TotalIncludingVAT>                 Total amount in Euro including VAT

As can be seen in Image 4 the <Totals> is divided into a <TotalPurchases> and <TotalSales> element, each containing the same child elements as described above.

3.6 SubscriptionDetails element

The root element <SubscriptionDetails> in the xml file with the same name (see Image 7) is substituted of:

  • 1 <Subscription> element

  • 1 <ServicePlan> element

  • 1 <ServicePlanPeriod> element

  • 1 <Resources> element containing 1 or more <Resource> elements

3.6.1 Subscription element

Although it has the same name as the one described in $3.3 this <Subscription> element has different child elements:

<SubscriptionID>                      Corresponds to the subscription in the Platform

<StartDate>                               Initial start date of the subscription

<ExpirationDate>                      Date the subscription expires

<Period>                                    Amount of timespan(s) defined by PeriodType

<PeriodType>                            Type of timespan: Day, Month or Year

<BillingPeriod>                          Amount of timespan(s) defined by BillingPeriodType for which the                                                    customer will be billed

<BillingPeriodType>                  Type of (Billing) timespan: Day, Month or Year

3.6.2 ServicePlan element

The <ServicePlan> gives more information about the service plan used for the Subscription.

<PlanId>                                    Identification number of the Plan as stored in 2tCloud portal

<PlanName>                             This element contains collections of <Language> items

<Language>                              Contains combinations of <Value> and <Name> children

<Value>                             Identifier for the language code: en, fr and nl

       <Name>                                        Actual name of the plan for specified language(code)

<PlanCategoryId>                     Id of the Plan Category (Parent) the Plan is a subset of

<PlanCategoryName>              Name of the Plan Category (Parent) of which the Plan is a subset

3.6.3 ServicePlanPeriod element

<PlanPeriodId>                              Internal Identifier of the Service, unique for each reseller

<PlanPeriodSetupSKUName>              The name of the SKU that a reseller has assigned to the plan

period Setup SKU

<PlanPeriodSubscriptionSKUName>    This is the name of the SKU that a reseller has assigned to the

plan period Recurring SKU

<PlanPeriodRenewalsSKUName>         The name of the SKU that a reseller has assigned to the plan

period Renewal SKU

<PlanPeriodTransferSKUName>           This is a name for the SKU that a reseller has assigned to the plan

period Transfer SKU

<PlanPeriodCancellationSKUName>    Name of the SKU that a reseller has assigned to the plan period

Cancelation SKU

3.6.4 Resource element

The <Resource> has the following child elements:

<ResourceRate>                           See $3.6.5

<ResourceId>                               Internal global Identifier of the resource in the platform, same for ALL

accounts

<ResourceName>                        Contains combinations of <Value> and <Name> children

       <Value>                                         Identifier for the language code: en, fr and nl

       <Name>                                        The given name that is specific to the language, like “Microsoft

   365 Business Premium”

<IncludedValue>                          The amount of this resource that is included in the base service plan

period price/SKU, like 1

<Amount>                                    The amount of this resource that is additionally purchased in your

subscription.

<Manufacturer>                           Contains the vendor identifier number that provides this resource

<ManufacturerName>                Contains the vendor name that provides this resource

<MPNumber>                              Contains the resource external ID that is used by the vendor

<MeasureUnit>                            This element contains a list of names given to the Unit of Measure in

different languages for this resource

<Value>                                   Identifier of the language, like en, nl or fr

<Name>                                  The given name that is specific to the language, like License

or Unit

3.6.5 ResourceRate element

This element consists of:

<PlanRateId>                                          Internal Identifier of the ResourceRate in the platform, is unique

for each reseller

<PlanRateSetupSKUName>                   The name of the SKU a reseller has assigned to the resource

rate Setup SKU

<PlanRateRecurringSKUName>             Name of the SKU that a reseller has assigned to the resource rate

Recurring SKU           

<PlanRateOveruseSKUName>               SKU’s Name which a reseller has assigned to the resource rate

Overusage SKU                

<PlanRateCancellationSKUName>        The name of the SKU that a reseller has assigned to the resource

rate Cancelation SKU

3.6.6 ResourceRatePeriod element

 <RatePeriodId>                                                  Internal Identifier of the resource rate period in the

    platform, unique per reseller

<PlanRatePeriodRecurringSKUName>               The name of the SKU that a reseller has assigned to the

resource rate period Recurring SKU

<PlanRatePeriodOveruseSKUName>                  Name of the SKU that a reseller has assigned to the

resource rate period Overusage SKU

<PlanRatePeriodCancellationSKUName>          The name of the SKU that a reseller has assigned to the

resource rate period Cancelation SKU