Jasmin Developers - Web API Reference

Financials | Account Transaction

Service to manage entities of type 'AccountTransaction'.

Overview


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

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

All Enumerations

This service uses the following enumerations:

GET Operations

GET AccountTransactions (odata)

Returns a page of the list of all the entity records available.

The following elements are optional:

opts (ODataQueryOptions) OData query option.

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:

GET /financialCore/accountTransactions/odata

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:

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:

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

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:

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:

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:

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 (MoneyResource) Amount.
See MoneyResource .
transactionAccount (string) Transaction Account.
nature (enum Nature) Nature.
See Nature.
isExternallyManaged (bool) Is Externally Managed.
taxTotalAmount (MoneyResource) Tax Total Amount.
See MoneyResource .
taxExclusiveAmount (MoneyResource) Tax Exclusive Amount.
See MoneyResource .

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 (MoneyResource) Amount.
See MoneyResource .
transactionAccount (string) Transaction Account.
nature (enum Nature) Nature.
See Nature.
isExternallyManaged (bool) Is Externally Managed.
taxTotalAmount (MoneyResource) Tax Total Amount.
See MoneyResource .
taxExclusiveAmount (MoneyResource) Tax Exclusive Amount.
See MoneyResource .

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.


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.



Enumerations


Nature

1 Debit
2 Credit