Billing API

Create and manage billing accounts, products, orders, services, billing, invoicing, payments, and the general ledger. This microservice provides core functionality for the Gotransverse billing platform.

For more information, please search through the Gotransverse online documentation:

Request Content-Types: application/json
Response Content-Types: application/json
Version: 2

Authentication

api_key_header

An authorization key that is assigned to perform an action in the system. Passed in the form of a X-Api-Key header that is attached to the call. e.g 325509ed604449279d4587c5e35e3235

type
apiKey
name
X-Api-Key
in
header

Action

The Action entity is a definition of the event that occurs in Gotransverse core. Actions may contain one or more operations.

Get actions

GET /actions

Retrieves a subset of existing actions using query keys.

filter: string
in query

Filters query results using the Gotransverse API Query Language. It allows API consumers to view response data evaluated against the specified filter criteria. For example, filter=(status EQ 'SUSPENDED') OR (status EQ 'ACTIVE') will return items in either SUSPENDED or ACTIVE status. For a list of comparison and logical operators as well as use cases, refer to the Filtering section in the API Getting Started guide.

sort: string[]
in query

Sorts query results in ascending or descending order. By default, query results are sorted in the ascending order. To sort in the descending order, insert - in front of the query parameter name. For example, sort=-name value sorts the results in the descending order by the name query parameter. For details and use cases, refer to the Sorting section in the API Getting Started guide.

Array values passed separated by comma: ?sort=aaa,bbb

return: string SIMPLE, FULL FULL
in query

Specifies the amount of detail to provide in a response. The value may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer HTTP header parameter to return=minimal, and FULL is the same as the header parameter set to return=representation.

page_number: integer (int32) x ≥ 0 1
in query

The page number for multiple page queries.

page_size: integer (int32) 0 ≤ x ≤ 50 50
in query

The page size for multiple page queries. Default maximum is 50.

id: string
in query

(sortable) The internal ID of the object.

product_id: string
in query

(sortable) The ID of the product.

action_type: string agreement, agreement-service, bill-cycle-run, bill-batch-run, billing-account, counter, credit-adjustment, disbursement, invoice, payment, product-sale, remote-prepaid-register, sales-order, service, service-cfv, system-notification, usage-rule, dunning, payment-plan, scheduled-payment
in query

The type of the action.

agreement_id: string
in query

(sortable) The ID of the agreement.

bill_cycle_id: string
in query

(sortable) The ID of the bill cycle.

200 OK

Success

type
400 Bad Request

Bad request.

default

Unknown error.

Response Example (200 OK)
[
  {
    "name": "string",
    "description": "string",
    "enabled": "boolean",
    "friendly_name": "string",
    "supports_approval": "boolean",
    "action_type": "string",
    "operations": [
      {
        "operation_discriminator_type": "string",
        "operation_type": "string",
        "name": "string",
        "enabled": "boolean",
        "id": "1438752"
      }
    ],
    "id": "1438752"
  }
]
Response Headers (200 OK)
X-total-count

The total results for the particular query. Used to drive paging requests.

integer (int64)
X-element-count

The number of elements returned in the current request. Used to drive paging requests.

integer (int64)
X-total-pages

The total number of pages that can be requested. Used to drive paging requests.

integer (int64)
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (default )
{
  "code": "string",
  "message": "string"
}

Get action by ID

GET /actions/{id}

Retrieves an existing action associated with the specified ID.

id: string
in path

The internal ID of the object.

return: string SIMPLE, FULL FULL
in query

Specifies the amount of detail to provide in a response. The value may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer HTTP header parameter to return=minimal, and FULL is the same as the header parameter set to return=representation.

200 OK

