Changes for page Customer - DRAFT API

Last modified by Anders Göthberg on 2026/05/25 10:45
From empty
To version 4.1
edited by Anders Göthberg
on 2026/05/20 10:06
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,0 +1,1 @@
1 +Customer - DRAFT API
Parent
... ... @@ -1,0 +1,1 @@
1 +Main.Invoicing.billing.technical-reference.Billing API.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.XWikiGuest
1 +xwiki:XWiki.AndersGothberg
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Tags
... ... @@ -1,0 +1,1 @@
1 +px-custom-page-content
Content
... ... @@ -1,0 +1,77 @@
1 +(% class="jumbotron" %)
2 +(((
3 +(% class="container" %)
4 +(((
5 +Integrate to **PayEx Billing Usage API **
6 +)))
7 +)))
8 +
9 +(% id="HChangelog" %)
10 += Changelog =
11 +
12 +(% border="1" %)
13 +|=**Version**|=**Date**|=**Description**|=**Created by**
14 +|1.0|2024-06-10|(((
15 +Created document
16 +)))|Anders Göthberg
17 +|1.1|2024-10-04|API in production|Anders Göthberg
18 +
19 +(% id="HRoutesegments" %)
20 += Introduction =
21 +
22 +Link to the general step-by-step implementations guide that guides you through setting up a REST API integration towards PayEx Invoice Service can be found [[here >>doc:Main.Invoicing.invoice-service.invoice-service-apis.WebHome]]
23 +
24 +Billing Usage API presents calls to customers' billed and unbilled usage calls. This can be used for presentation on the company's various applications such as "my pages" or customer service users in the company's own CRM.
25 +
26 +== Usage API ==
27 +
28 +[[image:1766408706217-976.png||height="819" width="841"]]
29 +
30 +
31 +(% id="HRoutedescription" %)
32 +=== Route description ===
33 +
34 +Each resource in the API corresponds to its own route. All routes are structured according to a specific standard, explained below
35 +
36 +The below route is an example of a route towards resource3Id, to operate on this resource you must also include the ids of its parent resources in the route.
37 +//lf-api.payex.com/billing/**{subdomain}**/v1/**{ownerNo}**/resource1/**{resource1Id}**/resource2/**{resource2Id}**/resource3/**{resource3Id}**//
38 +
39 +(% border="1" %)
40 +|=Route segment|=Description
41 +|subdomain|In this part of the API it will be "billing"
42 +|ownerNo|The ledger identifier/number at PayEx
43 +|resource1Id|Identifier of resource1 (invoices or customers)
44 +|resource2Id|identifier of resource2, subresource to resource1 (subscriptions)
45 +|resource3Id|identifier of resource3, subresource to resource2
46 +
47 +(% border="1" %)
48 +Routes that occurs in examples of this documentation will use the following identifiers
49 +
50 +(% border="1" %)
51 +|=(% style="width: 330px;" %)Resource|=(% style="width: 1517px;" %)Identifier
52 +|(% style="width:330px" %)ownerNo|(% style="width:1517px" %)The ledger identifier/number at PayEx
53 +|(% style="width:330px" %)invoiceNo|(% style="width:1517px" %)Invoice number
54 +|(% style="width:330px" %)customerNo|(% style="width:1517px" %)(((
55 +Customer number
56 +)))
57 +|(% style="width:330px" %)subscriptionNo|(% style="width:1517px" %)Subscription number (mobile or fixed telephone number or other identifier)
58 +
59 +
60 +
61 +=== Problem types ===
62 +
63 +(% class="box infomessage" %)
64 +(((
65 +Note, each problem typecode is preceded by** "billing/usage/service"** in this API, e.g. the error "validation" in the table below will appear as typecode **"billing/usage/problems/validation".**
66 +)))
67 +
68 +(% class="table-bordered table-striped" %)
69 +|=(% style="width: 537px;" %)Problem type (code)|=(% style="width: 172px;" %)Http status|=(% style="width: 796px;" %)Description
70 +|(% style="width:537px" %)validation|(% style="width:172px" %)400|(% style="width:796px" %)occurs if any of the inputvalidation fails, it is described in the problem which parameter that failed the validation
71 +|(% style="width:537px" %)invoice-not-found|(% style="width:172px" %)404|(% style="width:796px" %)(((
72 +Invoice number not found in Usage
73 +)))
74 +|(% style="width:537px" %)customer-not-found|(% style="width:172px" %)404|(% style="width:796px" %)Customer not found in Usage for unbilled usage.
75 +|(% style="width:537px" %)invoice-has-no-usage|(% style="width:172px" %)404|(% style="width:796px" %)Invoice has no usage
76 +|(% style="width:537px" %)subscription-not found|(% style="width:172px" %)404|(% style="width:796px" %)Subscription not found on selected invoice (billed) or customer (unbilled)
77 +