Get the template fields of the recurring invoice crm.invoice.recurring.fields

Scope: crm

Who can execute the method: any user

Warning

The method is deprecated. It is recommended to use Universal methods for invoices

The method returns a list of fields for the recurring invoice template along with their descriptions.

No parameters.

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.invoice.recurring.fields
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.invoice.recurring.fields
        
try
        {
        	const response = await $b24.callMethod(
        		'crm.invoice.recurring.fields',
        		{}
        	);
        	
        	const result = response.getData().result;
        	if(result.error())
        	{
        		console.error(result.error());
        	}
        	else
        	{
        		console.dir(result);
        	}
        }
        catch(error)
        {
        	console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.invoice.recurring.fields',
                    []
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching recurring invoice fields: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "crm.invoice.recurring.fields",
            {},
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.invoice.recurring.fields',
            []
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Returned Data

Required parameters are marked with *

Field / Type

Description

Note

ID
integer

Identifier of the record in the recurring invoice settings table

Read-only

INVOICE_ID
integer

ID of the invoice template

Immutable

ACTIVE
char

Active flag. Values: Y/N

NEXT_EXECUTION
date

Date of the next creation of a new invoice from the template. Calculated by the system based on the specified parameters. If the value is empty, new invoices are not created

Read-only.

LAST_EXECUTION
date

Date of the last creation of a new invoice from the template

Read-only

COUNTER_REPEAT
integer

Number of invoices created from the template

Read-only

START_DATE
date

Start date for calculating the date of the next creation of a new invoice

SEND_BILL
char

Send the invoice to the email associated with the payer. Values: Y/N

EMAIL_ID
integer

ID of the field containing the payer's email

IS_LIMIT
char

Are there limitations on creating new invoices

LIMIT_REPEAT
integer

Maximum number of invoices that can be created from this template

Considered if IS_LIMIT is T

LIMIT_DATE
date

Date until which invoices can be created from this template

Considered if IS_LIMIT is D

PARAMS
unknown

Set of parameters for calculation - recurring_params:

  • PERIOD - repetition period:
    • day - day
    • week - week
    • month - month
    • year - year
  • TYPE - type of repetition for month and year:
    • if PERIOD is month
      • 1 - calculation by the ordinal day number in the month
      • 2 - calculation by the weekday numbers in the month
    • if PERIOD is year
      • 1 - calculation by the ordinal day number in the specified month
      • 2 - calculation by the weekday numbers in the specified month
  • INTERVAL - offset in calculation
  • IS_WORKING_ONLY - only working days are considered (Y/N)
  • WEEKDAY - full name of the weekday (according to the formatting of the PHP method date())
  • NUM_DAY_IN_MONTH - ordinal date number in the month (PERIOD is month or year)
  • NUM_WEEKDAY_IN_MONTH - ordinal weekday number in the month (PERIOD is month or year)
  • FIELD_YEARLY_INTERVAL_MONTH_NAME - ordinal weekday number in the month (PERIOD is month or year)
  • DATE_PAY_BEFORE_OFFSET_TYPE - offset value for calculating the payment term, calculation is made from the moment of creating a new invoice from the template:
    • day - day
    • week - week
    • month - month
    • year - year
  • DATE_PAY_BEFORE_OFFSET_VALUE - offset value for calculating the payment term, calculation is made from the moment of creating a new invoice from the template

Previous
Create New Invoice from Template
Next
Get Recurring Invoice Settings by ID