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

API query language string. The syntax of the API query language is similar to SQL, the criteria are expressed in the form of predicates. On the left side of the equation, there is a name of the available query parameter (for example, billing_account_id). On the right side, there is a constant value in single quotes ('sample value'). Brackets are used to group predicates, for example, '(start_date GT '1994-01-24T23:33:07+00:00')'. Use the following logical operators: AND - conjunction, OR - disjunction, NOT - negation. Compare operators: NEQ - Not equals, EQ - Equals, LT - Less, LTE - Less or equals, GT - Greater, GTE - Greater or equals, IS NULL - Is null, IS NOT NULL - Is not null, LIKE - Match pattern (LIKE operator is only applicable to parameters of the string type). Wildcard characters: '%' - matches any number of characters, including no characters, ' ' - matches exactly one character. Here is the sample query: the accountnum GT '15' AND (name LIKE 'start of name% end of name' OR status EQ 'ACTIVE').

sort: string[]
in query

Arranges search results in either ascending or descending order. By default, response results are sorted in the ascending order. To sort results in the descending order, use "-". For example, the "-name." value sorts the results in the descending order by name, and "id" sorts results in the ascending order by ID.

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, it may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer 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

The internal ID of the object.

product_id: string
in query

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
in query

The type of the action.

agreement_id: string
in query

The ID of the agreement.

bill_cycle_id: string
in query

The ID of the bill cycle.

200 OK

Success

type
400 Bad Request

Bad request.

default

