Ctrl+K

Get billing report by ID

get/api/v2/admin/billing/reports/{reportId}

Returns a billing report associated with the public ID.

Path Parameters

  • reportIdstringRequired
    The public ID of the billing report
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$

200 Response

report object
id string required
The report’s public ID
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
billingTaskId string required
The report’s public ID
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
userId string required
Public ID of the admin user who created this task
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
type string required
Allowed values: aum txn aggregate
created string <date-time>required
Timestamp of when this report was created
bitgoOrg string required
BitGo Organization related to this entity
Allowed values: BitGo Inc BitGo Trust BitGo New York BitGo Germany BitGo Switzerland Frankfurt DE Trust BitGo Sister Trust 1 BitGo Korea BitGo Singapore BitGo Europe ApS BitGo Mena Fze BitGo Custody MENA FZE BitGo India
enterpriseId string required
Public ID of the enterprise this report was generated for
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
pricingPlanId string required
Public ID of the pricing plan used to generate this report
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
month string required
The billing period month (MM)
Match pattern: ^(0[1-9]|1[0-2])$
year string required
The billing period year (YYYY)
Match pattern: ^([0-9]{4})$
s3Bucket string required
The S3 bucket this report was saved to
s3File string required
The S3 filename this report was saved as
invoiceId string
Invoice ID that this report relates to. Will not be set on an aggregate report
notes array[string]
List of notes that will be attached to each report linked to this billing task

400 Response

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