Go Back

POST v1/invoices/recurring

Create a new recurring profile

Request Information

URI Parameters

None.

Body Parameters

Recurring profile

RecurringProfile
NameDescriptionTypeAdditional information
RecurringSchedule

RecurringSchedule

None.

Invoice

Invoice

None.

Request Formats

application/json, text/json

Sample:
{
  "RecurringSchedule": {
    "StartDate": "2016-12-03T02:49:57.901211+00:00",
    "Frequency": 64,
    "NumOfTimes": 1
  },
  "Invoice": {
    "ReferenceNumber": "sample string 1",
    "Discount": 1.0,
    "Shipping": 1.0,
    "Due": 64,
    "ClientNotes": "sample string 2",
    "InternalNotes": "sample string 3",
    "DocItems": [
      {
        "ItemId": "sample string 1",
        "ItemDescription": "sample string 2",
        "ItemPrice": 1.0,
        "ItemQuantity": 1.0,
        "TaxId1": 1,
        "TaxId2": 1,
        "DiscountType": 64,
        "DiscountValue": 1.0
      },
      {
        "ItemId": "sample string 1",
        "ItemDescription": "sample string 2",
        "ItemPrice": 1.0,
        "ItemQuantity": 1.0,
        "TaxId1": 1,
        "TaxId2": 1,
        "DiscountType": 64,
        "DiscountValue": 1.0
      }
    ],
    "BankAccountId": 1,
    "EarlyPaymentDiscount": {
      "DiscountValue": 1.0,
      "DueDate": "2016-12-03T02:49:57.901211+00:00"
    },
    "Key": "sample string 4",
    "ClientId": "sample string 5",
    "Id": "sample string 6",
    "CurrencyId": 1,
    "LanguageId": 64,
    "IssueDate": "2016-12-03T02:49:57.901211+00:00",
    "CompanyId": 1,
    "AcceptCreditCard": true,
    "AcceptPayPal": true,
    "Uri": "sample string 9"
  }
}

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.

Go Back