Recurring invoice lines

Line items in a recurring invoice represent transactions captured in that recurring invoice. Create and maintain recurring invoice lines from the owning recurring invoice object.

List recurring invoice lines

get/objects/accounts-receivable/recurring-invoice-line

Returns a collection with a key, ID, and link for each recurring invoice line. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "9",
      • "id": "9",
      • "href": "/objects/accounts-receivable/recurring-invoice-line/9"
      },
    • {
      • "key": "10",
      • "id": "10",
      • "href": "/objects/accounts-receivable/recurring-invoice-line/10"
      },
    • {
      • "key": "13",
      • "id": "13",
      • "href": "/objects/accounts-receivable/recurring-invoice-line/13"
      },
    • {
      • "key": "14",
      • "id": "14",
      • "href": "/objects/accounts-receivable/recurring-invoice-line/14"
      }
    ],
  • "ia::meta": {
    • "totalCount": 4,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get a recurring invoice line
get/objects/accounts-receivable/recurring-invoice-line/{key}
Returns detailed information for a specified line item in a recurring invoice.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the recurring invoice line.


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "51",
    • "key": "51",
    • "recurringInvoice": {
      • "id": "24",
      • "key": "24",
      • "href": "/objects/accounts-receivable/recurring-invoice/24"
      },
    • "offsetGLAccount": {
      • "key": null
      },
    • "description": "line 1",
    • "glAccount": {
      • "key": "254",
      • "id": "6103",
      • "name": "Bonuses",
      • "href": "/objects/general-ledger/account/254"
      },
    • "amount": "400.00",
    • "dimensions": {
      • "location": {
        },
      • "department": {
        },
      • "project": {
        },
      • "customer": {
        },
      • "vendor": {
        },
      • "employee": {
        },
      • "item": {
        },
      • "class": {
        }
      },
    • "lineNumber": 0,
    • "accountLabel": {
      • "id": "Bonuses",
      • "key": "35",
      • "href": "/objects/accounts-receivable/account-label/35"
      },
    • "currency": {
      • "txnCurrency": "AUD",
      • "baseCurrency": "AUD",
      • "exchangeRateDate": null,
      • "exchangeRateTypeId": null,
      • "exchangeRate": 1
      },
    • "txnAmount": "400.00",
    • "allocation": {
      • "key": null,
      • "id": null
      },
    • "isBillable": null,
    • "audit": {
      • "createdDateTime": "2024-09-24T14:18:18Z",
      • "modifiedDateTime": "2024-09-24T14:18:18Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "deferredRevenueGLAccount": {
      • "key": null,
      • "id": null,
      • "name": null
      },
    • "startDate": null,
    • "endDate": null,
    • "taxDetail": {
      • "taxRate": null,
      • "id": null,
      • "key": null
      },
    • "isTax": false,
    • "isSubTotal": null,
    • "taxEntries": [
      • {
        }
      ],
    • "href": "/objects/accounts-receivable/recurring-invoice-line/51"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}