Skip to content
/
Get the invoice summary i...

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

Get a list of invoices

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
idstring(IdFilterParam)

Filter by generated invoice identifier

Example: id=0
contractOwnerIdstring(IdFilterParam)

Filter by contract owner identifier

Example: contractOwnerId=0
billingCycleIdstring(IdFilterParam)

Filter by billing cycle identifier

Example: billingCycleId=0
billRunIdstring(IdFilterParam)

Filter by bill run identifier

Example: billRunId=0
billRunTypestring(IdFilterParam)

Filter by bill run type

Example: billRunType=0
billRunStatusstring(StringFilterParam)

Filter by bill run status

Example: billRunStatus=xyz | in:x,y | like:xyz
customerIdstring(IdFilterParam)

Filter by customer identifier

Example: customerId=0
siteIdstring(IdFilterParam)

Filter by site identifier

Example: siteId=0
dueDatestring(DateFilterParam)

Filter by invoice due date

Example: dueDate=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
invoiceDatestring(DateFilterParam)

Filter by invoice date

Example: invoiceDate=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
paymentMethodstring(StringFilterParam)

Filter by payment method

Example: paymentMethod=xyz | in:x,y | like:xyz
mandateStatusstring(StringFilterParam)

Filter by mandate status

Example: mandateStatus=xyz | in:x,y | like:xyz
paymentStatusstring(StringFilterParam)

Filter by invoice payment status

Example: paymentStatus=xyz | in:x,y | like:xyz
thirdPartyPaymentStatusstring(StringFilterParam)

Filter by invoice payment status of the integrated payment provider

Example: thirdPartyPaymentStatus=xyz | in:x,y | like:xyz
invoiceNumberstring(StringFilterParam)

Filter by invoice number

Example: invoiceNumber=xyz | in:x,y | like:xyz
createdDatestring(StringFilterParam)

Filter by created date

Example: createdDate=xyz | in:x,y | like:xyz
thirdPartyPaymentStatusUpdatedTimestring(StringFilterParam)

Filter by third party payment status updated date and time

Example: thirdPartyPaymentStatusUpdatedTime=xyz | in:x,y | like:xyz
paymentStatusUpdatedDatestring(StringFilterParam)

Filter by payment status updated date

Example: paymentStatusUpdatedDate=xyz | in:x,y | like:xyz
refundStatusUpdatedDatestring(StringFilterParam)

Filter by refund status updated date

Example: refundStatusUpdatedDate=xyz | in:x,y | like:xyz
thirdPartyRefundStatusstring(StringFilterParam)

Filter by third party refund status

Example: thirdPartyRefundStatus=xyz | in:x,y | like:xyz
paymentStatusUpdatedTimestring(StringFilterParam)

Filter by payment status updated date and time

Example: paymentStatusUpdatedTime=xyz | in:x,y | like:xyz
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/invoices?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&id=0&contractOwnerId=0&billingCycleId=0&billRunId=0&billRunType=0&billRunStatus=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&customerId=0&siteId=0&dueDate=yyyy-MM-dd+%2C+lt%3Ayyyy-MM-dd+%2C+gt%3Ayyyy-MM-dd+%2C+gtn%3Ayyyy-MM-dd&invoiceDate=yyyy-MM-dd+%2C+lt%3Ayyyy-MM-dd+%2C+gt%3Ayyyy-MM-dd+%2C+gtn%3Ayyyy-MM-dd&paymentMethod=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&mandateStatus=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&paymentStatus=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&thirdPartyPaymentStatus=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&invoiceNumber=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&createdDate=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&thirdPartyPaymentStatusUpdatedTime=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&paymentStatusUpdatedDate=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&refundStatusUpdatedDate=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&thirdPartyRefundStatus=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&paymentStatusUpdatedTime=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)read-only

Invoice identifier

Example: 1
invoiceSummaryIdinteger(int64)read-only

Invoice summary identifier

Example: 1
contractOwnerIdinteger(int32)

Contract owner identifier

Example: 0
billingCycleIdinteger(int64)

Billing cycle identifier

Example: 0
billRunIdinteger(int64)

Bill run identifier

Example: 0
billRunTypestring(BillRunType)

Billing run type

Enum"NORMAL""ADHOC"
billRunStatusstring(BillRunStatus)

Bill run status

Enum"OPEN""CLOSED""FINALIZED"
customerIdinteger(int64)

Customer identifier

Example: 0
siteIdinteger(int64)

Site identifier

Example: 0
dueDatestring(date)

Invoice due date

invoiceDatestring(date)

Invoice date

createdDatestring(date)

Invoice created date

thirdPartyPaymentStatusUpdatedTimestring(date-time)

Invoice thirdPartyPaymentStatus updated date and time

paymentStatusUpdatedDatestring(date)

Invoice paymentStatus updated date (deprecated and can be removed in future releases, use paymentStatusUpdatedTime instead)

paymentStatusUpdatedTimestring(date-time)

Invoice paymentStatus updated date and time

refundStatusUpdatedDatestring(date)

Invoice thirdPartyRefundStatus updated date

paymentMethodstring(PaymentMethod)

Payment method

Enum"CHEQUE""DIRECT_DEBIT""CANCELLED_DD""CANCELLED_CARD""CREDIT_CARD""PAYPAL""BACS""POST_OFFICE_PAYMENT_CARD""EZYPAY""GO_CARDLESS"
mandateStatusstring(PaymentProviderMandateStatus)

