What a period's figures were built from: posted entries by origin and by source journal
GET
/v1/entities/{entity_id}/reports/composition
const url = 'https://example.com/v1/entities/example/reports/composition';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/v1/entities/example/reports/compositionCount a period’s posted entries per origin and per source journal. Counts, not a verdict.
A reader looking at a nearly empty income statement wants to know whether that is what the books say or only what has been loaded so far. The other reports cannot tell, because an absent invoice looks the same as one never issued. Here, a book loaded from its bank statement alone and a book with nothing to report look different, and neither is called wrong.
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”entity_id
required
Entity Id
The entity this path is relative to
string
The entity this path is relative to
Query Parameters
Section titled “Query Parameters”Responses
Section titled “Responses”Successful Response
Media typeapplication/json
Composition
object
entity_id
required
Entity Id
string
legal_name
required
Legal Name
string
base_currency
required
Base Currency
string
snapshot_seq
required
Snapshot Seq
integer
report
required
Report
string
origins
required
Origins
object
key
additional properties
integer
journals
required
Journals
object
key
additional properties
integer
entry_count
required
Entry Count
integer
links
required
Links
object
key
additional properties
string
Example generated
{ "entity_id": "example", "legal_name": "example", "base_currency": "example", "snapshot_seq": 1, "report": "example", "start": "example", "end": "example", "origins": { "additionalProperty": 1 }, "journals": { "additionalProperty": 1 }, "entry_count": 1, "links": { "additionalProperty": "example" }}Bad Request
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Unauthorized
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Forbidden
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Not Found
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Conflict
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Precondition Failed
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Unprocessable Content
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Internal Server Error
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Service Unavailable
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}