POST api/RecurringInvoices

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
code	string	Required
name	string	Required
cyclePeriod	integer	None.
dayOfTheWeek	integer	None.
dayOfTheMonth	integer	None.
repeat	integer	None.
documentType	integer	None.
bufor	integer	None.
inactive	integer	None.
magId	integer	None.
magCode	string	None.
nb	integer	None.
reminder	integer	None.
sendEmailToCustomer	integer	None.
comments	string	None.
currency	string	Max length: 3
vatCalculationMethod	byte	None.
documentDateType	byte	None.
documentDate	date	None.
documentDateDayOfMonth	integer	None.
saleDateType	byte	None.
saleDate	date	None.
saleDateDayOfMonth	integer	None.
paymentType	byte	None.
paymentMethod	string	None.
fixedPaymentFormId	integer	None.
paymentTermType	byte	None.
paymentTermDay	integer	None.
categoryType	byte	None.
category	string	None.
categoryDescription	string	Max length: 50
reminderTime	date	None.
nextGenerationDate	date	None.
invoiceDescription	string	Max length: 1024
autoGenerate	byte	None.
autoSendEmail	byte	None.
emailTemplateId	integer	None.
standardPrint	byte	None.
printTemplateId	integer	None.
blockDuplicateEntities	byte	None.
transferAttributes	byte	None.
customers	Collection of CustomerRecurringInvoice	None.
products	Collection of ProductRecurringInvoice	None.
attributes	Collection of Attribute	None.
companyData	CompanyData	None.

Request Formats

application/json, text/json

Sample:

