Jasmin Developers - Web API Reference

Financials | Summary Value

Overview


URL api/{tenantKey}/{orgKey}/financialCore/summaryValues
Methods Supported GET

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET Get Purchases Open Card Data

Custom operation 'GetPurchasesOpenCardData'.

The following elements are required:

company (string) Company.

Response:

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

Response status codes:

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

Resource URL:

GET /financialCore/summaryValues/getPurchasesOpenCardData/{company}

GET Get Sales Open Card Data

Custom operation 'GetSalesOpenCardData'.

The following elements are required:

company (string) Company.

Response:

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

Response status codes:

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

Resource URL:

GET /financialCore/summaryValues/getSalesOpenCardData/{company}

GET Get Purchases Open List Count

Custom operation 'GetPurchasesOpenListCount'.

The following elements are required:

company (string) Company.
code (string) Code.

Response:

When successful, the response body contains an item of type 'number'.

Resource URL:

GET /financialCore/summaryValues/getPurchasesOpenListCount/{company}/{code}

GET Get Sales Open List Count

Custom operation 'GetSalesOpenListCount'.

The following elements are required:

company (string) Company.
code (string) Code.

Response:

When successful, the response body contains an item of type 'number'.

Resource URL:

GET /financialCore/summaryValues/getSalesOpenListCount/{company}/{code}

GET Get Purchases Open List Data

Custom operation 'GetPurchasesOpenListData'.

The following elements are required:

company (string) Company.
code (string) Code.

Response:

When successful, the response body contains a list of resources of type 'OpenListData'. See OpenListData.

Response status codes:

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

Resource URL:

GET /financialCore/summaryValues/getPurchasesOpenListData/{company}/{code}

GET Get Sales Open List Data

Custom operation 'GetSalesOpenListData'.

The following elements are required:

company (string) Company.
code (string) Code.

Response:

When successful, the response body contains a list of resources of type 'OpenListData'. See OpenListData.

Response status codes:

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

Resource URL:

GET /financialCore/summaryValues/getSalesOpenListData/{company}/{code}

Resources


NamedSummarizedValue

The following elements are required:

amount (decimal) Amount.
typeAmount (string) Type Amount.
fractionDigits (int) Fraction Digits.
currencySymbol (string) Currency Symbol.
description (string) Description.


OpenListData

The following elements are required:

sourceDoc (string) Source Doc.
dueDate (DateTime) Due Date.
party (string) Party.
partyName (string) Party Name.
paymentMethod (string) Payment Method.
amount (decimal) Amount.
openAmount (decimal) Open Amount.
symbol (string) Symbol.
fractionDigits (int) Fraction Digits.

The following elements are optional:

sourceDocLink (string) Source Doc Link.
partyLink (string) Party Link.
operation (string) Operation.
operationLink (string) Operation Link.