Organization API: Billing & Payouts: Statements

The 7 Organization API operations for statements.

View as Markdown

Operations

Method	Path	Summary
GET	`/api/v1/orgs/{org_slug}/statements`	Org list statements
POST	`/api/v1/orgs/{org_slug}/statements/generate`	Org generate statement
GET	`/api/v1/orgs/{org_slug}/statements/options-catalog`	Org statements options catalog
GET	`/api/v1/orgs/{org_slug}/statements/{statement_id}`	Org get statement
DELETE	`/api/v1/orgs/{org_slug}/statements/{statement_id}`	Org delete statement
GET	`/api/v1/orgs/{org_slug}/statements/{statement_id}/csv`	Org statement CSV
GET	`/api/v1/orgs/{org_slug}/statements/{statement_id}/pdf`	Org statement pdf

Org list statements

Section titled Org list statements

GET /api/v1/orgs/{org_slug}/statements

Parameters

Section titled Parameters

Name	In	Type	Required	Description
`org_slug`	path	string	yes
`limit`	query	integer	no	Default: `50`.
`offset`	query	integer	no	Default: `0`.

Responses

Section titled Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org generate statement

Section titled Org generate statement

POST /api/v1/orgs/{org_slug}/statements/generate

Parameters

Section titled Parameters

Name	In	Type	Required
`org_slug`	path	string	yes

Request body

Section titled Request body

application/json (required)

Field	Type	Required
`period_start`	string (date-time)	yes
`period_end`	string (date-time)	yes
`force`	boolean	no
`notes`	string or null	no
`options`	StatementGenerateOptions or null	no
`options.include`	StatementIncludeOptions or null	no
`options.presentation`	StatementPresentationOptions or null	no

Responses

Section titled Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org statements options catalog

Section titled Org statements options catalog

GET /api/v1/orgs/{org_slug}/statements/options-catalog

Parameters

Section titled Parameters

Name	In	Type	Required
`org_slug`	path	string	yes

Responses

Section titled Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org get statement

Section titled Org get statement

GET /api/v1/orgs/{org_slug}/statements/{statement_id}

Parameters

Section titled Parameters

Name	In	Type	Required
`statement_id`	path	integer	yes
`org_slug`	path	string	yes

Responses

Section titled Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org delete statement

Section titled Org delete statement

DELETE /api/v1/orgs/{org_slug}/statements/{statement_id}

Parameters

Section titled Parameters

Name	In	Type	Required
`statement_id`	path	integer	yes
`org_slug`	path	string	yes

Responses

Section titled Responses

Status	Meaning
`204`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org statement CSV

Section titled Org statement CSV

GET /api/v1/orgs/{org_slug}/statements/{statement_id}/csv

Parameters

Section titled Parameters

Name	In	Type	Required
`statement_id`	path	integer	yes
`org_slug`	path	string	yes

Responses

Section titled Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org statement pdf

Section titled Org statement pdf

GET /api/v1/orgs/{org_slug}/statements/{statement_id}/pdf

Parameters

Section titled Parameters

Name	In	Type	Required
`statement_id`	path	integer	yes
`org_slug`	path	string	yes

Responses

Section titled Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.