Invoice payment status

Enum"NEW""INACTIVE""CREATED""CUSTOMER_APPROVAL_GRANTED""CUSTOMER_APPROVAL_SKIPPED""ACTIVE""CANCELLED""FAILED""TRANSFERRED""EXPIRED"
paymentStatusstring(PaymentStatus)

Invoice payment status

Enum"NA""PAID""UNPAID""PENDING""REFUNDED""PART_REFUNDED""REFUND_PENDING""WRITTEN_OFF""DISPUTED""PARTIALLY_PAID"
thirdPartyPaymentStatusstring(ThirdPartyPaymentStatus)

Invoice payment status. Not applicable for manual payments

Enum"NEW""CREATED""PENDING_CUSTOMER_APPROVAL""PENDING_SUBMISSION""SUBMITTED""CONFIRMED""PAID_OUT""CANCELLED""FAILED""FAILED_RETRYING"
thirdPartyRefundStatusstring(ThirdPartyRefundStatus)read-only

Third party refund status

Enum"CREATED""PENDING_SUBMISSION""SUBMITTED""PAID""CANCELLED""BOUNCED""FUNDS_RETURNED""MANUALLY_REFUNDED""REFUND_SETTLED"
invoiceNumberstring

Invoice Number

invoiceTotalAmountnumber(decimal)

Invoice total amount

invoiceTaxAmountnumber(decimal)

Invoice total tax amount

taxExemptboolean

Invoice is tax exempt

purchaseOrderNumberstring

Purchase Order Number

invoiceRemainingAmountnumber(decimal)

Invoice remaining amount

totalRentalAmountnumber(decimal)read-only

Invoice total rental charge amount

totalRentalTaxAmountnumber(decimal)read-only

Invoice total rental charge tax amount

totalUsageAmountnumber(decimal)read-only

Invoice total usage charge amount

totalUsageTaxAmountnumber(decimal)read-only

Invoice total usage charge tax amount

usageBreakdownArray of objects(UsageBreakdown)
totalAdhocAmountnumber(decimal)read-only

Invoice total adhoc charge amount

totalAdhocTaxAmountnumber(decimal)read-only

Invoice total adhoc charge tax amount

totalBoltOnAmountnumber(decimal)read-only

Invoice total bolt-on charge amount

totalBoltOnTaxAmountnumber(decimal)read-only

Invoice total bolt-on charge tax amount

totalReverseVatAmountnumber(decimal)read-only

Invoice total reverse-vat charge amount

paymentRetryCountinteger(int32)read-only

Number of payment retries attempted

Example: 0
]
Response
application/json
[
  {
    "id": 1,
    "invoiceSummaryId": 1,
    "contractOwnerId": 0,
    "billingCycleId": 0,
    "billRunId": 0,
    "billRunType": "NORMAL",
    "billRunStatus": "OPEN",
    "customerId": 0,
    "siteId": 0,
    "dueDate": "2019-08-24",
    "invoiceDate": "2019-08-24",
    "createdDate": "2019-08-24",
    "thirdPartyPaymentStatusUpdatedTime": "2019-08-24T14:15:22Z",
    "paymentStatusUpdatedDate": "2019-08-24",
    "paymentStatusUpdatedTime": "2019-08-24T14:15:22Z",
    "refundStatusUpdatedDate": "2019-08-24",
    "paymentMethod": "CHEQUE",
    "mandateStatus": "NEW",
    "paymentStatus": "NA",
    "thirdPartyPaymentStatus": "NEW",
    "thirdPartyRefundStatus": "CREATED",
    "invoiceNumber": "string",
    "invoiceTotalAmount": 0,
    "invoiceTaxAmount": 0,
    "taxExempt": true,
    "purchaseOrderNumber": "string",
    "invoiceRemainingAmount": 0,
    "totalRentalAmount": 0,
    "totalRentalTaxAmount": 0,
    "totalUsageAmount": 0,
    "totalUsageTaxAmount": 0,
    "usageBreakdown": [ … ],
    "totalAdhocAmount": 0,
    "totalAdhocTaxAmount": 0,
    "totalBoltOnAmount": 0,
    "totalBoltOnTaxAmount": 0,
    "totalReverseVatAmount": 0,
    "paymentRetryCount": 0
  }
]

Get the invoice in PDF format

Request

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

Invoice identifier

Example: 1
billRunTypestring(BillRunType)required

Bill Run Type

Enum"NORMAL""ADHOC"
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/invoices/{billRunType}/1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

A PDF file

Bodyapplication/pdf
string(binary)

Get the invoice summary in PDF format

Request

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

Invoice summary identifier

Example: 1
billRunTypestring(BillRunType)required

Bill Run Type

Enum"NORMAL""ADHOC"
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/invoice-summaries/{billRunType}/1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

A PDF file

Bodyapplication/pdf
string(binary)
Response
No content

Resend customer invoice email

Request

Resend customer invoice email to configured contacts

Security
bearerAuth
Bodyapplication/jsonrequired

Resend customer invoice email request

invoiceIdinteger(int64)required

Invoice identifier

Example: 0
billRunTypestring(BillRunType)required

Billing run type

Enum"NORMAL""ADHOC"
curl -i -X POST \
  https://rest.elevatebilling.com/v1/resend-invoice \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "invoiceId": 0,
    "billRunType": "NORMAL"
  }'

Responses

OK

Body

invoice-payment-events

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

Operations