Unknown error.

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "name": "string",
    "enabled": "boolean",
    "friendly_name": "string",
    "supports_approval": "boolean",
    "action_type": "string",
    "operations": [
      {
        "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, it may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer 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 Content-Types: application/json
Response Example (200 OK)
{
  "name": "string",
  "enabled": "boolean",
  "friendly_name": "string",
  "supports_approval": "boolean",
  "action_type": "string",
  "operations": [
    {
      "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

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

API query language string. The syntax of the API query language is similar to SQL, the criteria are expressed in the form of predicates. On the left side of the equation, there is a name of the available query parameter (for example, billing_account_id). On the right side, there is a constant value in single quotes ('sample value'). Brackets are used to group predicates, for example, '(start_date GT '1994-01-24T23:33:07+00:00')'. Use the following logical operators: AND - conjunction, OR - disjunction, NOT - negation. Compare operators: NEQ - Not equals, EQ - Equals, LT - Less, LTE - Less or equals, GT - Greater, GTE - Greater or equals, IS NULL - Is null, IS NOT NULL - Is not null, LIKE - Match pattern (LIKE operator is only applicable to parameters of the string type). Wildcard characters: '%' - matches any number of characters, including no characters, ' ' - matches exactly one character. Here is the sample query: the accountnum GT '15' AND (name LIKE 'start of name% end of name' OR status EQ 'ACTIVE').

sort: string[]
in query

Arranges search results in either ascending or descending order. By default, response results are sorted in the ascending order. To sort results in the descending order, use "-". For example, the "-name." value sorts the results in the descending order by name, and "id" sorts results in the ascending order by ID.

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, it may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer 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

The internal ID of the object.

Success

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "name": "string",
    "enabled": "boolean",
    "friendly_name": "string",
    "supports_approval": "boolean",
    "action_type": "string",
    "operations": [
      {
        "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 actions

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, it may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer 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 Content-Types: application/json
Response Example (200 OK)
{
  "name": "string",
  "enabled": "boolean",
  "friendly_name": "string",
  "supports_approval": "boolean",
  "action_type": "string",
  "operations": [
    {
      "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

API query language string. The syntax of the API query language is similar to SQL, the criteria are expressed in the form of predicates. On the left side of the equation, there is a name of the available query parameter (for example, billing_account_id). On the right side, there is a constant value in single quotes ('sample value'). Brackets are used to group predicates, for example, '(start_date GT '1994-01-24T23:33:07+00:00')'. Use the following logical operators: AND - conjunction, OR - disjunction, NOT - negation. Compare operators: NEQ - Not equals, EQ - Equals, LT - Less, LTE - Less or equals, GT - Greater, GTE - Greater or equals, IS NULL - Is null, IS NOT NULL - Is not null, LIKE - Match pattern (LIKE operator is only applicable to parameters of the string type). Wildcard characters: '%' - matches any number of characters, including no characters, ' ' - matches exactly one character. Here is the sample query: the accountnum GT '15' AND (name LIKE 'start of name% end of name' OR status EQ 'ACTIVE').

sort: string[]
in query

Arranges search results in either ascending or descending order. By default, response results are sorted in the ascending order. To sort results in the descending order, use "-". For example, the "-name." value sorts the results in the descending order by name, and "id" sorts results in the ascending order by ID.

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, it may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer 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

The internal ID of the object.

adjustment_id: string
in query

The ID of the adjustment.

billing_account_id: string
in query

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

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

The ID of the invoice.

invoice_num: string
in query

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 Content-Types: application/json
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"
    },
    "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, it may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer 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 Content-Types: application/json
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"
  },
  "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

API query language string. The syntax of the API query language is similar to SQL, the criteria are expressed in the form of predicates. On the left side of the equation, there is a name of the available query parameter (for example, billing_account_id). On the right side, there is a constant value in single quotes ('sample value'). Brackets are used to group predicates, for example, '(start_date GT '1994-01-24T23:33:07+00:00')'. Use the following logical operators: AND - conjunction, OR - disjunction, NOT - negation. Compare operators: NEQ - Not equals, EQ - Equals, LT - Less, LTE - Less or equals, GT - Greater, GTE - Greater or equals, IS NULL - Is null, IS NOT NULL - Is not null, LIKE - Match pattern (LIKE operator is only applicable to parameters of the string type). Wildcard characters: '%' - matches any number of characters, including no characters, ' ' - matches exactly one character. Here is the sample query: the accountnum GT '15' AND (name LIKE 'start of name% end of name' OR status EQ 'ACTIVE').

sort: string[]
in query

Arranges search results in either ascending or descending order. By default, response results are sorted in the ascending order. To sort results in the descending order, use "-". For example, the "-name." value sorts the results in the descending order by name, and "id" sorts results in the ascending order by ID.

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, it may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer 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

The internal ID of the object.

name: string
in query

The name of the adjustment charge category.

status: string ACTIVE, SUSPENDED, CANCELED
in query

The status of the adjustment charge category.

Success

400 Bad Request

Bad request.

default

Unknown error.

Response Content-Types: application/json
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, it may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer 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 Content-Types: application/json
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

API query language string. The syntax of the API query language is similar to SQL, the criteria are expressed in the form of predicates. On the left side of the equation, there is a name of the available query parameter (for example, billing_account_id). On the right side, there is a constant value in single quotes ('sample value'). Brackets are used to group predicates, for example, '(start_date GT '1994-01-24T23:33:07+00:00')'. Use the following logical operators: AND - conjunction, OR - disjunction, NOT - negation. Compare operators: NEQ - Not equals, EQ - Equals, LT - Less, LTE - Less or equals, GT - Greater, GTE - Greater or equals, IS NULL - Is null, IS NOT NULL - Is not null, LIKE - Match pattern (LIKE operator is only applicable to parameters of the string type). Wildcard characters: '%' - matches any number of characters, including no characters, ' ' - matches exactly one character. Here is the sample query: the accountnum GT '15' AND (name LIKE 'start of name% end of name' OR status EQ 'ACTIVE').

sort: string[]
in query

Arranges search results in either ascending or descending order. By default, response results are sorted in the ascending order. To sort results in the descending order, use "-". For example, the "-name." value sorts the results in the descending order by name, and "id" sorts results in the ascending order by ID.

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, it may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer 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

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

The name of the agreement.

product_id: string
in query

The ID of the product.

status: string DRAFT, ACTIVE, SUSPENDED
in query

The status of the agreement.

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 Content-Types: application/json
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"
    },
    "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, it may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer 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 Content-Types: application/json
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"
  },
  "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

API query language string. The syntax of the API query language is similar to SQL, the criteria are expressed in the form of predicates. On the left side of the equation, there is a name of the available query parameter (for example, billing_account_id). On the right side, there is a constant value in single quotes ('sample value'). Brackets are used to group predicates, for example, '(start_date GT '1994-01-24T23:33:07+00:00')'. Use the following logical operators: AND - conjunction, OR - disjunction, NOT - negation. Compare operators: NEQ - Not equals, EQ - Equals, LT - Less, LTE - Less or equals, GT - Greater, GTE - Greater or equals, IS NULL - Is null, IS NOT NULL - Is not null, LIKE - Match pattern (LIKE operator is only applicable to parameters of the string type). Wildcard characters: '%' - matches any number of characters, including no characters, ' ' - matches exactly one character. Here is the sample query: the accountnum GT '15' AND (name LIKE 'start of name% end of name' OR status EQ 'ACTIVE').

sort: string[]
in query

Arranges search results in either ascending or descending order. By default, response results are sorted in the ascending order. To sort results in the descending order, use "-". For example, the "-name." value sorts the results in the descending order by name, and "id" sorts results in the ascending order by ID.

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, it may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer 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

The internal ID of the object.

service_id: string
in query

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

The ID of the product.

billing_account_id: string
in query

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

The status of the service.

Success

400 Bad Request

Bad request.

default

Unknown error.

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "start_date": "string (date-time)",
    "next_service_pay_on_purchase": "boolean",
    "renewed": "boolean",
    "accumulated_charges_amount": "number",
    "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_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",
    "minimum_amount_currency_code": "string",
    "omit_minimum_amount": "boolean",
    "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.

agreement_service_id: string
in path

The ID of the agreement service.

filter: string
in query

API query language string. The syntax of the API query language is similar to SQL, the criteria are expressed in the form of predicates. On the left side of the equation, there is a name of the available query parameter (for example, billing_account_id). On the right side, there is a constant value in single quotes ('sample value'). Brackets are used to group predicates, for example, '(start_date GT '1994-01-24T23:33:07+00:00')'. Use the following logical operators: AND - conjunction, OR - disjunction, NOT - negation. Compare operators: NEQ - Not equals, EQ - Equals, LT - Less, LTE - Less or equals, GT - Greater, GTE - Greater or equals, IS NULL - Is null, IS NOT NULL - Is not null, LIKE - Match pattern (LIKE operator is only applicable to parameters of the string type). Wildcard characters: '%' - matches any number of characters, including no characters, ' ' - matches exactly one character. Here is the sample query: the accountnum GT '15' AND (name LIKE 'start of name% end of name' OR status EQ 'ACTIVE').

sort: string[]
in query

Arranges search results in either ascending or descending order. By default, response results are sorted in the ascending order. To sort results in the descending order, use "-". For example, the "-name." value sorts the results in the descending order by name, and "id" sorts results in the ascending order by ID.

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, it may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer 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

The internal ID of the object.

Success

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Content-Types: application/json
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.

agreement_service_id: string
in path

The ID of the 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'.

Request Content-Types: application/json
Request Example
{
  "true_up_charge_type": "string"
}

Success

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Content-Types: application/json
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.

agreement_service_id: string
in path

The ID of the agreement service.

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, it may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer 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 Content-Types: application/json
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, it may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer 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 Content-Types: application/json
Response Example (200 OK)
{
  "start_date": "string (date-time)",
  "next_service_pay_on_purchase": "boolean",
  "renewed": "boolean",
  "accumulated_charges_amount": "number",
  "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_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",
  "minimum_amount_currency_code": "string",
  "omit_minimum_amount": "boolean",
  "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 Content-Types: application/json
Request Example
{
  "next_service_pay_on_purchase": "boolean",
  "accumulated_charges_amount": "number",
  "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_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",
  "omit_minimum_amount": "boolean",
  "true_up_charge_types": [
    "string"
  ]
}

Success

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Content-Types: application/json
Response Example (200 OK)
{
  "start_date": "string (date-time)",
  "next_service_pay_on_purchase": "boolean",
  "renewed": "boolean",
  "accumulated_charges_amount": "number",
  "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_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",
  "minimum_amount_currency_code": "string",
  "omit_minimum_amount": "boolean",
  "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"
}

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

API query language string. The syntax of the API query language is similar to SQL, the criteria are expressed in the form of predicates. On the left side of the equation, there is a name of the available query parameter (for example, billing_account_id). On the right side, there is a constant value in single quotes ('sample value'). Brackets are used to group predicates, for example, '(start_date GT '1994-01-24T23:33:07+00:00')'. Use the following logical operators: AND - conjunction, OR - disjunction, NOT - negation. Compare operators: NEQ - Not equals, EQ - Equals, LT - Less, LTE - Less or equals, GT - Greater, GTE - Greater or equals, IS NULL - Is null, IS NOT NULL - Is not null, LIKE - Match pattern (LIKE operator is only applicable to parameters of the string type). Wildcard characters: '%' - matches any number of characters, including no characters, ' ' - matches exactly one character. Here is the sample query: the accountnum GT '15' AND (name LIKE 'start of name% end of name' OR status EQ 'ACTIVE').

sort: string[]
in query

Arranges search results in either ascending or descending order. By default, response results are sorted in the ascending order. To sort results in the descending order, use "-". For example, the "-name." value sorts the results in the descending order by name, and "id" sorts results in the ascending order by ID.

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, it may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer 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

The internal ID of the object.

bill_batch_type: string reissue, reverse, adhoc, on-demand 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

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

The currency code for the amount.

billing_account_id: string
in query

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 Content-Types: application/json
Response Example (200 OK)
[
  {
    "bill_batch_type": "string",
    "description": "string",
    "end_date": "string (date-time)",
    "auto_approve": "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",
              "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"
            },
            "original_billing_account": {
              "id": "1438752"
            },
            "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",
        "id": "1438752"
      }
    ],
    "name": "string",
    "use_payment_term": "boolean",
    "internal_render": "boolean",
    "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 Bill batch

POST /bill-batches

Updates an existing bill batch associated with the specified ID.

A payload for creating a new 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 Content-Types: application/json
Request Example
{
  "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"
}
200 OK

Success

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Content-Types: application/json
Response Example (200 OK)
{
  "bill_batch_type": "string",
  "description": "string",
  "end_date": "string (date-time)",
  "auto_approve": "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",
            "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"
          },
          "original_billing_account": {
            "account_num": "104-2345676",
            "id": "1438752"
          },
          "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",
      "id": "1438752"
    }
  ],
  "name": "string",
  "use_payment_term": "boolean",
  "internal_render": "boolean",
  "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

API query language string. The syntax of the API query language is similar to SQL, the criteria are expressed in the form of predicates. On the left side of the equation, there is a name of the available query parameter (for example, billing_account_id). On the right side, there is a constant value in single quotes ('sample value'). Brackets are used to group predicates, for example, '(start_date GT '1994-01-24T23:33:07+00:00')'. Use the following logical operators: AND - conjunction, OR - disjunction, NOT - negation. Compare operators: NEQ - Not equals, EQ - Equals, LT - Less, LTE - Less or equals, GT - Greater, GTE - Greater or equals, IS NULL - Is null, IS NOT NULL - Is not null, LIKE - Match pattern (LIKE operator is only applicable to parameters of the string type). Wildcard characters: '%' - matches any number of characters, including no characters, ' ' - matches exactly one character. Here is the sample query: the accountnum GT '15' AND (name LIKE 'start of name% end of name' OR status EQ 'ACTIVE').

sort: string[]
in query

Arranges search results in either ascending or descending order. By default, response results are sorted in the ascending order. To sort results in the descending order, use "-". For example, the "-name." value sorts the results in the descending order by name, and "id" sorts results in the ascending order by ID.

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, it may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer 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

The internal ID of the object.

account_num: string
in query

The billing account number.

external_account_num: string
in query

The account number tied to an external system.

Success

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Content-Types: application/json
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",
      "tax_id_number": "string",
      "addresses": [
        {
          "address_type": "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",
      "reason_entity_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": {},
              "custom_field_value_type": "string",
              "value": "string",
              "id": "1438752"
            }
          ],
          "id": "1438752"
        },
        "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"
}

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

Add billing accounts to 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 Content-Types: application/json
Request Example
{
  "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"
        }
      ],
      "id": "1438752"
    }
  ]
}
207 Multi-status

