curl --request GET \
--url https://api.exowpee.com/v1/accounting/organization/books/{fiscalEvent}/fiscal-events/{fiscal_event} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.exowpee.com/v1/accounting/organization/books/{fiscalEvent}/fiscal-events/{fiscal_event}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.exowpee.com/v1/accounting/organization/books/{fiscalEvent}/fiscal-events/{fiscal_event}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.exowpee.com/v1/accounting/organization/books/{fiscalEvent}/fiscal-events/{fiscal_event}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.exowpee.com/v1/accounting/organization/books/{fiscalEvent}/fiscal-events/{fiscal_event}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.exowpee.com/v1/accounting/organization/books/{fiscalEvent}/fiscal-events/{fiscal_event}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.exowpee.com/v1/accounting/organization/books/{fiscalEvent}/fiscal-events/{fiscal_event}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"owner_type": "<string>",
"profile": "<string>",
"subtype": "<string>",
"label": "<string>",
"description": "<string>",
"fiscal_year_id": "<string>",
"fiscal_year": {},
"provision_account_id": "<string>",
"provision_account": {},
"counterpart_account_id": "<string>",
"counterpart_account": {},
"subject_type": "<string>",
"subject_id": "<string>",
"amount": 123,
"reversed_amount": 123,
"remaining_amount": 123,
"status": "<string>",
"expected_reversal_on": "2023-12-25",
"currency_code": "<string>",
"currency_exponent": 123,
"dotation_journal_entry_id": "<string>",
"origin_journal_entry_id": "<string>",
"reversals": "<array>",
"created_by": "<string>",
"created_by_type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"message": "<string>",
"errors": {}
}View a fiscal event (organization)
Shows one fiscal event with its amounts and status (organization space).
curl --request GET \
--url https://api.exowpee.com/v1/accounting/organization/books/{fiscalEvent}/fiscal-events/{fiscal_event} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.exowpee.com/v1/accounting/organization/books/{fiscalEvent}/fiscal-events/{fiscal_event}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.exowpee.com/v1/accounting/organization/books/{fiscalEvent}/fiscal-events/{fiscal_event}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.exowpee.com/v1/accounting/organization/books/{fiscalEvent}/fiscal-events/{fiscal_event}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.exowpee.com/v1/accounting/organization/books/{fiscalEvent}/fiscal-events/{fiscal_event}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.exowpee.com/v1/accounting/organization/books/{fiscalEvent}/fiscal-events/{fiscal_event}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.exowpee.com/v1/accounting/organization/books/{fiscalEvent}/fiscal-events/{fiscal_event}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"owner_type": "<string>",
"profile": "<string>",
"subtype": "<string>",
"label": "<string>",
"description": "<string>",
"fiscal_year_id": "<string>",
"fiscal_year": {},
"provision_account_id": "<string>",
"provision_account": {},
"counterpart_account_id": "<string>",
"counterpart_account": {},
"subject_type": "<string>",
"subject_id": "<string>",
"amount": 123,
"reversed_amount": 123,
"remaining_amount": 123,
"status": "<string>",
"expected_reversal_on": "2023-12-25",
"currency_code": "<string>",
"currency_exponent": 123,
"dotation_journal_entry_id": "<string>",
"origin_journal_entry_id": "<string>",
"reversals": "<array>",
"created_by": "<string>",
"created_by_type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"message": "<string>",
"errors": {}
}fiscal_events.retrieve
Conditions
- The accounting module must be part of the organization’s plan.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Identifier of the accounting book (27-character KSUID string); the route parameter carries this name by mistake and does not name the event, which is given by fiscal_event.
Identifier of the fiscal event (27-character KSUID string).
Query Parameters
Response mode. Default resource; none answers 204 No Content.
resource Comma-separated JSON keys of the root resource (id is always rendered). Available: id, owner_type, profile, subtype, label, description, fiscal_year_id, provision_account_id, counterpart_account_id, subject_type, subject_id, amount, reversed_amount, status, expected_reversal_on, currency_code, currency_exponent, dotation_journal_entry_id, origin_journal_entry_id, created_by, created_by_type, created_at, updated_at, remaining_amount.
Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: provisionAccount, counterpartAccount, fiscalYear, reversals.
Response
Resource.
Identifier of the fiscal event (27-character KSUID string).
Kind of book that owns the event, set by the server from the selected book (organization or client).
Kind of event: provision, regularization (accruals and deferrals), derogatory_depreciation or reinvestment_gain. The last two are created by depreciation runs and disposals.
Subtype inside the profile, for example litigation, inventory, receivable, cca, pca, cap, par, derogatory.
Name of the event.
Free-text description, null when none was given.
Identifier of the fiscal year the event belongs to (27-character KSUID string).
The fiscal year, only when requested through include=fiscalYear and the caller may view fiscal years.
Identifier of the provision (balance sheet) account (27-character KSUID string).
The provision account, only when requested through include=provisionAccount and the caller may view accounting accounts.
Identifier of the counterpart (expense or income) account (27-character KSUID string).
The counterpart account, only when requested through include=counterpartAccount and the caller may view accounting accounts.
Type of record the event relates to; fixed_asset or null.
Identifier of the fixed asset the event relates to (27-character KSUID string), null when none.
Total amount of the event, in minor units (divide by 10 to the power currency_exponent).
Part of the amount already taken back, in minor units.
Amount still standing: amount minus reversed_amount, in minor units.
open (nothing taken back), partially_reversed, reversed (fully taken back) or cancelled (opening entry reversed).
Date the event is expected to be taken back (ISO 8601 date), null when not set.
Currency code of the event (ISO 4217), copied from the fiscal year.
Number of decimal places of the currency (0 for XOF). An amount in minor units divided by 10 to this power gives the amount in the currency.
Identifier of the opening (dotation) journal entry (27-character KSUID string), null when none.
Identifier of the journal entry of a depreciation run or disposal that opened the event, null for events opened by hand. Such events cannot be cancelled by hand.
The reversals recorded on the event, only when requested through include=reversals.
Identifier of the actor who created the event.
Type of the actor who created the event.
Date and time the record was created (ISO 8601, UTC).
Date and time the record was last changed (ISO 8601, UTC).