Skip to main content
Loading...

API docs by

Get specific billing account summary

Request

This method returns a billing summary of an account based on the account number given.

Path
accountNumberstringrequired

Account number

Query
monthsArray of strings

Finance documents will be pulled for these months ex: 2017-12-03,2018-01-03 in ISO_LOCAL_DATE format

Default:""
Headers
Authorizationstringrequired

Specify the Access token with prefix 'Bearer '.

Payload
// No request payload

Responses

Bodyapplication/json
accountNumberstring
Example:"124353"
parentAccountNumberstring
Example:"54321"
accountNamestring
Example:"Example Inc."
billingFrequencystring

Frequency of billing

Enum:"MONTHLY""QUARTERLY""ANNUALLY"
Example:"MONTHLY"
currencyCodestring, non-empty

Currency code of the account

Example:"SGD"
invoiceLanguagestring

Language of the invoice

Example:"English"
invoiceFormatstring

Format of the invoice

Enum:"PDF""EXCEL"
Example:"PDF"
invoicesArray of objects(Invoice)

Available invoices for the account

Example:
[
  {
    "invoiceId": "123435",
    "transactionNumber": "654321879",
    "date": "2017-03-23",
    "type": "CREDIT_MEMO",
    "amount": 13456.87,
    "documents": [ … ]
  },
  {
    "invoiceId": "123435",
    "transactionNumber": "654321879",
    "date": "2017-03-23",
    "type": "CREDIT_MEMO",
    "amount": -914.52,
    "documents": [ … ]
  }
]
paymentsArray of objects(Payment)

Available payments for the account

Example:
[
  {
    "paymentId": "123435",
    "amount": 43218.79,
    "date": "2017-03-23",
    "type": "APPLIED"
  }
]
billingContactobject(BillingContact)

Details of billing contact

Example:
{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.lk"
}
accountIbxsArray of strings
Example:
[
  "IBX1",
  "IBX2",
  "IBX3",
  "IBX4"
]
Response
{
  "accountNumber": "124353",
  "billingContact": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.lk"
  },
  "billingFrequency": "MONTHLY",
  "invoiceLanguage": "English",
  "invoiceFormat": "PDF",
  "invoices": [
    { … },
    { … }
  ],
  "currencyCode": "GBP",
  "payments": [
    { … },
    { … }
  ]
}
Was this page helpful?