Changes for page 5. Output
Last modified by David Persson on 2024/01/11 08:56
From empty
To version 43.1
edited by Fredrik Nilsson
on 2023/04/27 11:06
on 2023/04/27 11:06
Change comment: There is no comment for this version
Summary
-
Page properties (6 modified, 0 added, 0 removed)
-
Attachments (0 modified, 2 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,0 +1,1 @@ 1 +5. Output - Parent
-
... ... @@ -1,0 +1,1 @@ 1 +developer:Main.Invoicing.invoice-service.invoice-service-apis.Technical reference.WebHome - Author
-
... ... @@ -1,1 +1,1 @@ 1 - XWiki.XWikiGuest1 +xwiki:XWiki.frn - Default language
-
... ... @@ -1,0 +1,1 @@ 1 +en - Tags
-
... ... @@ -1,0 +1,1 @@ 1 +px-custom-page-content - Content
-
... ... @@ -1,0 +1,407 @@ 1 +(% class="jumbotron" %) 2 +((( 3 +(% class="container" %) 4 +((( 5 +Integrate to **PayEx Output API ** 6 +))) 7 +))) 8 + 9 +== Introduction == 10 + 11 +This api is used to download available reports and files related to the companys accounts receivable 12 + 13 +[[image:1624263385817-770.png||height="212" width="340"]] 14 + 15 + 16 +== Files == 17 + 18 +This resource lists all types of files that is available for download 19 + 20 +{{code language="http" title="**Request**"}} 21 +GET /ledger/output/v1/XXX/files HTTP/1.1 22 +Host: - 23 +Authorization: Bearer <Token> 24 +Content-Type: application/json 25 + 26 +{{/code}} 27 + 28 +{{code language="http" title="**Response**"}} 29 +HTTP/1.1 200 OK 30 +Content-Type: application/json 31 + 32 +{ 33 + "@id": "/ledger/output/v1/XXX/files", 34 + "ar-accounting" : "/ledger/output/v1/XXX/files/NNN/ar-settlement", 35 + "operations": null 36 +} 37 +{{/code}} 38 + 39 +(% id="HAccountresourceproperties" %) 40 +==== Files resource properties ==== 41 + 42 +(% class="table-bordered table-striped" %) 43 +|=Property|=Data type|=Format|=Description 44 +|@id|string|Uri|The uri identifier of this resource 45 +|ar-accounting|string|Uri|The uri identifier of the accounts receivable report file type, this uri will return a list of all availbale ar-accounting reports 46 + 47 +== AR Accounting (Accounts receivable accounting report) == 48 + 49 +This report contains detailed accounting data from the companys accounts receviable 50 +Each instance of this resource is a downloadable file (the actual report). 51 +The reports are created automatically accoring to configured schedule and will show up in this list-response upon creation. 52 + 53 +(% class="box infomessage" %) 54 +((( 55 +Detailed information and examples of the report can be found [[here>>doc:Main.Invoicing.invoice-service.invoice-service-apis.Technical reference.5\. Output.1\. AR Accounting.WebHome]] 56 +))) 57 + 58 +(% id="HListallbillsofanaccount" %) 59 +==== List all available ar-accounting reports ==== 60 + 61 +Below examples show how to list the files that are available for download. By default, the files created in the last 7 days are displayed. To list older files, date filters in querystring can be used 62 + 63 +(% class="box infomessage" %) 64 +((( 65 +Date filter parameters "**FromDate**" and "**ToDate**" must both be used if filtering in a date interval. The maximum number of days for filtering is 31 66 +))) 67 + 68 +**Request example of how to list all files created between 2021-02-05 and 2021-02-25** 69 + 70 +{{code language="http" title="**Request**"}} 71 +GET /ledger/output/v1/XXX/files/ar-accounting?FromDate=2021-02-05&ToDate=2021-02-25 HTTP/1.1 72 +Host: - 73 +Authorization: Bearer <Token> 74 +Content-Type: application/json 75 + 76 +{{/code}} 77 + 78 +**Request example of how to list all files created in the last deafult (7) number of days. No querystring parameters are used** 79 + 80 +{{code language="http" title="**Request**"}} 81 +GET /ledger/output/v1/XXX/files/ar-accounting HTTP/1.1 82 +Host: - 83 +Authorization: Bearer <Token> 84 +Content-Type: application/json 85 + 86 +{{/code}} 87 + 88 + 89 +{{code language="http" title="**Response**"}} 90 +HTTP/1.1 200 OK 91 +Content-Type: application/json 92 + 93 + 94 +{ 95 + "items": [ 96 + { 97 + "fileName": "ARAccounting10_853_20210225112347_12.xml", 98 + "sequence": 12, 99 + "@id": "/ledger/output/v1/XXX/files/ar-accounting/2021-02-25_89764", 100 + }, 101 + { 102 + "fileName": "ARAccounting10_853_20210224112347_11.xml", 103 + "sequence": 11, 104 + "@id": "/ledger/output/v1/XXX/files/ar-accounting/2021-02-24_89760", 105 + }, 106 + { 107 + "fileName": "ARAccounting10_853_20210223112347_10.xml", 108 + "sequence": 10, 109 + "@id": "/ledger/output/v1/XXX/files/ar-accounting/2021-02-23_89756", 110 + }, 111 + { 112 + "fileName": "ARAccounting10_853_20210222112347_9.xml", 113 + "sequence": 9, 114 + "@id": "/ledger/output/v1/XXX/files/ar-accounting/2021-02-22_89754", 115 + }, 116 + { 117 + "fileName": "ARAccounting10_853_20210221112347_8.xml", 118 + "sequence": 8, 119 + "@id": "/ledger/output/v1/XXX/files/ar-accounting/2021-02-21_89740", 120 + }, 121 + { 122 + "fileName": "ARAccounting10_853_20210220112347_7.xml", 123 + "sequence": 7, 124 + "@id": "/ledger/output/v1/XXX/files/ar-accounting/2021-02-20_89737", 125 + }, 126 + { 127 + "fileName": "ARAccounting10_853_20210219112347_6.xml", 128 + "sequence": 6, 129 + "@id": "/ledger/output/v1/XXX/files/ar-accounting/2021-02-19_89736", 130 + }, 131 + { 132 + "fileName": "ARAccounting10_853_20210218112347_5.xml", 133 + "sequence": 5, 134 + "@id": "/ledger/output/v1/XXX/files/ar-accounting/2021-02-18_89729", 135 + }, 136 + { 137 + "fileName": "ARAccounting10_853_20210217112347_4.xml", 138 + "sequence": 4, 139 + "@id": "/ledger/output/v1/XXX/files/ar-accounting/2021-02-17_89725", 140 + }, 141 + { 142 + "fileName": "ARAccounting10_853_20210216112347_3.xml", 143 + "sequence": 3, 144 + "@id": "/ledger/output/v1/XXX/files/ar-accounting/2021-02-16_89722", 145 + }, 146 + ], 147 + "@id": "/ledger/output/v1/XXX/files/ar-accounting", 148 + "operations": null, 149 +} 150 +{{/code}} 151 + 152 +(% id="H-1" %) 153 +==== Querystring parameters ==== 154 + 155 +(% class="table-bordered table-striped" %) 156 +|=Property|=Data type|=Format|=Description 157 +|FromDate|string|YYYY-MM-DD|List files from this date 158 +|ToDate|string|YYYY-MM-DD|List files to this date 159 + 160 +(% id="HBillresourceproperties" %) 161 +==== Resource properties ==== 162 + 163 +(% class="table-bordered table-striped" %) 164 +|=Property|=Data type|=Format|=Description 165 +|fileName|string| |Name of the file. The name format in the above example is not guaranteed to match the real files in this API 166 +|sequence|number| |All files of this type created for a specific company follow this sequence. Sequence should be used to validate that you have received all files 167 +|@id|string|Uri|Uri to the download the file 168 + 169 +== == 170 + 171 +== AR Settlement == 172 + 173 + 174 +(% id="HListallbillsofanaccount" %) 175 +==== List all available ar-settlement reports ==== 176 + 177 +Below examples show how to list the files that are available for download. By default, the files created in the last 7 days are displayed. To list older files, date filters in querystring can be used 178 + 179 +(% class="box infomessage" %) 180 +((( 181 +Detailed information and examples of the report can be found [[here>>doc:Main.Invoicing.invoice-service.invoice-service-apis.Technical reference.5\. Output.2\. AR Settlement.WebHome]] 182 + 183 +Date filter parameters "**FromDate**" and "**ToDate**" must both be used if filtering in a date interval. The maximum number of days for filtering is 31 184 +))) 185 + 186 +**Request example of how to list all files created between 2021-02-05 and 2021-02-25** 187 + 188 +{{code language="http" title="**Request**"}} 189 +GET /ledger/output/v1/XXX/files/ar-settlement?FromDate=2021-02-05&ToDate=2021-02-25 HTTP/1.1 190 +Host: - 191 +Authorization: Bearer <Token> 192 +Content-Type: application/json 193 + 194 +{{/code}} 195 + 196 +**Request example of how to list all files created in the last deafult (7) number of days. No querystring parameters are used** 197 + 198 +{{code language="http" title="**Request**"}} 199 +GET /ledger/output/v1/XXX/files/ar-settlement HTTP/1.1 200 +Host: - 201 +Authorization: Bearer <Token> 202 +Content-Type: application/json 203 + 204 +{{/code}} 205 + 206 + 207 +{{code language="http" title="**Response**"}} 208 +HTTP/1.1 200 OK 209 +Content-Type: application/json 210 + 211 + 212 +{ 213 + "items": [ 214 + { 215 + "fileName": "ARSettlement_853_20210225112347_12.pdf", 216 + "sequence": 12, 217 + "@id": "/ledger/output/v1/XXX/files/ar-settlement/2021-02-25_89764", 218 + }, 219 + { 220 + "fileName": "ARSettlement_853_20210224112347_11.pdf", 221 + "sequence": 11, 222 + "@id": "/ledger/output/v1/XXX/files/ar-settlement/2021-02-24_89760", 223 + }, 224 + { 225 + "fileName": "ARSettlement_853_20210223112347_10.pdf", 226 + "sequence": 10, 227 + "@id": "/ledger/output/v1/XXX/files/ar-settlement/2021-02-23_89756", 228 + }, 229 + { 230 + "fileName": "ARSettlement_853_20210222112347_9.pdf", 231 + "sequence": 9, 232 + "@id": "/ledger/output/v1/XXX/files/ar-settlement/2021-02-22_89754", 233 + }, 234 + { 235 + "fileName": "ARSettlement_853_20210221112347_8.pdf", 236 + "sequence": 8, 237 + "@id": "/ledger/output/v1/XXX/files/ar-settlement/2021-02-21_89740", 238 + }, 239 + { 240 + "fileName": "ARSettlement_853_20210220112347_7.pdf", 241 + "sequence": 7, 242 + "@id": "/ledger/output/v1/XXX/files/ar-settlement/2021-02-20_89737", 243 + }, 244 + { 245 + "fileName": "ARSettlement_853_20210219112347_6.pdf", 246 + "sequence": 6, 247 + "@id": "/ledger/output/v1/XXX/files/ar-settlement/2021-02-19_89736", 248 + }, 249 + { 250 + "fileName": "ARSettlement_853_20210218112347_5.pdf", 251 + "sequence": 5, 252 + "@id": "/ledger/output/v1/XXX/files/ar-settlement/2021-02-18_89729", 253 + }, 254 + { 255 + "fileName": "ARSettlement_853_20210217112347_4.pdf", 256 + "sequence": 4, 257 + "@id": "/ledger/output/v1/XXX/files/ar-settlement/2021-02-17_89725", 258 + }, 259 + { 260 + "fileName": "ARSettlement_853_20210216112347_3.pdf", 261 + "sequence": 3, 262 + "@id": "/ledger/output/v1/XXX/files/ar-settlement/2021-02-16_89722", 263 + }, 264 + ], 265 + "@id": "/ledger/output/v1/XXX/files/ar-settlement", 266 + "operations": null, 267 +} 268 +{{/code}} 269 + 270 +(% id="H-1" %) 271 +==== Querystring parameters ==== 272 + 273 +(% class="table-bordered table-striped" %) 274 +|=Property|=Data type|=Format|=Description 275 +|FromDate|string|YYYY-MM-DD|List files from this date 276 +|ToDate|string|YYYY-MM-DD|List files to this date 277 + 278 +(% id="HBillresourceproperties" %) 279 +==== Resource properties ==== 280 + 281 +(% class="table-bordered table-striped" %) 282 +|=Property|=Data type|=Format|=Description 283 +|fileName|string| |Name of the file. The name format in the above example is not guaranteed to match the real files in this API 284 +|sequence|number| |All files of this type created for a specific company follow this sequence. Sequence should be used to validate that you have received all files 285 +|@id|string|Uri|Uri to the download the file 286 + 287 +== AR Report 106 == 288 + 289 +This is a complete ledger report, for accounting reconciliation (ledger value as of specified date) 290 +Each instance of this resource is a downloadable file (the actual report). 291 +The reports are created automatically accoring to configured schedule and will show up in this list-response upon creation. 292 + 293 +(% class="box infomessage" %) 294 +((( 295 +Detailed information and examples of the report can be found [[here>>doc:Main.Invoicing.invoice-service.invoice-service-apis.Technical reference.5\. Output.3\. AR FILEREPORT 106.WebHome]] 296 +))) 297 + 298 +(% id="HListallbillsofanaccount" %) 299 +==== List all available "ar-report106" files ==== 300 + 301 +Below examples show how to list the files that are available for download. By default, the files created in the last 7 days are displayed. To list older files, date filters in querystring can be used 302 + 303 +(% class="box infomessage" %) 304 +((( 305 +Date filter parameters "**FromDate**" and "**ToDate**" must both be used if filtering in a date interval. The maximum number of days for filtering is 31 306 +))) 307 + 308 +**Request example of how to list all files created between 2021-02-05 and 2021-02-25** 309 + 310 +{{code language="http" title="**Request**"}} 311 +GET /ledger/output/v1/XXX/files/ar-report106?FromDate=2021-02-05&ToDate=2021-02-25 HTTP/1.1 312 +Host: - 313 +Authorization: Bearer <Token> 314 +Content-Type: application/json 315 + 316 +{{/code}} 317 + 318 +**Request example of how to list all files created in the last deafult (7) number of days. No querystring parameters are used** 319 + 320 +{{code language="http" title="**Request**"}} 321 +GET /ledger/output/v1/XXX/files/ar-report106 HTTP/1.1 322 +Host: - 323 +Authorization: Bearer <Token> 324 +Content-Type: application/json 325 + 326 +{{/code}} 327 + 328 + 329 +{{code language="http" title="**Response**"}} 330 +HTTP/1.1 200 OK 331 +Content-Type: application/json 332 + 333 + 334 +{ 335 + "items": [ 336 + { 337 + "fileName": "ARREPORT106_853_20210225112347_12.xml", 338 + "sequence": 12, 339 + "@id": "/ledger/output/v1/XXX/files/ar-report106/2021-02-25_89764", 340 + }, 341 + { 342 + "fileName": "ARREPORT106_853_20210224112347_11.xml", 343 + "sequence": 11, 344 + "@id": "/ledger/output/v1/XXX/files/ar-report106/2021-02-24_89760", 345 + }, 346 + { 347 + "fileName": "ARREPORT106_853_20210223112347_10.xml", 348 + "sequence": 10, 349 + "@id": "/ledger/output/v1/XXX/files/ar-report106/2021-02-23_89756", 350 + }, 351 + { 352 + "fileName": "ARREPORT106_853_20210222112347_9.xml", 353 + "sequence": 9, 354 + "@id": "/ledger/output/v1/XXX/files/ar-report106/2021-02-22_89754", 355 + }, 356 + { 357 + "fileName": "ARREPORT106_853_20210221112347_8.xml", 358 + "sequence": 8, 359 + "@id": "/ledger/output/v1/XXX/files/ar-report106/2021-02-21_89740", 360 + }, 361 + { 362 + "fileName": "ARREPORT106_853_20210220112347_7.xml", 363 + "sequence": 7, 364 + "@id": "/ledger/output/v1/XXX/files/ar-report106/2021-02-20_89737", 365 + }, 366 + { 367 + "fileName": "ARREPORT106_853_20210219112347_6.xml", 368 + "sequence": 6, 369 + "@id": "/ledger/output/v1/XXX/files/ar-report106/2021-02-19_89736", 370 + }, 371 + { 372 + "fileName": "ARREPORT106_853_20210218112347_5.xml", 373 + "sequence": 5, 374 + "@id": "/ledger/output/v1/XXX/files/ar-report106/2021-02-18_89729", 375 + }, 376 + { 377 + "fileName": "ARREPORT106_853_20210217112347_4.xml", 378 + "sequence": 4, 379 + "@id": "/ledger/output/v1/XXX/files/ar-report106/2021-02-17_89725", 380 + }, 381 + { 382 + "fileName": "ARREPORT106_853_20210216112347_3.xml", 383 + "sequence": 3, 384 + "@id": "/ledger/output/v1/XXX/files/ar-report106/2021-02-16_89722", 385 + }, 386 + ], 387 + "@id": "/ledger/output/v1/XXX/files/ar-report106", 388 + "operations": null, 389 +} 390 +{{/code}} 391 + 392 +(% id="H-1" %) 393 +==== Querystring parameters ==== 394 + 395 +(% class="table-bordered table-striped" %) 396 +|=Property|=Data type|=Format|=Description 397 +|FromDate|string|YYYYMMDD|List files from this date 398 +|ToDate|string|YYYYMMDD|List files to this date 399 + 400 +(% id="HBillresourceproperties" %) 401 +==== Resource properties ==== 402 + 403 +(% class="table-bordered table-striped" %) 404 +|=Property|=Data type|=Format|=Description 405 +|fileName|string| |Name of the file. The name format in the above example is not guaranteed to match the real files in this API 406 +|sequence|number| |All files of this type created for a specific company follow this sequence. Sequence should be used to validate that you have received all files 407 +|@id|string|Uri|Uri to the download the file
- 1615145651335-583.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.dap - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 1624263385817-770.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.dap - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content