API

Sales APIs

GET sales/recurring-invoice-plans

List of recurring invoice plans

HTTP method GET
URI https://api.rambase.net/sales/recurring-invoice-plans
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 4343, version 28

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

Active() Named filter Active recurring invoice plans
AdvanceInvoiced() Named filter Recurring invoice plans that are invoiced in advance
AutoIssued() Named filter Automatically invoiced recurring invoice plans
InvoiceReady() Named filter Recurring invoice plans with items that are ready to be invoiced
ManuallyIssued() Named filter Manually invoiced recurring invoice plans
BaseDate Date A date from which invoices will start to be generated from. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
BaseDateAdvanceDays Integer Number of days to advance invoicing from base date.
CreatedAt Datetime Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Currency String Three character code following the ISO 4217 standard.
CustomerId Integer Customer identifier.
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person).
CustomersReference String Customers reference. Typically a person.
CustomersReferenceNumber String Customers reference number. E.g. the internal sales order id the customer use in their own system.
InvoiceFrequency Integer Sets frequency at which invoice can be issued.
IsAutomaticallyIssued Boolean "True" if invoices in this recurring invoice plan should be release automatically.
IsInvoicedInAdvance Boolean True if plan is invoiced in advance.
RecurringInvoicePlanId Integer Recurring invoice plan identifier.
Responsible Integer PID reference to the owner of the recurring invoice plan. Available macros: currentUser()
Status Integer Recurring invoice plan status. 4 = active, 9 = closed.
Title String A short description of the recurring invoice plan.

Read more about filters and sorting on how to use sortable parameters

BaseDate Date A date from which invoices will start to be generated from
BaseDateAdvanceDays Integer Number of days to advance invoicing from base date
CreatedAt Datetime Date and time of creation
Currency String Three character code following the ISO 4217 standard
CustomerId Integer Customer identifier
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person)
CustomersReference String Customers reference. Typically a person.
CustomersReferenceNumber String Customers reference number. E.g. the internal sales order id the customer use in their own system.
InvoiceFrequency Integer Sets frequency at which invoice can be issued.
IsAutomaticallyIssued Boolean "True" if invoices in this recurring invoice plan should be release automatically
IsInvoicedInAdvance Boolean True if plan is invoiced in advance
RecurringInvoicePlanId Integer Recurring invoice plan identifier
Responsible Integer PID reference to the owner of the recurring invoice plan
Status Integer Recurring invoice plan status. 4 = active, 9 = closed
Title String A short description of the recurring invoice plan

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<RecurringInvoicePlans>
2
     <RecurringInvoicePlan>
3
          <RecurringInvoicePlanId
RecurringInvoicePlanId

Recurring invoice plan identifier

>{Integer}</RecurringInvoicePlanId>
4
          <Status
Status

Recurring invoice plan status. 4 = active, 9 = closed

Possible domain values can be found here

>{Integer}</Status>
5
          <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
6
          <Title
Title

A short description of the recurring invoice plan

>{String}</Title>
7
          <Description
Description

A more detailed description of the recurring invoice plan

>{String}</Description>
8
          <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

>{String}</Currency>
9
          <IsAutomaticallyIssued
IsAutomaticallyIssued

"True" if invoices in this recurring invoice plan should be release automatically

>{Boolean}</IsAutomaticallyIssued>
10
          <BaseDate
BaseDate

A date from which invoices will start to be generated from

>{Date}</BaseDate>
11
          <InvoiceFrequency
InvoiceFrequency

Sets frequency at which invoice can be issued.

Possible domain values can be found here

>{Integer}</InvoiceFrequency>
12
          <CustomersReference
CustomersReference

Customers reference. Typically a person.

>{String}</CustomersReference>
13
          <CustomersReferenceNumber
CustomersReferenceNumber

Customers reference number. E.g. the internal sales order id the customer use in their own system.

>{String}</CustomersReferenceNumber>
14
          <AdvanceInvoicing>
15
               <IsInvoicedInAdvance
IsInvoicedInAdvance

True if plan is invoiced in advance

>{Boolean}</IsInvoicedInAdvance>
16
               <BaseDateAdvanceDays
BaseDateAdvanceDays

Number of days to advance invoicing from base date

>{Integer}</BaseDateAdvanceDays>
17
          </AdvanceInvoicing>
18
          <Responsible
Responsible

PID reference to the owner of the recurring invoice plan

>
19
               <UserId
UserId

User identifier

>{Integer}</UserId>
20
               <UserLink
