Get paused recurring profiles

Extensibility
1

Hi,
I am trying to return all paused recurring profiles but it seems to not be an option.

Is it possible to open this option on the API?

2

Hi @APereira

Iā€™ll refer this to our development team to take a look. Someone will come back to you shortly, although this may be Tuesday because of the bank holiday.

3

@QFMathew
Thank for your reply.

Iā€™ve also noticed that when creating a recurring profile when using the API it doesnā€™t look like it is possible to define a number of times that this profile will happen as in the web interface.

Is it also possible to add this to the API?

Thanks again for your help and time.

4

This does already exist, although I notice it appears to be missing from the documentation. Iā€™ve referred this to a developer to investigate, but for your reference, Iā€™ve included the recurring invoice data below (See ā€˜Frequencyā€™)

<xs:complexType name="RecurringInvoiceDataType">
	<xs:annotation>
		<xs:documentation>Element for specific recurring invoice data.</xs:documentation>
	</xs:annotation>
	<xs:sequence>
		<xs:element name="Interval" type="xs:string">
			<xs:annotation>
				<xs:documentation>
					The preset interval between issuing invoices. 1WEEK equals weekly, 2WEEK equals fortnightly, 1MONTH equals monthly, etc...
				</xs:documentation>
			</xs:annotation>
		</xs:element>
		<xs:element name="Frequency" type="xs:integer">
			<xs:annotation>
				<xs:documentation>
					How many intervals should the profile run for?
				</xs:documentation>
			</xs:annotation>
		</xs:element>
		<xs:element name="StartDate" type="xs:date">
			<xs:annotation>
				<xs:documentation>
					When will the first invoice be issued?
				</xs:documentation>
			</xs:annotation>
		</xs:element>
		<xs:element name="ProRataDays" type="xs:integer" minOccurs="0">
			<xs:annotation>
				<xs:documentation>
					Use to pro-rata the first payment for x number of days.
				</xs:documentation>
			</xs:annotation>
		</xs:element>
		<xs:element name="GoCardlessAutoBill" type="xs:boolean" minOccurs="0">
			<xs:annotation>
				<xs:documentation>
					Set as true to use the pre-authorised Direct Debit details to automatically collect payment.
				</xs:documentation>
			</xs:annotation>
		</xs:element>
		<xs:element name="SendByEmail" type="xs:boolean" minOccurs="0">
			<xs:annotation>
				<xs:documentation>
					Send invoices by email when they are created from this recurring template.
				</xs:documentation>
			</xs:annotation>
		</xs:element>
		<xs:element name="SendByPost" type="xs:boolean" minOccurs="0">
			<xs:annotation>
				<xs:documentation>
					Send invoices by post when they are created from this recurring template.
				</xs:documentation>
			</xs:annotation>
		</xs:element>
		<xs:element name="ActivateOnCreation" type="xs:boolean" minOccurs="0">
			<xs:annotation>
				<xs:documentation>
					Activates the recurring profile on creation. By default this is set to false and the profile will remain in DRAFT status until it is activated in Quick File
				</xs:documentation>
			</xs:annotation>
		</xs:element>
	</xs:sequence>
</xs:complexType>

This should come between the project tags and the invoice lines.

5

Oh Great.

As I noticed that I couldnā€™t retrieve the paused recurring profiles Iā€™ve checked the documentation to create them.

Thanks for your quick reply.

Will wait for you on retrieving the paused status for recurring profiles.

6

We now have this on our short term planner so it should be ready to use later this week, or early next week.

7

Thank you very much for your reply and time to help us.

Is it possible to update us here once it is available?

Regards

8

Of course. You should also receive an email from the forums when we reply :slight_smile:

1 Like
9

This is now in the API documentation with the status ā€œPAUSEDā€, but it seems to not work.

I am getting an error

20The 'http://www.QuickFile.co.uk:Status' element has an invalid value according to its data type.
10

Hi @APereira

The documentation has been updated, but the function itself hasnā€™t yet gone live. Weā€™ll be sure to update you once this is the case.

11

Hi @APereira

Weā€™ve released an update today which includes this. You can now retrieve a list of paused recurring invoices by setting invoice type to RECURRING and then status to PAUSED.

Hope that helps!

12

Hi @QFMathew

Thank you very much for your update.

I can confirm it is working :slight_smile:

Regards

1 Like
13

@QFMathew

Just noticed.

Is there any way of getting the last time a recurring profile has been processed?

Regards

14

There isnā€™t unfortunately. Itā€™s certainly something we can consider though.