Multi Status.

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Content-Types: application/json
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"
}

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

Remove billing account from 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 Content-Types: application/json
Request Example
{
  "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"
        }
      ],
      "id": "1438752"
    }
  ]
}
207 Multi-status

Multi Status.

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Content-Types: application/json
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, it may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer header parameter to 'return=minimal', and FULL is the same as the header parameter set to 'return=representation'.

expand: string[]
in query

Includes additional entities in the response. You can expand only those entities which have a specific extension for it. The primary value is a CSV of the available sub-entities.

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 Content-Types: application/json
Response Example (200 OK)
{
  "bill_batch_type": "string",
  "description": "string",
  "end_date": "string (date-time)",
  "auto_approve": "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",
            "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"
          },
          "original_billing_account": {
            "account_num": "104-2345676",
            "id": "1438752"
          },
          "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",
      "id": "1438752"
    }
  ],
  "name": "string",
  "use_payment_term": "boolean",
  "internal_render": "boolean",
  "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 Content-Types: application/json
Request Example
{
  "bill_batch_type": "string",
  "description": "string",
  "end_date": "string (date-time)",
  "auto_approve": "boolean",
  "bill_batch_runs": [
    {
      "invoices": [
        {
          "invoice_type": "string",
          "external_invoice_num": "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"
              }
            ],
            "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"
              }
            ],
            "id": "1438752"
          }
        }
      ],
      "bill_run_type": "string",
      "step_status": "string",
      "step": "string",
      "status": "string"
    }
  ],
  "name": "string",
  "use_payment_term": "boolean",
  "internal_render": "boolean",
  "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 Content-Types: application/json
