Wiki source code of Invoice - DRAFT API

Last modified by Anders Göthberg on 2026/05/25 15:12
Hide last authors
Anders Göthberg 3.1 1 (% class="jumbotron" %)
2 (((
3 (% class="container" %)
4 (((
Anders Göthberg 4.1 5 Integrate to **PayEx Billing Invoice API **
Anders Göthberg 3.1 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
Anders Göthberg 15.1 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]]
Anders Göthberg 3.1 23
Anders Göthberg 15.1 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.
Anders Göthberg 3.1 25
Anders Göthberg 5.1 26 == Invoice API ==
Anders Göthberg 3.1 27
Anders Göthberg 13.1 28 [[image:1779266755446-810.png||height="481" width="596"]]
Anders Göthberg 3.1 29
30
31 (% id="HRoutedescription" %)
32 === Route description ===
33
Anders Göthberg 15.1 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.
Anders Göthberg 3.1 35
Anders Göthberg 15.1 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.
Anders Göthberg 3.1 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
Anders Göthberg 8.1 43 |resource1Id|Identifier of resource1 (invoices)
Anders Göthberg 12.1 44 |resource2Id|identifier of resource2, subresource to resource1 (customer recurring products or subscriptions)
45 |resource3Id|identifier of resource3, subresource to resource2 (subscription recurring products)
Anders Göthberg 3.1 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
Anders Göthberg 9.1 54 |invoiceNo|Invoice number
Anders Göthberg 3.1 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
Anders Göthberg 16.1 58 {{display reference="developer:Main.Invoicing.billing.technical-reference.Billing API.Invoice.Invoice-from-swagger.WebHome"/}}
Anders Göthberg 15.1 59
Anders Göthberg 3.1 60 === Problem types ===
61
62 (% class="box infomessage" %)
63 (((
Anders Göthberg 10.1 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".**
Anders Göthberg 3.1 65 )))
66
67 (% class="table-bordered table-striped" %)
68 |=(% style="width: 537px;" %)Problem type (code)|=(% style="width: 172px;" %)Http status|=(% style="width: 796px;" %)Description
Anders Göthberg 12.1 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
Anders Göthberg 3.1 70 |(% style="width:537px" %)customer-not-found|(% style="width:172px" %)404|(% style="width:796px" %)Customer not found in PayEx Billing
Anders Göthberg 11.1 71 |invoice-not-found|404|(((
Anders Göthberg 10.1 72 Invoice number not found in Usage
73 )))
Anders Göthberg 3.1 74 |(% style="width:537px" %)subscription-not-found|(% style="width:172px" %)404|(% style="width:796px" %)Subscription not found on selected customer