Financials | Account Transaction

Service to manage entities of type 'AccountTransaction'.

Overview

api/{tenantKey}/{orgKey}/financialCore/accountTransactions

URL	api/{tenantKey}/{orgKey}/financialCore/accountTransactions
Methods Supported	GET, POST

All Operations

This service includes the following operations:

GET:
POST:
- POST AccountTransactions
- POST Annul Account Transaction

All Resources

This service uses the following resources:

AccountTransactionResource
ApiAccountTransactionResource

All Enumerations

This service uses the following enumerations:

Nature

GET Operations

GET AccountTransactions

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See AccountTransactionResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/accountTransactions

GET /financialCore/accountTransactions

GET AccountTransactions (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 AccountTransactionResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/accountTransactions?page={page}&pageSize={pageSize}

GET /financialCore/accountTransactions?page={page}&pageSize={pageSize}

GET AccountTransaction 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 AccountTransactionResource.

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/accountTransactions/{id}

GET /financialCore/accountTransactions/{id}

GET AccountTransaction by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
accountTransactionKey	(int) The account transaction's key.

Response:

When successful, the response body contains the entity record. See AccountTransactionResource.

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/accountTransactions/{companyKey}/{accountTransactionKey}

GET /financialCore/accountTransactions/{companyKey}/{accountTransactionKey}

GET Print AccountTransaction 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/accountTransactions/{id}/print?template={template}

GET /financialCore/accountTransactions/{id}/print?template={template}

GET Print AccountTransaction by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
accountTransactionKey	(int) The account transaction's 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/accountTransactions/{companyKey}/{accountTransactionKey}/print

GET /financialCore/accountTransactions/{companyKey}/{accountTransactionKey}/print

GET Original Print AccountTransactionOriginal 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/accountTransactions/{id}/printOriginal?template={template}

GET /financialCore/accountTransactions/{id}/printOriginal?template={template}

GET Original Print AccountTransaction by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
accountTransactionKey	(int) The account transaction's 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/accountTransactions/{companyKey}/{accountTransactionKey}/printOriginal

GET /financialCore/accountTransactions/{companyKey}/{accountTransactionKey}/printOriginal

GET Get External Account Transaction

Custom operation 'GetExternalAccountTransaction'.

The following elements are required:

externalId

(string) ExternalId.

Response:

When successful, the response body contains a resource of type 'AccountTransactionResource'. See AccountTransactionResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/accountTransactions/getExternalAccountTransaction

GET /financialCore/accountTransactions/getExternalAccountTransaction

POST Operations

POST AccountTransactions

Creates a new entity record.

The following elements are required:

accountTransactionResource

(ApiAccountTransactionResource) The request body should contain the entity record that should be created.
See ApiAccountTransactionResource.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiAccountTransactionResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/accountTransactions

POST /financialCore/accountTransactions

POST Annul Account Transaction

Custom operation 'AnnulAccountTransaction'.

The following elements are required:

externalId

(string) ExternalId.

Response:

When successful, the response body is empty.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/accountTransactions/annulAccountTransaction

POST /financialCore/accountTransactions/annulAccountTransaction

Resources

AccountTransactionResource

The following elements are required:

accountTransactionKey	(int) The account transaction's key.
company	(string) Company.
postingDate	(DateTime) Posting Date.
fiscalYear	(int) Fiscal Year.
period	(int) Period.
currency	(string) Currency.
amount	(decimal) Amount.
transactionAccount	(string) Transaction Account.
nature	(enum Nature) Nature. See Nature.
isExternallyManaged	(bool) Is Externally Managed.
taxTotalAmount	(decimal) Tax Total Amount.
taxExclusiveAmount	(decimal) Tax Exclusive Amount.

The following elements are optional:

party	(string) Party.
sourceDoc	(string) Source Doc.
sourceDocId	(Guid) Source Doc Id.
sourceLineId	(Guid) Source Line Id.
sourceSchemaEntity	(string) Source Schema Entity.
sourceDocPartyName	(string) Source Doc Party Name.
sourceDocItemName	(string) Source Doc Item Name.
item	(string) Item.
externalId	(string) External Id.
externalVersion	(string) External Version.

ApiAccountTransactionResource

The following elements are required:

accountTransactionKey	(int) The account transaction's key.
company	(string) Company.
postingDate	(DateTime) Posting Date.
currency	(string) Currency.
amount	(decimal) Amount.
transactionAccount	(string) Transaction Account.
nature	(enum Nature) Nature. See Nature.
isExternallyManaged	(bool) Is Externally Managed.
taxTotalAmount	(decimal) Tax Total Amount.
taxExclusiveAmount	(decimal) Tax Exclusive Amount.

The following elements are optional:

party	(string) Party.
sourceDoc	(string) Source Doc.
sourceDocId	(Guid) Source Doc Id.
sourceLineId	(Guid) Source Line Id.
sourceSchemaEntity	(string) Source Schema Entity.
sourceDocPartyName	(string) Source Doc Party Name.
sourceDocItemName	(string) Source Doc Item Name.
item	(string) Item.
externalId	(string) External Id.
externalVersion	(string) External Version.

Enumerations

Nature

1	Debit
2	Credit