List documents
Changed onReturns a list of accounting documents.
Request
- Base URLhttps://api.atlar.com
- AuthHTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Limit the number of items in resulting query response.
If a query response contains a non-empty nextToken, use that value as token query parameter to continue pagination.
Unique resource identifier.
Filter by GL entity ID.
Unique resource identifier.
Filter by reconciliation match ID.
Response
A list of documents.
Example response
{
"items": [
{
"id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
"organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
"glEntityId": "01925d46-2dd4-7ceb-b929-ed9aa3a9481e",
"amount": {
"baseAmount": {
"currency": "EUR",
"stringValue": "15.02",
"value": 1502
},
"instructedAmount": {
"currency": "EUR",
"stringValue": "15.02",
"value": 1502
}
},
"remainingAmount": {
"baseAmount": {
"currency": "EUR",
"stringValue": "15.02",
"value": 1502
},
"instructedAmount": {
"currency": "EUR",
"stringValue": "15.02",
"value": 1502
}
},
"date": "2022-05-07",
"issueDate": "2022-05-07",
"invoiceDetails": {
"settledDate": "2022-05-07"
},
"description": "Invoice #10001",
"reference": "INV-10001",
"reconciliationStatus": "OPEN",
"reconciliationMatchId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
"outgoingDocumentId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
"glEntries": [
{
"id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
"glAccountId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
"vendorBankAccountId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
"glClassificationIds": [
"2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8"
],
"amount": {
"baseAmount": {
"currency": "EUR",
"stringValue": "15.02",
"value": 1502
},
"instructedAmount": {
"currency": "EUR",
"stringValue": "15.02",
"value": 1502
}
}
}
],
"appliedDocuments": [
{
"amount": {
"currency": "EUR",
"stringValue": "15.02",
"value": 1502
},
"targetDocumentId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
"date": "2022-05-07"
}
],
"provenance": {
"resource": {
"contentType": "application/vnd.iso20022.camt.053.001.02+xml"
}
},
"currencyExchange": {
"sourceCurrency": "EUR",
"targetCurrency": "SEK",
"unitCurrency": "EUR",
"exchangeRate": "11.21320"
},
"version": 1,
"etag": "version:3",
"created": "2022-05-04T18:31:12.889104898Z",
"updated": "2022-05-04T18:47:32.213842599Z"
}
],
"nextToken": "eyIxIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
"token": "eyIwIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
"limit": 100
}Changes
- breaking
the response property
//////became optional for the status - warning
added the new
EXPENSE_REPORTenum value to the/////response property for the response status - warning
added the new
EXPENSE_REPORTenum value to the///response property for the response status - warning
added the new
GL_ENTITYenum value to the////response property for the response status - warning
added the new
application/pdfenum value to the/////////response property for the response status - warning
added the new
application/pdfenum value to the/////////response property for the response status - warning
added the new
application/vnd.adyen.balance-platform.statement-report+csvenum value to the/////////response property for the response status - warning
added the new
application/vnd.adyen.balance-platform.statement-report+csvenum value to the/////////response property for the response status - warning
added the new
application/vnd.atlar.connectivity.v2.instrument-product-statement+jsonenum value to the/////////response property for the response status - warning
added the new
application/vnd.atlar.connectivity.v2.instrument-product-statement+jsonenum value to the/////////response property for the response status - warning
added the new
application/vnd.blackrock.cachematrix.balance+csvenum value to the/////////response property for the response status - warning
added the new
application/vnd.blackrock.cachematrix.balance+csvenum value to the/////////response property for the response status - warning
added the new
application/vnd.blackrock.cachematrix.transactions+csvenum value to the/////////response property for the response status - warning
added the new
application/vnd.blackrock.cachematrix.transactions+csvenum value to the/////////response property for the response status - warning
added the new
application/vnd.deutsche.wealth-online+csvenum value to the/////////response property for the response status - warning
added the new
application/vnd.deutsche.wealth-online+csvenum value to the/////////response property for the response status - warning
added the new
application/vnd.ebics.hac.v25+xmlenum value to the/////////response property for the response status - warning
added the new
application/vnd.ebics.hac.v25+xmlenum value to the/////////response property for the response status - warning
added the new
application/vnd.ebics.hac.v30+xmlenum value to the/////////response property for the response status - warning
added the new
application/vnd.ebics.hac.v30+xmlenum value to the/////////response property for the response status - warning
added the new
application/vnd.ebics.htd.v30+xmlenum value to the/////////response property for the response status - warning
added the new
application/vnd.ebics.htd.v30+xmlenum value to the/////////response property for the response status - warning
added the new
application/vnd.edi.997enum value to the/////////response property for the response status - warning
added the new
application/vnd.edi.997enum value to the/////////response property for the response status - warning
added the new
application/vnd.iso20022.camt.053.001.12+xmlenum value to the/////////response property for the response status - warning
added the new
application/vnd.iso20022.camt.053.001.12+xmlenum value to the/////////response property for the response status - warning
added the new
application/vnd.iso20022.pacs.002.001.10+xmlenum value to the/////////response property for the response status - warning
added the new
application/vnd.iso20022.pacs.002.001.10+xmlenum value to the/////////response property for the response status - warning
added the new
application/vnd.iso20022.pain.008.001.08+xmlenum value to the/////////response property for the response status - warning
added the new
application/vnd.iso20022.pain.008.001.08+xmlenum value to the/////////response property for the response status - warning
added the new
application/vnd.jpm.daily-feed+zipenum value to the/////////response property for the response status - warning
added the new
application/vnd.jpm.daily-feed+zipenum value to the/////////response property for the response status - warning
added the new
application/vnd.jpm.morgan-money.balance-report+csvenum value to the/////////response property for the response status - warning
added the new
application/vnd.jpm.morgan-money.balance-report+csvenum value to the/////////response property for the response status - warning
added the new
application/vnd.jpm.morgan-money.transaction-report+csvenum value to the/////////response property for the response status - warning
added the new
application/vnd.jpm.morgan-money.transaction-report+csvenum value to the/////////response property for the response status - warning
added the new
application/vnd.jpm.soci.cash-balance+csvenum value to the/////////response property for the response status - warning
added the new
application/vnd.jpm.soci.cash-balance+csvenum value to the/////////response property for the response status - warning
added the new
application/vnd.jpm.soci.holdings+csvenum value to the/////////response property for the response status - warning
added the new
application/vnd.jpm.soci.holdings+csvenum value to the/////////response property for the response status - warning
added the new
application/vnd.jpm.soci.transactions+csvenum value to the/////////response property for the response status - warning
added the new
application/vnd.jpm.soci.transactions+csvenum value to the/////////response property for the response status - warning
added the new
application/vnd.m2.m006.m001+xmlenum value to the/////////response property for the response status - warning
added the new
application/vnd.m2.m006.m001+xmlenum value to the/////////response property for the response status - warning
added the new
application/vnd.m2.m006.m005+xmlenum value to the/////////response property for the response status - warning
added the new
application/vnd.m2.m006.m005+xmlenum value to the/////////response property for the response status - warning
added the new
application/vnd.nordea.investments.abasec.pos+csvenum value to the/////////response property for the response status - warning
added the new
application/vnd.nordea.investments.abasec.pos+csvenum value to the/////////response property for the response status - warning
added the new
application/vnd.nordea.investments.abasec.tra+csvenum value to the/////////response property for the response status - warning
added the new
application/vnd.nordea.investments.abasec.tra+csvenum value to the/////////response property for the response status - warning
added the new
application/zipenum value to the/////////response property for the response status - warning
added the new
application/zipenum value to the/////////response property for the response status - warning
added the new
text/csvenum value to the/////////response property for the response status - warning
added the new
text/csvenum value to the/////////response property for the response status - info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
///to the response with the status - info
added the optional property
//to the response with the status
- breaking