Get a list of invoices

get/invoices
SecuritybearerAuth
Request
query Parameters
page
required
integer <int32> (PageParam) >= 1

Page of results to show

Example: page=1
pageSize
required
integer <int32> (ResultsPerPageParam) [ 1 .. 1000 ]

Results to return per page

Example: pageSize=100
sort
string (SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fields
string (FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
id
string (IdFilterParam)

Filter by generated invoice identifier

Example: id=0
contractOwnerId
string (IdFilterParam)

Filter by contract owner identifier

Example: contractOwnerId=0
billingCycleId
string (IdFilterParam)

Filter by billing cycle identifier

Example: billingCycleId=0
billRunId
string (IdFilterParam)

Filter by bill run identifier

Example: billRunId=0
billRunType
string (IdFilterParam)

Filter by bill run type

Example: billRunType=0
billRunStatus
string (StringFilterParam)

Filter by bill run status

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

Filter by customer identifier

Example: customerId=0
siteId
string (IdFilterParam)

Filter by site identifier

Example: siteId=0
dueDate
string (DateFilterParam)

Filter by invoice due date

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

Filter by invoice date

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

Filter by payment method

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

Filter by mandate status

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

Filter by invoice payment status

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

Filter by invoice payment status of the integrated payment provider

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

Filter by invoice number

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

Filter by created date

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

Filter by payment status updated date

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

Filter by refund status updated date

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

Filter by third party refund status

Example: thirdPartyRefundStatus=xyz | in:x,y | like:xyz
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

Response samples
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",
    • "paymentStatusUpdatedDate": "2019-08-24",
    • "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": [
      • {
        • "usageProductId": 0,
        • "chargeGroupCategoryId": 0,
        • "taxBandId": 0,
        • "costPrice": 0,
        • "sellPrice": 0,
        • "taxAmount": 0,
        • "ratedCostPrice": 0
        }
      ],
    • "totalAdhocAmount": 0,
    • "totalAdhocTaxAmount": 0,
    • "totalBoltOnAmount": 0,
    • "totalBoltOnTaxAmount": 0,
    • "totalReverseVatAmount": 0,
    • "paymentRetryCount": 0
    }
]