Jasmin Developers - Web API Reference

Sales | Recurring Invoice Template

Service to manage entities of type 'RecurringInvoiceTemplate'.

Overview


URL api/{tenantKey}/{orgKey}/billing/recurringInvoiceTemplates
Methods Supported GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

All Enumerations

This service uses the following enumerations:

GET Operations

GET RecurringInvoiceTemplates (odata)

Returns a page of the list of all the entity records available.

The following elements are optional:

opts (ODataQueryOptions) OData query option.

Response:

When successful, the response body contains the list of records available. See RecurringInvoiceTemplateResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /billing/recurringInvoiceTemplates/odata

GET RecurringInvoiceTemplate by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id (string) The record identifier.

Response:

When successful, the response body contains the entity record. See RecurringInvoiceTemplateResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /billing/recurringInvoiceTemplates/{id}

GET RecurringInvoiceTemplate by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
recurringInvoiceKey (string) The recurring invoice key.

Response:

When successful, the response body contains the entity record. See RecurringInvoiceTemplateResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /billing/recurringInvoiceTemplates/{companyKey}/{recurringInvoiceKey}

POST Operations

POST RecurringInvoiceTemplates

Creates a new entity record.

The following elements are required:

recurringInvoiceTemplateResource (ApiRecurringInvoiceTemplateResource) The request body should contain the entity record that should be created.
See ApiRecurringInvoiceTemplateResource.

The following elements are optional:

