Company Statements

Schedule a statement generation

POST {base url}/api/v1/company_statements/

This request allows you to schedule statement generation for a company. The response will include an object with fields such as id, status, and download_url. These are the key fields to focus on.

Headers

Name	Type	Description
Content-Type*	String	application/json
Authorization*	String	Bearer
Token*	String	{{secret key}}

201: Created

Payload

{
  "format": "csv",
  "timezone": "UTC"
}

Response

Optional Parameters

Retrieve a statement by ID.

GET {base url}/api/v1/company_statements/{id}/

Headers

Name	Type	Description
Content-Type*	String	application/json
Authorization*	String	Bearer {{secret key}}

200: OK

Response

{
  "format": "csv",
  "timezone": "UTC",
  "is_test": false,
  "company_uid": "706d0675-b131-468c-940d-bc0ea3599e7f",
  "query_string": "",
  "status": "success",
  "download_url": "https://paytota-private.s3.af-south-1.amazonaws.com/706d0675-b131-468c-940d-bc0ea3599e7f/src/statement/022b9a1f-1411-4d60-b7e9-4e7daaf6903b?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2DOUUV7G3EN%2F20231026%2Faf-south-1%2Fs3%2Faws4_request&X-Amz-Date=20231026T124044Z&X-Amz-pires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=e7fd9eda97b07abadb9caad3f555a9a06815db541a4bec11110a87ed699d",
  "began_on": 1698322277,
  "finished_on": 1698322277,
  "created_on": 1698322275,
  "updated_on": 1698322277,
  "type": "statement_request",
  "id": "1dd24660-527d-422a-9bfa-937c5b752eb0"
}