JUjustifi
Proceeds

Get a Proceeds Report

[DEPRECATION WARNING] This endpoint will be deprecated, please use Reports API.

get/reports/proceeds/{id}

Request

Path parameters

idstring uuid required

Headers

Authorizationstring required

the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)

Response

Successfully get a link to a csv and json report for a proceeds payout

idstring uuid

the object id, also found in the data object

typestring

the object type, or array of objects

page_infounknown

Example response

{
  "id": "prefix_xyz (same as id of data object)",
  "type": "procceds",
  "data": {
    "id": "po_xyz",
    "csv_url": "https://justifi-test-platform-proceeds-reports.s3.amazonaws.com/acc_1234lkj/po_23jdfi36dqhj.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=test",
    "report_url": "https://justifi-test-platform-proceeds-reports.s3.amazonaws.com/acc_1234lkj/po_23jdfi36dqhj.json?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=test"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.