Sales APIs
Resource for creating new recurring invoice plan
| HTTP method | POST |
| URI | https://api.rambase.net/sales/recurring-invoice-plans |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 201 |
| API resource identifier | 4390, version 19 |
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.
Title
A short description of the recurring invoice plan
This field is optional.
>{String}</Title>Description
A more detailed description of the recurring invoice plan
This field is optional.
>{String}</Description>Currency
Three character code following the ISO 4217 standard
Applicable domain values can be found here
Input must match the following regular expression pattern: ^[A-Z]{3}$
This field is optional.
>{String}</Currency>IsAutomaticallyIssued
"True" if invoices in this recurring invoice plan should be release automatically
Default value: False
This field is optional.
>{Boolean}</IsAutomaticallyIssued>BaseDate
A date from which invoices will start to be generated from
This field is optional.
>{Date}</BaseDate>InvoiceFrequency
Sets frequency at which invoice can be issued.
Applicable domain values can be found here
Minimum value: 0
Default value: 3
This field is optional.
>{Integer}</InvoiceFrequency>CreateAccountAdjustmentPlan
The control bit of a mechanism of automatic creation of periods adustments
Default value: False
This field is optional.
>{Boolean}</CreateAccountAdjustmentPlan>AdvanceInvoicing
This field is optional.
>IsInvoicedInAdvance
True if plan is invoiced in advance
Default value: False
This field is optional.
>{Boolean}</IsInvoicedInAdvance>BaseDateAdvanceDays
Number of days to advance invoicing from base date
Minimum value: 0
Maximum value: 30
This field is optional.
>{Integer}</BaseDateAdvanceDays>CustomerId
Required/mandatory field
Customer identifier
Minimum value: 10000
>{Integer}</CustomerId>ShippingAddress
This field is optional.
>AddressId
Reference to customer's shipping address
Minimum value: 1
This field is optional.
>{Integer}</AddressId>Payment
This field is optional.
>PaymentTerms
Specifies how much time the buyer has to make payment
Applicable domain values can be found here
This field is optional.
>{String}</PaymentTerms>VATDetails
This field is optional.
>VATHandling
Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.
Applicable domain values can be found here
This field is optional.
>{String}</VATHandling>Location
This field is optional.
>LocationId
Location identifier
Minimum value: 10000
This field is optional.
>{Integer}</LocationId>Title
A short description of the recurring invoice plan
This field is optional.
": "{String}",Description
A more detailed description of the recurring invoice plan
This field is optional.
": "{String}",Currency
Three character code following the ISO 4217 standard
Applicable domain values can be found here
Input must match the following regular expression pattern: ^[A-Z]{3}$
This field is optional.
": "{String}",IsAutomaticallyIssued
"True" if invoices in this recurring invoice plan should be release automatically
Default value: False
This field is optional.
": "{Boolean}",BaseDate
A date from which invoices will start to be generated from
This field is optional.
": "{Date}",InvoiceFrequency
Sets frequency at which invoice can be issued.
Applicable domain values can be found here
Minimum value: 0
Default value: 3
This field is optional.
": "{Integer}",CreateAccountAdjustmentPlan
The control bit of a mechanism of automatic creation of periods adustments
Default value: False
This field is optional.
": "{Boolean}",AdvanceInvoicing
This field is optional.
": {IsInvoicedInAdvance
True if plan is invoiced in advance
Default value: False
This field is optional.
": "{Boolean}",BaseDateAdvanceDays
Number of days to advance invoicing from base date
Minimum value: 0
Maximum value: 30
This field is optional.
": "{Integer}"CustomerId
Required/mandatory field
Customer identifier
Minimum value: 10000
": "{Integer}"ShippingAddress
This field is optional.
": {AddressId
Reference to customer's shipping address
Minimum value: 1
This field is optional.
": "{Integer}"Payment
This field is optional.
": {PaymentTerms
Specifies how much time the buyer has to make payment
Applicable domain values can be found here
This field is optional.
": "{String}"VATDetails
This field is optional.
": {VATHandling
Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.
Applicable domain values can be found here
This field is optional.
": "{String}"Location
This field is optional.
": {LocationId
Location identifier
Minimum value: 10000
This field is optional.
": "{Integer}"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.
| $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 |
| $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. |
| $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] |
| $showCustomFields Boolean, optional | Set to "true" to include custom fields. Default value is false. |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
RecurringInvoicePlanId
Recurring invoice plan identifier
>{Integer}</RecurringInvoicePlanId>Status
Recurring invoice plan status. 4 = active, 9 = closed
Possible domain values can be found here
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Title
A short description of the recurring invoice plan
>{String}</Title>Description
A more detailed description of the recurring invoice plan
>{String}</Description>Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
>{String}</Currency>IsAutomaticallyIssued
"True" if invoices in this recurring invoice plan should be release automatically
>{Boolean}</IsAutomaticallyIssued>CreateAccountAdjustmentPlan
The control bit of a mechanism of automatic creation of periods adustments
>{Boolean}</CreateAccountAdjustmentPlan>BaseDate
A date from which invoices will start to be generated from
>{Date}</BaseDate>InvoiceFrequency
Sets frequency at which invoice can be issued.
Possible domain values can be found here
>{Integer}</InvoiceFrequency>CustomersReference
Customers reference. Typically a person.
>{String}</CustomersReference>CustomersReferenceNumber
Customers reference number. E.g. the internal sales order id the customer use in their own system.
>{String}</CustomersReferenceNumber>IsInvoicedInAdvance
True if plan is invoiced in advance
>{Boolean}</IsInvoicedInAdvance>BaseDateAdvanceDays
Number of days to advance invoicing from base date
>{Integer}</BaseDateAdvanceDays>Responsible
PID reference to the owner of the recurring invoice plan
>UserId
User identifier
>{Integer}</UserId>Name
Name of the user
>{String}</Name>FirstName
First name of the user
>{String}</FirstName>UserLink
User reference
>{String}</UserLink>CustomerId
Customer identifier
>{Integer}</CustomerId>Name
Name of customer (name of company or surname/familyname/lastname of a person)
>{String}</Name>FirstName
Secondary name of a company or firstname of a person
>{String}</FirstName>IsCompany
Indicator if a customer is private entity or a company
>{Boolean}</IsCompany>CustomerLink
Customer reference
>{String}</CustomerLink>AddressId
Reference to customer's invoice address
>{Integer}</AddressId>Name
Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.
>{String}</Name>FirstName
Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.
>{String}</FirstName>AddressLine1
First address line
>{String}</AddressLine1>AddressLine2
Second address line
>{String}</AddressLine2>PostalCode
Postalcode/Postcode/ZIP
>{String}</PostalCode>City
City/town/village
>{String}</City>Region
Region/province/state
>{String}</Region>CountryCode
Two-character code (ISO 3166) identifying the country.
>{String}</CountryCode>Country
English name of country.
>{String}</Country>AddressLink
Address reference
>{String}</AddressLink>AddressId
Reference to customer's shipping address
>{Integer}</AddressId>Name
Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.
>{String}</Name>FirstName
Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.
>{String}</FirstName>AddressLine1
First address line
>{String}</AddressLine1>AddressLine2
Second address line
>{String}</AddressLine2>PostalCode
Postalcode/Postcode/ZIP
>{String}</PostalCode>City
City/town/village
>{String}</City>Region
Region/province/state
>{String}</Region>CountryCode
Two-character code (ISO 3166) identifying the country.
>{String}</CountryCode>Country
English name of country.
>{String}</Country>ExternalReference
External address identifier. Normally defined by the customer.
>{String}</ExternalReference>AddressLink
Address reference
>{String}</AddressLink>PaymentTerms
Specifies how much time the buyer has to make payment
Possible domain values can be found here
>{String}</PaymentTerms>Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
>{String}</Currency>EstimatedAmount
Accumulated value of all amounts from recurring invoice periods
>{Decimal}</EstimatedAmount>AccruedAmount
Value of accrued amount from recurring invoice period
>{Decimal}</AccruedAmount>InvoicedAmount
Accumulated value of invoiced amounts from recurring invoice periods
>{Decimal}</InvoicedAmount>ForecastAmount
Accumulated value of forecasted amounts
>{Decimal}</ForecastAmount>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>LocationId
Location identifier
>{Integer}</LocationId>LocationLink
Location reference
>{String}</LocationLink>RecurringInvoicePlanLink
Recurring invoice plan reference
>{String}</RecurringInvoicePlanLink>RecurringInvoicePlanId
Recurring invoice plan identifier
": "{Integer}",Status
Recurring invoice plan status. 4 = active, 9 = closed
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Title
A short description of the recurring invoice plan
": "{String}",Description
A more detailed description of the recurring invoice plan
": "{String}",Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
": "{String}",IsAutomaticallyIssued
"True" if invoices in this recurring invoice plan should be release automatically
": "{Boolean}",CreateAccountAdjustmentPlan
The control bit of a mechanism of automatic creation of periods adustments
": "{Boolean}",BaseDate
A date from which invoices will start to be generated from
": "{Date}",InvoiceFrequency
Sets frequency at which invoice can be issued.
Possible domain values can be found here
": "{Integer}",CustomersReference
Customers reference. Typically a person.
": "{String}",CustomersReferenceNumber
Customers reference number. E.g. the internal sales order id the customer use in their own system.
": "{String}",IsInvoicedInAdvance
True if plan is invoiced in advance
": "{Boolean}",BaseDateAdvanceDays
Number of days to advance invoicing from base date
": "{Integer}"Responsible
PID reference to the owner of the recurring invoice plan
": {UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"CustomerId
Customer identifier
": "{Integer}",Name
Name of customer (name of company or surname/familyname/lastname of a person)
": "{String}",FirstName
Secondary name of a company or firstname of a person
": "{String}",IsCompany
Indicator if a customer is private entity or a company
": "{Boolean}",CustomerLink
Customer reference
": "{String}"AddressId
Reference to customer's invoice address
": "{Integer}",Name
Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.
": "{String}",FirstName
Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.
": "{String}",AddressLine1
First address line
": "{String}",AddressLine2
Second address line
": "{String}",PostalCode
Postalcode/Postcode/ZIP
": "{String}",City
City/town/village
": "{String}",Region
Region/province/state
": "{String}",CountryCode
Two-character code (ISO 3166) identifying the country.
": "{String}",Country
English name of country.
": "{String}",AddressLink
Address reference
": "{String}"AddressId
Reference to customer's shipping address
": "{Integer}",Name
Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.
": "{String}",FirstName
Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.
": "{String}",AddressLine1
First address line
": "{String}",AddressLine2
Second address line
": "{String}",PostalCode
Postalcode/Postcode/ZIP
": "{String}",City
City/town/village
": "{String}",Region
Region/province/state
": "{String}",CountryCode
Two-character code (ISO 3166) identifying the country.
": "{String}",Country
English name of country.
": "{String}",ExternalReference
External address identifier. Normally defined by the customer.
": "{String}",AddressLink
Address reference
": "{String}"PaymentTerms
Specifies how much time the buyer has to make payment
Possible domain values can be found here
": "{String}",Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
": "{String}",EstimatedAmount
Accumulated value of all amounts from recurring invoice periods
": "{Decimal}",AccruedAmount
Value of accrued amount from recurring invoice period
": "{Decimal}",InvoicedAmount
Accumulated value of invoiced amounts from recurring invoice periods
": "{Decimal}",ForecastAmount
Accumulated value of forecasted amounts
": "{Decimal}"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}"LocationId
Location identifier
": "{Integer}",LocationLink
Location reference
": "{String}"RecurringInvoicePlanLink
Recurring invoice plan reference
": "{String}"
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:
| Error 100104 HTTP 404 | Address not found |
| Error 100001 HTTP 404 | Address not found |
| Error 106086 HTTP 400 | Base date of recurring invoice plan is required |
| Error 102048 HTTP 400 | Customer is not activated |