NIninjarmm
Billing

Get all invoices

Changed on

Returns a list of invoices with optional filters

get/v2/billing/invoices

Request

Query parameters

clientIdinteger

Filter invoices by organization/client ID.

agreementIdinteger

Filter invoices by agreement ID.

createdDateFromstring date

Filter invoices created on or after this date (inclusive). Format: yyyy-MM-dd

createdDateTostring date

Filter invoices created on or before this date (inclusive). Format: yyyy-MM-dd

periodFromstring date

Filter invoices by billing period start (inclusive). Must be provided together with periodTo. Format: yyyy-MM-dd

periodTostring date

Filter invoices by billing period end (inclusive). Must be provided together with periodFrom. Format: yyyy-MM-dd

Response

List of invoices successfully retrieved

idinteger

Unique identifier for the invoice

invoiceNumberstring

Invoice number

agreementNamestring

Name of the agreement associated with this invoice

agreementIdinteger

Unique identifier for the agreement

subTotalnumber required

Subtotal amount before taxes and discounts

totalTaxnumber required

Total tax amount

totalnumber required

Total amount including taxes and discounts

createTimenumber double required

Timestamp when the invoice was created

updateTimenumber double required

Timestamp when the invoice was last updated

invoiceGenerationType'AUTOMATIC' | 'MANUAL' | 'ONE_OFF' required

Type of invoice generation (MANUAL or AUTOMATIC)

status'PENDING' | 'APPROVED' | 'COMPLETE' | 'EXPORTING' | 'FAILED' | 'EXPORTED' | 'ARCHIVED' required

Current status of the invoice

failureReasonstring nullable

Reason for failure if the invoice export failed

currency'USD' | 'EUR' | 'CAD' | 'GBP' | 'AUD' | 'JPY' | 'SEK' | 'NOK' | 'DKK' | 'CHF' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'AOA' | 'ARS' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CDF' | 'CHE' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'FJD' | 'FKP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYI' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAD' | 'XAF' | 'XCD' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWG' required

Currency used for this invoice

billingPeriodStartDatestring

Start date of the billing period in YYYY-MM-DD format

billingPeriodEndDatestring

End date of the billing period in YYYY-MM-DD format

dueDatestring

Due date for payment in YYYY-MM-DD format

hasActiveIntegrationDataboolean required

Indicates if the invoice has active integration data configured

Example response

[
  {
    "id": 123,
    "invoiceNumber": "INV-2024-001",
    "agreementName": "Monthly Service Agreement",
    "agreementId": 456,
    "subTotal": 1000,
    "totalTax": 80,
    "total": 1080,
    "invoiceGenerationType": "AUTOMATIC",
    "status": "PENDING",
    "client": {
      "id": 789,
      "name": "Acme Corporation"
    },
    "failureReason": "Connection timeout to external system",
    "currency": "USD",
    "billingPeriodStartDate": "2024-01-01T00:00:00.000Z",
    "billingPeriodEndDate": "2024-01-31T00:00:00.000Z",
    "dueDate": "2024-02-15T00:00:00.000Z",
    "hasActiveIntegrationData": true
  }
]

Changes

  • 5932b93aea2aRevision changes
    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • warning

      added the new EXPORTED enum value to the / response property for the response status

    • warning

      added the new ONE_OFF enum value to the / response property for the response status

  • dec5d4ed264eRevision changes
    • info

      endpoint added