Changes for page Invoice - DRAFT API

Last modified by Anders Göthberg on 2026/05/25 15:12
From empty
To version 5.1
edited by Anders Göthberg
on 2026/05/20 10:41
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,0 +1,1 @@
1 +Invoice - 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,69 @@
1 +(% class="jumbotron" %)
2 +(((
3 +(% class="container" %)
4 +(((
5 +Integrate to **PayEx Billing Invoice API **
6 +)))
7 +)))
8 +
9 +(% id="HChangelog" %)
10 += Changelog =
11 +
12 +(% border="1" %)
13 +|=**Version**|=**Date**|=**Description**|=**Created by**
14 +|1.0|2025-05-20|(((
15 +Created document
16 +)))|Anders Göthberg
17 +|1.1| |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 Ledger Invoice Service can be found [[here >>doc:Main.Invoicing.invoice-service.invoice-service-apis.WebHome]]
23 +
24 +Billing Invoice API presents presents at the lowest level all incoming charges that generated an invoice regardless of presentation in PDF. 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 +== Invoice API ==
27 +
28 +
29 +
30 +(% id="HRoutedescription" %)
31 +=== Route description ===
32 +
33 +Each resource in the API corresponds to its own route. All routes are structured according to a specific standard, explained below
34 +
35 +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.
36 +//lf-api.payex.com/billing/**{subdomain}**/v1/**{ownerNo}**/resource1/**{resource1Id}**/resource2/**{resource2Id}**/resource3/**{resource3Id}**//
37 +
38 +(% border="1" %)
39 +|=Route segment|=Description
40 +|subdomain|In this part of the API it will be "billing"
41 +|ownerNo|The ledger identifier/number at PayEx
42 +|resource1Id|Identifier of resource1 (customers)
43 +|resource2Id|identifier of resource2, subresource to resource1 (recurring products or subscriptions)
44 +|resource3Id|identifier of resource3, subresource to resource2 (recurring products)
45 +
46 +(% border="1" %)
47 +Routes that occurs in examples of this documentation will use the following identifiers
48 +
49 +(% border="1" %)
50 +|=(% style="width: 330px;" %)Resource|=(% style="width: 1517px;" %)Identifier
51 +|(% style="width:330px" %)ownerNo|(% style="width:1517px" %)The ledger identifier/number at PayEx
52 +|(% style="width:330px" %)customerNo|(% style="width:1517px" %)Customer number
53 +|(% style="width:330px" %)subscriptionNo|(% style="width:1517px" %)Subscription number (identifier for subscription)
54 +|(% style="width:330px" %)recurring-products|(% style="width:1517px" %)Recurring products on customer or subscription level
55 +
56 += Swaggerfil!!! =
57 +
58 +=== Problem types ===
59 +
60 +(% class="box infomessage" %)
61 +(((
62 +Note, each problem typecode is preceded by** "billing/customer/service"** in this API, e.g. the error "validation" in the table below will appear as typecode **"billing/customer/problems/validation".**
63 +)))
64 +
65 +(% class="table-bordered table-striped" %)
66 +|=(% style="width: 537px;" %)Problem type (code)|=(% style="width: 172px;" %)Http status|=(% style="width: 796px;" %)Description
67 +|(% 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
68 +|(% style="width:537px" %)customer-not-found|(% style="width:172px" %)404|(% style="width:796px" %)Customer not found in PayEx Billing
69 +|(% style="width:537px" %)subscription-not-found|(% style="width:172px" %)404|(% style="width:796px" %)Subscription not found on selected customer