v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB

RecurringExpense

Retrieves a RecurringExpense resource.

get/recurring_expenses/{id}

Path parameters

idstring required

Resource identifier

Response

RecurringExpense resource

idstring

integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

srcIdstring

Unique identifier of the source 3rd party integration eg. 982000000567240

recurrenceNamestring nullable

Name of the recurring-expense eg. "Monthly Rental"

startDatestring nullable

Start date of the recurring expense eg. 2016-11-19T00:00:00.000Z

endDatestring nullable

End date of the recurring expense eg. 2016-11-19T00:00:00.000Z

lastCreatedDatestring nullable

When expense was last generated eg. "2013-11-18T00:00:00.000Z"

recurrenceFrequencystring nullable

The frequency of time interval at which the invoice is to be generated eg. "months"

repeatEverystring nullable

The period between every recurrency frequency eg. "2"

nextExpenseDatestring nullable

Date the next expense will be generated eg. "2013-12-18T00:00:00.000Z"

accountIdstring nullable

Unique identifier for the account associated with the recurring expense "982000000561057"

accountNamestring nullable

Expense account name eg. "Rent"

currencystring nullable

Currency of the expense eg. "USD"

totalinteger nullable

Total amount in cents eg. "1000"

customerIdstring nullable

Customer ID of the customer for whom the recurring invoice is raised eg. "982000000567001"

statusstring nullable

Status of the recurring expense eg. "active"

createdstring date-time nullable

Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z"

modifiedstring date-time nullable

Time at which the recurring invoice details were last updated eg. "2013-11-18T02:17:40.080Z"

Example response

{
  "id": "xero-01e01427-6b48-4d5f-aa2e-87c43f2a32a9",
  "integration": "quickbooks",
  "srcId": "982000000567240",
  "recurrenceName": "Monthly Rental",
  "startDate": "2020-11-19T00:00:00.000Z",
  "endDate": "2024-11-19T00:00:00.000Z",
  "lastCreatedDate": "2021-11-18T00:00:00.000Z",
  "recurrenceFrequency": "months",
  "repeatEvery": "2",
  "nextExpenseDate": "2021-12-18T00:00:00.000Z",
  "accountId": "982000000561057",
  "accountName": "Rent",
  "currency": "USD",
  "total": 100,
  "customerId": "982000000567001",
  "status": "active",
  "created": "2021-07-28 00:00:00",
  "modified": "2021-09-15 00:00:00"
}