Retrieve journal entries detail (JSON)
Action:GETEndpoint:
/views/credit/journalentries/detail
Retrieve journal entries detail for all credit accounts in a program. This endpoint returns a JSON object that contains an array of records matching your filter query.
Sample response body
The following sample shows a representative response for aGET request to the /views/journalentries/detail?program=my_program&fields=status,amount,created_time endpoint.
JSON
Retrieve journal entries detail (file export)
Action:GETEndpoint:
/views/credit/journalentries/detail/{export_type}
Retrieve journal entries detail for all credit accounts in a program and export to a file. This endpoint asynchronously generates a file in the specified format and returns a job token for retrieving the file when it is completed. The file contains a list of records matching your filter query.
URL path parameters
| Fields | Description |
|---|---|
| export_type string Required | File format in which to export the data. Allowable Values: csv |
Query parameters
| Fields | Description |
|---|---|
| compress string optional | Type of file compression for the exported file. Allowable Values: gz, zip Default value: gz |
Sample response body
JSON
Retrieve schema for journal entries detail
Action:GETEndpoint:
/views/credit/journalentries/detail/schema
Retrieve a JSON representation of the journal entries detail view schema. The schema object contains an array of objects that describe the available columns and the data type of each column.
Sample response body
The following sample shows a representative response for aGET request to the /views/journalentries/detail/schema?program=my_program endpoint. The schema can vary based on the data you are authorized to access (based on the credentials you provide in your request).
JSON