Skip to main content

Create a ledger billing group report

POST 
/ledger_billing_group_reports

Create a ledger billing group report

Request ​

Body

required

New ledger billing group report parameters

    year integer

    Year of the ledger billing group report

    month integer

    Month of the ledger billing group report

Responses ​

200: Expected ledger billing group report response to a valid request

Schema

    data

    object

    record_type string

    Possible values: [ledger_billing_group_report]

    Identifies the type of the resource.

    id uuid

    Identifies the type of resource.

    organization_id uuid

    Uniquely identifies the organization that owns the resource.

    status string

    Possible values: [pending, complete, failed, deleted]

    Status of the ledger billing group report

    report_url stringnullable

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

    created_at date-time

    ISO 8601 formatted date indicating when the resource was created.

    updated_at date-time

    ISO 8601 formatted date indicating when the resource was updated.

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

    • code intrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta object

  • ]

Request samples

curl -L 'https://api.telnyx.com/v2/ledger_billing_group_reports' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "year": 2019,
  "month": 10
}'

Response samples

{
  "data": {
    "record_type": "ledger_billing_group_report",
    "id": "f5586561-8ff0-4291-a0ac-84fe544797bd",
    "organization_id": "f5586561-8ff0-4291-a0ac-84fe544797bd",
    "report_url": "https://example.com",
    "created_at": "2019-10-15T10:07:15.527Z",
    "updated_at": "2019-10-15T10:07:15.527Z"
  }
}