Reports

Reports

Create a ledger billing group report

SecuritybearerAuth
Request
Request Body schema: application/json
required

New ledger billing group report parameters

month
integer

Month of the ledger billing group report

year
integer

Year of the ledger billing group report

Responses
200

Expected ledger billing group report response to a valid request

Response Schema: application/json
object (LedgerBillingGroupReport)
created_at
string <date-time>

ISO 8601 formatted date indicating when the resource was created.

id
string <uuid>

Identifies the type of resource.

organization_id
string <uuid>

Uniquely identifies the organization that owns the resource.

record_type
string

Identifies the type of the resource.

Value: "ledger_billing_group_report"
report_url
string <string>

External url of the ledger billing group report, if the status is complete

status
string <string>

Status of the ledger billing group report

Enum: "pending" "complete" "failed" "deleted"
updated_at
string <date-time>

ISO 8601 formatted date indicating when the resource was updated.

default

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
post/ledger_billing_group_reports
Request samples
application/json
{
  • "month": 10,
  • "year": 2019
}
Response samples
application/json
{
  • "data": {
    • "created_at": "2019-10-15T10:07:15.527Z",
    • "id": "f5586561-8ff0-4291-a0ac-84fe544797bd",
    • "organization_id": "f5586561-8ff0-4291-a0ac-84fe544797bd",
    • "record_type": "ledger_billing_group_report",
    • "report_url": "https://example.com",
    • "updated_at": "2019-10-15T10:07:15.527Z"
    }
}

Retrieve a ledger billing group report

SecuritybearerAuth
Request
path Parameters
id
required
string <uuid>

The id of the ledger billing group report

Responses
200

Expected ledger billing group report response to a valid request

Response Schema: application/json
object (LedgerBillingGroupReport)
created_at
string <date-time>

ISO 8601 formatted date indicating when the resource was created.

id
string <uuid>

Identifies the type of resource.

organization_id
string <uuid>

Uniquely identifies the organization that owns the resource.

record_type
string

Identifies the type of the resource.

Value: "ledger_billing_group_report"
report_url
string <string>

External url of the ledger billing group report, if the status is complete

status
string <string>

Status of the ledger billing group report

Enum: "pending" "complete" "failed" "deleted"
updated_at
string <date-time>

ISO 8601 formatted date indicating when the resource was updated.

default

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
get/ledger_billing_group_reports/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "created_at": "2019-10-15T10:07:15.527Z",
    • "id": "f5586561-8ff0-4291-a0ac-84fe544797bd",
    • "organization_id": "f5586561-8ff0-4291-a0ac-84fe544797bd",
    • "record_type": "ledger_billing_group_report",
    • "report_url": "https://example.com",
    • "updated_at": "2019-10-15T10:07:15.527Z"
    }
}