API

Finance APIs

GET finance/accounts-receivable-transactions/totals

Aggregated values of Amount and VAT amount for accounts receivable transactions

HTTP method GET
URI https://api.rambase.net/finance/accounts-receivable-transactions/totals
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 5083, version 1

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.

Read more about filters and sorting on how to use filter parameters and named filters.

ActiveReceivTrans() Named filter Active receivable transactions (status between 1 and 9)
ImportedReceivTrans() Named filter Imported receivable transactions
AccountingPeriod Integer Accounting period. Available macros: currentPeriod(), previousPeriod()
AccountsReceivableTransactionId Integer Accounts payable transaction identifier.
Currency String Three character code following the ISO 4217 standard.
CustomerId Integer Customer identifier.
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person).
IssueDate Date Date when the document was issued. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ReferenceObjectType String Type of object.
Status Integer Status of accounts payable transaction.
TotalAmount Decimal Total amount.
TotalAmountConverted Decimal Total amount.
VATRegistrationNumber String Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

Read more about filters and sorting on how to use sortable parameters

AccountingPeriod Integer Accounting period
AccountsReceivableTransactionId Integer Accounts payable transaction identifier
Currency String Three character code following the ISO 4217 standard
CustomerId Integer Customer identifier
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person)
IssueDate Date Date when the document was issued.
ReferenceObjectType String Type of object
Status Integer Status of accounts payable transaction
TotalAmount Decimal Total amount
TotalAmountConverted Decimal Total amount
VATRegistrationNumber String Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<Total>
2
     <ConvertedVATAmount
ConvertedVATAmount

Amount/{SYSCUR}

>{Decimal}</ConvertedVATAmount>
3
     <ConvertedAmount
ConvertedAmount

Amount/{SYSCUR}

>{Decimal}</ConvertedAmount>
4
</Total>
1
{
2
     "total": {
3
          "convertedVATAmount
ConvertedVATAmount

Amount/{SYSCUR}

": "{Decimal}",
4
          "convertedAmount
ConvertedAmount

Amount/{SYSCUR}

": "{Decimal}"
5
     }
6
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 102738 HTTP 404 Price list not found