Sign in

v10

latestOpenAPI 3.0.1raw.githubusercontent.com2025-12-033223581.2 MB
Bill

Retrieve latest Bill

Retrieve the latest Bill for the given Account.

This endpoint retrieves the latest Bill for the given Account in the specified Organization. It facilitates tracking of the most recent charges and consumption details.

get/organizations/{orgId}/bills/latest/{accountId}

Path parameters

orgIdstring required

The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.

accountIdstring required

The unique identifier (UUID) of the Account for which the latest Bill should be retrieved.

Query parameters

additionalstring[]

Comma separated list of additional fields.

Response

Returns the latest Bill for the given Account

purchaseOrderNumberstring

Purchase Order number linked to the Account the Bill is for.

externalInvoiceReferencestring

The reference ID to use for external invoice.

externalInvoiceDatestring date

For accounting purposes, the date set at Organization level to use for external invoicing with respect to billing periods - two options:

  • FIRST_DAY_OF_NEXT_PERIOD (Default).
  • LAST_DAY_OF_ARREARS

For example, if the retrieved Bill was on a monthly billing frequency and the billing period for the Bill is September 2023 and the External invoice date is set at FIRST_DAY_OF_NEXT_PERIOD, then the externalInvoiceDate will be "2023-10-01".

NOTE: To change the externalInvoiceDate setting for your Organization, you can use the Update OrganizationConfig call.

jsonStatementGeneratedboolean

Flag to indicate that the statement in JSON format has been generated for the Bill.

  • TRUE - JSON statement has been generated.
  • FALSE - no JSON statement generated.
csvStatementGeneratedboolean

Flag to indicate that the statement in CSV format has been generated for the Bill.

  • TRUE - CSV statement has been generated.
  • FALSE - no CSV statement generated.
statementStaleboolean

True if the existing bill statement (JSON or CSV) is marked as stale/outdated.

billTotalnumber

The sum total for the Bill.

sequentialInvoiceNumberstring

The sequential invoice number of the Bill.

NOTE: If you have not defined a billPrefix for your Organization, a sequentialInvoiceNumber is not returned in the response. See Update OrganizationConfig

dtCreatedstring date-time

The date and time (in ISO 8601 format) when the Bill was first created.

dtLastModifiedstring date-time

The date and time (in ISO 8601 format) when the Bill was last modified.

createdBystring

The unique identifier (UUID) for the user who created the Bill.

lastModifiedBystring

The unique identifier (UUID) for the user who last modified this Bill.

dtApprovedstring date-time

The DateTime when the bill was approved.

approvedBystring

The id of the user who approved this bill.

dtLockedstring date-time

The DateTime when the bill was locked.

lockedBystring

The id of the user who locked this bill.

idstring required

The UUID of the entity.

versioninteger

The version number:

  • Create: On initial Create to insert a new entity, the version is set at 1 in the response.
  • Update: On successful Update, the version is incremented by 1 in the response.
accountIdstring
accountCodestring
startDatestring date
endDatestring date
startDateTimeUTCstring date-time
endDateTimeUTCstring date-time
billDatestring date
dueDatestring date
billingFrequency'DAILY' | 'WEEKLY' | 'MONTHLY' | 'ANNUALLY' | 'AD_HOC' | 'MIXED'

Defines how often Bills are generated.

  • Daily. Starting at midnight each day, covering a twenty-four hour period following.

  • Weekly. Starting at midnight on a Monday morning covering the seven-day period following.

  • Monthly. Starting at midnight on the morning of the first day of each month covering the entire calendar month following.

  • Annually. Starting at midnight on the morning of the first day of each year covering the entire calendar year following.

  • Ad_Hoc. Use this setting when a custom billing schedule is used for billing an Account, such as for billing of Prepayment/Commitment fees using a custom billing schedule.

billFrequencyIntervalinteger
timezonestring
currencystring
lockedboolean
createdDatestring date-time
status'PENDING' | 'APPROVED'

Indicates whether the Bill has passed human/manual approval.

  • Pending - Bill has not yet been passed by a human reviewer.
  • Approved - Bill has been approved after manual review.
billJobIdstring
lastCalculatedDatestring date-time

Example response

{
  "timezone": "UTC",
  "currencyConversions": [
    {
      "from": "EUR",
      "to": "USD",
      "multiplier": 1.12
    }
  ]
}