UserLink

User reference

>{String}</UserLink>
21
          </Responsible>
22
          <Customer>
23
               <CustomerId
CustomerId

Customer identifier

>{Integer}</CustomerId>
24
               <Name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

>{String}</Name>
25
               <FirstName
FirstName

Secondary name of a company or firstname of a person

>{String}</FirstName>
26
               <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
27
          </Customer>
28
          <Payment>
29
               <PaymentTerms
PaymentTerms

Specifies how much time the buyer has to make payment

Possible domain values can be found here

>{String}</PaymentTerms>
30
          </Payment>
31
          <VATDetails>
32
               <VATHandling
VATHandling

Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.

Possible domain values can be found here

>{String}</VATHandling>
33
          </VATDetails>
34
          <Location>
35
               <LocationId
LocationId

Location identifier

>{Integer}</LocationId>
36
               <LocationLink
LocationLink

Location reference

>{String}</LocationLink>
37
          </Location>
38
          <RecurringInvoicePlanLink
RecurringInvoicePlanLink

Recurring invoice plan reference

>{String}</RecurringInvoicePlanLink>
39
     </RecurringInvoicePlan>
40
     <Paging
Paging

Detailed paging information for this list.

>
41
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
42
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
43
          <Page
Page

Page index

>{Integer}</Page>
44
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>
45
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
46
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>
47
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
48
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>
49
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
50
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>
51
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
52
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
53
     </Paging>
54
</RecurringInvoicePlans>
1
{
2
     "recurringInvoicePlans": [
3
          {
4
               "recurringInvoicePlanId
RecurringInvoicePlanId

Recurring invoice plan identifier

": "{Integer}",
5
               "status
Status

Recurring invoice plan status. 4 = active, 9 = closed

Possible domain values can be found here

": "{Integer}",
6
               "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
7
               "title
Title

A short description of the recurring invoice plan

": "{String}",
8
               "description
Description

A more detailed description of the recurring invoice plan

": "{String}",
9
               "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

": "{String}",
10
               "isAutomaticallyIssued
IsAutomaticallyIssued

"True" if invoices in this recurring invoice plan should be release automatically

": "{Boolean}",
11
               "baseDate
BaseDate

A date from which invoices will start to be generated from

": "{Date}",
12
               "invoiceFrequency
InvoiceFrequency

Sets frequency at which invoice can be issued.

Possible domain values can be found here

": "{Integer}",
13
               "customersReference
CustomersReference

Customers reference. Typically a person.

": "{String}",
14
               "customersReferenceNumber
CustomersReferenceNumber

Customers reference number. E.g. the internal sales order id the customer use in their own system.

": "{String}",
15
               "advanceInvoicing": {
16
                    "isInvoicedInAdvance
IsInvoicedInAdvance

True if plan is invoiced in advance

": "{Boolean}",
17
                    "baseDateAdvanceDays
BaseDateAdvanceDays

Number of days to advance invoicing from base date

": "{Integer}"
18
               },
19
               "responsible
Responsible

PID reference to the owner of the recurring invoice plan

": {
20
                    "userId
UserId

User identifier

": "{Integer}",
21
                    "userLink
UserLink

User reference

": "{String}"
22
               },
23
               "customer": {
24
                    "customerId
CustomerId

Customer identifier

": "{Integer}",
25
                    "name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

": "{String}",
26
                    "firstName
FirstName

Secondary name of a company or firstname of a person

": "{String}",
27
                    "customerLink
CustomerLink

Customer reference

": "{String}"
28
               },
29
               "payment": {
30
                    "paymentTerms
PaymentTerms

Specifies how much time the buyer has to make payment

Possible domain values can be found here

": "{String}"
31
               },
32
               "vATDetails": {
33
                    "vATHandling
VATHandling

Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.

Possible domain values can be found here

": "{String}"
34
               },
35
               "location": {
36
                    "locationId
LocationId

Location identifier

": "{Integer}",
37
                    "locationLink
LocationLink

Location reference

": "{String}"
38
               },
39
               "recurringInvoicePlanLink
RecurringInvoicePlanLink

Recurring invoice plan reference

": "{String}"
40
          }
41
     ],
42
     "paging
Paging

Detailed paging information for this list.

": {
43
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
44
          "position
Position

Position of the first element in the list

": "{Integer}",
45
          "page
Page

Page index

": "{Integer}",
46
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
47
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
48
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
49
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
50
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
51
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
52
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
53
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
54
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
55
     }
56
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return: