Skip to content
/
Create a new invoice paym...

Elevate Invoices API (1.21)

Invoice

Provides read and write access to customer invoices and invoice payment events

Definitions

  • Invoice - a record of charges for a customer. They maybe 'normal' or 'adhoc' and are split into Invoice and Invoice Summary providing the break down of charges
  • InvoicePaymentEvent - a change to an invoice as a result of payments, refunds or state changes
Download OpenAPI description
billing-rest-invoices.json
billing-rest-invoices.yaml
Languages
Servers
https://rest.elevatebilling.com/v1

invoices

Customer invoices

Operations

invoice-payment-events

Invoice state changes. Can be used to write off or dispute to and from unpaid invoices

Operations

Get a list of invoice payment events

Request

Security
bearerAuth
Query
customerIdinteger(int64)(IdParam)>= 1

Customer identifier

Example: customerId=1
invoiceIdinteger(int64)(IdParam)>= 1

Invoice identifier

Example: invoiceId=1
billRunTypestring(BillRunType)

Bill Run Type

Enum"NORMAL""ADHOC"
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
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/invoice-payment-events?customerId=1&invoiceId=1&billRunType=NORMAL&page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)read-only

Invoice History identifier

Example: 1
invoiceIdinteger(int64)required

Invoice identifier

Example: 0
customerIdinteger(int64)read-only

Customer identifier

Example: 1
billRunTypestring(BillRunType)required

Billing run type

Enum"NORMAL""ADHOC"
paymentStatusstring(PaymentStatus)required

Invoice payment status

Enum"NA""PAID""UNPAID""PENDING""REFUNDED""PART_REFUNDED""REFUND_PENDING""WRITTEN_OFF""DISPUTED""PARTIALLY_PAID"
notesstring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Notes on payment change

amountInMajorCurrencynumber[ 0.01 .. 100000 ]

Amount in major currency (e.g pounds/dollars/euros)

Example: 10.5
]
Response
application/json
[
  {
    "id": 1,
    "invoiceId": 0,
    "customerId": 1,
    "billRunType": "NORMAL",
    "paymentStatus": "NA",
    "notes": "string",
    "amountInMajorCurrency": 10.5
  }
]

Create a new invoice payment event

Request

Create a new invoice payment event. Used for disputing an invoice, writing off an invoice, undisputing, un-writting off and undoing a payment for an invoice made in error

Security
bearerAuth
Bodyapplication/jsonrequired

New invoice payment event

invoiceIdinteger(int64)required

Invoice identifier

Example: 0
billRunTypestring(BillRunType)required

Billing run type

Enum"NORMAL""ADHOC"
paymentStatusstring(PaymentStatus)required

Invoice payment status

Enum"NA""PAID""UNPAID""PENDING""REFUNDED""PART_REFUNDED""REFUND_PENDING""WRITTEN_OFF""DISPUTED""PARTIALLY_PAID"
notesstring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Notes on payment change

amountInMajorCurrencynumber[ 0.01 .. 100000 ]

Amount in major currency (e.g pounds/dollars/euros)

Example: 10.5
curl -i -X POST \
  https://rest.elevatebilling.com/v1/invoice-payment-events \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "invoiceId": 0,
    "billRunType": "NORMAL",
    "paymentStatus": "NA",
    "notes": "string",
    "amountInMajorCurrency": 10.5
  }'

Responses

OK

Bodyapplication/json
idinteger(int64)read-only

Invoice History identifier

Example: 1
invoiceIdinteger(int64)required

Invoice identifier

Example: 0
customerIdinteger(int64)read-only

Customer identifier

Example: 1
billRunTypestring(BillRunType)required

Billing run type

Enum"NORMAL""ADHOC"
paymentStatusstring(PaymentStatus)required

Invoice payment status

Enum"NA""PAID""UNPAID""PENDING""REFUNDED""PART_REFUNDED""REFUND_PENDING""WRITTEN_OFF""DISPUTED""PARTIALLY_PAID"
notesstring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Notes on payment change

amountInMajorCurrencynumber[ 0.01 .. 100000 ]

Amount in major currency (e.g pounds/dollars/euros)

Example: 10.5
Response
application/json
{
  "id": 1,
  "invoiceId": 0,
  "customerId": 1,
  "billRunType": "NORMAL",
  "paymentStatus": "NA",
  "notes": "string",
  "amountInMajorCurrency": 10.5
}