Sales | Recurring Invoice Schedule

Service to manage entities of type 'RecurringInvoiceSchedule'.

Overview

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

All Operations

This service includes the following operations:

• GET:
  • GET RecurringInvoiceSchedules (odata)
  • GET RecurringInvoiceSchedule by identifier
  • GET RecurringInvoiceSchedule by key
• PUT:
  • PUT Set IsActive RecurringInvoiceSchedule
  • PUT Set RecurringInvoiceScheduleKey RecurringInvoiceSchedule
  • PUT Set Date RecurringInvoiceSchedule
  • PUT Set DocumentStatus RecurringInvoiceSchedule
  • PUT Set Total RecurringInvoiceSchedule
  • PUT Set NoteToRecipient RecurringInvoiceSchedule
  • PUT Set Serie RecurringInvoiceSchedule
  • PUT Set Invoice RecurringInvoiceSchedule
  • PUT Set RecurringInvoiceTemplate RecurringInvoiceSchedule
  • PUT Set Remarks RecurringInvoiceSchedule
  • PUT Set SalesItem RecurringInvoiceScheduleLine
  • PUT Set Unit RecurringInvoiceScheduleLine
  • PUT Set PartyTaxSchema RecurringInvoiceScheduleLine
  • PUT Set ItemTaxSchema RecurringInvoiceScheduleLine
  • PUT Set Warehouse RecurringInvoiceScheduleLine
  • PUT Set UnitPrice RecurringInvoiceScheduleLine
  • PUT Set Currency RecurringInvoiceScheduleLine
  • PUT Set Description RecurringInvoiceScheduleLine
  • PUT Set Quantity RecurringInvoiceScheduleLine
  • PUT Set Discount RecurringInvoiceScheduleLine
• POST:
  • POST Recurring Invoice Schedule Line
• DELETE:
  • DELETE Recurring Invoice Schedule Line by identifier

All Resources

This service uses the following resources:

• ApiRecurringInvoiceScheduleRecurringInvoiceScheduleLinesResource
• ApiRecurringInvoiceScheduleResource
• MoneyResource
• RecurringInvoiceScheduleResource

All Enumerations

This service uses the following enumerations:

• DocumentStatus

GET Operations

GET RecurringInvoiceSchedules (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 RecurringInvoiceScheduleResource.

Response status codes:

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

Resource URL:

GET RecurringInvoiceSchedule 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 RecurringInvoiceScheduleResource.

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 RecurringInvoiceSchedule by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
recurringInvoiceScheduleKey	(string) The recurring invoice schedule key.

Response:

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

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:

POST Operations

POST Recurring Invoice Schedule Line

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

The following elements are required:

recurringInvoiceScheduleKey	(string) The recurring invoice schedule key.
companyKey	(string) The company key.
value	(ApiRecurringInvoiceScheduleRecurringInvoiceScheduleLinesResource) The ApiRecurringInvoiceScheduleRecurringInvoiceScheduleLinesResource instance. See ApiRecurringInvoiceScheduleRecurringInvoiceScheduleLinesResource.

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:

PUT Operations

PUT Set Currency RecurringInvoiceScheduleLine

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

The following elements are required:

recurringInvoiceScheduleKey	(string) The recurring invoice schedule 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 Set Date RecurringInvoiceSchedule

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

The following elements are required:

recurringInvoiceScheduleKey	(string) The recurring invoice schedule 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 Set Description RecurringInvoiceScheduleLine

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

The following elements are required:

recurringInvoiceScheduleKey	(string) The recurring invoice schedule 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 Set Discount RecurringInvoiceScheduleLine

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

The following elements are required:

recurringInvoiceScheduleKey	(string) The recurring invoice schedule 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 Set DocumentStatus RecurringInvoiceSchedule

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

The following elements are required:

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

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 Set Invoice RecurringInvoiceSchedule

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

The following elements are required:

recurringInvoiceScheduleKey	(string) The recurring invoice schedule 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 Set IsActive RecurringInvoiceSchedule

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

The following elements are required:

recurringInvoiceScheduleKey	(string) The recurring invoice schedule 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 Set ItemTaxSchema RecurringInvoiceScheduleLine

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

The following elements are required:

recurringInvoiceScheduleKey	(string) The recurring invoice schedule 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 Set NoteToRecipient RecurringInvoiceSchedule

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

The following elements are required:

recurringInvoiceScheduleKey	(string) The recurring invoice schedule 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 Set PartyTaxSchema RecurringInvoiceScheduleLine

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

The following elements are required:

recurringInvoiceScheduleKey	(string) The recurring invoice schedule 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 Set Quantity RecurringInvoiceScheduleLine

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

The following elements are required:

recurringInvoiceScheduleKey	(string) The recurring invoice schedule 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 Set RecurringInvoiceScheduleKey RecurringInvoiceSchedule

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

The following elements are required:

recurringInvoiceScheduleKey	(string) The recurring invoice schedule 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 Set RecurringInvoiceTemplate RecurringInvoiceSchedule

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

The following elements are required:

recurringInvoiceScheduleKey	(string) The recurring invoice schedule 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 Set Remarks RecurringInvoiceSchedule

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

The following elements are required:

recurringInvoiceScheduleKey	(string) The recurring invoice schedule 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 Set SalesItem RecurringInvoiceScheduleLine

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

The following elements are required:

recurringInvoiceScheduleKey	(string) The recurring invoice schedule 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 Set Serie RecurringInvoiceSchedule

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

The following elements are required:

recurringInvoiceScheduleKey	(string) The recurring invoice schedule 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 Set Total RecurringInvoiceSchedule

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

The following elements are required:

recurringInvoiceScheduleKey	(string) The recurring invoice schedule 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 Set Unit RecurringInvoiceScheduleLine

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

The following elements are required:

recurringInvoiceScheduleKey	(string) The recurring invoice schedule 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 Set UnitPrice RecurringInvoiceScheduleLine

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

The following elements are required:

recurringInvoiceScheduleKey	(string) The recurring invoice schedule 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 Set Warehouse RecurringInvoiceScheduleLine

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

The following elements are required:

recurringInvoiceScheduleKey	(string) The recurring invoice schedule 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:

DELETE Operations

DELETE Recurring Invoice Schedule Line by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

recurringInvoiceScheduleKey	(string) The recurring invoice schedule 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:

Resources

ApiRecurringInvoiceScheduleRecurringInvoiceScheduleLinesResource

The following elements are required:

salesItem	(string) The sales item representing the good or service.
unit	(string) The line item sales unit. The default sales unit is defined on the sales item.
partyTaxSchema	(string) The 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) The line item tax schema. The tax schema identifies the group of taxes a item is liable for. The default tax schema is defined on the sales item.
unitPrice	(MoneyResource) The 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) The money’s unit. Inferred from the template currency.

