Retrieve the statements for a specific enterprise.

get/api/v2/admin/enterprise/{enterpriseId}/statements

Path Parameters

  • enterpriseIdstringRequired
    The enterprise id
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$

Query Parameters

  • limitstring<number>
    The limit of statements to return
  • createdAtGtstring<date-time>
    The date to filter statements created at
  • statementTypestring
    The type of statement
    Enum: quarterly monthly
  • prevIdstring
    Min length: >= 1 characters

200 Response

statements array[object] required
The list of statements
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
nextBatchPrevId string
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