{
  "code": "sample string 1",
  "name": "sample string 2",
  "cyclePeriod": 3,
  "dayOfTheWeek": 4,
  "dayOfTheMonth": 5,
  "repeat": 6,
  "documentType": 7,
  "bufor": 8,
  "inactive": 9,
  "magId": 10,
  "magCode": "sample string 11",
  "nb": 12,
  "reminder": 13,
  "sendEmailToCustomer": 14,
  "comments": "sample string 15",
  "currency": "sample string 16",
  "vatCalculationMethod": 64,
  "documentDateType": 64,
  "documentDate": "2025-11-08T13:32:15.8856119+01:00",
  "documentDateDayOfMonth": 20,
  "saleDateType": 64,
  "saleDate": "2025-11-08T13:32:15.8856119+01:00",
  "saleDateDayOfMonth": 23,
  "paymentType": 64,
  "paymentMethod": "sample string 25",
  "fixedPaymentFormId": 1,
  "paymentTermType": 64,
  "paymentTermDay": 27,
  "categoryType": 64,
  "category": "sample string 29",
  "categoryDescription": "sample string 30",
  "reminderTime": "2025-11-08T13:32:15.8856119+01:00",
  "nextGenerationDate": "2025-11-08T13:32:15.8856119+01:00",
  "invoiceDescription": "sample string 31",
  "autoGenerate": 64,
  "autoSendEmail": 64,
  "emailTemplateId": 34,
  "standardPrint": 64,
  "printTemplateId": 36,
  "blockDuplicateEntities": 64,
  "transferAttributes": 64,
  "customers": [
    {
      "code": "sample string 1",
      "id": 2,
      "customerType": 64,
      "lpCustomerType": 4,
      "customerOrGroup": 1,
      "customerOrGroupId": 1,
      "name": "sample string 5",
      "recipientType": 1,
      "recipientId": 1,
      "recipientCode": "sample string 6",
      "recipientName": "sample string 7",
      "isActiveFrom": 64,
      "activeFromDate": "2025-11-08T13:32:15.8856119+01:00",
      "isActiveTo": 64,
      "activeToDate": "2025-11-08T13:32:15.8856119+01:00",
      "invoiceDescription": "sample string 10"
    },
    {
      "code": "sample string 1",
      "id": 2,
      "customerType": 64,
      "lpCustomerType": 4,
      "customerOrGroup": 1,
      "customerOrGroupId": 1,
      "name": "sample string 5",
      "recipientType": 1,
      "recipientId": 1,
      "recipientCode": "sample string 6",
      "recipientName": "sample string 7",
      "isActiveFrom": 64,
      "activeFromDate": "2025-11-08T13:32:15.8856119+01:00",
      "isActiveTo": 64,
      "activeToDate": "2025-11-08T13:32:15.8856119+01:00",
      "invoiceDescription": "sample string 10"
    }
  ],
  "products": [
    {
      "priceType": 64,
      "orderNumber": 2,
      "productId": 3,
      "code": "sample string 4",
      "name": "sample string 5",
      "warehouseId": 1,
      "quantityType": 64,
      "quantity": 7.1,
      "quantityPrinted": 1.0,
      "unit": "sample string 8",
      "unitShort": "sample string 9",
      "unitConversionNumerator": 10.0,
      "unitConversionDenominator": 11,
      "priceCategory": 64,
      "pricePrecision": 64,
      "netPrice": 14.0,
      "grossPrice": 1.0,
      "currency": "sample string 15",
      "netPricePLN": 16.0,
      "grossPricePLN": 17.0,
      "priceGroup": 18,
      "priceGroupName": "sample string 19"
    },
    {
      "priceType": 64,
      "orderNumber": 2,
      "productId": 3,
      "code": "sample string 4",
      "name": "sample string 5",
      "warehouseId": 1,
      "quantityType": 64,
      "quantity": 7.1,
      "quantityPrinted": 1.0,
      "unit": "sample string 8",
      "unitShort": "sample string 9",
      "unitConversionNumerator": 10.0,
      "unitConversionDenominator": 11,
      "priceCategory": 64,
      "pricePrecision": 64,
      "netPrice": 14.0,
      "grossPrice": 1.0,
      "currency": "sample string 15",
      "netPricePLN": 16.0,
      "grossPricePLN": 17.0,
      "priceGroup": 18,
      "priceGroupName": "sample string 19"
    }
  ],
  "attributes": [
    {
      "id": 1,
      "attributeId": 2,
      "objectId": 3,
      "code": "sample string 4",
      "value": "sample string 5",
      "copyToTransaction": 6,
      "copyToDelivery": 7,
      "companyData": {
        "companyName": "sample string 1",
        "databaseName": "sample string 2"
      }
    },
    {
      "id": 1,
      "attributeId": 2,
      "objectId": 3,
      "code": "sample string 4",
      "value": "sample string 5",
      "copyToTransaction": 6,
      "copyToDelivery": 7,
      "companyData": {
        "companyName": "sample string 1",
        "databaseName": "sample string 2"
      }
    }
  ],
  "companyData": {
    "companyName": "sample string 1",
    "databaseName": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<RecurringInvoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebApiOptima_v._2._0.Models">
  <attributes>
    <Attribute>
      <attributeId>2</attributeId>
      <code>sample string 4</code>
      <companyData>
        <companyName>sample string 1</companyName>
        <databaseName>sample string 2</databaseName>
      </companyData>
      <copyToDelivery>7</copyToDelivery>
      <copyToTransaction>6</copyToTransaction>
      <id>1</id>
      <objectId>3</objectId>
      <value>sample string 5</value>
    </Attribute>
    <Attribute>
      <attributeId>2</attributeId>
      <code>sample string 4</code>
      <companyData>
        <companyName>sample string 1</companyName>
        <databaseName>sample string 2</databaseName>
      </companyData>
      <copyToDelivery>7</copyToDelivery>
      <copyToTransaction>6</copyToTransaction>
      <id>1</id>
      <objectId>3</objectId>
      <value>sample string 5</value>
    </Attribute>
  </attributes>
  <autoGenerate>64</autoGenerate>
  <autoSendEmail>64</autoSendEmail>
  <blockDuplicateEntities>64</blockDuplicateEntities>
  <bufor>8</bufor>
  <category>sample string 29</category>
  <categoryDescription>sample string 30</categoryDescription>
  <categoryType>64</categoryType>
  <code>sample string 1</code>
  <comments>sample string 15</comments>
  <companyData>
    <companyName>sample string 1</companyName>
    <databaseName>sample string 2</databaseName>
  </companyData>
  <currency>sample string 16</currency>
  <customers>
    <CustomerRecurringInvoice>
      <activeFromDate>2025-11-08T13:32:15.8856119+01:00</activeFromDate>
      <activeToDate>2025-11-08T13:32:15.8856119+01:00</activeToDate>
      <code>sample string 1</code>
      <customerOrGroup>1</customerOrGroup>
      <customerOrGroupId>1</customerOrGroupId>
      <customerType>64</customerType>
      <id>2</id>
      <invoiceDescription>sample string 10</invoiceDescription>
      <isActiveFrom>64</isActiveFrom>
      <isActiveTo>64</isActiveTo>
      <lpCustomerType>4</lpCustomerType>
      <name>sample string 5</name>
      <recipientCode>sample string 6</recipientCode>
      <recipientId>1</recipientId>
      <recipientName>sample string 7</recipientName>
      <recipientType>1</recipientType>
    </CustomerRecurringInvoice>
    <CustomerRecurringInvoice>
      <activeFromDate>2025-11-08T13:32:15.8856119+01:00</activeFromDate>
      <activeToDate>2025-11-08T13:32:15.8856119+01:00</activeToDate>
      <code>sample string 1</code>
      <customerOrGroup>1</customerOrGroup>
      <customerOrGroupId>1</customerOrGroupId>
      <customerType>64</customerType>
      <id>2</id>
      <invoiceDescription>sample string 10</invoiceDescription>
      <isActiveFrom>64</isActiveFrom>
      <isActiveTo>64</isActiveTo>
      <lpCustomerType>4</lpCustomerType>
      <name>sample string 5</name>
      <recipientCode>sample string 6</recipientCode>
      <recipientId>1</recipientId>
      <recipientName>sample string 7</recipientName>
      <recipientType>1</recipientType>
    </CustomerRecurringInvoice>
  </customers>
  <cyclePeriod>3</cyclePeriod>
  <dayOfTheMonth>5</dayOfTheMonth>
  <dayOfTheWeek>4</dayOfTheWeek>
  <documentDate>2025-11-08T13:32:15.8856119+01:00</documentDate>
  <documentDateDayOfMonth>20</documentDateDayOfMonth>
  <documentDateType>64</documentDateType>
  <documentType>7</documentType>
  <emailTemplateId>34</emailTemplateId>
  <fixedPaymentFormId>1</fixedPaymentFormId>
  <inactive>9</inactive>
  <invoiceDescription>sample string 31</invoiceDescription>
  <magCode>sample string 11</magCode>
  <magId>10</magId>
  <name>sample string 2</name>
  <nb>12</nb>
  <nextGenerationDate>2025-11-08T13:32:15.8856119+01:00</nextGenerationDate>
  <paymentMethod>sample string 25</paymentMethod>
  <paymentTermDay>27</paymentTermDay>
  <paymentTermType>64</paymentTermType>
  <paymentType>64</paymentType>
  <printTemplateId>36</printTemplateId>
  <products>
    <ProductRecurringInvoice>
      <code>sample string 4</code>
      <currency>sample string 15</currency>
      <grossPrice>1</grossPrice>
      <grossPricePLN>17</grossPricePLN>
      <name>sample string 5</name>
      <netPrice>14</netPrice>
      <netPricePLN>16</netPricePLN>
      <orderNumber>2</orderNumber>
      <priceCategory>64</priceCategory>
      <priceGroup>18</priceGroup>
      <priceGroupName>sample string 19</priceGroupName>
      <pricePrecision>64</pricePrecision>
      <priceType>64</priceType>
      <productId>3</productId>
      <quantity>7.1</quantity>
      <quantityPrinted>1</quantityPrinted>
      <quantityType>64</quantityType>
      <unit>sample string 8</unit>
      <unitConversionDenominator>11</unitConversionDenominator>
      <unitConversionNumerator>10</unitConversionNumerator>
      <unitShort>sample string 9</unitShort>
      <warehouseId>1</warehouseId>
    </ProductRecurringInvoice>
    <ProductRecurringInvoice>
      <code>sample string 4</code>
      <currency>sample string 15</currency>
      <grossPrice>1</grossPrice>
      <grossPricePLN>17</grossPricePLN>
      <name>sample string 5</name>
      <netPrice>14</netPrice>
      <netPricePLN>16</netPricePLN>
      <orderNumber>2</orderNumber>
      <priceCategory>64</priceCategory>
      <priceGroup>18</priceGroup>
      <priceGroupName>sample string 19</priceGroupName>
      <pricePrecision>64</pricePrecision>
      <priceType>64</priceType>
      <productId>3</productId>
      <quantity>7.1</quantity>
      <quantityPrinted>1</quantityPrinted>
      <quantityType>64</quantityType>
      <unit>sample string 8</unit>
      <unitConversionDenominator>11</unitConversionDenominator>
      <unitConversionNumerator>10</unitConversionNumerator>
      <unitShort>sample string 9</unitShort>
      <warehouseId>1</warehouseId>
    </ProductRecurringInvoice>
  </products>
  <reminder>13</reminder>
  <reminderTime>2025-11-08T13:32:15.8856119+01:00</reminderTime>
  <repeat>6</repeat>
  <saleDate>2025-11-08T13:32:15.8856119+01:00</saleDate>
  <saleDateDayOfMonth>23</saleDateDayOfMonth>
  <saleDateType>64</saleDateType>
  <sendEmailToCustomer>14</sendEmailToCustomer>
  <standardPrint>64</standardPrint>
  <transferAttributes>64</transferAttributes>
  <vatCalculationMethod>64</vatCalculationMethod>
</RecurringInvoice>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'RecurringInvoice'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.