Ctrl+K

Create an admin statement

post/api/v2/admin/enterprise/statements

Request Body

type string required
The type of statement
Allowed values: quarterly monthly
startDate string <date-time>required
The start date of the statement
trustOrgs array[string]
The trust organizations
Allowed values: BitGo Trust BitGo New York BitGo Germany BitGo Switzerland BitGo Europe ApS Frankfurt DE Trust BitGo Singapore BitGo Korea BitGo Custody MENA FZE BitGo India BitGo Sister Trust 1
enterprises array[string]
The public ids of the enterprises
format string
The report format
Allowed values: csv pdf
backFill boolean
Whether to backfill or not
priority number
The priority of the statement generation job
disableNotification boolean
Don't send email notification to enterprise admin if this is set to true
allowNegativeValues boolean
Allow negative balance in the statement

201 Response

statements array[object] required
The statements
priority number required
The priority of the statement generation job
disableNotification boolean required
Don't send email notification to enterprise admin if this is set to true
allowNegativeValues boolean required
Allow negative balances in the statement
id string required
The statement id
Min length: >= 1 characters
enterprise string required
The enterprise
Min length: >= 1 characters
type string required
The statement type
Allowed values: quarterly monthly
format string required
The report format
Allowed values: csv pdf
status string required
The report status
Allowed values: pending processing completed failed
startDate string <date-time>required
The statement start date
endDate string <date-time>required
The statement end date
completedAt string <date-time>
The date the statement was completed
documentName string
The name of the document
Min length: >= 1 characters
displayName string
The display name of the statement
Min length: >= 1 characters

400 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

401 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

403 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

404 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

500 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id