v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB

RepeatingInvoice

Replaces the RepeatingInvoice resource.

put/repeating_invoices/{id}

Path parameters

idstring required

Resource identifier

Request body

idstring

integrationstring

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

srcIdstring

Unique identifier for each repeating invoice

periodinteger nullable

Number of times the invoice is charged per unit

unitstring nullable

Interval unit defining how often the invoice is charged e.g. WEEKLY e.g. MONTHLY

dueDatestring nullable

Number of days defining when the invoice is scheduled to be charged

dueDateTypestring nullable

The type of billing used together with due date e.g. "DAYSAFTERBILLDATE" e.g. "DAYSAFTERBILLMONTH" e.g. "OFCURRENTMONTH" e.g. "OFFOLLOWINGMONTH"

startDatestring nullable

date on which the recurring invoice starts

nextScheduledDatestring nullable

date at which next invoice is to be sent

typestring nullable

The type of invoice e.g. "ACCPAY" e.g. "ACCREC"

referencestring nullable

Order number of recurring invoice

hasAttachmentsboolean nullable

Whether the invoice has attachments or not

contactIdstring nullable

Id of customer for whom recurring invoice is raised

contactNamestring nullable

Full name of contact

statusstring nullable

Status of the repeating invoice e.g. "DRAFT" e.g. "AUTHORISED"

lineAmountTypesstring nullable

Whether the line amount includes, excludes or doesn't have tax.

lineItemDescriptionstring nullable

A description of the line item

lineItemUnitAmountinteger nullable

The unit amount of the line item

lineItemTaxTypestring nullable

The type of tax applied to line items e.g. "OUTPUT" e.g. "INPUT" e.g. "CAPEXINPUT"

lineAmountinteger nullable

The final amount for the line items

lineItemAccountCodestring nullable

Account code for the line item

lineItemQuantityinteger nullable

The quantity of the line items

lineItemIdstring nullable

Unique ID for the line item

subTotalinteger nullable

Total of invoice excluding taxes

totalTaxinteger nullable

Total tax on invoice

totalinteger

Total of invoice tax inclusive

currencyCodestring nullable

currency of invoice

recurrenceNamestring nullable

Unique name for the recurring profile given by the user

endDatestring nullable

date on which the recurring invoice expires

lastSentDatestring nullable

date at which the last invoice was sent

paidInvoicesTotalinteger nullable

total amount paid to date

unpaidInvoicesBalanceinteger nullable

total amount left to be paid

discountinteger nullable

billingStreetstring nullable

billingStreet2string nullable

billingCitystring nullable

billingStatestring nullable

billingPostalCodestring nullable

billingCountrystring nullable

createdstring date-time nullable

modifiedstring date-time nullable

Example request

{
  "id": "xero-01e01427-6b48-4d5f-aa2e-87c43f2a32a9",
  "integration": "quickbooks",
  "srcId": "01e01427-6b48-4d5f-aa2e-87c43f2a32a9",
  "period": 1,
  "unit": "MONTHLY",
  "dueDate": "0",
  "dueDateType": "DAYSAFTERBILLDATE",
  "startDate": "2021-02-27 00:00:00",
  "nextScheduledDate": "2021-07-28 00:00:00",
  "type": "ACCPAY",
  "reference": "AP",
  "contactId": "3b30a108-9156-4a42-a893-3bbbe7af1ef8",
  "contactName": "Xero",
  "status": "AUTHORISED",
  "lineAmountTypes": "Exclusive",
  "lineItemDescription": "Monthly subscription",
  "lineItemUnitAmount": 29,
  "lineItemTaxType": "INPUT",
  "lineAmount": 29,
  "lineItemAccountCode": "412",
  "lineItemQuantity": 1,
  "lineItemId": "304e5b38-d62f-4c43-91d2-24786154c3c0",
  "subTotal": 2900,
  "totalTax": 239,
  "total": 3139,
  "currencyCode": "USD",
  "recurrenceName": "412",
  "endDate": "2022-07-28 00:00:00",
  "lastSentDate": "2021-08-28 00:00:00",
  "paidInvoicesTotal": 1000,
  "unpaidInvoicesBalance": 2139,
  "discount": 412,
  "billingStreet": "123 lonecrest drive",
  "billingStreet2": "412 fuller cres",
  "billingCity": "Toronto",
  "billingState": "Ontario",
  "billingPostalCode": "H6F 3F6",
  "billingCountry": "Canada",
  "created": "2021-07-28 00:00:00",
  "modified": "2021-09-15 00:00:00"
}

Response

RepeatingInvoice resource updated