Main.Invoicing.invoice-service.invoice-service-apis.Technical reference.5\. Output - 5. Output 
Page of - last modified by dap on 2024/01/11 08:56 
5. Output 

dap

2024/01/11 08:56
Table of Contents
Introduction
Files
AR Accounting (Accounts receivable accounting report)
AR Settlement
AR Report 106

Integrate to 
Introduction
This api is used to download available reports and files related to the companys accounts receivable

Files
This resource lists all types of files that is available for download

GET /ledger/output/v1/XXX/files HTTP/1.1
Host: -
Authorization: Bearer <Token>
Content-Type: application/json

HTTP/1.1 200 OK
Content-Type: application/json

{
      "@id": "/ledger/output/v1/XXX/files",
      "ar-accounting" : "/ledger/output/v1/XXX/files/NNN/ar-settlement",
      "operations": null
}
Files resource properties
Property | Data type | Format | Description
@id | string | Uri | The uri identifier of this resource
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
AR Accounting (Accounts receivable accounting report)
This report contains detailed accounting data from the companys accounts receviable
Each instance of this resource is a downloadable file (the actual report).
The reports are created automatically accoring to configured schedule and will show up in this list-response upon creation.
Detailed information and examples of the report can be found here
List all available ar-accounting reports
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
Date filter parameters "" and "" must both be used if filtering in a date interval. The maximum number of days for filtering is 31

GET /ledger/output/v1/XXX/files/ar-accounting?FromDate=2021-02-05&ToDate=2021-02-25 HTTP/1.1
Host: -
Authorization: Bearer <Token>
Content-Type: application/json

GET /ledger/output/v1/XXX/files/ar-accounting HTTP/1.1
Host: -
Authorization: Bearer <Token>
Content-Type: application/json

HTTP/1.1 200 OK
Content-Type: application/json

{
      "items": [
                {
                      "fileName": "ARAccounting10_853_20210225112347_12.xml",
                      "sequence": 12,
                      "@id": "/ledger/output/v1/XXX/files/ar-accounting/2021-02-25_89764",
                },
                {
                      "fileName": "ARAccounting10_853_20210224112347_11.xml",
                      "sequence": 11,
                      "@id": "/ledger/output/v1/XXX/files/ar-accounting/2021-02-24_89760",
                },
                {
                      "fileName": "ARAccounting10_853_20210223112347_10.xml",
                      "sequence": 10,
                      "@id": "/ledger/output/v1/XXX/files/ar-accounting/2021-02-23_89756",
                },
                {
                      "fileName": "ARAccounting10_853_20210222112347_9.xml",
                      "sequence": 9,
                      "@id": "/ledger/output/v1/XXX/files/ar-accounting/2021-02-22_89754",
                },
                {
                      "fileName": "ARAccounting10_853_20210221112347_8.xml",
                      "sequence": 8,
                      "@id": "/ledger/output/v1/XXX/files/ar-accounting/2021-02-21_89740",
                },
                {
                      "fileName": "ARAccounting10_853_20210220112347_7.xml",
                      "sequence": 7,
                      "@id": "/ledger/output/v1/XXX/files/ar-accounting/2021-02-20_89737",
                },
                {
                      "fileName": "ARAccounting10_853_20210219112347_6.xml",
                      "sequence": 6,
                      "@id": "/ledger/output/v1/XXX/files/ar-accounting/2021-02-19_89736",
                },
                {
                      "fileName": "ARAccounting10_853_20210218112347_5.xml",
                      "sequence": 5,
                      "@id": "/ledger/output/v1/XXX/files/ar-accounting/2021-02-18_89729",
                },
                {
                      "fileName": "ARAccounting10_853_20210217112347_4.xml",
                      "sequence": 4,
                      "@id": "/ledger/output/v1/XXX/files/ar-accounting/2021-02-17_89725",
                },
                {
                      "fileName": "ARAccounting10_853_20210216112347_3.xml",
                      "sequence": 3,
                      "@id": "/ledger/output/v1/XXX/files/ar-accounting/2021-02-16_89722",
                },
        ],
      "@id": "/ledger/output/v1/XXX/files/ar-accounting",
      "operations": null,
}
Querystring parameters
Property | Data type | Format | Description
FromDate | string | YYYY-MM-DD | List files from this date
ToDate | string | YYYY-MM-DD | List files to this date
Resource properties
Property | Data type | Format | Description
fileName | string | | Name of the file. The name format in the above example is not guaranteed to match the real files in this API
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
@id | string | Uri | Uri to the download the file
AR Settlement
List all available ar-settlement reports
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
Detailed information and examples of the report can be found here
Date filter parameters "" and "" must both be used if filtering in a date interval. The maximum number of days for filtering is 31

GET /ledger/output/v1/XXX/files/ar-settlement?FromDate=2021-02-05&ToDate=2021-02-25 HTTP/1.1
Host: -
Authorization: Bearer <Token>
Content-Type: application/json

GET /ledger/output/v1/XXX/files/ar-settlement HTTP/1.1
Host: -
Authorization: Bearer <Token>
Content-Type: application/json

HTTP/1.1 200 OK
Content-Type: application/json