Response Example (200 OK)
{
  "bill_batch_type": "string",
  "description": "string",
  "end_date": "string (date-time)",
  "auto_approve": "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",
            "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"
          },
          "original_billing_account": {
            "account_num": "104-2345676",
            "id": "1438752"
          },
          "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",
      "id": "1438752"
    }
  ],
  "name": "string",
  "use_payment_term": "boolean",
  "internal_render": "boolean",
  "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"
}

Delete bill batch

DELETE /bill-batches/{id}

Deletes a bill batch associated with a specified ID.

id: string
in path

The internal ID of the object.

204 No Content

Successful request. No content returned.

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 ad hoc invoice bill batches

GET /billing-accounts/{billing_account_id}/adhoc-bill-batches

Retrieves ad hoc invoice bill batches associated with the specified billing account ID.

billing_account_id: string
in path

The ID of the billing account.

filter: string
in query

API query language string. The syntax of the API query language is similar to SQL, the criteria are expressed in the form of predicates. On the left side of the equation, there is a name of the available query parameter (for example, billing_account_id). On the right side, there is a constant value in single quotes ('sample value'). Brackets are used to group predicates, for example, '(start_date GT '1994-01-24T23:33:07+00:00')'. Use the following logical operators: AND - conjunction, OR - disjunction, NOT - negation. Compare operators: NEQ - Not equals, EQ - Equals, LT - Less, LTE - Less or equals, GT - Greater, GTE - Greater or equals, IS NULL - Is null, IS NOT NULL - Is not null, LIKE - Match pattern (LIKE operator is only applicable to parameters of the string type). Wildcard characters: '%' - matches any number of characters, including no characters, ' ' - matches exactly one character. Here is the sample query: the accountnum GT '15' AND (name LIKE 'start of name% end of name' OR status EQ 'ACTIVE').

sort: string[]
in query

Arranges search results in either ascending or descending order. By default, response results are sorted in the ascending order. To sort results in the descending order, use "-". For example, the "-name." value sorts the results in the descending order by name, and "id" sorts results in the ascending order by ID.

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, it may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer 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

The internal ID of the object.

Success

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "bill_batch_type": "string",
    "description": "string",
    "end_date": "string (date-time)",
    "auto_approve": "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",
              "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"
            },
            "original_billing_account": {},
            "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",
        "id": "1438752"
      }
    ],
    "name": "string",
    "use_payment_term": "boolean",
    "internal_render": "boolean",
    "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 (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (default )
{
  "code": "string",
  "message": "string"
}

Create ad hoc invoice bill batch

POST /billing-accounts/{billing_account_id}/adhoc-bill-batches

Creates a new ad hoc bill batch for the specified billing account ID.

A payload for creating a new ad hoc invoice bill batch.

billing_account_id: string
in path

The ID of the billing account.

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 Content-Types: application/json
Request Example
{
  "invoices": [
    {
      "invoice_type": "string",
      "invoice_items": [
        {
          "invoice_item_type": "string",
          "quantity": "number",
          "start_date": "string (date-time)",
          "end_date": "string (date-time)",
          "description": "string",
          "charges": [
            {
              "invoice_item_charge_type": "string",
              "charge_category": {
                "charge_category_type": "string",
                "name": "string",
                "id": "1438752"
              },
              "quantity": "number",
              "start_date": "string (date-time)",
              "end_date": "string (date-time)",
              "amount": "number",
              "exclude_from_taxation": "boolean"
            }
          ],
          "source_item": {
            "invoice_item_type": "string",
            "id": "1438752"
          },
          "reason": {
            "reason_entity_type": "string",
            "name": "string",
            "id": "1438752"
          }
        }
      ]
    }
  ],
  "reason": {
    "reason_type": "string",
    "reason_entity_type": "string",
    "name": "string",
    "id": "1438752"
  },
  "description": "string",
  "invoice_date": "string (date-time)",
  "auto_approve": "boolean",
  "invoice_due_date": "string (date-time)",
  "name": "string",
  "use_payment_term": "boolean"
}
201 Created

Success

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Content-Types: application/json
Response Example (201 Created)
{
  "bill_batch_type": "string",
  "description": "string",
  "end_date": "string (date-time)",
  "auto_approve": "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",
            "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"
          },
          "original_billing_account": {},
          "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",
      "id": "1438752"
    }
  ],
  "name": "string",
  "use_payment_term": "boolean",
  "internal_render": "boolean",
  "status": "string",
  "billing_account_category": {
    "name": "string",
    "id": "1438752"
  },
  "id": "1438752"
}
Response Headers (201 Created)
Location

The HTTP Location header. Specifies the location of the new resource.

string (url)
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 ad hoc invoice bill batch by ID

GET /billing-accounts/{billing_account_id}/adhoc-bill-batches/{id}

Retrieves the ad hoc bill batch associated with the specified billing account by billing account and ad hoc bill batch IDs.

billing_account_id: string
in path

The ID of the billing account.

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, it may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer 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 Content-Types: application/json
Response Example (200 OK)
{
  "bill_batch_type": "string",
  "description": "string",
  "end_date": "string (date-time)",
  "auto_approve": "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",
            "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"
          },
          "original_billing_account": {},
          "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",
      "id": "1438752"
    }
  ],
  "name": "string",
  "use_payment_term": "boolean",
  "internal_render": "boolean",
  "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"
}

Get On Demand bill batch

GET /billing-accounts/{billing_account_id}/on-demand-bill-batches
billing_account_id: string
in path

The ID of the billing account.

filter: string
in query

API query language string. The syntax of the API query language is similar to SQL, the criteria are expressed in the form of predicates. On the left side of the equation, there is a name of the available query parameter (for example, billing_account_id). On the right side, there is a constant value in single quotes ('sample value'). Brackets are used to group predicates, for example, '(start_date GT '1994-01-24T23:33:07+00:00')'. Use the following logical operators: AND - conjunction, OR - disjunction, NOT - negation. Compare operators: NEQ - Not equals, EQ - Equals, LT - Less, LTE - Less or equals, GT - Greater, GTE - Greater or equals, IS NULL - Is null, IS NOT NULL - Is not null, LIKE - Match pattern (LIKE operator is only applicable to parameters of the string type). Wildcard characters: '%' - matches any number of characters, including no characters, ' ' - matches exactly one character. Here is the sample query: the accountnum GT '15' AND (name LIKE 'start of name% end of name' OR status EQ 'ACTIVE').

sort: string[]
in query

Arranges search results in either ascending or descending order. By default, response results are sorted in the ascending order. To sort results in the descending order, use "-". For example, the "-name." value sorts the results in the descending order by name, and "id" sorts results in the ascending order by ID.

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, it may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer 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

The internal ID of the object.

name: string
in query

The name of the bill batch.

status: string ACTIVE, SUSPENDED, CANCELED ACTIVE
in query

The accounting status, meaning the status of the General Ledger.

Success

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "bill_batch_type": "string",
    "description": "string",
    "end_date": "string (date-time)",
    "auto_approve": "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",
              "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"
            },
            "original_billing_account": {},
            "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",
        "id": "1438752"
      }
    ],
    "name": "string",
    "use_payment_term": "boolean",
    "internal_render": "boolean",
    "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 (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (default )
{
  "code": "string",
  "message": "string"
}

Get On Demand bill batch

GET /billing-accounts/{billing_account_id}/on-demand-bill-batches/{id}
billing_account_id: string
in path

The ID of the billing account.

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, it may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer 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 Content-Types: application/json
Response Example (200 OK)
{
  "bill_batch_type": "string",
  "description": "string",
  "end_date": "string (date-time)",
  "auto_approve": "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",
            "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"
          },
          "original_billing_account": {
            "id": "1438752"
          },
          "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",
      "id": "1438752"
    }
  ],
  "name": "string",
  "use_payment_term": "boolean",
  "internal_render": "boolean",
  "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"
}

Get reissued invoices

GET /invoices/{invoice_id}/reissue-bill-batches

Retrieves existing reissued invoices associated with a specified invoice. Specifically, returns bill batches of the reissue invoice type. Gotransverse core uses a bill batch of the reissue invoice type to process reissued invoices.

invoice_id: string
in path

The ID of the invoice.

filter: string
in query

API query language string. The syntax of the API query language is similar to SQL, the criteria are expressed in the form of predicates. On the left side of the equation, there is a name of the available query parameter (for example, billing_account_id). On the right side, there is a constant value in single quotes ('sample value'). Brackets are used to group predicates, for example, '(start_date GT '1994-01-24T23:33:07+00:00')'. Use the following logical operators: AND - conjunction, OR - disjunction, NOT - negation. Compare operators: NEQ - Not equals, EQ - Equals, LT - Less, LTE - Less or equals, GT - Greater, GTE - Greater or equals, IS NULL - Is null, IS NOT NULL - Is not null, LIKE - Match pattern (LIKE operator is only applicable to parameters of the string type). Wildcard characters: '%' - matches any number of characters, including no characters, ' ' - matches exactly one character. Here is the sample query: the accountnum GT '15' AND (name LIKE 'start of name% end of name' OR status EQ 'ACTIVE').

sort: string[]
in query

Arranges search results in either ascending or descending order. By default, response results are sorted in the ascending order. To sort results in the descending order, use "-". For example, the "-name." value sorts the results in the descending order by name, and "id" sorts results in the ascending order by ID.

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, it may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer 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

The internal ID of the object.

name: string
in query

The name of the bill batch.

status: string ACTIVE, SUSPENDED, CANCELED ACTIVE
in query

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

The currency code for the amount.

Success

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "bill_batch_type": "string",
    "description": "string",
    "end_date": "string (date-time)",
    "auto_approve": "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",
              "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"
            },
            "original_billing_account": {},
            "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",
        "id": "1438752"
      }
    ],
    "name": "string",
    "use_payment_term": "boolean",
    "internal_render": "boolean",
    "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 (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (default )
{
  "code": "string",
  "message": "string"
}

Reissue invoice

POST /invoices/{invoice_id}/reissue-bill-batches

Reissues the specified invoice by posting a bill batch of the reissue type. Gotransverse core uses a bill batch of the reissue invoice type to process reissued invoices.

A payload for creating a new reissue invoice bill batch.

invoice_id: string
in path

The ID of the invoice.

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 Content-Types: application/json
Request Example
{
  "re_tax": "boolean",
  "tax_effective_date": "string (date-time)",
  "reason": {
    "reason_type": "string",
    "reason_entity_type": "string",
    "name": "string",
    "id": "1438752"
  },
  "description": "string",
  "invoice_date": "string (date-time)",
  "auto_approve": "boolean",
  "invoice_due_date": "string (date-time)",
  "name": "string",
  "use_payment_term": "boolean"
}

Successfully created.

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Content-Types: application/json
Response Example (201 Created)
{
  "bill_batch_type": "string",
  "description": "string",
  "end_date": "string (date-time)",
  "auto_approve": "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",
            "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"
          },
          "original_billing_account": {},
          "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",
      "id": "1438752"
    }
  ],
  "name": "string",
  "use_payment_term": "boolean",
  "internal_render": "boolean",
  "status": "string",
  "billing_account_category": {
    "name": "string",
    "id": "1438752"
  },
  "id": "1438752"
}
Response Headers (201 Created)
Location

The HTTP Location header. Specifies the location of the new resource.

string (url)
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 reissued invoice by ID

GET /invoices/{invoice_id}/reissue-bill-batches/{id}

Retrieves an existing reissued invoice associated with a specific invoice and reissue bill batch ID. Specifically, returns a bill batch of the reissue type. Gotransverse core uses a bill batch of the reissue invoice type to process reissued invoices.

invoice_id: string
in path

The ID of the invoice.

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, it may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer 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 Content-Types: application/json
Response Example (200 OK)
{
  "bill_batch_type": "string",
  "description": "string",
  "end_date": "string (date-time)",
  "auto_approve": "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",
            "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"
          },
          "original_billing_account": {},
          "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",
      "id": "1438752"
    }
  ],
  "name": "string",
  "use_payment_term": "boolean",
  "internal_render": "boolean",
  "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 reissued invoice

PUT /invoices/{invoice_id}/reissue-bill-batches/{id}

Updates an existing bill batch of the reissue invoice type. Gotransverse core uses a bill batch of the reissue invoice type to process reissued invoices.

A payload for updating an existing bill batch of the reissue invoice type.

invoice_id: string
in path

The ID of the invoice.

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 Content-Types: application/json
Request Example
{
  "bill_batch_type": "string",
  "description": "string",
  "end_date": "string (date-time)",
  "auto_approve": "boolean",
  "bill_batch_runs": [
    {
      "invoices": [
        {
          "invoice_type": "string",
          "external_invoice_num": "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"
              }
            ],
            "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"
              }
            ],
            "id": "1438752"
          }
        }
      ],
      "bill_run_type": "string",
      "step_status": "string",
      "step": "string",
      "status": "string"
    }
  ],
  "name": "string",
  "use_payment_term": "boolean",
  "internal_render": "boolean",
  "status": "string",
  "billing_account_category": {
    "name": "string",
    "id": "1438752"
  }
}

Success

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Content-Types: application/json
Response Example (200 OK)
{
  "bill_batch_type": "string",
  "description": "string",
  "end_date": "string (date-time)",
  "auto_approve": "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",
            "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"
          },
          "original_billing_account": {},
          "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",
      "id": "1438752"
    }
  ],
  "name": "string",
  "use_payment_term": "boolean",
  "internal_render": "boolean",
  "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 reversed invoices

GET /invoices/{invoice_id}/reverse-bill-batches

Retrieves existing reversed invoices associated with a specified invoice. Specifically, returns bill batches of the reverse invoice type. Gotransverse core uses a bill batch of the reverse invoice type to process reversed invoices.

invoice_id: string
in path

The ID of the invoice.

filter: string
in query

API query language string. The syntax of the API query language is similar to SQL, the criteria are expressed in the form of predicates. On the left side of the equation, there is a name of the available query parameter (for example, billing_account_id). On the right side, there is a constant value in single quotes ('sample value'). Brackets are used to group predicates, for example, '(start_date GT '1994-01-24T23:33:07+00:00')'. Use the following logical operators: AND - conjunction, OR - disjunction, NOT - negation. Compare operators: NEQ - Not equals, EQ - Equals, LT - Less, LTE - Less or equals, GT - Greater, GTE - Greater or equals, IS NULL - Is null, IS NOT NULL - Is not null, LIKE - Match pattern (LIKE operator is only applicable to parameters of the string type). Wildcard characters: '%' - matches any number of characters, including no characters, ' ' - matches exactly one character. Here is the sample query: the accountnum GT '15' AND (name LIKE 'start of name% end of name' OR status EQ 'ACTIVE').

sort: string[]
in query

Arranges search results in either ascending or descending order. By default, response results are sorted in the ascending order. To sort results in the descending order, use "-". For example, the "-name." value sorts the results in the descending order by name, and "id" sorts results in the ascending order by ID.

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, it may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer 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

The internal ID of the object.

name: string
in query

The name of the bill batch.

status: string ACTIVE, SUSPENDED, CANCELED ACTIVE
in query

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

The currency code for the amount.

Success

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "bill_batch_type": "string",
    "description": "string",
    "end_date": "string (date-time)",
    "auto_approve": "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",
              "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"
            },
            "original_billing_account": {},
            "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",
        "id": "1438752"
      }
    ],
    "name": "string",
    "use_payment_term": "boolean",
    "internal_render": "boolean",
    "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 (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (default )
{
  "code": "string",
  "message": "string"
}

Reverse invoice

POST /invoices/{invoice_id}/reverse-bill-batches

Creates a reversed invoice by creating a bill batch of reverse invoice type. Gotransverse core uses a bill batch of the reverse invoice type to process reversed invoices.

A payload for creating a new reverse invoice bill batch.