Success

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Example (200 OK)
{
  "name": "string",
  "description": "string",
  "enabled": "boolean",
  "friendly_name": "string",
  "supports_approval": "boolean",
  "action_type": "string",
  "operations": [
    {
      "operation_discriminator_type": "string",
      "operation_type": "string",
      "name": "string",
      "enabled": "boolean",
      "id": "1438752"
    }
  ],
  "id": "1438752"
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (default )
{
  "code": "string",
  "message": "string"
}

Get actions for bill cycle

GET /bill-cycles/{bill_cycle_id}/actions

Retrieves a subset of existing actions using query keys.

bill_cycle_id: string
in path

The ID of the bill cycle.

filter: string
in query

Filters query results using the Gotransverse API Query Language. It allows API consumers to view response data evaluated against the specified filter criteria. For example, filter=(status EQ 'SUSPENDED') OR (status EQ 'ACTIVE') will return items in either SUSPENDED or ACTIVE status. For a list of comparison and logical operators as well as use cases, refer to the Filtering section in the API Getting Started guide.

sort: string[]
in query

Sorts query results in ascending or descending order. By default, query results are sorted in the ascending order. To sort in the descending order, insert - in front of the query parameter name. For example, sort=-name value sorts the results in the descending order by the name query parameter. For details and use cases, refer to the Sorting section in the API Getting Started guide.

Array values passed separated by comma: ?sort=aaa,bbb

return: string SIMPLE, FULL FULL
in query

Specifies the amount of detail to provide in a response. The value may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer HTTP header parameter to return=minimal, and FULL is the same as the header parameter set to return=representation.

page_number: integer (int32) x ≥ 0 1
in query

The page number for multiple page queries.

page_size: integer (int32) 0 ≤ x ≤ 50 50
in query

The page size for multiple page queries. Default maximum is 50.

id: string
in query

(sortable) The internal ID of the object.

Success

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Example (200 OK)
[
  {
    "name": "string",
    "description": "string",
    "enabled": "boolean",
    "friendly_name": "string",
    "supports_approval": "boolean",
    "action_type": "string",
    "operations": [
      {
        "operation_discriminator_type": "string",
        "operation_type": "string",
        "name": "string",
        "enabled": "boolean",
        "id": "1438752"
      }
    ],
    "id": "1438752"
  }
]
Response Headers (200 OK)
X-total-count

The total results for the particular query. Used to drive paging requests.

integer (int64)
X-element-count

The number of elements returned in the current request. Used to drive paging requests.

integer (int64)
X-total-pages

The total number of pages that can be requested. Used to drive paging requests.

integer (int64)
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (default )
{
  "code": "string",
  "message": "string"
}

Get action for bill cycle by ID

GET /bill-cycles/{bill_cycle_id}/actions/{id}

Retrieves a subset of existing actions using query keys.

bill_cycle_id: string
in path

The ID of the bill cycle.

id: string
in path

The internal ID of the object.

return: string SIMPLE, FULL FULL
in query

Specifies the amount of detail to provide in a response. The value may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer HTTP header parameter to return=minimal, and FULL is the same as the header parameter set to return=representation.

Success

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Example (200 OK)
{
  "name": "string",
  "description": "string",
  "enabled": "boolean",
  "friendly_name": "string",
  "supports_approval": "boolean",
  "action_type": "string",
  "operations": [
    {
      "operation_discriminator_type": "string",
      "operation_type": "string",
      "name": "string",
      "enabled": "boolean",
      "id": "1438752"
    }
  ],
  "id": "1438752"
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (default )
{
  "code": "string",
  "message": "string"
}

AdjustmentApplication

The Adjustment Application entity is used for applying the adjustment amount to the invoice.

Get adjustment applications

GET /adjustment-applications

Uses query keys to retrieve a subset of existing adjustment applications.

filter: string
in query

Filters query results using the Gotransverse API Query Language. It allows API consumers to view response data evaluated against the specified filter criteria. For example, filter=(status EQ 'SUSPENDED') OR (status EQ 'ACTIVE') will return items in either SUSPENDED or ACTIVE status. For a list of comparison and logical operators as well as use cases, refer to the Filtering section in the API Getting Started guide.

sort: string[]
in query

Sorts query results in ascending or descending order. By default, query results are sorted in the ascending order. To sort in the descending order, insert - in front of the query parameter name. For example, sort=-name value sorts the results in the descending order by the name query parameter. For details and use cases, refer to the Sorting section in the API Getting Started guide.

Array values passed separated by comma: ?sort=aaa,bbb

return: string SIMPLE, FULL FULL
in query

Specifies the amount of detail to provide in a response. The value may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer HTTP header parameter to return=minimal, and FULL is the same as the header parameter set to return=representation.

page_number: integer (int32) x ≥ 0 1
in query

The page number for multiple page queries.

page_size: integer (int32) 0 ≤ x ≤ 50 50
in query

The page size for multiple page queries. Default maximum is 50.

id: string
in query

(sortable) The internal ID of the object.

adjustment_id: string
in query

(sortable) The ID of the adjustment.

billing_account_id: string
in query

(sortable) The ID of the billing account.

account_num: string
in query

The billing account number.

occurred_on: string (date-time)
in query

The date and time when the adjustment occurred.

unapplied_amount: number
in query

The amount of the adjustment that was not applied to the invoice.

adjustment_application_type: string standard-invoice, negative-invoice, reversed-invoice, write-off-invoice
in query

(sortable) Indicates the type of the adjustment application. It can be standard invoice, negative-invoice, reversed-invoice, or write off invoice.

invoice_id: string
in query

(sortable) The ID of the invoice.

invoice_num: string
in query

(sortable) The number of the invoice.

adjustment_credit_number: string
in query

The number for this adjustment (if applicable) defined by system settings. Increments by one for each credit issued.

external_account_num: string
in query

The account number tied to an external system.

Success

400 Bad Request

Bad request.

default

Unknown error.

Response Example (200 OK)
[
  {
    "account_adjustment": {
      "occurred_on": "string (date-time)",
      "amount": "number",
      "description": "string",
      "invoiced": "boolean",
      "status": "string",
      "adjustment_type": "string",
      "billing_account": {
        "account_num": "104-2345676",
        "external_account_num": "ACME 543-0987",
        "cpq_discounts": [
          {
            "start_date": "string (date-time)",
            "deactivation_date": "string (date-time)",
            "duration": "integer (int32)",
            "recurrence": "string",
            "value": "number",
            "application_type": "string",
            "price_type": "string",
            "discount_key": "string",
            "id": "string (uuid)"
          }
        ],
        "id": "1438752"
      },
      "reason": {
        "name": "string",
        "id": "1438752"
      },
      "secondary_reason": {
        "name": "string",
        "id": "1438752"
      },
      "posted_on": "string (date-time)",
      "posted_by": "string",
      "unapplied_amount": "number",
      "items": [
        {
          "adjustment_item_type": "string",
          "amount": "number",
          "description": "string",
          "reason": {
            "name": "string",
            "id": "1438752"
          },
          "secondary_reason": {
            "name": "string",
            "id": "1438752"
          },
          "category": {
            "charge_category_type": "string",
            "name": "string",
            "id": "1438752"
          },
          "id": "1438752"
        }
      ],
      "id": "1438752"
    },
    "applied_on": "string (date-time)",
    "amount": "number",
    "adjustment_application_type": "string",
    "id": "1438752"
  }
]
Response Headers (200 OK)
X-total-count

The total results for the particular query. Used to drive paging requests.

integer (int64)
X-element-count

The number of elements returned in the current request. Used to drive paging requests.

integer (int64)
X-total-pages

The total number of pages that can be requested. Used to drive paging requests.

integer (int64)
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (default )
{
  "code": "string",
  "message": "string"
}

Get adjustment application by ID

GET /adjustment-applications/{id}

Retrieves an existing adjustment application associated with the specified ID.

id: string
in path

The internal ID of the object.

return: string SIMPLE, FULL FULL
in query

Specifies the amount of detail to provide in a response. The value may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer HTTP header parameter to return=minimal, and FULL is the same as the header parameter set to return=representation.

Success

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Example (200 OK)
{
  "account_adjustment": {
    "occurred_on": "string (date-time)",
    "amount": "number",
    "description": "string",
    "invoiced": "boolean",
    "status": "string",
    "adjustment_type": "string",
    "billing_account": {
      "account_num": "104-2345676",
      "external_account_num": "ACME 543-0987",
      "cpq_discounts": [
        {
          "start_date": "string (date-time)",
          "deactivation_date": "string (date-time)",
          "duration": "integer (int32)",
          "recurrence": "string",
          "value": "number",
          "application_type": "string",
          "price_type": "string",
          "discount_key": "string",
          "id": "string (uuid)"
        }
      ],
      "id": "1438752"
    },
    "reason": {
      "name": "string",
      "id": "1438752"
    },
    "secondary_reason": {
      "name": "string",
      "id": "1438752"
    },
    "posted_on": "string (date-time)",
    "posted_by": "string",
    "unapplied_amount": "number",
    "items": [
      {
        "adjustment_item_type": "string",
        "amount": "number",
        "description": "string",
        "reason": {
          "name": "string",
          "id": "1438752"
        },
        "secondary_reason": {
          "name": "string",
          "id": "1438752"
        },
        "category": {
          "charge_category_type": "string",
          "name": "string",
          "id": "1438752"
        },
        "id": "1438752"
      }
    ],
    "id": "1438752"
  },
  "applied_on": "string (date-time)",
  "amount": "number",
  "adjustment_application_type": "string",
  "id": "1438752"
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (default )
{
  "code": "string",
  "message": "string"
}

AdjustmentCategory

The Adjustment Category entity defines specific categories of adjustments.

Get adjustment categories

GET /adjustment-categories

Uses query keys to retrieve a subset of existing adjustment categories.

filter: string
in query

Filters query results using the Gotransverse API Query Language. It allows API consumers to view response data evaluated against the specified filter criteria. For example, filter=(status EQ 'SUSPENDED') OR (status EQ 'ACTIVE') will return items in either SUSPENDED or ACTIVE status. For a list of comparison and logical operators as well as use cases, refer to the Filtering section in the API Getting Started guide.

sort: string[]
in query

Sorts query results in ascending or descending order. By default, query results are sorted in the ascending order. To sort in the descending order, insert - in front of the query parameter name. For example, sort=-name value sorts the results in the descending order by the name query parameter. For details and use cases, refer to the Sorting section in the API Getting Started guide.

Array values passed separated by comma: ?sort=aaa,bbb

return: string SIMPLE, FULL FULL
in query

Specifies the amount of detail to provide in a response. The value may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer HTTP header parameter to return=minimal, and FULL is the same as the header parameter set to return=representation.

page_number: integer (int32) x ≥ 0 1
in query

The page number for multiple page queries.

page_size: integer (int32) 0 ≤ x ≤ 50 50
in query

The page size for multiple page queries. Default maximum is 50.

id: string
in query

(sortable) The internal ID of the object.

name: string
in query

(sortable) The name of the adjustment charge category.

status: string ACTIVE, SUSPENDED, CANCELED
in query

(sortable) The status of the adjustment charge category.

Success

400 Bad Request

Bad request.

default

Unknown error.

Response Example (200 OK)
[
  {
    "charge_category_type": "string",
    "name": "string",
    "description": "string",
    "priority": "integer (int64)",
    "status": "string",
    "id": "1438752"
  }
]
Response Headers (200 OK)
X-total-count

The total results for the particular query. Used to drive paging requests.

integer (int64)
X-element-count

The number of elements returned in the current request. Used to drive paging requests.

integer (int64)
X-total-pages

The total number of pages that can be requested. Used to drive paging requests.

integer (int64)
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (default )
{
  "code": "string",
  "message": "string"
}

Get adjustment category by ID

GET /adjustment-categories/{id}

Retrieves an existing adjustment category associated with the specified ID.

id: string
in path

The internal ID of the object.

return: string SIMPLE, FULL FULL
in query

Specifies the amount of detail to provide in a response. The value may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer HTTP header parameter to return=minimal, and FULL is the same as the header parameter set to return=representation.

Success

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Example (200 OK)
{
  "charge_category_type": "string",
  "name": "string",
  "description": "string",
  "priority": "integer (int64)",
  "status": "string",
  "id": "1438752"
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (default )
{
  "code": "string",
  "message": "string"
}

Agreement

The Agreement entity is used for terms by which a product is offered in the service.

Get agreements

GET /agreements

Uses query keys to retrieve a subset of existing agreements.

filter: string
in query

Filters query results using the Gotransverse API Query Language. It allows API consumers to view response data evaluated against the specified filter criteria. For example, filter=(status EQ 'SUSPENDED') OR (status EQ 'ACTIVE') will return items in either SUSPENDED or ACTIVE status. For a list of comparison and logical operators as well as use cases, refer to the Filtering section in the API Getting Started guide.

sort: string[]
in query

Sorts query results in ascending or descending order. By default, query results are sorted in the ascending order. To sort in the descending order, insert - in front of the query parameter name. For example, sort=-name value sorts the results in the descending order by the name query parameter. For details and use cases, refer to the Sorting section in the API Getting Started guide.

Array values passed separated by comma: ?sort=aaa,bbb

return: string SIMPLE, FULL FULL
in query

Specifies the amount of detail to provide in a response. The value may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer HTTP header parameter to return=minimal, and FULL is the same as the header parameter set to return=representation.

page_number: integer (int32) x ≥ 0 1
in query

The page number for multiple page queries.

page_size: integer (int32) 0 ≤ x ≤ 50 50
in query

The page size for multiple page queries. Default maximum is 50.

id: string
in query

(sortable) The internal ID of the object.

valid_from: string (date-time)
in query

The date and time from when the resource is valid.

valid_to: string (date-time)
in query

The date and time until when the resource is valid.

name: string
in query

(sortable) The name of the agreement.

product_id: string
in query

(sortable) The ID of the product.

status: string DRAFT, ACTIVE, SUSPENDED
in query

(sortable) The status of the agreement.

period_type: string MONTH, DAY
in query

The period type of the agreement.

end_action: string RENEW_AGREEMENT, SERVICE_ONLY, DEACTIVATE_SERVICE, CHANGE_AGREEMENT, CHANGE_SERVICE, CPQ_MANAGED
in query

The end action of the agreement.

termination_flat_charge: number
in query

The flat charge to apply on termination, if applicable.

termination_percentage_charge: number
in query

The percentage charge to apply on termination, if applicable.

termination_fee_currency_code: string USD, GBP, EUR, SEK, NOK, DKK, CAD, AUD, ZAR, NZD, MXN, INR, JPY, SAR, QAR, EGP, AED, BHD, KWD, OMR, HKD, CHF, ILS, CNY, BRL, PLN, COP, PEN, RUB, SGD, IDR, MYR, KRW, TWD, PKR, ARS, CLP, CRC, CZK, HUF, ISK, PHP, RON, THB, TRY, BWP, NGN
in query

The currency code for the agreement termination fee.

max_termination_fee_currency_code: string USD, GBP, EUR, SEK, NOK, DKK, CAD, AUD, ZAR, NZD, MXN, INR, JPY, SAR, QAR, EGP, AED, BHD, KWD, OMR, HKD, CHF, ILS, CNY, BRL, PLN, COP, PEN, RUB, SGD, IDR, MYR, KRW, TWD, PKR, ARS, CLP, CRC, CZK, HUF, ISK, PHP, RON, THB, TRY, BWP, NGN
in query

The currency code for the maximum agreement termination fee.

200 OK

Success

type
400 Bad Request

Bad request.

default

Unknown error.

Response Example (200 OK)
[
  {
    "name": "string",
    "agreement_period": "integer (int32)",
    "status": "string",
    "termination_flat_charge": "number",
    "termination_percentage_charge": "number",
    "max_termination_charge": "number",
    "prorate_on_cancel": "boolean",
    "adjustment_category": {
      "charge_category_type": "string",
      "name": "string",
      "id": "1438752"
    },
    "end_action": "string",
    "termination_fee_currency_code": "string",
    "max_termination_fee_currency_code": "string",
    "valid_from": "string (date-time)",
    "valid_to": "string (date-time)",
    "next_agreement": {
      "name": "string",
      "id": "1438752"
    },
    "agreement_period_type": "string",
    "minimum_amount": "number",
    "minimum_amount_currency_type": "string",
    "true_up_adjustment_reason": {
      "name": "string",
      "id": "1438752"
    },
    "true_up_charge_types": [
      "string"
    ],
    "preserve_service_price": "boolean",
    "id": "1438752"
  }
]
Response Headers (200 OK)
X-total-count

The total results for the particular query. Used to drive paging requests.

integer (int64)
X-element-count

The number of elements returned in the current request. Used to drive paging requests.

integer (int64)
X-total-pages

The total number of pages that can be requested. Used to drive paging requests.

integer (int64)
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (default )
{
  "code": "string",
  "message": "string"
}

Get agreement by ID

GET /agreements/{id}

Retrieves an existing agreement associated with the specified ID.

id: string
in path

The internal ID of the object.

return: string SIMPLE, FULL FULL
in query

Specifies the amount of detail to provide in a response. The value may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer HTTP header parameter to return=minimal, and FULL is the same as the header parameter set to return=representation.

200 OK

Success

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Example (200 OK)
{
  "name": "string",
  "agreement_period": "integer (int32)",
  "status": "string",
  "termination_flat_charge": "number",
  "termination_percentage_charge": "number",
  "max_termination_charge": "number",
  "prorate_on_cancel": "boolean",
  "adjustment_category": {
    "charge_category_type": "string",
    "name": "string",
    "id": "1438752"
  },
  "end_action": "string",
  "termination_fee_currency_code": "string",
  "max_termination_fee_currency_code": "string",
  "valid_from": "string (date-time)",
  "valid_to": "string (date-time)",
  "next_agreement": {
    "name": "string",
    "id": "1438752"
  },
  "agreement_period_type": "string",
  "minimum_amount": "number",
  "minimum_amount_currency_type": "string",
  "true_up_adjustment_reason": {
    "name": "string",
    "id": "1438752"
  },
  "true_up_charge_types": [
    "string"
  ],
  "preserve_service_price": "boolean",
  "id": "1438752"
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (default )
{
  "code": "string",
  "message": "string"
}

AgreementService

The Agreement Service entity is used for an agreement that is actively associated with the service.

Get agreement services

GET /agreement-services

Uses query keys to retrieve a subset of existing agreement services.

filter: string
in query

Filters query results using the Gotransverse API Query Language. It allows API consumers to view response data evaluated against the specified filter criteria. For example, filter=(status EQ 'SUSPENDED') OR (status EQ 'ACTIVE') will return items in either SUSPENDED or ACTIVE status. For a list of comparison and logical operators as well as use cases, refer to the Filtering section in the API Getting Started guide.

sort: string[]
in query

Sorts query results in ascending or descending order. By default, query results are sorted in the ascending order. To sort in the descending order, insert - in front of the query parameter name. For example, sort=-name value sorts the results in the descending order by the name query parameter. For details and use cases, refer to the Sorting section in the API Getting Started guide.

Array values passed separated by comma: ?sort=aaa,bbb

return: string SIMPLE, FULL FULL
in query

Specifies the amount of detail to provide in a response. The value may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer HTTP header parameter to return=minimal, and FULL is the same as the header parameter set to return=representation.

page_number: integer (int32) x ≥ 0 1
in query

The page number for multiple page queries.

page_size: integer (int32) 0 ≤ x ≤ 50 50
in query

The page size for multiple page queries. Default maximum is 50.

id: string
in query

(sortable) The internal ID of the object.

service_id: string
in query

(sortable) The ID of the service.

service_resource_identifier: string (up to 255 chars)
in query

The identifier of the service resource.

child_service_resource_identifier: string
in query

The identifier of the child service resource.

product_id: string
in query

(sortable) The ID of the product.

billing_account_id: string
in query

(sortable) The ID of the billing account.

account_num: string
in query

The billing account number.

external_account_num: string
in query

The account number tied to an external system.

status: string ACTIVE, SUSPENDED, DEACTIVATED, PENDING, CANCELED, TRANSFERRED, REPLACED, TRIAL, SCHEDULED
in query

(sortable) The status of the service.

Success

400 Bad Request

Bad request.

default

Unknown error.

Response Example (200 OK)
[
  {
    "agreement": {
      "name": "string",
      "id": "1438752"
    },
    "start_date": "string (date-time)",
    "end_date": "string (date-time)",
    "renewed": "boolean",
    "accumulated_charges_amount": "number",
    "agreement_period": "integer (int32)",
    "omit_minimum_amount": "boolean",
    "end_action": "string",
    "next_agreement": {
      "name": "string",
      "id": "1438752"
    },
    "next_service_pay_on_purchase": "boolean",
    "next_end_action": "string",
    "next_service_product": {
      "name": "string",
      "sku": "string",
      "external_product_number": "string",
      "id": "1438752"
    },
    "next_service_product_price": {
      "product_price_type": "string",
      "price_type": "string",
      "id": "1438752"
    },
    "preserve_service_price": "boolean",
    "next_preserve_service_price": "boolean",
    "minimum_amount": "number",
    "minimum_amount_currency_code": "string",
    "true_up_charge_types": [
      "string"
    ],
    "id": "1438752"
  }
]
Response Headers (200 OK)
X-total-count

The total results for the particular query. Used to drive paging requests.

integer (int64)
X-element-count

The number of elements returned in the current request. Used to drive paging requests.

integer (int64)
X-total-pages

The total number of pages that can be requested. Used to drive paging requests.

integer (int64)
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (default )
{
  "code": "string",
  "message": "string"
}

Get true up charge type relations

GET /agreement-services/{agreement_service_id}/true-up-charge-type-relations

Retrieves a list of true up charge relations for the agreement service with the specified ID.

filter: string
in query

Filters query results using the Gotransverse API Query Language. It allows API consumers to view response data evaluated against the specified filter criteria. For example, filter=(status EQ 'SUSPENDED') OR (status EQ 'ACTIVE') will return items in either SUSPENDED or ACTIVE status. For a list of comparison and logical operators as well as use cases, refer to the Filtering section in the API Getting Started guide.

sort: string[]
in query

Sorts query results in ascending or descending order. By default, query results are sorted in the ascending order. To sort in the descending order, insert - in front of the query parameter name. For example, sort=-name value sorts the results in the descending order by the name query parameter. For details and use cases, refer to the Sorting section in the API Getting Started guide.

Array values passed separated by comma: ?sort=aaa,bbb

return: string SIMPLE, FULL FULL
in query

Specifies the amount of detail to provide in a response. The value may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer HTTP header parameter to return=minimal, and FULL is the same as the header parameter set to return=representation.

page_number: integer (int32) x ≥ 0 1
in query

The page number for multiple page queries.

page_size: integer (int32) 0 ≤ x ≤ 50 50
in query

The page size for multiple page queries. Default maximum is 50.

id: string
in query

(sortable) The internal ID of the object.

agreement_service_id: string
in path

The ID of the agreement service.

Success

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Example (200 OK)
[
  {
    "true_up_charge_type": "string",
    "agreement_service": {
      "id": "1438752"
    },
    "id": "1438752"
  }
]
Response Headers (200 OK)
X-total-count

The total results for the particular query. Used to drive paging requests.

integer (int64)
X-element-count

The number of elements returned in the current request. Used to drive paging requests.

integer (int64)
X-total-pages

The total number of pages that can be requested. Used to drive paging requests.

integer (int64)
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (default )
{
  "code": "string",
  "message": "string"
}

Create true up charge type relation

POST /agreement-services/{agreement_service_id}/true-up-charge-type-relations

Creates a new true up charge type relation for the agreement service with the specified ID.

The payload for creating true up charge type relations.

Prefer: string
in header

The HTTP Prefer header per https://tools.ietf.org/html/rfc7240. The 'return=[representation|minimal]' preferences are the only implemented settings at the moment and are the same as 'return=SIMPLE', and it indicates that the client wishes the server to return a minimal response to a successful request. The 'return=representation' preference in this header is the same as setting query parameter 'return=FULL'.

agreement_service_id: string
in path

The ID of the agreement service.

Request Example
{
  "true_up_charge_type": "string"
}

Success

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Example (201 Created)
{
  "true_up_charge_type": "string",
  "agreement_service": {
    "id": "1438752"
  },
  "id": "1438752"
}
Response Headers (201 Created)
Preference-Applied

Settings applied from the "Prefer" header.

string
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (default )
{
  "code": "string",
  "message": "string"
}

Get true up charge type relation by ID

GET /agreement-services/{agreement_service_id}/true-up-charge-type-relations/{id}

Retrieves the true up charge type relation for the specified agreement service by associated IDs.

return: string SIMPLE, FULL FULL
in query

Specifies the amount of detail to provide in a response. The value may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer HTTP header parameter to return=minimal, and FULL is the same as the header parameter set to return=representation.

agreement_service_id: string
in path

The ID of the agreement service.

id: string
in path

The internal ID of the object.

Success

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Example (200 OK)
{
  "true_up_charge_type": "string",
  "agreement_service": {
    "id": "1438752"
  },
  "id": "1438752"
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (default )
{
  "code": "string",
  "message": "string"
}

Delete true up charge type relation

DELETE /agreement-services/{agreement_service_id}/true-up-charge-type-relations/{id}

Deletes the true up charge type relation for the specified agreement service by the associated IDs.

agreement_service_id: string
in path

The ID of the agreement service.

id: string
in path

The internal ID of the object.

204 No Content

Success

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (default )
{
  "code": "string",
  "message": "string"
}

Get agreement service by ID

GET /agreement-services/{id}

Retrieves an existing agreement service associated with the specified ID.

id: string
in path

The internal ID of the object.

return: string SIMPLE, FULL FULL
in query

Specifies the amount of detail to provide in a response. The value may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer HTTP header parameter to return=minimal, and FULL is the same as the header parameter set to return=representation.

Success

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Example (200 OK)
{
  "agreement": {
    "name": "string",
    "id": "1438752"
  },
  "start_date": "string (date-time)",
  "end_date": "string (date-time)",
  "renewed": "boolean",
  "accumulated_charges_amount": "number",
  "agreement_period": "integer (int32)",
  "omit_minimum_amount": "boolean",
  "end_action": "string",
  "next_agreement": {
    "name": "string",
    "id": "1438752"
  },
  "next_service_pay_on_purchase": "boolean",
  "next_end_action": "string",
  "next_service_product": {
    "name": "string",
    "sku": "string",
    "external_product_number": "string",
    "id": "1438752"
  },
  "next_service_product_price": {
    "product_price_type": "string",
    "price_type": "string",
    "id": "1438752"
  },
  "preserve_service_price": "boolean",
  "next_preserve_service_price": "boolean",
  "minimum_amount": "number",
  "minimum_amount_currency_code": "string",
  "true_up_charge_types": [
    "string"
  ],
  "id": "1438752"
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (default )
{
  "code": "string",
  "message": "string"
}

Update agreement service

PUT /agreement-services/{id}

Updates an existing agreement service associated with the specified ID.

The payload for updating an existing agreement service.

id: string
in path

The internal ID of the object.

Prefer: string
in header

The HTTP Prefer header per https://tools.ietf.org/html/rfc7240. The 'return=[representation|minimal]' preferences are the only implemented settings at the moment and are the same as 'return=SIMPLE', and it indicates that the client wishes the server to return a minimal response to a successful request. The 'return=representation' preference in this header is the same as setting query parameter 'return=FULL'.

Request Example
{
  "agreement": {
    "name": "string",
    "id": "1438752"
  },
  "end_date": "string (date-time)",
  "omit_minimum_amount": "boolean",
  "end_action": "string",
  "next_agreement": {
    "name": "string",
    "id": "1438752"
  },
  "next_service_pay_on_purchase": "boolean",
  "next_end_action": "string",
  "next_service_product": {
    "name": "string",
    "sku": "string",
    "external_product_number": "string",
    "id": "1438752"
  },
  "next_service_product_price": {
    "product_price_type": "string",
    "price_type": "string",
    "id": "1438752"
  },
  "preserve_service_price": "boolean",
  "next_preserve_service_price": "boolean",
  "minimum_amount": "number",
  "minimum_amount_currency_code": "string"
}

Success

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Example (200 OK)
{
  "agreement": {
    "name": "string",
    "id": "1438752"
  },
  "start_date": "string (date-time)",
  "end_date": "string (date-time)",
  "renewed": "boolean",
  "accumulated_charges_amount": "number",
  "agreement_period": "integer (int32)",
  "omit_minimum_amount": "boolean",
  "end_action": "string",
  "next_agreement": {
    "name": "string",
    "id": "1438752"
  },
  "next_service_pay_on_purchase": "boolean",
  "next_end_action": "string",
  "next_service_product": {
    "name": "string",
    "sku": "string",
    "external_product_number": "string",
    "id": "1438752"
  },
  "next_service_product_price": {
    "product_price_type": "string",
    "price_type": "string",
    "id": "1438752"
  },
  "preserve_service_price": "boolean",
  "next_preserve_service_price": "boolean",
  "minimum_amount": "number",
  "minimum_amount_currency_code": "string",
  "true_up_charge_types": [
    "string"
  ],
  "id": "1438752"
}
Response Headers (200 OK)
Preference-Applied

Settings applied from the "Prefer" header.

string
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (default )
{
  "code": "string",
  "message": "string"
}

Get agreement service on an order item

GET /order-items/{order_item_id}/agreement-service

Retrieves an agreement service on a draft order for the specified order item ID.

return: string SIMPLE, FULL FULL
in query

Specifies the amount of detail to provide in a response. The value may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer HTTP header parameter to return=minimal, and FULL is the same as the header parameter set to return=representation.

order_item_id: string
in path

The ID of the order item.

Success

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Example (200 OK)
{
  "agreement": {
    "name": "string",
    "id": "1438752"
  },
  "agreement_period": "integer (int32)",
  "end_date": "string (date-time)",
  "end_date_overridden": "boolean",
  "end_action": "string",
  "next_agreement": {
    "name": "string",
    "id": "1438752"
  },
  "next_service_pay_on_purchase": "boolean",
  "next_end_action": "string",
  "next_service_product": {
    "name": "string",
    "sku": "string",
    "external_product_number": "string",
    "id": "1438752"
  },
  "next_service_product_price": {
    "product_price_type": "string",
    "price_type": "string",
    "id": "1438752"
  },
  "preserve_service_price": "boolean",
  "next_preserve_service_price": "boolean",
  "minimum_amount": "number",
  "minimum_amount_currency_code": "string",
  "true_up_charge_types": [
    "string"
  ],
  "id": "1438752"
}
Response Headers (200 OK)
Preference-Applied

Settings applied from the "Prefer" header.

string
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (default )
{
  "code": "string",
  "message": "string"
}

Create agreement service on an order item

POST /order-items/{order_item_id}/agreement-service

Creates an agreement service on a draft order for the specified order item ID.

The payload for creating an order item agreement service.

Prefer: string
in header

The HTTP Prefer header per https://tools.ietf.org/html/rfc7240. The 'return=[representation|minimal]' preferences are the only implemented settings at the moment and are the same as 'return=SIMPLE', and it indicates that the client wishes the server to return a minimal response to a successful request. The 'return=representation' preference in this header is the same as setting query parameter 'return=FULL'.

order_item_id: string
in path

The ID of the order item.

Request Example
{
  "agreement": {
    "name": "string",
    "id": "1438752"
  },
  "end_date": "string (date-time)",
  "end_action": "string",
  "next_agreement": {
    "name": "string",
    "id": "1438752"
  },
  "next_end_action": "string",
  "next_service_product": {
    "name": "string",
    "sku": "string",
    "external_product_number": "string",
    "id": "1438752"
  },
  "next_service_pay_on_purchase": "boolean",
  "next_service_product_price": {
    "product_price_type": "string",
    "price_type": "string",
    "id": "1438752"
  },
  "preserve_service_price": "boolean",
  "next_preserve_service_price": "boolean",
  "agreement_period": "integer (int32)",
  "minimum_amount": "number",
  "omit_minimum_amount": "boolean",
  "true_up_charge_types": [
    "string"
  ]
}

Success

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Example (201 Created)
{
  "agreement": {
    "name": "string",
    "id": "1438752"
  },
  "agreement_period": "integer (int32)",
  "end_date": "string (date-time)",
  "end_date_overridden": "boolean",
  "end_action": "string",
  "next_agreement": {
    "name": "string",
    "id": "1438752"
  },
  "next_service_pay_on_purchase": "boolean",
  "next_end_action": "string",
  "next_service_product": {
    "name": "string",
    "sku": "string",
    "external_product_number": "string",
    "id": "1438752"
  },
  "next_service_product_price": {
    "product_price_type": "string",
    "price_type": "string",
    "id": "1438752"
  },
  "preserve_service_price": "boolean",
  "next_preserve_service_price": "boolean",
  "minimum_amount": "number",
  "minimum_amount_currency_code": "string",
  "true_up_charge_types": [
    "string"
  ],
  "id": "1438752"
}
Response Headers (201 Created)
Preference-Applied

Settings applied from the "Prefer" header.

string
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (default )
{
  "code": "string",
  "message": "string"
}

Update agreement service on an order item

PUT /order-items/{order_item_id}/agreement-service

Updates an agreement service on a draft order for the specified order item ID.

The payload for updating an order item agreement service.

Prefer: string
in header

The HTTP Prefer header per https://tools.ietf.org/html/rfc7240. The 'return=[representation|minimal]' preferences are the only implemented settings at the moment and are the same as 'return=SIMPLE', and it indicates that the client wishes the server to return a minimal response to a successful request. The 'return=representation' preference in this header is the same as setting query parameter 'return=FULL'.

order_item_id: string
in path

The ID of the order item.

Request Example
{
  "agreement": {
    "name": "string",
    "id": "1438752"
  },
  "agreement_period": "integer (int32)",
  "end_date": "string (date-time)",
  "end_date_overridden": "boolean",
  "end_action": "string",
  "next_agreement": {
    "name": "string",
    "id": "1438752"
  },
  "next_service_pay_on_purchase": "boolean",
  "next_end_action": "string",
  "next_service_product": {
    "name": "string",
    "sku": "string",
    "external_product_number": "string",
    "id": "1438752"
  },
  "next_service_product_price": {
    "product_price_type": "string",
    "price_type": "string",
    "id": "1438752"
  },
  "preserve_service_price": "boolean",
  "next_preserve_service_price": "boolean",
  "minimum_amount": "number",
  "minimum_amount_currency_code": "string"
}

Success

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Example (200 OK)
{
  "agreement": {
    "name": "string",
    "id": "1438752"
  },
  "agreement_period": "integer (int32)",
  "end_date": "string (date-time)",
  "end_date_overridden": "boolean",
  "end_action": "string",
  "next_agreement": {
    "name": "string",
    "id": "1438752"
  },
  "next_service_pay_on_purchase": "boolean",
  "next_end_action": "string",
  "next_service_product": {
    "name": "string",
    "sku": "string",
    "external_product_number": "string",
    "id": "1438752"
  },
  "next_service_product_price": {
    "product_price_type": "string",
    "price_type": "string",
    "id": "1438752"
  },
  "preserve_service_price": "boolean",
  "next_preserve_service_price": "boolean",
  "minimum_amount": "number",
  "minimum_amount_currency_code": "string",
  "true_up_charge_types": [
    "string"
  ],
  "id": "1438752"
}
Response Headers (200 OK)
Preference-Applied

Settings applied from the "Prefer" header.

string
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (default )
{
  "code": "string",
  "message": "string"
}

Remove agreement service from order item

DELETE /order-items/{order_item_id}/agreement-service

Removes an agreement service from the specified order item ID for a draft order.

order_item_id: string
in path

The ID of the order item.

204 No Content

Success

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (default )
{
  "code": "string",
  "message": "string"
}

BillBatch

The Bill Batch entity is used for billing of a customer billing account on demand, as opposed to being timed to a bill cycle. Bill batch is also used for invoice reversal, reissue, and ad hoc manual invoices.

Get bill batches

GET /bill-batches

Uses query keys to retrieve a subset of existing bill batches.

filter: string
in query

Filters query results using the Gotransverse API Query Language. It allows API consumers to view response data evaluated against the specified filter criteria. For example, filter=(status EQ 'SUSPENDED') OR (status EQ 'ACTIVE') will return items in either SUSPENDED or ACTIVE status. For a list of comparison and logical operators as well as use cases, refer to the Filtering section in the API Getting Started guide.

sort: string[]
in query

Sorts query results in ascending or descending order. By default, query results are sorted in the ascending order. To sort in the descending order, insert - in front of the query parameter name. For example, sort=-name value sorts the results in the descending order by the name query parameter. For details and use cases, refer to the Sorting section in the API Getting Started guide.

Array values passed separated by comma: ?sort=aaa,bbb

return: string SIMPLE, FULL FULL
in query

Specifies the amount of detail to provide in a response. The value may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer HTTP header parameter to return=minimal, and FULL is the same as the header parameter set to return=representation.

page_number: integer (int32) x ≥ 0 1
in query

The page number for multiple page queries.

page_size: integer (int32) 0 ≤ x ≤ 50 50
in query

The page size for multiple page queries. Default maximum is 50.

id: string
in query

(sortable) The internal ID of the object.

bill_batch_type: string reissue, reverse, adhoc, on-demand, invoice-on-order monthly
in query

The type of the bill batch.

name: string
in query

The name of the bill batch.

status: string ACTIVE, SUSPENDED, CANCELED ACTIVE
in query

(sortable) The accounting status, meaning the status of the General Ledger.

currency_code: string USD, GBP, EUR, SEK, NOK, DKK, CAD, AUD, ZAR, NZD, MXN, INR, JPY, SAR, QAR, EGP, AED, BHD, KWD, OMR, HKD, CHF, ILS, CNY, BRL, PLN, COP, PEN, RUB, SGD, IDR, MYR, KRW, TWD, PKR, ARS, CLP, CRC, CZK, HUF, ISK, PHP, RON, THB, TRY, BWP, NGN
in query

(sortable) The currency code for the amount.

billing_account_id: string
in query

(sortable) The ID of the billing account.

account_num: string
in query

The billing account number.

external_account_num: string
in query

The account number tied to an external system.

200 OK

Success

type
400 Bad Request

Bad request.

default

Unknown error.

Response Example (200 OK)
[
  {
    "bill_batch_type": "string",
    "description": "string",
    "auto_approve": "boolean",
    "use_payment_term": "boolean",
    "bill_batch_runs": [
      {
        "invoices": [
          {
            "invoice_type": "string",
            "invoice_num": "string",
            "external_invoice_num": "string",
            "amount": "number",
            "description": "string",
            "billing_account": {
              "account_num": "104-2345676",
              "external_account_num": "ACME 543-0987",
              "bill_cycle": {
                "bill_cycle_type": "string",
                "name": "string",
                "id": "1438752"
              },
              "responsible_party": {
                "party_type": "string",
                "customer_num": "string",
                "external_customer_num": "string",
                "default_billing_account": {
                  "account_num": "104-2345676",
                  "external_account_num": "ACME 543-0987",
                  "cpq_discounts": [
                    {
                      "start_date": "string (date-time)",
                      "deactivation_date": "string (date-time)",
                      "duration": "integer (int32)",
                      "recurrence": "string",
                      "value": "number",
                      "application_type": "string",
                      "price_type": "string",
                      "discount_key": "string",
                      "id": "string (uuid)"
                    }
                  ],
                  "id": "1438752"
                },
                "tax_id_number": "string",
                "addresses": [
                  {
                    "address_type": "string",
                    "id": "1438752"
                  }
                ],
                "contact_category": {
                  "name": "string",
                  "id": "1438752"
                },
                "id": "1438752"
              },
              "billing_account_category": {
                "name": "string",
                "id": "1438752"
              },
              "bill_type": "string",
              "auto_payment_authorized": "boolean",
              "status": "string",
              "status_reason": {
                "reason_type": "string",
                "name": "string",
                "description": "string",
                "status": "string",
                "id": "1438752"
              },
              "pending_charges_total": 200,
              "balance": 100,
              "currency_code": "string",
              "recurring_payments": [
                {
                  "payment_method": {
                    "payment_method_type": "string",
                    "custom_field_values": [
                      {
                        "custom_field": {
                          "name": "string",
                          "custom_field_type": "string",
                          "id": "1438752"
                        },
                        "custom_field_value_type": "string",
                        "value": "string",
                        "id": "1438752"
                      }
                    ],
                    "multi_factor_auth": "boolean",
                    "id": "1438752"
                  },
                  "billing_account": {
                    "account_num": "104-2345676",
                    "external_account_num": "ACME 543-0987",
                    "cpq_discounts": [
                      {
                        "start_date": "string (date-time)",
                        "deactivation_date": "string (date-time)",
                        "duration": "integer (int32)",
                        "recurrence": "string",
                        "value": "number",
                        "application_type": "string",
                        "price_type": "string",
                        "discount_key": "string",
                        "id": "string (uuid)"
                      }
                    ],
                    "id": "1438752"
                  },
                  "valid_from": "string (date-time)",
                  "valid_to": "string (date-time)",
                  "auto_payment": "boolean",
                  "id": "1438752"
                }
              ],
              "custom_field_values": [
                {
                  "custom_field": {
                    "name": "string",
                    "custom_field_type": "string",
                    "id": "1438752"
                  },
                  "custom_field_value_type": "string",
                  "value": "string",
                  "id": "1438752"
                }
              ],
              "contacts": [
                {
                  "party_type": "string",
                  "first_name": "string",
                  "last_name": "string",
                  "middle_name": "string",
                  "suffix": "string",
                  "dob": "string (date)",
                  "company": "string",
                  "department": "string",
                  "title": "string",
                  "tax_id_number": "string",
                  "addresses": [
                    {
                      "address_type": "string",
                      "id": "1438752"
                    }
                  ],
                  "contact_category": {
                    "name": "string",
                    "id": "1438752"
                  },
                  "id": "1438752"
                }
              ],
              "payment_term": {
                "name": "string",
                "id": "1438752"
              },
              "effective_payment_term": {
                "name": "string",
                "term_days": "integer (int32)",
                "grace_days": "integer (int32)",
                "id": "1438752"
              },
              "start_date": "2015-04-01T12:13:26.000-05:00",
              "end_date": "2015-04-12T08:21:45.000-05:00",
              "tax_exempt": "boolean",
              "next_invoice_date": "2015-04-12T00:00:00.000-05:00",
              "parent_billing_account": {
                "account_num": "104-2345676",
                "external_account_num": "ACME 543-0987",
                "cpq_discounts": [
                  {
                    "start_date": "string (date-time)",
                    "deactivation_date": "string (date-time)",
                    "duration": "integer (int32)",
                    "recurrence": "string",
                    "value": "number",
                    "application_type": "string",
                    "price_type": "string",
                    "discount_key": "string",
                    "id": "string (uuid)"
                  }
                ],
                "id": "1438752"
              },
              "responsible_account": {
                "account_num": "104-2345676",
                "external_account_num": "ACME 543-0987",
                "cpq_discounts": [
                  {
                    "start_date": "string (date-time)",
                    "deactivation_date": "string (date-time)",
                    "duration": "integer (int32)",
                    "recurrence": "string",
                    "value": "number",
                    "application_type": "string",
                    "price_type": "string",
                    "discount_key": "string",
                    "id": "string (uuid)"
                  }
                ],
                "id": "1438752"
              },
              "auto_pay_offset": "integer (int32)",
              "cpq_discounts": [
                {
                  "start_date": "string (date-time)",
                  "deactivation_date": "string (date-time)",
                  "duration": "integer (int32)",
                  "recurrence": "string",
                  "value": "number",
                  "application_type": "string",
                  "price_type": "string",
                  "discount_key": "string",
                  "id": "string (uuid)"
                }
              ],
              "responsible_account_invoice_rendering_type": "string",
              "background_allocation": "boolean",
              "dunning_state": {
                "enabled": "boolean",
                "plan_code": "string",
                "plan_name": "string",
                "tier_code": "string",
                "tier_name": "string",
                "effective_date": "string (date-time)",
                "previous_tier_code": "string",
                "previous_tier_name": "string",
                "id": "1438752"
              },
              "tax_exemptions": [
                {
                  "certificate": "string",
                  "valid_from": "string (date-time)",
                  "valid_to": "string (date-time)",
                  "exemption_category": {
                    "name": "string",
                    "id": "1438752"
                  },
                  "all_states": "boolean",
                  "states": [
                    "string"
                  ],
                  "id": "1438752"
                }
              ],
              "preferred_language_code": "string",
              "minimum_invoice_amount": "number",
              "billing_schedules": [
                {
                  "billing_schedule_type": "string",
                  "id": "1438752"
                }
              ],
              "past_due_amount": "number",
              "id": "1438752"
            },
            "original_billing_account": {
              "account_num": "104-2345676",
              "external_account_num": "ACME 543-0987",
              "cpq_discounts": [
                {
                  "start_date": "string (date-time)",
                  "deactivation_date": "string (date-time)",
                  "duration": "integer (int32)",
                  "recurrence": "string",
                  "value": "number",
                  "application_type": "string",
                  "price_type": "string",
                  "discount_key": "string",
                  "id": "string (uuid)"
                }
              ],
              "id": "1438752"
            },
            "occurred_on": "string (date-time)",
            "due_date": "string (date)",
            "original_due_date": "string (date)",
            "paid_date": "string (date-time)",
            "amount_to_pay": "number",
            "late_fee_charged": "boolean",
            "invoice_items": [
              {
                "invoice_item_type": "string",
                "quantity": "number",
                "unit_amount": "number",
                "total_amount": "number",
                "description": "string",
                "billing_account": {
                  "account_num": "104-2345676",
                  "external_account_num": "ACME 543-0987",
                  "cpq_discounts": [
                    {
                      "start_date": "string (date-time)",
                      "deactivation_date": "string (date-time)",
                      "duration": "integer (int32)",
                      "recurrence": "string",
                      "value": "number",
                      "application_type": "string",
                      "price_type": "string",
                      "discount_key": "string",
                      "id": "string (uuid)"
                    }
                  ],
                  "id": "1438752"
                },
                "taxable": "boolean",
                "prorated_percentage": "number",
                "start_date": "string (date-time)",
                "end_date": "string (date-time)",
                "invoice_line_item_type": "string",
                "charges": [
                  {
                    "invoice_item_charge_type": "string",
                    "un_prorated_amount": "number",
                    "amount": "number",
                    "price_category": {
                      "charge_category_type": "string",
                      "name": "string",
                      "id": "1438752"
                    },
                    "balance": "number",
                    "paid": "boolean",
                    "recurring_charge": "boolean",
                    "bill_in_advance": "boolean",
                    "description": "string",
                    "quantity": "number",
                    "exclude_from_taxation": "boolean",
                    "tax_inclusive": "boolean",
                    "details": [
                      {
                        "charge_detail_type": "string",
                        "amount": "number",
                        "id": "1438752"
                      }
                    ],
                    "id": "1438752"
                  }
                ],
                "invoice": "#/definitions/Invoice",
                "sourced_item_count": "number",
                "id": "1438752"
              }
            ],
            "status": "string",
            "billing_statement": {
              "statement_type": "string",
              "total_amount": "number",
              "service_charges": "number",
              "activity_charges": "number",
              "other_charges_and_credits": "number",
              "taxes_and_fees": "number",
              "total_current_charges": "number",
              "total_tax_inclusive_amount": "number",
              "id": "1438752"
            },
            "auto_payment_date": "string (date)",
            "disputed": "boolean",
            "adjustment_applications": [
              {
                "invoice": {
                  "invoice_type": "string",
                  "invoice_num": "string",
                  "id": "1438752"
                },
                "account_adjustment": {
                  "occurred_on": "string (date-time)",
                  "amount": "number",
                  "description": "string",
                  "invoiced": "boolean",
                  "status": "string",
                  "adjustment_type": "string",
                  "billing_account": {
                    "account_num": "104-2345676",
                    "external_account_num": "ACME 543-0987",
                    "cpq_discounts": [
                      {
                        "start_date": "string (date-time)",
                        "deactivation_date": "string (date-time)",
                        "duration": "integer (int32)",
                        "recurrence": "string",
                        "value": "number",
                        "application_type": "string",
                        "price_type": "string",
                        "discount_key": "string",
                        "id": "string (uuid)"
                      }
                    ],
                    "id": "1438752"
                  },
                  "reason": {
                    "name": "string",
                    "id": "1438752"
                  },
                  "secondary_reason": {
                    "name": "string",
                    "id": "1438752"
                  },
                  "posted_on": "string (date-time)",
                  "posted_by": "string",
                  "unapplied_amount": "number",
                  "items": [
                    {
                      "adjustment_item_type": "string",
                      "amount": "number",
                      "description": "string",
                      "reason": {
                        "name": "string",
                        "id": "1438752"
                      },
                      "secondary_reason": {
                        "name": "string",
                        "id": "1438752"
                      },
                      "category": {
                        "charge_category_type": "string",
                        "name": "string",
                        "id": "1438752"
                      },
                      "id": "1438752"
                    }
                  ],
                  "id": "1438752"
                },
                "applied_on": "string (date-time)",
                "amount": "number",
                "adjustment_application_type": "string",
                "id": "1438752"
              }
            ],
            "payment_plans": [
              {
                "id": "1438752"
              }
            ],
            "invoice_content_metadatas": [
              {
                "name": "string",
                "description": "string",
                "distributed": "boolean",
                "created_by": "string",
                "valid_from": "string (date-time)",
                "valid_to": "string (date-time)",
                "invoice_content_type": "string",
                "bill_interval_run": {
                  "bill_run_type": "string",
                  "id": "1438752"
                },
                "id": "1438752"
              }
            ],
            "distribution_status": "string",
            "id": "1438752"
          }
        ],
        "bill_run_type": "string",
        "step_status": "string",
        "sequence": "integer (int32)",
        "step": "string",
        "status": "string",
        "status_date": "string (date-time)",
        "open_date": "string (date-time)",
        "close_date": "string (date-time)",
        "scheduled_run_date": "string (date-time)",
        "invoice_due_date": "string (date-time)",
        "invoice_date": "string (date-time)",
        "processed_invoice_count": "integer (int64)",
        "error_msg": "string",
        "use_payment_term": "boolean",
        "run_command_actions": [
          "string"
        ],
        "id": "1438752"
      }
    ],
    "currency_code": "string",
    "name": "string",
    "status": "string",
    "billing_account_category": {
      "name": "string",
      "id": "1438752"
    },
    "id": "1438752"
  }
]
Response Headers (200 OK)
X-total-count

The total results for the particular query. Used to drive paging requests.

integer (int64)
X-element-count

The number of elements returned in the current request. Used to drive paging requests.

integer (int64)
X-total-pages

The total number of pages that can be requested. Used to drive paging requests.

integer (int64)
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (default )
{
  "code": "string",
  "message": "string"
}

Create on-demand bill batch

POST /bill-batches

Creates an on-demand bill batch allowing multiple billing accounts.

A payload for creating an on-demand bill batch allowing multiple billing accounts.

Prefer: string
in header

The HTTP Prefer header per https://tools.ietf.org/html/rfc7240. The 'return=[representation|minimal]' preferences are the only implemented settings at the moment and are the same as 'return=SIMPLE', and it indicates that the client wishes the server to return a minimal response to a successful request. The 'return=representation' preference in this header is the same as setting query parameter 'return=FULL'.

Request Example
{
  "end_date": "string (date-time)",
  "billing_accounts": [
    {
      "account_num": "104-2345676",
      "external_account_num": "ACME 543-0987",
      "id": "1438752"
    }
  ],
  "auto_run": "boolean",
  "bill_batch_type": "string",
  "description": "string",
  "invoice_date": "string (date-time)",
  "auto_approve": "boolean",
  "invoice_due_date": "string (date-time)",
  "name": "string",
  "use_payment_term": "boolean"
}

Success

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Example (200 OK)
{
  "internal_render": "boolean",
  "end_date": "string (date-time)",
  "billing_accounts": [
    {
      "account_num": "104-2345676",
      "external_account_num": "ACME 543-0987",
      "cpq_discounts": [
        {
          "start_date": "string (date-time)",
          "deactivation_date": "string (date-time)",
          "duration": "integer (int32)",
          "recurrence": "string",
          "value": "number",
          "application_type": "string",
          "price_type": "string",
          "discount_key": "string",
          "id": "string (uuid)"
        }
      ],
      "id": "1438752"
    }
  ],
  "bill_batch_type": "string",
  "description": "string",
  "auto_approve": "boolean",
  "use_payment_term": "boolean",
  "bill_batch_runs": [
    {
      "invoices": [
        {
          "invoice_type": "string",
          "invoice_num": "string",
          "external_invoice_num": "string",
          "amount": "number",
          "description": "string",
          "billing_account": {
            "account_num": "104-2345676",
            "external_account_num": "ACME 543-0987",
            "bill_cycle": {
              "bill_cycle_type": "string",
              "name": "string",
              "id": "1438752"
            },
            "responsible_party": {
              "party_type": "string",
              "customer_num": "string",
              "external_customer_num": "string",
              "default_billing_account": {
                "account_num": "104-2345676",
                "external_account_num": "ACME 543-0987",
                "cpq_discounts": [
                  {
                    "start_date": "string (date-time)",
                    "deactivation_date": "string (date-time)",
                    "duration": "integer (int32)",
                    "recurrence": "string",
                    "value": "number",
                    "application_type": "string",
                    "price_type": "string",
                    "discount_key": "string",
                    "id": "string (uuid)"
                  }
                ],
                "id": "1438752"
              },
              "tax_id_number": "string",
              "addresses": [
                {
                  "address_type": "string",
                  "id": "1438752"
                }
              ],
              "contact_category": {
                "name": "string",
                "id": "1438752"
              },
              "id": "1438752"
            },
            "billing_account_category": {
              "name": "string",
              "id": "1438752"
            },
            "bill_type": "string",
            "auto_payment_authorized": "boolean",
            "status": "string",
            "status_reason": {
              "reason_type": "string",
              "name": "string",
              "description": "string",
              "status": "string",
              "id": "1438752"
            },
            "pending_charges_total": 200,
            "balance": 100,
            "currency_code": "string",
            "recurring_payments": [
              {
                "payment_method": {
                  "payment_method_type": "string",
                  "custom_field_values": [
                    {
                      "custom_field": {
                        "name": "string",
                        "custom_field_type": "string",
                        "id": "1438752"
                      },
                      "custom_field_value_type": "string",
                      "value": "string",
                      "id": "1438752"
                    }
                  ],
                  "multi_factor_auth": "boolean",
                  "id": "1438752"
                },
                "billing_account": {
                  "account_num": "104-2345676",
                  "external_account_num": "ACME 543-0987",
                  "cpq_discounts": [
                    {
                      "start_date": "string (date-time)",
                      "deactivation_date": "string (date-time)",
                      "duration": "integer (int32)",
                      "recurrence": "string",
                      "value": "number",
                      "application_type": "string",
                      "price_type": "string",
                      "discount_key": "string",
                      "id": "string (uuid)"
                    }
                  ],
                  "id": "1438752"
                },
                "valid_from": "string (date-time)",
                "valid_to": "string (date-time)",
                "auto_payment": "boolean",
                "id": "1438752"
              }
            ],
            "custom_field_values": [
              {
                "custom_field": {
                  "name": "string",
                  "custom_field_type": "string",
                  "id": "1438752"
                },
                "custom_field_value_type": "string",
                "value": "string",
                "id": "1438752"
              }
            ],
            "contacts": [
              {
                "party_type": "string",
                "first_name": "string",
                "last_name": "string",
                "middle_name": "string",
                "suffix": "string",
                "dob": "string (date)",
                "company": "string",
                "department": "string",
                "title": "string",
                "tax_id_number": "string",
                "addresses": [
                  {
                    "address_type": "string",
                    "id": "1438752"
                  }
                ],
                "contact_category": {
                  "name": "string",
                  "id": "1438752"
                },
                "id": "1438752"
              }
            ],
            "payment_term": {
              "name": "string",
              "id": "1438752"
            },
            "effective_payment_term": {
              "name": "string",
              "term_days": "integer (int32)",
              "grace_days": "integer (int32)",
              "id": "1438752"
            },
            "start_date": "2015-04-01T12:13:26.000-05:00",
            "end_date": "2015-04-12T08:21:45.000-05:00",
            "tax_exempt": "boolean",
            "next_invoice_date": "2015-04-12T00:00:00.000-05:00",
            "parent_billing_account": {
              "account_num": "104-2345676",
              "external_account_num": "ACME 543-0987",
              "cpq_discounts": [
                {
                  "start_date": "string (date-time)",
                  "deactivation_date": "string (date-time)",
                  "duration": "integer (int32)",
                  "recurrence": "string",
                  "value": "number",
                  "application_type": "string",
                  "price_type": "string",
                  "discount_key": "string",
                  "id": "string (uuid)"
                }
              ],
              "id": "1438752"
            },
            "responsible_account": {
              "account_num": "104-2345676",
              "external_account_num": "ACME 543-0987",
              "cpq_discounts": [
                {
                  "start_date": "string (date-time)",
                  "deactivation_date": "string (date-time)",
                  "duration": "integer (int32)",
                  "recurrence": "string",
                  "value": "number",
                  "application_type": "string",
                  "price_type": "string",
                  "discount_key": "string",
                  "id": "string (uuid)"
                }
              ],
              "id": "1438752"
            },
            "auto_pay_offset": "integer (int32)",
            "cpq_discounts": [
              {
                "start_date": "string (date-time)",
                "deactivation_date": "string (date-time)",
                "duration": "integer (int32)",
                "recurrence": "string",
                "value": "number",
                "application_type": "string",
                "price_type": "string",
                "discount_key": "string",
                "id": "string (uuid)"
              }
            ],
            "responsible_account_invoice_rendering_type": "string",
            "background_allocation": "boolean",
            "dunning_state": {
              "enabled": "boolean",
              "plan_code": "string",
              "plan_name": "string",
              "tier_code": "string",
              "tier_name": "string",
              "effective_date": "string (date-time)",
              "previous_tier_code": "string",
              "previous_tier_name": "string",
              "id": "1438752"
            },
            "tax_exemptions": [
              {
                "certificate": "string",
                "valid_from": "string (date-time)",
                "valid_to": "string (date-time)",
                "exemption_category": {
                  "name": "string",
                  "id": "1438752"
                },
                "all_states": "boolean",
                "states": [
                  "string"
                ],
                "id": "1438752"
              }
            ],
            "preferred_language_code": "string",
            "minimum_invoice_amount": "number",
            "billing_schedules": [
              {
                "billing_schedule_type": "string",
                "id": "1438752"
              }
            ],
            "past_due_amount": "number",
            "id": "1438752"
          },
          "original_billing_account": {
            "account_num": "104-2345676",
            "external_account_num": "ACME 543-0987",
            "cpq_discounts": [
              {
                "start_date": "string (date-time)",
                "deactivation_date": "string (date-time)",
                "duration": "integer (int32)",
                "recurrence": "string",
                "value": "number",
                "application_type": "string",
                "price_type": "string",
                "discount_key": "string",
                "id": "string (uuid)"
              }
            ],
            "id": "1438752"
          },
          "occurred_on": "string (date-time)",
          "due_date": "string (date)",
          "original_due_date": "string (date)",
          "paid_date": "string (date-time)",
          "amount_to_pay": "number",
          "late_fee_charged": "boolean",
          "invoice_items": [
            {
              "invoice_item_type": "string",
              "quantity": "number",
              "unit_amount": "number",
              "total_amount": "number",
              "description": "string",
              "billing_account": {
                "account_num": "104-2345676",
                "external_account_num": "ACME 543-0987",
                "cpq_discounts": [
                  {
                    "start_date": "string (date-time)",
                    "deactivation_date": "string (date-time)",
                    "duration": "integer (int32)",
                    "recurrence": "string",
                    "value": "number",
                    "application_type": "string",
                    "price_type": "string",
                    "discount_key": "string",
                    "id": "string (uuid)"
                  }
                ],
                "id": "1438752"
              },
              "taxable": "boolean",
              "prorated_percentage": "number",
              "start_date": "string (date-time)",
              "end_date": "string (date-time)",
              "invoice_line_item_type": "string",
              "charges": [
                {
                  "invoice_item_charge_type": "string",
                  "un_prorated_amount": "number",
                  "amount": "number",
                  "price_category": {
                    "charge_category_type": "string",
                    "name": "string",
                    "id": "1438752"
                  },
                  "balance": "number",
                  "paid": "boolean",
                  "recurring_charge": "boolean",
                  "bill_in_advance": "boolean",
                  "description": "string",
                  "quantity": "number",
                  "exclude_from_taxation": "boolean",
                  "tax_inclusive": "boolean",
                  "details": [
                    {
                      "charge_detail_type": "string",
                      "amount": "number",
                      "id": "1438752"
                    }
                  ],
                  "id": "1438752"
                }
              ],
              "invoice": "#/definitions/Invoice",
              "sourced_item_count": "number",
              "id": "1438752"
            }
          ],
          "status": "string",
          "billing_statement": {
            "statement_type": "string",
            "total_amount": "number",
            "service_charges": "number",
            "activity_charges": "number",
            "other_charges_and_credits": "number",
            "taxes_and_fees": "number",
            "total_current_charges": "number",
            "total_tax_inclusive_amount": "number",
            "id": "1438752"
          },
          "auto_payment_date": "string (date)",
          "disputed": "boolean",
          "adjustment_applications": [
            {
              "invoice": {
                "invoice_type": "string",
                "invoice_num": "string",
                "id": "1438752"
              },
              "account_adjustment": {
                "occurred_on": "string (date-time)",
                "amount": "number",
                "description": "string",
                "invoiced": "boolean",
                "status": "string",
                "adjustment_type": "string",
                "billing_account": {
                  "account_num": "104-2345676",
                  "external_account_num": "ACME 543-0987",
                  "cpq_discounts": [
                    {
                      "start_date": "string (date-time)",
                      "deactivation_date": "string (date-time)",
                      "duration": "integer (int32)",
                      "recurrence": "string",
                      "value": "number",
                      "application_type": "string",
                      "price_type": "string",
                      "discount_key": "string",
                      "id": "string (uuid)"
                    }
                  ],
                  "id": "1438752"
                },
                "reason": {
                  "name": "string",
                  "id": "1438752"
                },
                "secondary_reason": {
                  "name": "string",
                  "id": "1438752"
                },
                "posted_on": "string (date-time)",
                "posted_by": "string",
                "unapplied_amount": "number",
                "items": [
                  {
                    "adjustment_item_type": "string",
                    "amount": "number",
                    "description": "string",
                    "reason": {
                      "name": "string",
                      "id": "1438752"
                    },
                    "secondary_reason": {
                      "name": "string",
                      "id": "1438752"
                    },
                    "category": {
                      "charge_category_type": "string",
                      "name": "string",
                      "id": "1438752"
                    },
                    "id": "1438752"
                  }
                ],
                "id": "1438752"
              },
              "applied_on": "string (date-time)",
              "amount": "number",
              "adjustment_application_type": "string",
              "id": "1438752"
            }
          ],
          "payment_plans": [
            {
              "id": "1438752"
            }
          ],
          "invoice_content_metadatas": [
            {
              "name": "string",
              "description": "string",
              "distributed": "boolean",
              "created_by": "string",
              "valid_from": "string (date-time)",
              "valid_to": "string (date-time)",
              "invoice_content_type": "string",
              "bill_interval_run": {
                "bill_run_type": "string",
                "id": "1438752"
              },
              "id": "1438752"
            }
          ],
          "distribution_status": "string",
          "id": "1438752"
        }
      ],
      "bill_run_type": "string",
      "step_status": "string",
      "sequence": "integer (int32)",
      "step": "string",
      "status": "string",
      "status_date": "string (date-time)",
      "open_date": "string (date-time)",
      "close_date": "string (date-time)",
      "scheduled_run_date": "string (date-time)",
      "invoice_due_date": "string (date-time)",
      "invoice_date": "string (date-time)",
      "processed_invoice_count": "integer (int64)",
      "error_msg": "string",
      "use_payment_term": "boolean",
      "run_command_actions": [
        "string"
      ],
      "id": "1438752"
    }
  ],
  "currency_code": "string",
  "name": "string",
  "status": "string",
  "billing_account_category": {
    "name": "string",
    "id": "1438752"
  },
  "id": "1438752"
}
Response Headers (200 OK)
Preference-Applied

Settings applied from the "Prefer" header.

string
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (default )
{
  "code": "string",
  "message": "string"
}

Get billing accounts

GET /bill-batches/{bill_batch_id}/billing-accounts

Uses query keys to retrieve a subset of billing accounts.

bill_batch_id: string
in path

The ID of the bill batch.

filter: string
in query

Filters query results using the Gotransverse API Query Language. It allows API consumers to view response data evaluated against the specified filter criteria. For example, filter=(status EQ 'SUSPENDED') OR (status EQ 'ACTIVE') will return items in either SUSPENDED or ACTIVE status. For a list of comparison and logical operators as well as use cases, refer to the Filtering section in the API Getting Started guide.

sort: string[]
in query

Sorts query results in ascending or descending order. By default, query results are sorted in the ascending order. To sort in the descending order, insert - in front of the query parameter name. For example, sort=-name value sorts the results in the descending order by the name query parameter. For details and use cases, refer to the Sorting section in the API Getting Started guide.

Array values passed separated by comma: ?sort=aaa,bbb

return: string SIMPLE, FULL FULL
in query

Specifies the amount of detail to provide in a response. The value may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer HTTP header parameter to return=minimal, and FULL is the same as the header parameter set to return=representation.

page_number: integer (int32) x ≥ 0 1
in query

The page number for multiple page queries.

page_size: integer (int32) 0 ≤ x ≤ 50 50
in query

The page size for multiple page queries. Default maximum is 50.

id: string
in query

(sortable) The internal ID of the object.

account_num: string
in query

(sortable) The billing account number.

external_account_num: string
in query

(sortable) The account number tied to an external system.

Success

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Example (200 OK)
[
  {
    "account_num": "104-2345676",
    "external_account_num": "ACME 543-0987",
    "bill_cycle": {
      "bill_cycle_type": "string",
      "name": "string",
      "id": "1438752"
    },
    "responsible_party": {
      "party_type": "string",
      "customer_num": "string",
      "external_customer_num": "string",
      "default_billing_account": {
        "account_num": "104-2345676",
        "external_account_num": "ACME 543-0987",
        "cpq_discounts": [
          {
            "start_date": "string (date-time)",
            "deactivation_date": "string (date-time)",
            "duration": "integer (int32)",
            "recurrence": "string",
            "value": "number",
            "application_type": "string",
            "price_type": "string",
            "discount_key": "string",
            "id": "string (uuid)"
          }
        ],
        "id": "1438752"
      },
      "tax_id_number": "string",
      "addresses": [
        {
          "address_type": "string",
          "id": "1438752"
        }
      ],
      "contact_category": {
        "name": "string",
        "id": "1438752"
      },
      "id": "1438752"
    },
    "billing_account_category": {
      "name": "string",
      "id": "1438752"
    },
    "bill_type": "string",
    "auto_payment_authorized": "boolean",
    "status": "string",
    "status_reason": {
      "reason_type": "string",
      "name": "string",
      "description": "string",
      "status": "string",
      "id": "1438752"
    },
    "pending_charges_total": 200,
    "balance": 100,
    "currency_code": "string",
    "recurring_payments": [
      {
        "payment_method": {
          "payment_method_type": "string",
          "custom_field_values": [
            {
              "custom_field": {
                "name": "string",
                "custom_field_type": "string",
                "id": "1438752"
              },
              "custom_field_value_type": "string",
              "value": "string",
              "id": "1438752"
            }
          ],
          "multi_factor_auth": "boolean",
          "id": "1438752"
        },
        "billing_account": {
          "account_num": "104-2345676",
          "external_account_num": "ACME 543-0987",
          "cpq_discounts": [
            {
              "start_date": "string (date-time)",
              "deactivation_date": "string (date-time)",
              "duration": "integer (int32)",
              "recurrence": "string",
              "value": "number",
              "application_type": "string",
              "price_type": "string",
              "discount_key": "string",
              "id": "string (uuid)"
            }
          ],
          "id": "1438752"
        },
        "valid_from": "string (date-time)",
        "valid_to": "string (date-time)",
        "auto_payment": "boolean",
        "id": "1438752"
      }
    ],
    "custom_field_values": [
      {
        "custom_field": {
          "name": "string",
          "custom_field_type": "string",
          "id": "1438752"
        },
        "custom_field_value_type": "string",
        "value": "string",
        "id": "1438752"
      }
    ],
    "contacts": [
      {
        "party_type": "string",
        "first_name": "string",
        "last_name": "string",
        "middle_name": "string",
        "suffix": "string",
        "dob": "string (date)",
        "company": "string",
        "department": "string",
        "title": "string",
        "tax_id_number": "string",
        "addresses": [
          {
            "address_type": "string",
            "id": "1438752"
          }
        ],
        "contact_category": {
          "name": "string",
          "id": "1438752"
        },
        "id": "1438752"
      }
    ],
    "payment_term": {
      "name": "string",
      "id": "1438752"
    },
    "effective_payment_term": {
      "name": "string",
      "term_days": "integer (int32)",
      "grace_days": "integer (int32)",
      "id": "1438752"
    },
    "start_date": "2015-04-01T12:13:26.000-05:00",
    "end_date": "2015-04-12T08:21:45.000-05:00",
    "tax_exempt": "boolean",
    "next_invoice_date": "2015-04-12T00:00:00.000-05:00",
    "parent_billing_account": {
      "account_num": "104-2345676",
      "external_account_num": "ACME 543-0987",
      "cpq_discounts": [
        {
          "start_date": "string (date-time)",
          "deactivation_date": "string (date-time)",
          "duration": "integer (int32)",
          "recurrence": "string",
          "value": "number",
          "application_type": "string",
          "price_type": "string",
          "discount_key": "string",
          "id": "string (uuid)"
        }
      ],
      "id": "1438752"
    },
    "responsible_account": {
      "account_num": "104-2345676",
      "external_account_num": "ACME 543-0987",
      "cpq_discounts": [
        {
          "start_date": "string (date-time)",
          "deactivation_date": "string (date-time)",
          "duration": "integer (int32)",
          "recurrence": "string",
          "value": "number",
          "application_type": "string",
          "price_type": "string",
          "discount_key": "string",
          "id": "string (uuid)"
        }
      ],
      "id": "1438752"
    },
    "auto_pay_offset": "integer (int32)",
    "cpq_discounts": [
      {
        "start_date": "string (date-time)",
        "deactivation_date": "string (date-time)",
        "duration": "integer (int32)",
        "recurrence": "string",
        "value": "number",
        "application_type": "string",
        "price_type": "string",
        "discount_key": "string",
        "id": "string (uuid)"
      }
    ],
    "responsible_account_invoice_rendering_type": "string",
    "background_allocation": "boolean",
    "dunning_state": {
      "enabled": "boolean",
      "plan_code": "string",
      "plan_name": "string",
      "tier_code": "string",
      "tier_name": "string",
      "effective_date": "string (date-time)",
      "previous_tier_code": "string",
      "previous_tier_name": "string",
      "id": "1438752"
    },
    "tax_exemptions": [
      {
        "certificate": "string",
        "valid_from": "string (date-time)",
        "valid_to": "string (date-time)",
        "exemption_category": {
          "name": "string",
          "id": "1438752"
        },
        "all_states": "boolean",
        "states": [
          "string"
        ],
        "id": "1438752"
      }
    ],
    "preferred_language_code": "string",
    "minimum_invoice_amount": "number",
    "billing_schedules": [
      {
        "billing_schedule_type": "string",
        "id": "1438752"
      }
    ],
    "past_due_amount": "number",
    "id": "1438752"
  }
]
Response Headers (200 OK)
X-total-count

The total results for the particular query. Used to drive paging requests.

integer (int64)
X-element-count

The number of elements returned in the current request. Used to drive paging requests.

integer (int64)
X-total-pages

The total number of pages that can be requested. Used to drive paging requests.

integer (int64)
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (default )
{
  "code": "string",
  "message": "string"
}

Add billing accounts to bill batch

POST /bill-batches/{bill_batch_id}/billing-accounts/bulk

Adds billing accounts to the bill batch associated with the specified ID.

bill_batch_id: string
in path

The ID of the bill batch.

Prefer: string
in header

The HTTP Prefer header per https://tools.ietf.org/html/rfc7240. The 'return=[representation|minimal]' preferences are the only implemented settings at the moment and are the same as 'return=SIMPLE', and it indicates that the client wishes the server to return a minimal response to a successful request. The 'return=representation' preference in this header is the same as setting query parameter 'return=FULL'.

Request Example
{
  "billing_accounts": [
    {
      "account_num": "104-2345676",
      "external_account_num": "ACME 543-0987",
      "id": "1438752"
    }
  ]
}
207 Multi-status

Multi status.

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Example (207 Multi-status)
{
  "billing_accounts": [
    {
      "billing_account": {
        "account_num": "104-2345676",
        "external_account_num": "ACME 543-0987",
        "cpq_discounts": [
          {
            "start_date": "string (date-time)",
            "deactivation_date": "string (date-time)",
            "duration": "integer (int32)",
            "recurrence": "string",
            "value": "number",
            "application_type": "string",
            "price_type": "string",
            "discount_key": "string",
            "id": "string (uuid)"
          }
        ],
        "id": "1438752"
      },
      "status_code": "integer",
      "error": {
        "code": "string",
        "message": "string"
      }
    }
  ]
}
Response Headers (207 Multi-status)
Preference-Applied

Settings applied from the "Prefer" header.

string
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (default )
{
  "code": "string",
  "message": "string"
}

Remove billing account from bill batch

POST /bill-batches/{bill_batch_id}/billing-accounts/bulk-remove

Removes a billing account from the bill batch associated with the specified ID.

bill_batch_id: string
in path

The ID of the bill batch.

Prefer: string
in header

The HTTP Prefer header per https://tools.ietf.org/html/rfc7240. The 'return=[representation|minimal]' preferences are the only implemented settings at the moment and are the same as 'return=SIMPLE', and it indicates that the client wishes the server to return a minimal response to a successful request. The 'return=representation' preference in this header is the same as setting query parameter 'return=FULL'.

Request Example
{
  "billing_accounts": [
    {
      "account_num": "104-2345676",
      "external_account_num": "ACME 543-0987",
      "id": "1438752"
    }
  ]
}
207 Multi-status

Multi status.

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Example (207 Multi-status)
{
  "billing_accounts": [
    {
      "billing_account": {
        "account_num": "104-2345676",
        "external_account_num": "ACME 543-0987",
        "cpq_discounts": [
          {
            "start_date": "string (date-time)",
            "deactivation_date": "string (date-time)",
            "duration": "integer (int32)",
            "recurrence": "string",
            "value": "number",
            "application_type": "string",
            "price_type": "string",
            "discount_key": "string",
            "id": "string (uuid)"
          }
        ],
        "id": "1438752"
      },
      "status_code": "integer",
      "error": {
        "code": "string",
        "message": "string"
      }
    }
  ]
}
Response Headers (207 Multi-status)
Preference-Applied

Settings applied from the "Prefer" header.

string
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (default )
{
  "code": "string",
  "message": "string"
}

Get bill batch by ID

GET /bill-batches/{id}

Retrieves an existing bill batch associated with the specified ID.

id: string
in path

The internal ID of the object.

return: string SIMPLE, FULL FULL
in query

Specifies the amount of detail to provide in a response. The value may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer HTTP header parameter to return=minimal, and FULL is the same as the header parameter set to return=representation.

expand: string[]
in query

Specifies additional entities should be "expanded" in the response. An expandable parameter is indicated with (expandable) in its description. Multiple parameters may be specified using the CSV format - each parameter is separated with a , (comma).

Array values passed separated by comma: ?expand=aaa,bbb

200 OK

Success

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Example (200 OK)
{
  "bill_batch_type": "string",
  "description": "string",
  "auto_approve": "boolean",
  "use_payment_term": "boolean",
  "bill_batch_runs": [
    {
      "invoices": [
        {
          "invoice_type": "string",
          "invoice_num": "string",
          "external_invoice_num": "string",
          "amount": "number",
          "description": "string",
          "billing_account": {
            "account_num": "104-2345676",
            "external_account_num": "ACME 543-0987",
            "bill_cycle": {
              "bill_cycle_type": "string",
              "name": "string",
              "id": "1438752"
            },
            "responsible_party": {
              "party_type": "string",
              "customer_num": "string",
              "external_customer_num": "string",
              "default_billing_account": {
                "account_num": "104-2345676",
                "external_account_num": "ACME 543-0987",
                "cpq_discounts": [
                  {
                    "start_date": "string (date-time)",
                    "deactivation_date": "string (date-time)",
                    "duration": "integer (int32)",
                    "recurrence": "string",
                    "value": "number",
                    "application_type": "string",
                    "price_type": "string",
                    "discount_key": "string",
                    "id": "string (uuid)"
                  }
                ],
                "id": "1438752"
              },
              "tax_id_number": "string",
              "addresses": [
                {
                  "address_type": "string",
                  "id": "1438752"
                }
              ],
              "contact_category": {
                "name": "string",
                "id": "1438752"
              },
              "id": "1438752"
            },
            "billing_account_category": {
              "name": "string",
              "id": "1438752"
            },
            "bill_type": "string",
            "auto_payment_authorized": "boolean",
            "status": "string",
            "status_reason": {
              "reason_type": "string",
              "name": "string",
              "description": "string",
              "status": "string",
              "id": "1438752"
            },
            "pending_charges_total": 200,
            "balance": 100,
            "currency_code": "string",
            "recurring_payments": [
              {
                "payment_method": {
                  "payment_method_type": "string",
                  "custom_field_values": [
                    {
                      "custom_field": {
                        "name": "string",
                        "custom_field_type": "string",
                        "id": "1438752"
                      },
                      "custom_field_value_type": "string",
                      "value": "string",
                      "id": "1438752"
                    }
                  ],
                  "multi_factor_auth": "boolean",
                  "id": "1438752"
                },
                "billing_account": {
                  "account_num": "104-2345676",
                  "external_account_num": "ACME 543-0987",
                  "cpq_discounts": [
                    {
                      "start_date": "string (date-time)",
                      "deactivation_date": "string (date-time)",
                      "duration": "integer (int32)",
                      "recurrence": "string",
                      "value": "number",
                      "application_type": "string",
                      "price_type": "string",
                      "discount_key": "string",
                      "id": "string (uuid)"
                    }
                  ],
                  "id": "1438752"
                },
                "valid_from": "string (date-time)",
                "valid_to": "string (date-time)",
                "auto_payment": "boolean",
                "id": "1438752"
              }
            ],
            "custom_field_values": [
              {
                "custom_field": {
                  "name": "string",
                  "custom_field_type": "string",
                  "id": "1438752"
                },
                "custom_field_value_type": "string",
                "value": "string",
                "id": "1438752"
              }
            ],
            "contacts": [
              {
                "party_type": "string",
                "first_name": "string",
                "last_name": "string",
                "middle_name": "string",
                "suffix": "string",
                "dob": "string (date)",
                "company": "string",
                "department": "string",
                "title": "string",
                "tax_id_number": "string",
                "addresses": [
                  {
                    "address_type": "string",
                    "id": "1438752"
                  }
                ],
                "contact_category": {
                  "name": "string",
                  "id": "1438752"
                },
                "id": "1438752"
              }
            ],
            "payment_term": {
              "name": "string",
              "id": "1438752"
            },
            "effective_payment_term": {
              "name": "string",
              "term_days": "integer (int32)",
              "grace_days": "integer (int32)",
              "id": "1438752"
            },
            "start_date": "2015-04-01T12:13:26.000-05:00",
            "end_date": "2015-04-12T08:21:45.000-05:00",
            "tax_exempt": "boolean",
            "next_invoice_date": "2015-04-12T00:00:00.000-05:00",
            "parent_billing_account": {
              "account_num": "104-2345676",
              "external_account_num": "ACME 543-0987",
              "cpq_discounts": [
                {
                  "start_date": "string (date-time)",
                  "deactivation_date": "string (date-time)",
                  "duration": "integer (int32)",
                  "recurrence": "string",
                  "value": "number",
                  "application_type": "string",
                  "price_type": "string",
                  "discount_key": "string",
                  "id": "string (uuid)"
                }
              ],
              "id": "1438752"
            },
            "responsible_account": {
              "account_num": "104-2345676",
              "external_account_num": "ACME 543-0987",
              "cpq_discounts": [
                {
                  "start_date": "string (date-time)",
                  "deactivation_date": "string (date-time)",
                  "duration": "integer (int32)",
                  "recurrence": "string",
                  "value": "number",
                  "application_type": "string",
                  "price_type": "string",
                  "discount_key": "string",
                  "id": "string (uuid)"
                }
              ],
              "id": "1438752"
            },
            "auto_pay_offset": "integer (int32)",
            "cpq_discounts": [
              {
                "start_date": "string (date-time)",
                "deactivation_date": "string (date-time)",
                "duration": "integer (int32)",
                "recurrence": "string",
                "value": "number",
                "application_type": "string",
                "price_type": "string",
                "discount_key": "string",
                "id": "string (uuid)"
              }
            ],
            "responsible_account_invoice_rendering_type": "string",
            "background_allocation": "boolean",
            "dunning_state": {
              "enabled": "boolean",
              "plan_code": "string",
              "plan_name": "string",
              "tier_code": "string",
              "tier_name": "string",
              "effective_date": "string (date-time)",
              "previous_tier_code": "string",
              "previous_tier_name": "string",
              "id": "1438752"
            },
            "tax_exemptions": [
              {
                "certificate": "string",
                "valid_from": "string (date-time)",
                "valid_to": "string (date-time)",
                "exemption_category": {
                  "name": "string",
                  "id": "1438752"
                },
                "all_states": "boolean",
                "states": [
                  "string"
                ],
                "id": "1438752"
              }
            ],
            "preferred_language_code": "string",
            "minimum_invoice_amount": "number",
            "billing_schedules": [
              {
                "billing_schedule_type": "string",
                "id": "1438752"
              }
            ],
            "past_due_amount": "number",
            "id": "1438752"
          },
          "original_billing_account": {
            "account_num": "104-2345676",
            "external_account_num": "ACME 543-0987",
            "cpq_discounts": [
              {
                "start_date": "string (date-time)",
                "deactivation_date": "string (date-time)",
                "duration": "integer (int32)",
                "recurrence": "string",
                "value": "number",
                "application_type": "string",
                "price_type": "string",
                "discount_key": "string",
                "id": "string (uuid)"
              }
            ],
            "id": "1438752"
          },
          "occurred_on": "string (date-time)",
          "due_date": "string (date)",
          "original_due_date": "string (date)",
          "paid_date": "string (date-time)",
          "amount_to_pay": "number",
          "late_fee_charged": "boolean",
          "invoice_items": [
            {
              "invoice_item_type": "string",
              "quantity": "number",
              "unit_amount": "number",
              "total_amount": "number",
              "description": "string",
              "billing_account": {
                "account_num": "104-2345676",
                "external_account_num": "ACME 543-0987",
                "cpq_discounts": [
                  {
                    "start_date": "string (date-time)",
                    "deactivation_date": "string (date-time)",
                    "duration": "integer (int32)",
                    "recurrence": "string",
                    "value": "number",
                    "application_type": "string",
                    "price_type": "string",
                    "discount_key": "string",
                    "id": "string (uuid)"
                  }
                ],
                "id": "1438752"
              },
              "taxable": "boolean",
              "prorated_percentage": "number",
              "start_date": "string (date-time)",
              "end_date": "string (date-time)",
              "invoice_line_item_type": "string",
              "charges": [
                {
                  "invoice_item_charge_type": "string",
                  "un_prorated_amount": "number",
                  "amount": "number",
                  "price_category": {
                    "charge_category_type": "string",
                    "name": "string",
                    "id": "1438752"
                  },
                  "balance": "number",
                  "paid": "boolean",
                  "recurring_charge": "boolean",
                  "bill_in_advance": "boolean",
                  "description": "string",
                  "quantity": "number",
                  "exclude_from_taxation": "boolean",
                  "tax_inclusive": "boolean",
                  "details": [
                    {
                      "charge_detail_type": "string",
                      "amount": "number",
                      "id": "1438752"
                    }
                  ],
                  "id": "1438752"
                }
              ],
              "invoice": "#/definitions/Invoice",
              "sourced_item_count": "number",
              "id": "1438752"
            }
          ],
          "status": "string",
          "billing_statement": {
            "statement_type": "string",
            "total_amount": "number",
            "service_charges": "number",
            "activity_charges": "number",
            "other_charges_and_credits": "number",
            "taxes_and_fees": "number",
            "total_current_charges": "number",
            "total_tax_inclusive_amount": "number",
            "id": "1438752"
          },
          "auto_payment_date": "string (date)",
          "disputed": "boolean",
          "adjustment_applications": [
            {
              "invoice": {
                "invoice_type": "string",
                "invoice_num": "string",
                "id": "1438752"
              },
              "account_adjustment": {
                "occurred_on": "string (date-time)",
                "amount": "number",
                "description": "string",
                "invoiced": "boolean",
                "status": "string",
                "adjustment_type": "string",
                "billing_account": {
                  "account_num": "104-2345676",
                  "external_account_num": "ACME 543-0987",
                  "cpq_discounts": [
                    {
                      "start_date": "string (date-time)",
                      "deactivation_date": "string (date-time)",
                      "duration": "integer (int32)",
                      "recurrence": "string",
                      "value": "number",
                      "application_type": "string",
                      "price_type": "string",
                      "discount_key": "string",
                      "id": "string (uuid)"
                    }
                  ],
                  "id": "1438752"
                },
                "reason": {
                  "name": "string",
                  "id": "1438752"
                },
                "secondary_reason": {
                  "name": "string",
                  "id": "1438752"
                },
                "posted_on": "string (date-time)",
                "posted_by": "string",
                "unapplied_amount": "number",
                "items": [
                  {
                    "adjustment_item_type": "string",
                    "amount": "number",
                    "description": "string",
                    "reason": {
                      "name": "string",
                      "id": "1438752"
                    },
                    "secondary_reason": {
                      "name": "string",
                      "id": "1438752"
                    },
                    "category": {
                      "charge_category_type": "string",
                      "name": "string",
                      "id": "1438752"
                    },
                    "id": "1438752"
                  }
                ],
                "id": "1438752"
              },
              "applied_on": "string (date-time)",
              "amount": "number",
              "adjustment_application_type": "string",
              "id": "1438752"
            }
          ],
          "payment_plans": [
            {
              "id": "1438752"
            }
          ],
          "invoice_content_metadatas": [
            {
              "name": "string",
              "description": "string",
              "distributed": "boolean",
              "created_by": "string",
              "valid_from": "string (date-time)",
              "valid_to": "string (date-time)",
              "invoice_content_type": "string",
              "bill_interval_run": {
                "bill_run_type": "string",
                "id": "1438752"
              },
              "id": "1438752"
            }
          ],
          "distribution_status": "string",
          "id": "1438752"
        }
      ],
      "bill_run_type": "string",
      "step_status": "string",
      "sequence": "integer (int32)",
      "step": "string",
      "status": "string",
      "status_date": "string (date-time)",
      "open_date": "string (date-time)",
      "close_date": "string (date-time)",
      "scheduled_run_date": "string (date-time)",
      "invoice_due_date": "string (date-time)",
      "invoice_date": "string (date-time)",
      "processed_invoice_count": "integer (int64)",
      "error_msg": "string",
      "use_payment_term": "boolean",
      "run_command_actions": [
        "string"
      ],
      "id": "1438752"
    }
  ],
  "currency_code": "string",
  "name": "string",
  "status": "string",
  "billing_account_category": {
    "name": "string",
    "id": "1438752"
  },
  "id": "1438752"
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (default )
{
  "code": "string",
  "message": "string"
}

Update bill batch

PUT /bill-batches/{id}

Updates an existing bill batch associated with the specified ID.

A payload for updating an existing bill batch.

id: string
in path

The internal ID of the object.

Prefer: string
in header

The HTTP Prefer header per https://tools.ietf.org/html/rfc7240. The 'return=[representation|minimal]' preferences are the only implemented settings at the moment and are the same as 'return=SIMPLE', and it indicates that the client wishes the server to return a minimal response to a successful request. The 'return=representation' preference in this header is the same as setting query parameter 'return=FULL'.

Request Example
{
  "bill_batch_type": "string",
  "description": "string",
  "auto_approve": "boolean",
  "currency_code": "string",
  "name": "string",
  "status": "string",
  "billing_account_category": {
    "name": "string",
    "id": "1438752"
  }
}
200 OK

Success

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Example (200 OK)
{
  "bill_batch_type": "string",
  "description": "string",
  "auto_approve": "boolean",
  "use_payment_term": "boolean",
  "bill_batch_runs": [
    {
      "invoices": [
        {
          "invoice_type": "string",
          "invoice_num": "string",
          "external_invoice_num": "string",
          "amount": "number",
          "description": "string",
          "billing_account": {
            "account_num": "104-2345676",
            "external_account_num": "ACME 543-0987",
            "bill_cycle": {
              "bill_cycle_type": "string",
              "name": "string",
              "id": "1438752"
            },
            "responsible_party": {
              "party_type": "string",
              "customer_num": "string",
              "external_customer_num": "string",
              "default_billing_account": {
                "account_num": "104-2345676",
                "external_account_num": "ACME 543-0987",
                "cpq_discounts": [
                  {
                    "start_date": "string (date-time)",
                    "deactivation_date": "string (date-time)",
                    "duration": "integer (int32)",
                    "recurrence": "string",
                    "value": "number",
                    "application_type": "string",
                    "price_type": "string",
                    "discount_key": "string",
                    "id": "string (uuid)"
                  }
                ],
                "id": "1438752"
              },
              "tax_id_number": "string",
              "addresses": [
                {
                  "address_type": "string",
                  "id": "1438752"
                }
              ],
              "contact_category": {
                "name": "string",
                "id": "1438752"
              },
              "id": "1438752"
            },
            "billing_account_category": {
              "name": "string",
              "id": "1438752"
            },
            "bill_type": "string",
            "auto_payment_authorized": "boolean",
            "status": "string",
            "status_reason": {
              "reason_type": "string",
              "name": "string",
              "description": "string",
              "status": "string",
              "id": "1438752"
            },
            "pending_charges_total": 200,
            "balance": 100,
            "currency_code": "string",
            "recurring_payments": [
              {
                "payment_method": {
                  "payment_method_type": "string",
                  "custom_field_values": [
                    {
                      "custom_field": {
                        "name": "string",
                        "custom_field_type": "string",
                        "id": "1438752"
                      },
                      "custom_field_value_type": "string",
                      "value": "string",
                      "id": "1438752"
                    }
                  ],
                  "multi_factor_auth": "boolean",
                  "id": "1438752"
                },
                "billing_account": {
                  "account_num": "104-2345676",
                  "external_account_num": "ACME 543-0987",
                  "cpq_discounts": [
                    {
                      "start_date": "string (date-time)",
                      "deactivation_date": "string (date-time)",
                      "duration": "integer (int32)",
                      "recurrence": "string",
                      "value": "number",
                      "application_type": "string",
                      "price_type": "string",
                      "discount_key": "string",
                      "id": "string (uuid)"
                    }
                  ],
                  "id": "1438752"
                },
                "valid_from": "string (date-time)",
                "valid_to": "string (date-time)",
                "auto_payment": "boolean",
                "id": "1438752"
              }
            ],
            "custom_field_values": [
              {
                "custom_field": {
                  "name": "string",
                  "custom_field_type": "string",
                  "id": "1438752"
                },
                "custom_field_value_type": "string",
                "value": "string",
                "id": "1438752"
              }
            ],
            "contacts": [
              {
                "party_type": "string",
                "first_name": "string",
                "last_name": "string",
                "middle_name": "string",
                "suffix": "string",
                "dob": "string (date)",
                "company": "string",
                "department": "string",
                "title": "string",
                "tax_id_number": "string",
                "addresses": [
                  {
                    "address_type": "string",
                    "id": "1438752"
                  }
                ],
                "contact_category": {
                  "name": "string",
                  "id": "1438752"
                },
                "id": "1438752"
              }
            ],
            "payment_term": {
              "name": "string",
              "id": "1438752"
            },
            "effective_payment_term": {
              "name": "string",
              "term_days": "integer (int32)",
              "grace_days": "integer (int32)",
              "id": "1438752"
            },
            "start_date": "2015-04-01T12:13:26.000-05:00",
            "end_date": "2015-04-12T08:21:45.000-05:00",
            "tax_exempt": "boolean",
            "next_invoice_date": "2015-04-12T00:00:00.000-05:00",
            "parent_billing_account": {
              "account_num": "104-2345676",
              "external_account_num": "ACME 543-0987",
              "cpq_discounts": [
                {
                  "start_date": "string (date-time)",
                  "deactivation_date": "string (date-time)",
                  "duration": "integer (int32)",
                  "recurrence": "string",
                  "value": "number",
                  "application_type": "string",
                  "price_type": "string",
                  "discount_key": "string",
                  "id": "string (uuid)"
                }
              ],
              "id": "1438752"
            },
            "responsible_account": {
              "account_num": "104-2345676",
              "external_account_num": "ACME 543-0987",
              "cpq_discounts": [
                {
                  "start_date": "string (date-time)",
                  "deactivation_date": "string (date-time)",
                  "duration": "integer (int32)",
                  "recurrence": "string",
                  "value": "number",
                  "application_type": "string",
                  "price_type": "string",
                  "discount_key": "string",
                  "id": "string (uuid)"
                }
              ],
              "id": "1438752"
            },
            "auto_pay_offset": "integer (int32)",
            "cpq_discounts": [
              {
                "start_date": "string (date-time)",
                "deactivation_date": "string (date-time)",
                "duration": "integer (int32)",
                "recurrence": "string",
                "value": "number",
                "application_type": "string",
                "price_type": "string",
                "discount_key": "string",
                "id": "string (uuid)"
              }
            ],
            "responsible_account_invoice_rendering_type": "string",
            "background_allocation": "boolean",
            "dunning_state": {
              "enabled": "boolean",
              "plan_code": "string",
              "plan_name": "string",
              "tier_code": "string",
              "tier_name": "string",
              "effective_date": "string (date-time)",
              "previous_tier_code": "string",
              "previous_tier_name": "string",
              "id": "1438752"
            },
            "tax_exemptions": [
              {
                "certificate": "string",
                "valid_from": "string (date-time)",
                "valid_to": "string (date-time)",
                "exemption_category": {
                  "name": "string",
                  "id": "1438752"
                },
                "all_states": "boolean",
                "states": [
                  "string"
                ],
                "id": "1438752"
              }
            ],
            "preferred_language_code": "string",
            "minimum_invoice_amount": "number",
            "billing_schedules": [
              {
                "billing_schedule_type": "string",
                "id": "1438752"
              }
            ],
            "past_due_amount":