bill

Fetch bill records matching the supplied arguments.

Arguments

Argument	Type	Required	Default	Description
`id`	`String`!	Yes		Filter by ID; pass the public API ID unless the field name says legacy ID. Required.
`analyze`	`Boolean`	No		If true, the query will only be analyzed (cost estimated) without executing it.

Return Type

BillQueryResult

Query

query bill(
  $id: String!,
  $analyze: Boolean
) {
  bill(
    id: $id,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...BillFragment
    
      id
      legacy_id
      status
      customer_name
      profile_name
      created_at
      due_date
      amount
      totals {
        ...FeeCategoryTotalConnectionFragment
      
        pageInfo {
          ...PageInfoFragment
        
          hasNextPage
          hasPreviousPage
          startCursor
          endCursor
        }
        edges {
          ...FeeCategoryTotalEdgeFragment
        
          node {
            ...FeeCategoryTotalFragment
          
            id
            legacy_id
            amount
            label
            category
            quantity
          }
          cursor
        }
      }
      bill_exports {
        ...BillExportsConnectionFragment
      
        pageInfo {
          ...PageInfoFragment
        
          hasNextPage
          hasPreviousPage
          startCursor
          endCursor
        }
        edges {
          ...BillExportsEdgeFragment
        
          node {
            ...BillExportsFragment
          
            id
            legacy_id
            status
            file_url
          }
          cursor
        }
      }
      billing_period {
        ...BillingPeriodFragment
      
        start
        end
      }
      billing_frequency
    }
  }
}

Variables

{
  "id": "UmVjb3JkOjEyMzQ=",
  "analyze": true
}

Response

{
  "data": {
    "bill": {
      "request_id": "UmVjb3JkOjEyMzQ=",
      "complexity": 100,
      "data": {id: "QmlsbDoxMjM0"}
    }
  }
}