Signals Docs
Signals API

Your balance, and your financial documents, such as invoices, to list, read and download.


Read the organization's Treasury balance

GET
https://api.signals.pressone.africa
/billing/balance

Read the organization's Treasury balance › Headers

Signals-Version
​string · enum · required

The supported API snapshot to use for this request.

Enum values:
2026-10-27
X-Project-ID
​string

The project the request acts on, as prj_ and its lowercase UUID; optional while the organization has one active project.

Read the organization's Treasury balance › Responses

The live Treasury balance.

as_of
​string · date-time · required
available_minor
​integer · int64 · required
​required

Calls refused since the hard stop began; not counted on this route yet, so always null.

capacity_minor
​integer · int64 · required
​required

When cash went below zero; not recorded yet, so always null.

cash_minor
​integer · int64 · required
credit_limit_minor
​integer · int64 · required
currency
​string · required
​required

Hours until available cash runs out at the current spend; not estimated yet, so always null.

exponent
​integer · int32 · required
exposure_minor
​integer · int64 · required
holds_minor
​integer · int64 · required
id
​string · required
live
​boolean · required
​required

The balance below which the account counts as low; not configurable yet, so always null.

​BillingPromoPool[] · required
​required

The code calls are refused with during a stop; not reported here yet, so always null.

​required

When calls began to be refused; not reported here yet, so always null.

reserved_cash_minor
​integer · int64 · required
​required

How many live calls hold reserved cash; not counted yet, so always null.

revision
​integer · int64 · required
state
​BillingAccountState · enum · required
Enum values:
hard_stop_over_limit
unfunded
low_using_credit
promo_carrying
healthy
status
​BillingAccountStatus · enum · required
Enum values:
active
suspended
closed
​required

The suspension in force on the account; not reported yet, so always null.

​required

The unpaid invoice holding the account; not reported yet, so always null.


List immutable customer financial documents

GET
https://api.signals.pressone.africa
/billing/documents

List immutable customer financial documents › query Parameters

kind
​string · enum
Enum values:
statement
invoice
credit_note
receipt
status
​string · enum
Enum values:
open
issued
paid
unpaid
applied
void
period
​string

List immutable customer financial documents › Headers

Signals-Version
​string · enum · required

The supported API snapshot to use for this request.

Enum values:
2026-10-27
X-Project-ID
​string

The project the request acts on, as prj_ and its lowercase UUID; optional while the organization has one active project.

List immutable customer financial documents › Responses

The matching documents and per-kind counts.

as_of
​string · date-time · required
​BillingDocumentCounts · required
currency
​string · required
​BillingDocumentRow[] · required
exponent
​integer · int32 · required
invoiced
​boolean · required

Read one immutable customer financial document

GET
https://api.signals.pressone.africa
/billing/documents/{document_id}

Read one immutable customer financial document › path Parameters

document_id
​string · required

Billing document id

Read one immutable customer financial document › Headers

Signals-Version
​string · enum · required

The supported API snapshot to use for this request.

Enum values:
2026-10-27
X-Project-ID
​string

The project the request acts on, as prj_ and its lowercase UUID; optional while the organization has one active project.

Read one immutable customer financial document › Responses

The statement or invoice, tagged by kind.

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · requires: statement, kind
type = object · requires: invoice, kind
Properties for Variant 1:
kind
​string · enum · required
Enum values:
statement
​BillingStatementDetail · required

Download a financial document from its frozen lines

GET
https://api.signals.pressone.africa
/billing/documents/{document_id}/download

Download a financial document from its frozen lines › path Parameters

document_id
​string · required

Billing document id

Download a financial document from its frozen lines › query Parameters

format
​string · enum
Enum values:
csv

Download a financial document from its frozen lines › Headers

Signals-Version
​string · enum · required

The supported API snapshot to use for this request.

Enum values:
2026-10-27
X-Project-ID
​string

The project the request acts on, as prj_ and its lowercase UUID; optional while the organization has one active project.

Download a financial document from its frozen lines › Responses

The document lines as UTF-8 CSV.

string