{
      "items": [
                {
                      "fileName": "ARSettlement_853_20210225112347_12.pdf",
                      "sequence": 12,
                      "@id": "/ledger/output/v1/XXX/files/ar-settlement/2021-02-25_89764",
                },
                {
                      "fileName": "ARSettlement_853_20210224112347_11.pdf",
                      "sequence": 11,
                      "@id": "/ledger/output/v1/XXX/files/ar-settlement/2021-02-24_89760",
                },
                {
                      "fileName": "ARSettlement_853_20210223112347_10.pdf",
                      "sequence": 10,
                      "@id": "/ledger/output/v1/XXX/files/ar-settlement/2021-02-23_89756",
                },
                {
                      "fileName": "ARSettlement_853_20210222112347_9.pdf",
                      "sequence": 9,
                      "@id": "/ledger/output/v1/XXX/files/ar-settlement/2021-02-22_89754",
                },
                {
                      "fileName": "ARSettlement_853_20210221112347_8.pdf",
                      "sequence": 8,
                      "@id": "/ledger/output/v1/XXX/files/ar-settlement/2021-02-21_89740",
                },
                {
                      "fileName": "ARSettlement_853_20210220112347_7.pdf",
                      "sequence": 7,
                      "@id": "/ledger/output/v1/XXX/files/ar-settlement/2021-02-20_89737",
                },
                {
                      "fileName": "ARSettlement_853_20210219112347_6.pdf",
                      "sequence": 6,
                      "@id": "/ledger/output/v1/XXX/files/ar-settlement/2021-02-19_89736",
                },
                {
                      "fileName": "ARSettlement_853_20210218112347_5.pdf",
                      "sequence": 5,
                      "@id": "/ledger/output/v1/XXX/files/ar-settlement/2021-02-18_89729",
                },
                {
                      "fileName": "ARSettlement_853_20210217112347_4.pdf",
                      "sequence": 4,
                      "@id": "/ledger/output/v1/XXX/files/ar-settlement/2021-02-17_89725",
                },
                {
                      "fileName": "ARSettlement_853_20210216112347_3.pdf",
                      "sequence": 3,
                      "@id": "/ledger/output/v1/XXX/files/ar-settlement/2021-02-16_89722",
                },
        ],
      "@id": "/ledger/output/v1/XXX/files/ar-settlement",
      "operations": null,
}
Querystring parameters
Property | Data type | Format | Description
FromDate | string | YYYY-MM-DD | List files from this date
ToDate | string | YYYY-MM-DD | List files to this date
Resource properties
Property | Data type | Format | Description
fileName | string | | Name of the file. The name format in the above example is not guaranteed to match the real files in this API
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
@id | string | Uri | Uri to the download the file
AR Report 106
This is a complete ledger report, for accounting reconciliation (ledger value as of specified date)
Each instance of this resource is a downloadable file (the actual report).
The reports are created automatically accoring to configured schedule and will show up in this list-response upon creation.
Detailed information and examples of the report can be found here
List all available "ar-report106" files
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
Date filter parameters "" and "" must both be used if filtering in a date interval. The maximum number of days for filtering is 31

GET /ledger/output/v1/XXX/files/ar-report106?FromDate=2021-02-05&ToDate=2021-02-25 HTTP/1.1
Host: -
Authorization: Bearer <Token>
Content-Type: application/json

GET /ledger/output/v1/XXX/files/ar-report106 HTTP/1.1
Host: -
Authorization: Bearer <Token>
Content-Type: application/json

HTTP/1.1 200 OK
Content-Type: application/json

{
      "items": [
                {
                      "fileName": "ARREPORT106_853_20210225112347_12.xml",
                      "sequence": 12,
                      "@id": "/ledger/output/v1/XXX/files/ar-report106/2021-02-25_89764",
                },
                {
                      "fileName": "ARREPORT106_853_20210224112347_11.xml",
                      "sequence": 11,
                      "@id": "/ledger/output/v1/XXX/files/ar-report106/2021-02-24_89760",
                },
                {
                      "fileName": "ARREPORT106_853_20210223112347_10.xml",
                      "sequence": 10,
                      "@id": "/ledger/output/v1/XXX/files/ar-report106/2021-02-23_89756",
                },
                {
                      "fileName": "ARREPORT106_853_20210222112347_9.xml",
                      "sequence": 9,
                      "@id": "/ledger/output/v1/XXX/files/ar-report106/2021-02-22_89754",
                },
                {
                      "fileName": "ARREPORT106_853_20210221112347_8.xml",
                      "sequence": 8,
                      "@id": "/ledger/output/v1/XXX/files/ar-report106/2021-02-21_89740",
                },
                {
                      "fileName": "ARREPORT106_853_20210220112347_7.xml",
                      "sequence": 7,
                      "@id": "/ledger/output/v1/XXX/files/ar-report106/2021-02-20_89737",
                },
                {
                      "fileName": "ARREPORT106_853_20210219112347_6.xml",
                      "sequence": 6,
                      "@id": "/ledger/output/v1/XXX/files/ar-report106/2021-02-19_89736",
                },
                {
                      "fileName": "ARREPORT106_853_20210218112347_5.xml",
                      "sequence": 5,
                      "@id": "/ledger/output/v1/XXX/files/ar-report106/2021-02-18_89729",
                },
                {
                      "fileName": "ARREPORT106_853_20210217112347_4.xml",
                      "sequence": 4,
                      "@id": "/ledger/output/v1/XXX/files/ar-report106/2021-02-17_89725",
                },
                {
                      "fileName": "ARREPORT106_853_20210216112347_3.xml",
                      "sequence": 3,
                      "@id": "/ledger/output/v1/XXX/files/ar-report106/2021-02-16_89722",
                },
        ],
      "@id": "/ledger/output/v1/XXX/files/ar-report106",
      "operations": null,
}
Querystring parameters
Property | Data type | Format | Description
FromDate | string | YYYY-MM-DD | List files from this date
ToDate | string | YYYY-MM-DD | List files to this date
Resource properties
Property | Data type | Format | Description
fileName | string | | Name of the file. The name format in the above example is not guaranteed to match the real files in this API
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
@id | string | Uri | Uri to the download the file