Financials | Accounting Document
The Accounting Document represents the accounting document information of the a transaction (eg. sales invoice).(RESERVED FOR INTERNAL USE.).
Overview
| URL | api/{tenantKey}/{orgKey}/financialCore/accountDocuments |
| Methods Supported | GET |
All Operations
This service includes the following operations:
-
GET:
- GET AccountDocuments
- GET AccountDocuments (paged)
- GET AccountDocument by identifier
- GET AccountDocument by key
- GET Print AccountDocument by identifier
- GET Print AccountDocument by key
- GET Original Print AccountDocumentOriginal by identifier
- GET Original Print AccountDocument by key
- GET Get All Account Documents
All Resources
This service uses the following resources:
All Enumerations
This service uses the following enumerations:
GET AccountDocuments
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See AccountDocumentResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/financialCore/accountDocuments
GET /financialCore/accountDocuments
GET AccountDocuments (paged)
Returns a page of the list of all the entity records available.
The following elements are optional:
| page | (int) The index of the page of the list that should be returned. This is a query string parameter. |
| pageSize | (int) The number of page elements that should be returned (max. is 1000). This is a query string parameter. |
Response:
| When successful, the response body contains the list of records available. See AccountDocumentResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/financialCore/accountDocuments?page={page}&pageSize={pageSize}
GET /financialCore/accountDocuments?page={page}&pageSize={pageSize}
GET AccountDocument by identifier
Returns the entity record that matches the specified identifier.
The following elements are required:
| id | (string) The record identifier. |
Response:
| When successful, the response body contains the entity record. See AccountDocumentResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/financialCore/accountDocuments/{id}
GET /financialCore/accountDocuments/{id}
GET AccountDocument by key
Returns the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| journalType | (string) The journal type. |
| journalNumber | (int) The journal number. |
| financialYear | (string) The financial year. |
| ledger | (string) The ledger key. |
Response:
| When successful, the response body contains the entity record. See AccountDocumentResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/financialCore/accountDocuments/{companyKey}/{journalType}/{journalNumber}/{financialYear}/{ledger}
GET /financialCore/accountDocuments/{companyKey}/{journalType}/{journalNumber}/{financialYear}/{ledger}
GET Print AccountDocument by identifier
Prints the specified entity record.
The following elements are required:
| id | (string) The record identifier. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 404 | NotFound. The specified resord does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/financialCore/accountDocuments/{id}/print?template={template}
GET /financialCore/accountDocuments/{id}/print?template={template}
GET Print AccountDocument by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| journalType | (string) The journal type. |
| journalNumber | (int) The journal number. |
| financialYear | (string) The financial year. |
| ledger | (string) The ledger key. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/financialCore/accountDocuments/{companyKey}/{journalType}/{journalNumber}/{financialYear}/{ledger}/print
GET /financialCore/accountDocuments/{companyKey}/{journalType}/{journalNumber}/{financialYear}/{ledger}/print
GET Original Print AccountDocumentOriginal by identifier
Prints the specified entity record.
The following elements are required:
| id | (string) The record identifier. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 404 | NotFound. The specified resord does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/financialCore/accountDocuments/{id}/printOriginal?template={template}
GET /financialCore/accountDocuments/{id}/printOriginal?template={template}
GET Original Print AccountDocument by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| journalType | (string) The journal type. |
| journalNumber | (int) The journal number. |
| financialYear | (string) The financial year. |
| ledger | (string) The ledger key. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/financialCore/accountDocuments/{companyKey}/{journalType}/{journalNumber}/{financialYear}/{ledger}/printOriginal
GET /financialCore/accountDocuments/{companyKey}/{journalType}/{journalNumber}/{financialYear}/{ledger}/printOriginal
GET Get All Account Documents
This operation gets all Account Documents.
The following elements are required:
| pageIndex | (int) The page index. |
| pageSize | (int) The page size. |
Response:
| When successful, the response body contains a list of resources of type 'AccountDocumentResource'. See AccountDocumentResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/financialCore/accountDocuments/getAllAccountDocuments
GET /financialCore/accountDocuments/getAllAccountDocuments
Resources
AccountDocumentLineResource
The following elements are required:
| gLAccount | (string) The GL account. |
| chartOfAccount | (string) The chart of account. |
| currency | (string) The document line currency. |
| creditTotal | (MoneyResource) The credit amount.
See MoneyResource . |
| debitTotal | (MoneyResource) The debit amount.
See MoneyResource . |
The following elements are optional:
| party | (string) The party (when applicable). |
| cashFlowItem | (string) The cash flow item. |
| dimensionSet | (string) The document line dimension set. |
| dimensionSetJson | (string) The json representation of the dimension set (Internal). |
| exchangeRate | (decimal) The exchange rate between document currency and base currency. |
| reportingExchangeRate | (decimal) The exchange rate between document currency and reporting currency. |
| amountCreditBase | (string) The credit amount in base currency. |
| amountCreditReporting | (string) The credit amount in reporting currency. |
| amountDebitBase | (string) The debit amount in base currency. |
| amountDebitReporting | (string) The debit amount in reporting currency. |
| accountingNature | (enum AccountingNature) The accounting nature is the nature (debit or credit) of the movement.
See AccountingNature. |
AccountDocumentResource
The following elements are required:
| company | (string) The company key. |
| journalType | (string) The journal type. |
| journalNumber | (int) The journal number. |
| financialYear | (string) The financial year. |
| ledger | (string) The ledger key. |
| postingDate | (DateTime) The posting date. |
| sourceSchemaEntity | (string) The source schema entity. |
| chartOfAccount | (string) The chart of accounts. |
| currency | (string) The original currency of the document. |
| amountCreditTotal | (decimal) The total credit amount in document currency. |
| amountDebitTotal | (decimal) The total debit amount in document currency. |
The following elements are optional:
| documentDate | (DateTime) The document date. |
| period | (int) The financial period. |
| accountDocumentLines | (List of AccountDocumentLineResource) The list of document lines.
See AccountDocumentLineResource. |
| sourceDoc | (string) The source document. |
| note | (string) The reference of the posting. |
| sourceDocId | (Guid) The source document id. |
| amountCreditBase | (string) The total credit amount in base currency. |
| amountCreditReporting | (string) The total credit amount in reporting currency. |
| amountDebitBase | (string) The total debit amount in base currency. |
| amountDebitReporting | (string) The total debit amount in reporting currency. |
| party | (string) The party. |
| periodName | (string) The period name (internal). |
| isPrinted | (bool) Is Printed. |
| printedReportName | (string) Indicates the report name used to print the document. Internally determined. |
| isReprinted | (bool) Indicates if the document has been reprinted. Internally determined. |
| isSigned | (bool) Indicates if the document is electronically signed with a valid certificate. Internally determined. |
MoneyResource
The following elements are required:
| amount | (decimal) The amount. |
The following elements are optional:
| baseAmount | (decimal) The base amount. |
| reportingAmount | (decimal) The reporting amount. |
| fractionDigits | (int) The fraction digits. |
| symbol | (string) The symbol. |
Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.