customAttributes (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiRecurringInvoiceTemplateResource.

Response status codes:

201 Created. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

POST /billing/recurringInvoiceTemplates

POST Recurring Invoice Template Line

Inserts a new 'Recurring Invoice Template Line' in the 'Recurring Invoice Template'.

The following elements are required:

recurringInvoiceKey (string) The recurring invoice key.
companyKey (string) The company key.
value (ApiRecurringInvoiceTemplateInvoiceTemplateLinesResource) The ApiRecurringInvoiceTemplateInvoiceTemplateLinesResource instance.
See ApiRecurringInvoiceTemplateInvoiceTemplateLinesResource.

The following elements are optional:

customAttributes (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body is empty.

Response status codes:

204 NoContent. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

POST /billing/recurringInvoiceTemplates/{companyKey}/{recurringInvoiceKey}/invoiceTemplateLines

PUT Operations

PUT Set AccountingParty RecurringInvoiceTemplate

Updates the value of attribute 'AccountingParty' in the specified entity record.

The following elements are required:

recurringInvoiceKey (string) The recurring invoice key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/recurringInvoiceTemplates/{companyKey}/{recurringInvoiceKey}/accountingParty

PUT Set BuyerCustomerParty RecurringInvoiceTemplate

Updates the value of attribute 'BuyerCustomerParty' in the specified entity record.

The following elements are required:

recurringInvoiceKey (string) The recurring invoice key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/recurringInvoiceTemplates/{companyKey}/{recurringInvoiceKey}/buyerCustomerParty

PUT Set Company RecurringInvoiceTemplate

Updates the value of attribute 'Company' in the specified entity record.

The following elements are required:

recurringInvoiceKey (string) The recurring invoice key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/recurringInvoiceTemplates/{companyKey}/{recurringInvoiceKey}/company

PUT Set Currency RecurringInvoiceTemplate

Updates the value of attribute 'Currency' in the specified entity record.

The following elements are required:

recurringInvoiceKey (string) The recurring invoice key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/recurringInvoiceTemplates/{companyKey}/{recurringInvoiceKey}/currency

PUT Set Currency RecurringInvoiceTemplateLine

Updates the value of attribute 'Currency' in the specified entity record.

The following elements are required:

recurringInvoiceKey (string) The recurring invoice key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/recurringInvoiceTemplates/{companyKey}/{recurringInvoiceKey}/invoiceTemplateLines/{lineId}/currency

PUT Set Description RecurringInvoiceTemplate

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

recurringInvoiceKey (string) The recurring invoice key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/recurringInvoiceTemplates/{companyKey}/{recurringInvoiceKey}/description

PUT Set Description RecurringInvoiceTemplateLine

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

recurringInvoiceKey (string) The recurring invoice key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/recurringInvoiceTemplates/{companyKey}/{recurringInvoiceKey}/invoiceTemplateLines/{lineId}/description

PUT Set Discount RecurringInvoiceTemplateLine

Updates the value of attribute 'Discount' in the specified entity record.

The following elements are required:

recurringInvoiceKey (string) The recurring invoice key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/recurringInvoiceTemplates/{companyKey}/{recurringInvoiceKey}/invoiceTemplateLines/{lineId}/discount

PUT Set EndDate RecurringInvoiceTemplate

Updates the value of attribute 'EndDate' in the specified entity record.

The following elements are required:

recurringInvoiceKey (string) The recurring invoice key.
companyKey (string) The company key.
value (DateTime) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/recurringInvoiceTemplates/{companyKey}/{recurringInvoiceKey}/endDate

PUT Set Interval RecurringInvoiceTemplate

Updates the value of attribute 'Interval' in the specified entity record.

The following elements are required:

recurringInvoiceKey (string) The recurring invoice key.
companyKey (string) The company key.
value (int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/recurringInvoiceTemplates/{companyKey}/{recurringInvoiceKey}/interval

PUT Set IntervalType RecurringInvoiceTemplate

Updates the value of attribute 'IntervalType' in the specified entity record.

The following elements are required:

recurringInvoiceKey (string) The recurring invoice key.
companyKey (string) The company key.
value (enum IntervalTypeList) The request body should contain the new value for the attribute.
See IntervalTypeList.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/recurringInvoiceTemplates/{companyKey}/{recurringInvoiceKey}/intervalType

PUT Set InvoiceType RecurringInvoiceTemplate

Updates the value of attribute 'InvoiceType' in the specified entity record.

The following elements are required:

recurringInvoiceKey (string) The recurring invoice key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/recurringInvoiceTemplates/{companyKey}/{recurringInvoiceKey}/invoiceType

PUT Set IsActive RecurringInvoiceTemplate

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

recurringInvoiceKey (string) The recurring invoice key.
companyKey (string) The company key.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

PUT /billing/recurringInvoiceTemplates/{companyKey}/{recurringInvoiceKey}/isActive

PUT Set ItemTaxSchema RecurringInvoiceTemplateLine

Updates the value of attribute 'ItemTaxSchema' in the specified entity record.

The following elements are required:

recurringInvoiceKey (string) The recurring invoice key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/recurringInvoiceTemplates/{companyKey}/{recurringInvoiceKey}/invoiceTemplateLines/{lineId}/itemTaxSchema

PUT Set NoteToRecipient RecurringInvoiceTemplate

Updates the value of attribute 'NoteToRecipient' in the specified entity record.

The following elements are required:

recurringInvoiceKey (string) The recurring invoice key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/recurringInvoiceTemplates/{companyKey}/{recurringInvoiceKey}/noteToRecipient

PUT Set PartyTaxSchema RecurringInvoiceTemplateLine

Updates the value of attribute 'PartyTaxSchema' in the specified entity record.

The following elements are required:

recurringInvoiceKey (string) The recurring invoice key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/recurringInvoiceTemplates/{companyKey}/{recurringInvoiceKey}/invoiceTemplateLines/{lineId}/partyTaxSchema

PUT Set Quantity RecurringInvoiceTemplateLine

Updates the value of attribute 'Quantity' in the specified entity record.

The following elements are required:

recurringInvoiceKey (string) The recurring invoice key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/recurringInvoiceTemplates/{companyKey}/{recurringInvoiceKey}/invoiceTemplateLines/{lineId}/quantity

PUT Set RecurringInvoiceKey RecurringInvoiceTemplate

Updates the value of attribute 'RecurringInvoiceKey' in the specified entity record.

The following elements are required:

recurringInvoiceKey (string) The recurring invoice key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/recurringInvoiceTemplates/{companyKey}/{recurringInvoiceKey}/recurringInvoiceKey

PUT Set Remarks RecurringInvoiceTemplate

Updates the value of attribute 'Remarks' in the specified entity record.

The following elements are required:

recurringInvoiceKey (string) The recurring invoice key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/recurringInvoiceTemplates/{companyKey}/{recurringInvoiceKey}/remarks

PUT Set SalesItem RecurringInvoiceTemplateLine

Updates the value of attribute 'SalesItem' in the specified entity record.

The following elements are required:

recurringInvoiceKey (string) The recurring invoice key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/recurringInvoiceTemplates/{companyKey}/{recurringInvoiceKey}/invoiceTemplateLines/{lineId}/salesItem

PUT Set SalesPerson RecurringInvoiceTemplate

Updates the value of attribute 'SalesPerson' in the specified entity record.

The following elements are required:

recurringInvoiceKey (string) The recurring invoice key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/recurringInvoiceTemplates/{companyKey}/{recurringInvoiceKey}/salesPerson

PUT Set Serie RecurringInvoiceTemplate

Updates the value of attribute 'Serie' in the specified entity record.

The following elements are required:

recurringInvoiceKey (string) The recurring invoice key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/recurringInvoiceTemplates/{companyKey}/{recurringInvoiceKey}/serie

PUT Set StartDate RecurringInvoiceTemplate

Updates the value of attribute 'StartDate' in the specified entity record.

The following elements are required:

recurringInvoiceKey (string) The recurring invoice key.
companyKey (string) The company key.
value (DateTime) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/recurringInvoiceTemplates/{companyKey}/{recurringInvoiceKey}/startDate

PUT Set Total RecurringInvoiceTemplate

Updates the value of attribute 'Total' in the specified entity record.

The following elements are required:

recurringInvoiceKey (string) The recurring invoice key.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/recurringInvoiceTemplates/{companyKey}/{recurringInvoiceKey}/total

PUT Set Unit RecurringInvoiceTemplateLine

Updates the value of attribute 'Unit' in the specified entity record.

The following elements are required:

recurringInvoiceKey (string) The recurring invoice key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/recurringInvoiceTemplates/{companyKey}/{recurringInvoiceKey}/invoiceTemplateLines/{lineId}/unit

PUT Set UnitPrice RecurringInvoiceTemplateLine

Updates the value of attribute 'UnitPrice' in the specified entity record.

The following elements are required:

recurringInvoiceKey (string) The recurring invoice key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/recurringInvoiceTemplates/{companyKey}/{recurringInvoiceKey}/invoiceTemplateLines/{lineId}/unitPrice

PUT Set Warehouse RecurringInvoiceTemplateLine

Updates the value of attribute 'Warehouse' in the specified entity record.

The following elements are required:

recurringInvoiceKey (string) The recurring invoice key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/recurringInvoiceTemplates/{companyKey}/{recurringInvoiceKey}/invoiceTemplateLines/{lineId}/warehouse

PUT Set Custom Attribute RecurringInvoiceTemplate

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey (string) The company key.
recurringInvoiceKey (string) The recurring invoice key
customAttributeName (string) The custom attribute name.
value (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute.
See ExtensibilityCustomAttributeValueResource.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

PUT /billing/recurringInvoiceTemplates/{companyKey}/{recurringInvoiceKey}/{customAttributeName}

PUT Set Custom Attribute RecurringInvoiceTemplateLine

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey (string) The company key.
recurringInvoiceKey (string) The recurring invoice key
lineId (string) The detail identifier.
customAttributeName (string) The custom attribute name.
value (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute.
See ExtensibilityCustomAttributeValueResource.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

PUT /billing/recurringInvoiceTemplates/{companyKey}/{recurringInvoiceKey}/invoiceTemplateLines/{lineId}/{customAttributeName}

DELETE Operations

DELETE Recurring Invoice Template Line by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

recurringInvoiceKey (string) The recurring invoice key.
companyKey (string) The company key.
lineId (string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204 NoContent. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /billing/recurringInvoiceTemplates/{companyKey}/{recurringInvoiceKey}/invoiceTemplateLines/{lineId}

DELETE RecurringInvoiceTemplate by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id (string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204 Deleted. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /billing/recurringInvoiceTemplates/{id}

DELETE RecurringInvoiceTemplate by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
recurringInvoiceKey (string) The recurring invoice key.

Response:

When successful, the response body is empty.

Response status codes:

204 Deleted. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /billing/recurringInvoiceTemplates/{companyKey}/{recurringInvoiceKey}

Resources


ApiRecurringInvoiceTemplateInvoiceTemplateLinesResource

The following elements are required:

salesItem (string) The sales item representing the good or service.
unit (string) The template line item sales unit. The default sales unit is defined on the sales item.
unitPrice (MoneyResource) The template line item unit price. The default price is loaded from sales item prices when there is a match on the combination of price list, currency, tax included and unit.
See MoneyResource .
currency (string) Currency.
partyTaxSchema (string) The template customer party tax schema. The tax schema identifies the group of taxes a party is liable for. The tax schema is defined in the customer party.
itemTaxSchema (string) Item Tax Schema.

The following elements are optional:

quantity (decimal) The template line item quantity. The default 1.
description (string) The template line item description. The default is defined on the sales item.
warehouse (string) The template line item warehouse. The default is defined on the materials item.
discount (decimal) The line's item discount percentage. The default is 0.


ApiRecurringInvoiceTemplateResource

The following elements are required:

company (string) The recurring template company. The company code is the central organizational unit within the system.
recurringInvoiceKey (string) The recurring invoice key.
accountingParty (string) The customer designated in the document as the party to whom the invoice should be sent for payment.
currency (string) The currency of the recurring invoice template.
buyerCustomerParty (string) The customer party. Party that the invoice is for.
startDate (DateTime) The recurring invoice planning start date.
invoiceType (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted.
interval (int) The schedule interval ( Ex:. Every 'interval' 'interval type', every one month).
intervalType (enum IntervalTypeList) The interval type of schedule, reference IntervalTypeList table.
See IntervalTypeList.
total (MoneyResource) The recurring invoice total. The total without taxes.
See MoneyResource .

The following elements are optional:

invoiceTemplateLines (List of ApiRecurringInvoiceTemplateInvoiceTemplateLinesResource) The template lines.
See ApiRecurringInvoiceTemplateInvoiceTemplateLinesResource.
description (string) The template invoice description.
endDate (DateTime) The recurring invoice planning end date.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
salesPerson (string) The sales person. The seller of the invoice.
remarks (string) The invoice’s remarks.
noteToRecipient (string) The note to the invoice recipient.


MoneyResource

The following elements are required:

amount (decimal) The amount.

The following elements are optional:

baseAmount (decimal) The base amount.
reportingAmount (decimal) The reporting amount.
fractionDigits (int) The fraction digits.
symbol (string) The symbol.

Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.



RecurringInvoiceTemplateResource

The following elements are required:

company (string) The recurring template company. The company code is the central organizational unit within the system.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
recurringInvoiceKey (string) The recurring invoice key.
accountingParty (string) The customer designated in the document as the party to whom the invoice should be sent for payment.
(fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service.
currency (string) The currency of the recurring invoice template.
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.
buyerCustomerParty (string) The customer party. Party that the invoice is for.
(fk) Allowed value: the natural key of a record of type CustomerParty. These records are accessibly through the CustomerParties service.
startDate (DateTime) The recurring invoice planning start date.
invoiceType (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted.
(fk) Allowed value: the natural key of a record of type InvoiceType. These records are accessibly through the InvoiceTypes service.
interval (int) The schedule interval ( Ex:. Every 'interval' 'interval type', every one month).
intervalType (enum IntervalTypeList) The interval type of schedule, reference IntervalTypeList table.
See IntervalTypeList.
total (MoneyResource) The recurring invoice total. The total without taxes.
See MoneyResource .
ignoreAssociatedSalesItems (bool) Ignore Associated Sales Items.

The following elements are optional:

lastScheduleDate (DateTime) Last generated date.
invoiceTemplateLines (List of RecurringInvoiceTemplateLineResource) The template lines.
See RecurringInvoiceTemplateLineResource.
description (string) The template invoice description.
endDate (DateTime) The recurring invoice planning end date.
totalSchedules (int) Total number of schedules days.
totalCreatedInvoices (int) The total invoices created.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
(fk) Allowed value: the natural key of a record of type Serie. These records are accessibly through the Series service.
salesPerson (string) The sales person. The seller of the invoice.
(fk) Allowed value: the natural key of a record of type Salesperson. These records are accessibly through the Salespersons service.
remarks (string) The invoice’s remarks.
noteToRecipient (string) The note to the invoice recipient.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.

Enumerations


IntervalTypeList

1 Week
2 Month
3 Year