The following elements are optional:

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

ApiRecurringInvoiceScheduleResource

The following elements are required:

recurringInvoiceScheduleKey	(string) The recurring invoice schedule key.
date	(DateTime) The date of schedule.
currency	(string) The currency of the recurring invoice.
company	(string) The recurring template company. The company code is the central organizational unit within the system.
total	(MoneyResource) The recurring schedule total. The total without taxes. See MoneyResource .
invoiceType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted.
accountingParty	(string) The customer designated in the document as the party to whom the invoice should be sent for payment.
buyerCustomerParty	(string) The customer party. Party that the invoice is for.
recurringInvoiceTemplate	(string) The recurring invoice template.

The following elements are optional:

documentStatus	(enum DocumentStatus) The schedule status. Internally determined. See DocumentStatus.
recurringInvoiceScheduleLines	(List of ApiRecurringInvoiceScheduleRecurringInvoiceScheduleLinesResource) The recurring schedule lines. See ApiRecurringInvoiceScheduleRecurringInvoiceScheduleLinesResource.
noteToRecipient	(string) The note to the invoice recipient.
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.
description	(string) The template invoice description.
salesPerson	(string) The sales person. The seller of the invoice.
invoice	(string) The invoice created by billing request.
remarks	(string) The invoice’s remarks.

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.

RecurringInvoiceScheduleResource

The following elements are required:

recurringInvoiceScheduleKey	(string) The recurring invoice schedule key.
date	(DateTime) The date of schedule.
currency	(string) The currency of the recurring invoice. (fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.
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.
total	(MoneyResource) The recurring schedule total. The total without taxes. See MoneyResource .
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.
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.
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.
recurringInvoiceTemplate	(string) The recurring invoice template. (fk) Allowed value: the natural key of a record of type RecurringInvoiceTemplate. These records are accessibly through the RecurringInvoiceTemplates service.

The following elements are optional:

documentStatus	(enum DocumentStatus) The schedule status. Internally determined. See DocumentStatus.
recurringInvoiceScheduleLines	(List of RecurringInvoiceScheduleLineResource) The recurring schedule lines. See RecurringInvoiceScheduleLineResource.
noteToRecipient	(string) The note to the invoice recipient.
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.
description	(string) The template invoice description.
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.
invoice	(string) The invoice created by billing request. (fk) Allowed value: the natural key of a record of type Invoice. These records are accessibly through the Invoices service.
remarks	(string) The invoice’s remarks.

Enumerations

DocumentStatus

1	Open
2	Completed