API

Sales APIs

GET sales/billing-accounting-period-years/{year}

Sales billing for a specific year by accounting periods

HTTP method GET
URI https://api.rambase.net/sales/billing-accounting-period-years/{year}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {year} Billing year
Integer
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 5714, version 3

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.

AssetId Integer Asset identifier.
Currency String Three character code following the ISO 4217 standard.
CustomerId Integer Customer identifier.
DepartmentId Integer Department identifier.
FinanceProjectId Integer Finance project identifier.
GeneralLedgerAccountId Integer General ledger account identifier.
ProductId Integer Product identifier.

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

AssetId Integer Asset identifier
Currency String Three character code following the ISO 4217 standard
CustomerId Integer Customer identifier
DepartmentId Integer Department identifier
FinanceProjectId Integer Finance project identifier
GeneralLedgerAccountId Integer General ledger account identifier
ProductId Integer Product identifier

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
<BillingAccountingPeriodYear>
2
     <Year
Year

Billing year

>{Integer}</Year>
3
     <BillingAccountingPeriods>
4
          <BillingAccountingPeriod>
5
               <AccountingPeriodId
AccountingPeriodId

Accounting period identifier

>{Integer}</AccountingPeriodId>
6
               <Period
Period

Accounting period

>{Integer}</Period>
7
               <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
8
               <Amount
Amount

Billing period amount

>{Decimal}</Amount>
9
               <InvoicedAmount
InvoicedAmount

Billing period invoiced amount

>{Decimal}</InvoicedAmount>
10
               <CreditedAmount
CreditedAmount

Billing period credited amount

>{Decimal}</CreditedAmount>
11
               <AccountingPeriodLink
AccountingPeriodLink

Accounting period reference

>{String}</AccountingPeriodLink>
12
          </BillingAccountingPeriod>
13
     </BillingAccountingPeriods>
14
     <Totals>
15
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
16
          <Amount
Amount

Total amount.

>{Decimal}</Amount>
17
          <InvoicedAmount
InvoicedAmount

Total invoiced amount

>{Decimal}</InvoicedAmount>
18
          <CreditedAmount
CreditedAmount

Total credited amount

>{Decimal}</CreditedAmount>
19
     </Totals>
20
</BillingAccountingPeriodYear>
1
{
2
     "billingAccountingPeriodYear": {
3
          "year
Year

Billing year

": "{Integer}",
4
          "billingAccountingPeriods": [
5
               {
6
                    "accountingPeriodId
AccountingPeriodId

Accounting period identifier

": "{Integer}",
7
                    "period
Period

Accounting period

": "{Integer}",
8
                    "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
9
                    "amount
Amount

Billing period amount

": "{Decimal}",
10
                    "invoicedAmount
InvoicedAmount

Billing period invoiced amount

": "{Decimal}",
11
                    "creditedAmount
CreditedAmount

Billing period credited amount

": "{Decimal}",
12
                    "accountingPeriodLink
AccountingPeriodLink

Accounting period reference

": "{String}"
13
               }
14
          ],
15
          "totals": {
16
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
17
               "amount
Amount

Total amount.

": "{Decimal}",
18
               "invoicedAmount
InvoicedAmount

Total invoiced amount

": "{Decimal}",
19
               "creditedAmount
CreditedAmount

Total credited amount

": "{Decimal}"
20
          }
21
     }
22
}

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: