Skip to content
/
Update a specific adhoc b...

Elevate Bill Run API (1.15)

bill runs

Provides read & write access to bill run entities.

Definitions

  • Bill run - a process by which customers are invoiced for their usage, rental and adhoc charges
Download OpenAPI description
billing-rest-bill-run.json
billing-rest-bill-run.yaml
Languages
Servers
https://rest.elevatebilling.com/v1

bill-runs

a process by which customers are invoiced for their usage, rental and adhoc charges

Operations

adhoc-bill-runs

Operations

Get a list of available adhoc bill runs

Request

Security
bearerAuth
Query
pageinteger(int32)(PageParam)>= 1required

Page of results to show

Example: page=1
pageSizeinteger(int32)(ResultsPerPageParam)[ 1 .. 1000 ]required

Results to return per page

Example: pageSize=100
sortstring(SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fieldsstring(FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
billRunStatusstring(BillRunStatus)

Filter by adhoc bill run status

Enum"OPEN""CLOSED""FINALIZED"
closedStartTimestring(DateTimeFilterParam)

Filter by when the adhoc bill run was closed and reporting began

Example: closedStartTime=yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ
distributionStartTimestring(DateTimeFilterParam)

Filter by when invoice distribution started

Example: distributionStartTime=yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/adhoc-bill-runs?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&billRunStatus=OPEN&closedStartTime=yyyy-MM-ddTHH%3Amm%3AssZ+%2C+lt%3Ayyyy-MM-ddTHH%3Amm%3AssZ+%2C+gt%3Ayyyy-MM-ddTHH%3Amm%3AssZ&distributionStartTime=yyyy-MM-ddTHH%3Amm%3AssZ+%2C+lt%3Ayyyy-MM-ddTHH%3Amm%3AssZ+%2C+gt%3Ayyyy-MM-ddTHH%3Amm%3AssZ' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)read-only

Adhoc bill run identifier

Example: 1
namestring[ 1 .. 22 ] characters[a-zA-Z0-9\p{L}\s\+\/\-\._\&amp;#=,:@()]*required

Adhoc bill run name

nicknamestring[ 1 .. 100 ] characters[a-zA-Z0-9\p{L}\s\+\/\-\._\&amp;#=,:@()]*

Adhoc bill run nickname

createdstring(date)read-only

Creation date

invoiceDatestring(date)required

Date to be shown on the invoices

billRunStatusstring(BillRunStatus)

Bill run status

Enum"OPEN""CLOSED""FINALIZED"
summaryStatusstring(BillRunSummaryStatus)

Bill run summary status

Enum"PROPERTIES""STARTING""REPORTING""DRAFT_INVOICES""FULL_INVOICES""DISTRIBUTION""DIRECT_DEBITS""ACCOUNTING_PACKAGES""COMBINING_INVOICES""CUSTOM_REPORTS"
summaryStatusPercentageinteger(int64)

Summary status completion percentage

Example: 100
billingUserAdminIdinteger(int64)read-only

Bill user who closed the adhoc bill run

Example: 1
revenueInMajorCurrencyinteger(int64)required

Revenue in this bill run now

Example: 1
adhocProductInventoryIdsArray of integers(int32)read-only

Adhoc product inventory identifiers associated to the adhoc bill run

Example: [1]
rentalProductInventoryIdsArray of integers(int32)read-only

Rental product inventory identifiers associated to the adhoc bill run

Example: [1]
closedStartTimestring(date-time)read-only

Timestamp when the adhoc bill run was closed and reporting began

distributionStartTimestring(date-time)read-only

Timestamp when invoice distribution started

distributionEndTimestring(date-time)read-only

Timestamp when invoice distribution completed.

]
Response
application/json
[
  {
    "id": 1,
    "name": "string",
    "nickname": "string",
    "created": "2019-08-24",
    "invoiceDate": "2019-08-24",
    "billRunStatus": "OPEN",
    "summaryStatus": "PROPERTIES",
    "summaryStatusPercentage": 100,
    "billingUserAdminId": 1,
    "revenueInMajorCurrency": 1,
    "adhocProductInventoryIds": [ … ],
    "rentalProductInventoryIds": [ … ],
    "closedStartTime": "2019-08-24T14:15:22Z",
    "distributionStartTime": "2019-08-24T14:15:22Z",
    "distributionEndTime": "2019-08-24T14:15:22Z"
  }
]

Get a specific adhoc bill run

Request

Security
bearerAuth
Path
adhoc_bill_run_idinteger(int64)(IdParam)>= 1required

Adhoc bill run identifier

Example: 1
curl -i -X GET \
  https://rest.elevatebilling.com/v1/adhoc-bill-runs/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Adhoc bill run found

Bodyapplication/json
idinteger(int64)read-only

Adhoc bill run identifier

Example: 1
namestring[ 1 .. 22 ] characters[a-zA-Z0-9\p{L}\s\+\/\-\._\&amp;#=,:@()]*required

Adhoc bill run name

nicknamestring[ 1 .. 100 ] characters[a-zA-Z0-9\p{L}\s\+\/\-\._\&amp;#=,:@()]*

Adhoc bill run nickname

createdstring(date)read-only

Creation date

invoiceDatestring(date)required

Date to be shown on the invoices

billRunStatusstring(BillRunStatus)

Bill run status

Enum"OPEN""CLOSED""FINALIZED"
summaryStatusstring(BillRunSummaryStatus)

Bill run summary status

Enum"PROPERTIES""STARTING""REPORTING""DRAFT_INVOICES""FULL_INVOICES""DISTRIBUTION""DIRECT_DEBITS""ACCOUNTING_PACKAGES""COMBINING_INVOICES""CUSTOM_REPORTS"
summaryStatusPercentageinteger(int64)

Summary status completion percentage

Example: 100
billingUserAdminIdinteger(int64)read-only

Bill user who closed the adhoc bill run

Example: 1
revenueInMajorCurrencyinteger(int64)required

Revenue in this bill run now

Example: 1
adhocProductInventoryIdsArray of integers(int32)read-only

Adhoc product inventory identifiers associated to the adhoc bill run

Example: [1]
rentalProductInventoryIdsArray of integers(int32)read-only

Rental product inventory identifiers associated to the adhoc bill run

Example: [1]
closedStartTimestring(date-time)read-only

Timestamp when the adhoc bill run was closed and reporting began

distributionStartTimestring(date-time)read-only

Timestamp when invoice distribution started

distributionEndTimestring(date-time)read-only

Timestamp when invoice distribution completed.

Response
application/json
{
  "id": 1,
  "name": "string",
  "nickname": "string",
  "created": "2019-08-24",
  "invoiceDate": "2019-08-24",
  "billRunStatus": "OPEN",
  "summaryStatus": "PROPERTIES",
  "summaryStatusPercentage": 100,
  "billingUserAdminId": 1,
  "revenueInMajorCurrency": 1,
  "adhocProductInventoryIds": [
    1
  ],
  "rentalProductInventoryIds": [
    1
  ],
  "closedStartTime": "2019-08-24T14:15:22Z",
  "distributionStartTime": "2019-08-24T14:15:22Z",
  "distributionEndTime": "2019-08-24T14:15:22Z"
}

Update a specific adhoc bill run

Request

Close, reopen, and move an adhoc bill run to the next step. To fully close the adhoc bill run please initially patch the summaryStatus to REPORTING. To generate invoices of a CLOSED adhoc bill run, PATCH the summaryStatus to FULL_INVOICES. To distribute and finalise the adhoc bill run having generated invoices, PATCH the summaryStatus to DISTRIBUTION. You can monitor the progress of the bill run summary state by doing a GET and looking at the summaryStatusPercentage. Please refer to the examples

Security
bearerAuth
Path
adhoc_bill_run_idinteger(int64)(IdParam)>= 1required

Adhoc bill run identifier

Example: 1
Bodyapplication/json-patch+jsonrequired

A set of JSONPatch operations to be performed

Array [
opstringrequired

The JSON Patch operation to be performed

Enum"add""remove""replace""move""copy""test"
pathstringrequired

A JSON-Pointer

valueobject

The value to be used within the operations

fromstring

A string containing a JSON Pointer value

]
curl -i -X PATCH \
  https://rest.elevatebilling.com/v1/adhoc-bill-runs/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '[
    {
      "op": "replace",
      "path": "/summaryStatus",
      "value": "REPORTING"
    },
    {
      "op": "replace",
      "path": "/invoiceDate",
      "value": "2023-02-04"
    },
    {
      "op": "replace",
      "path": "/nickname",
      "value": "Maintenance Charge"
    }
  ]'

Responses

Success

Bodyapplication/json
idinteger(int64)read-only

Adhoc bill run identifier

Example: 1
namestring[ 1 .. 22 ] characters[a-zA-Z0-9\p{L}\s\+\/\-\._\&amp;#=,:@()]*required

Adhoc bill run name

nicknamestring[ 1 .. 100 ] characters[a-zA-Z0-9\p{L}\s\+\/\-\._\&amp;#=,:@()]*

Adhoc bill run nickname

createdstring(date)read-only

Creation date

invoiceDatestring(date)required

Date to be shown on the invoices

billRunStatusstring(BillRunStatus)

Bill run status

Enum"OPEN""CLOSED""FINALIZED"
summaryStatusstring(BillRunSummaryStatus)

Bill run summary status

Enum"PROPERTIES""STARTING""REPORTING""DRAFT_INVOICES""FULL_INVOICES""DISTRIBUTION""DIRECT_DEBITS""ACCOUNTING_PACKAGES""COMBINING_INVOICES""CUSTOM_REPORTS"
summaryStatusPercentageinteger(int64)

Summary status completion percentage

Example: 100
billingUserAdminIdinteger(int64)read-only

Bill user who closed the adhoc bill run

Example: 1
revenueInMajorCurrencyinteger(int64)required

Revenue in this bill run now

Example: 1
adhocProductInventoryIdsArray of integers(int32)read-only

Adhoc product inventory identifiers associated to the adhoc bill run

Example: [1]
rentalProductInventoryIdsArray of integers(int32)read-only

Rental product inventory identifiers associated to the adhoc bill run

Example: [1]
closedStartTimestring(date-time)read-only

Timestamp when the adhoc bill run was closed and reporting began

distributionStartTimestring(date-time)read-only

Timestamp when invoice distribution started

distributionEndTimestring(date-time)read-only

Timestamp when invoice distribution completed.

Response
application/json
{
  "id": 1,
  "name": "string",
  "nickname": "string",
  "created": "2019-08-24",
  "invoiceDate": "2019-08-24",
  "billRunStatus": "OPEN",
  "summaryStatus": "PROPERTIES",
  "summaryStatusPercentage": 100,
  "billingUserAdminId": 1,
  "revenueInMajorCurrency": 1,
  "adhocProductInventoryIds": [
    1
  ],
  "rentalProductInventoryIds": [
    1
  ],
  "closedStartTime": "2019-08-24T14:15:22Z",
  "distributionStartTime": "2019-08-24T14:15:22Z",
  "distributionEndTime": "2019-08-24T14:15:22Z"
}