invoice_id: string
in path

The ID of the invoice.

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 Content-Types: application/json
Request Example
{
  "reason": {
    "reason_type": "string",
    "reason_entity_type": "string",
    "name": "string",
    "id": "1438752"
  },
  "description": "string",
  "invoice_date": "string (date-time)",
  "auto_approve": "boolean",
  "invoice_due_date": "string (date-time)",
  "name": "string",
  "use_payment_term": "boolean"
}

A new reversed invoice was successfully created.

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Content-Types: application/json
Response Example (201 Created)
{
  "bill_batch_type": "string",
  "description": "string",
  "end_date": "string (date-time)",
  "auto_approve": "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",
            "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"
          },
          "original_billing_account": {},
          "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",
      "id": "1438752"
    }
  ],
  "name": "string",
  "use_payment_term": "boolean",
  "internal_render": "boolean",
  "status": "string",
  "billing_account_category": {
    "name": "string",
    "id": "1438752"
  },
  "id": "1438752"
}
Response Headers (201 Created)
Location

The HTTP Location header. Specifies the location of the new resource.

string (url)
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 reversed invoice by ID

GET /invoices/{invoice_id}/reverse-bill-batches/{id}

Retrieves an existing reversed invoice associated with the specified invoice and reverse bill batch IDs. Specifically, returns a bill batch of the reverse invoice type. Gotransverse core uses a bill batch of the reverse invoice type to process reversed invoices.

invoice_id: string
in path

The ID of the invoice.

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, it may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer 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 Content-Types: application/json
Response Example (200 OK)
{
  "bill_batch_type": "string",
  "description": "string",
  "end_date": "string (date-time)",
  "auto_approve": "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",
            "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"
          },
          "original_billing_account": {},
          "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",
      "id": "1438752"
    }
  ],
  "name": "string",
  "use_payment_term": "boolean",
  "internal_render": "boolean",
  "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 reversed invoice

PUT /invoices/{invoice_id}/reverse-bill-batches/{id}

Updates an existing bill batch of the reverse invoice type. Gotransverse core uses a bill batch of the reverse invoice type to process reversed invoices.

A payload for updating an existing bill batch of the reverse invoice type.

invoice_id: string
in path

The ID of the invoice.

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 Content-Types: application/json
Request Example
{
  "bill_batch_type": "string",
  "description": "string",
  "end_date": "string (date-time)",
  "auto_approve": "boolean",
  "bill_batch_runs": [
    {
      "invoices": [
        {
          "invoice_type": "string",
          "external_invoice_num": "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"
              }
            ],
            "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"
              }
            ],
            "id": "1438752"
          }
        }
      ],
      "bill_run_type": "string",
      "step_status": "string",
      "step": "string",
      "status": "string"
    }
  ],
  "name": "string",
  "use_payment_term": "boolean",
  "internal_render": "boolean",
  "status": "string",
  "billing_account_category": {
    "name": "string",
    "id": "1438752"
  }
}

Success

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Content-Types: application/json
Response Example (200 OK)
{
  "bill_batch_type": "string",
  "description": "string",
  "end_date": "string (date-time)",
  "auto_approve": "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",
            "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"
          },
          "original_billing_account": {},
          "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",
      "id": "1438752"
    }
  ],
  "name": "string",
  "use_payment_term": "boolean",
  "internal_render": "boolean",
  "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"
}

BillBatchRun

The Bill Batch Run entity is a runtime object created during the execution of a bill batch. The Bill Batch Run entity can be run, canceled, and approved, similar to the Bill Cycle Run entity.

Get bill batch runs

GET /bill-batch-runs

Retrieves existing bill batch runs.

filter: string
in query

API query language string. The syntax of the API query language is similar to SQL, the criteria are expressed in the form of predicates. On the left side of the equation, there is a name of the available query parameter (for example, billing_account_id). On the right side, there is a constant value in single quotes ('sample value'). Brackets are used to group predicates, for example, '(start_date GT '1994-01-24T23:33:07+00:00')'. Use the following logical operators: AND - conjunction, OR - disjunction, NOT - negation. Compare operators: NEQ - Not equals, EQ - Equals, LT - Less, LTE - Less or equals, GT - Greater, GTE - Greater or equals, IS NULL - Is null, IS NOT NULL - Is not null, LIKE - Match pattern (LIKE operator is only applicable to parameters of the string type). Wildcard characters: '%' - matches any number of characters, including no characters, ' ' - matches exactly one character. Here is the sample query: the accountnum GT '15' AND (name LIKE 'start of name% end of name' OR status EQ 'ACTIVE').

sort: string[]
in query

Arranges search results in either ascending or descending order. By default, response results are sorted in the ascending order. To sort results in the descending order, use "-". For example, the "-name." value sorts the results in the descending order by name, and "id" sorts results in the ascending order by ID.

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, it may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer 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

The internal ID of the object.

bill_batch_id: string
in query

The ID of the bill batch.

bill_batch_name: string
in query

The name of the bill batch.

sequence: integer (int32)
in query

The sequence of the the bill batch run.

step_status: string (int32) NEW, OPEN, READY, SCHEDULED, RUNNING, COMPLETED, APPROVED, CANCELED, ERRED, SIMULATE, PAUSED
in query

The status of the bill batch run.

step: string AVAILABLE, CALCULATE_BILLABLE_USAGE, GENERATE_KPIS, GENERATE_SAMPLE_INVOICES, DISTRIBUTE_INVOICES, RETRY_DISTRIBUTE_INVOICES, RENDER_INVOICES, RETRY_RENDER_INVOICES, POST_TAX, POST_ACCOUNTS, CALCULATE_BILLABLE_CHARGES, CANCELING, AUTO_RECURRING_PAY, APPROVAL, GENERATE_ARTIFACTS
in query

