Changes for page Invoice - DRAFT API

Last modified by Anders Göthberg on 2026/05/25 15:12
From empty
To version 16.1
edited by Anders Göthberg
on 2026/05/25 15:12
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,74 @@
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 +A link to the general step-by-step implementation guide for setting up a REST API integration with PayEx Ledger Invoice Service can be found [[here >>doc:Main.Invoicing.invoice-service.invoice-service-apis.WebHome]]
23 +
24 +The Billing Invoice API provides a detailed, line-level view of all incoming charges that contribute to an invoice, regardless of how they are presented in the PDF version. This data can be used for display in various company applications, such as customer self-service portals ("My Pages") or by customer service representatives within the company's CRM system.
25 +
26 +== Invoice API ==
27 +
28 +[[image:1779266755446-810.png||height="481" width="596"]]
29 +
30 +
31 +(% id="HRoutedescription" %)
32 +=== Route description ===
33 +
34 +Each resource in the API is mapped to its own route. All routes follow a consistent structure based on a defined standard, which is described 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)
44 +|resource2Id|identifier of resource2, subresource to resource1 (customer recurring products or subscriptions)
45 +|resource3Id|identifier of resource3, subresource to resource2 (subscription recurring products)
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" %)customerNo|(% style="width:1517px" %)Customer number
54 +|invoiceNo|Invoice number
55 +|(% style="width:330px" %)subscriptionNo|(% style="width:1517px" %)Subscription number (identifier for subscription)
56 +|(% style="width:330px" %)recurring-products|(% style="width:1517px" %)Recurring products on customer or subscription level
57 +
58 +{{display reference="developer:Main.Invoicing.billing.technical-reference.Billing API.Invoice.Invoice-from-swagger.WebHome"/}}
59 +
60 +=== Problem types ===
61 +
62 +(% class="box infomessage" %)
63 +(((
64 +Note, each problem typecode is preceded by** "billing/invoice/service"** in this API, e.g. the error "validation" in the table below will appear as typecode **"billing/invoice/problems/validation".**
65 +)))
66 +
67 +(% class="table-bordered table-striped" %)
68 +|=(% style="width: 537px;" %)Problem type (code)|=(% style="width: 172px;" %)Http status|=(% style="width: 796px;" %)Description
69 +|(% style="width:537px" %)validation|(% style="width:172px" %)400|(% style="width:796px" %)occurs if any of the input validation fails, it is described in the problem which parameter that failed the validation
70 +|(% style="width:537px" %)customer-not-found|(% style="width:172px" %)404|(% style="width:796px" %)Customer not found in PayEx Billing
71 +|invoice-not-found|404|(((
72 +Invoice number not found in Usage
73 +)))
74 +|(% style="width:537px" %)subscription-not-found|(% style="width:172px" %)404|(% style="width:796px" %)Subscription not found on selected customer
1779266755446-810.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.AndersGothberg
Size
... ... @@ -1,0 +1,1 @@
1 +68.5 KB
Content