The step of execution of the bill batch run.

open_date: string (date-time)
in query

The time stamp indicating when the bill interval run started.

close_date: string (date-time)
in query

The time stamp indicating when the bill interval run ended.

status: string READY, SIMULATE, APPROVAL, COMPLETED
in query

The status of the bill batch run.

200 OK

Success

400 Bad Request

Bad request.

default

Unknown error.

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "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",
          "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"
        },
        "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)",
        "paid_date": "string (date-time)",
        "amount_to_pay": "number",
        "late_fee_charged": "boolean",
        "bill_cycle": {},
        "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",
    "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 KPIs for bill batch run

GET /bill-batch-runs/{bill_batch_run_id}/kpis

Retrieves Key Performance Indicator (KPI) values per currency for the specified bill batch run ID.

bill_batch_run_id: string
in path

The ID of the bill batch run.

return: string SIMPLE, FULL FULL
in query

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

filter: string
in query

API query language string. The syntax of the API query language is similar to SQL, the criteria are expressed in the form of predicates. On the left side of the equation, there is a name of the available query parameter (for example, billing_account_id). On the right side, there is a constant value in single quotes ('sample value'). Brackets are used to group predicates, for example, '(start_date GT '1994-01-24T23:33:07+00:00')'. Use the following logical operators: AND - conjunction, OR - disjunction, NOT - negation. Compare operators: NEQ - Not equals, EQ - Equals, LT - Less, LTE - Less or equals, GT - Greater, GTE - Greater or equals, IS NULL - Is null, IS NOT NULL - Is not null, LIKE - Match pattern (LIKE operator is only applicable to parameters of the string type). Wildcard characters: '%' - matches any number of characters, including no characters, ' ' - matches exactly one character. Here is the sample query: the accountnum GT '15' AND (name LIKE 'start of name% end of name' OR status EQ 'ACTIVE').

sort: string[]
in query

Arranges search results in either ascending or descending order. By default, response results are sorted in the ascending order. To sort results in the descending order, use "-". For example, the "-name." value sorts the results in the descending order by name, and "id" sorts results in the ascending order by ID.

Array values passed separated by comma: ?sort=aaa,bbb
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

The internal ID of the object.

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "accounts_billed": "integer (int64)",
    "invoices_produced": "integer (int64)",
    "usage_events": "integer (int64)",
    "total_usage_charges": "number",
    "recurring_charges": "number",
    "onetime_charges": "number",
    "total_taxes": "number",
    "total_invoice_amount": "number",
    "total_manual_invoice_amount": "number",
    "total_on_demand_invoice_amount": "number",
    "total_out_of_cycle_invoice_amount": "number",
    "currency_code": "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 (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (default )
{
  "code": "string",
  "message": "string"
}

Get bill batch run by ID

GET /bill-batch-runs/{id}

Retrieves an existing bill batch run 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, it may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer 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 Content-Types: application/json
Response Example (200 OK)
{
  "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",
        "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"
      },
      "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)",
      "paid_date": "string (date-time)",
      "amount_to_pay": "number",
      "late_fee_charged": "boolean",
      "bill_cycle": {},
      "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",
  "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"
}

Approve bill batch run

POST /bill-batch-runs/{id}/approve

Approves a bill batch run associated with the specified ID. If approval is necessary but not completed yet, the bill batch run is suspended until approval is complete.

id: string
in path

The internal ID of the object.

204 No Content

Successful request. No content returned.

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"
}

Cancel bill batch run

POST /bill-batch-runs/{id}/cancel

Cancels a bill batch run associated with the specified ID. The status of the bill batch run changes to cancelled during the operation. After the cancel operation, the bill batch is reset to ready status.

id: string
in path

The internal ID of the object.

204 No Content

Successful request. No content returned.

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 Key Performance Indicator (KPI)

GET /bill-batch-runs/{id}/kpi

Retrieves Key Performance Indicator (KPI) values for the bill batch run 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, it may be SIMPLE or FULL. SIMPLE is the same as setting the Prefer header parameter to 'return=minimal', and FULL is the same as the header parameter set to 'return=representation'.

400 Bad Request

Bad request.

404 Not Found

Not found.

default

Unknown error.

Response Content-Types: application/json
Response Example (200 OK)
{
  "accounts_billed": "integer (int64)",
  "invoices_produced": "integer (int64)",
  "usage_events": "integer (int64)",
  "total_usage_charges": "number",
  "recurring_charges": "number",
  "onetime_charges": "number",
  "total_taxes": "number",
  "total_invoice_amount": "number",
  "total_manual_invoice_amount": "number",
  "total_on_demand_invoice_amount": "number",
  "total_out_of_cycle_invoice_amount": "number",
  "currency_code": "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"
}

Retry bill batch run

POST /bill-batch-runs/{id}/retry

Retries a bill batch run associated with the specified ID.

id: string
in path

The internal ID of the object.

204 No Content

Successful request. No content returned.

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"
}

Execute bill batch run

POST /bill-batch-runs/{id}/run

Executes a bill batch run associated with the specified ID.

A payload for running a bill batch run.

id: string
in path

The internal ID of the object.

Request Content-Types: application/json
Request Example
{
  "invoice_date": "string (date-time)",
  "invoice_due_date": "string (date-time)",
  "use_payment_term": "boolean",
  "scheduled_date": "string (date-time)"
}
204 No Content

Successful request. No content returned.

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"
}

POST /bill-batch-runs/{id}/simulate

Simulate bill batch run associated with the specified ID..

A payload for simulating a bill batch run.

id: string
in path

The internal ID of the object.

Request Content-Types: application/json
Request Example
{
  "re_rate_usage": "boolean",