Sales | Process Invoice Schedule
Overview
| URL | api/{tenantKey}/{orgKey}/billing/processInvoiceSchedules |
| Methods Supported | GET, POST |
All Operations
This service includes the following operations:
All Resources
This service uses the following resources:
GET Process Invoice Schedule
Returns the list of entity records that can be processed by the 'RecurringInvoiceSchedules' service.
The following elements are required:
| pageIndex | (int) The index of the page of the list that should be returned. |
| pageSize | (int) The number of page elements that should be returned (max. is 1000). |
The following elements are optional:
| customerParty | (string) Customer Party This is a query string parameter. |
| dateFrom | (DateTime?) Date From This is a query string parameter. |
| dateUntil | (DateTime?) Date Until This is a query string parameter. |
| recurringInvoice | (string) Recurring Invoice This is a query string parameter. |
| invoiceDate | (DateTime?) Invoice Date This is a query string parameter. |
| sendEmail | (bool?) Send Email This is a query string parameter. |
| company | (string) Company This is a query string parameter. |
Response:
| When successful, the response body contains the list of entity records available for processing. See InvoiceScheduleLine. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/billing/processInvoiceSchedules/{pageIndex}/{pageSize}?customerParty={customerParty}&dateFrom={dateFrom}&dateUntil={dateUntil}&recurringInvoice={recurringInvoice}&invoiceDate={invoiceDate}&sendEmail={sendEmail}&company={company}
GET /billing/processInvoiceSchedules/{pageIndex}/{pageSize}?customerParty={customerParty}&dateFrom={dateFrom}&dateUntil={dateUntil}&recurringInvoice={recurringInvoice}&invoiceDate={invoiceDate}&sendEmail={sendEmail}&company={company}
POST Process Invoice Schedule
Instructs the 'RecurringInvoiceSchedules' service to process the specified entity records.
The following elements are required:
| list | (InvoiceScheduleLine) List of the entity records that should be processed. See InvoiceScheduleLine. |
| companyKey | (string) The company key. |
Response:
| When successful, the response body is empty. The URL of the processed items is returned in the response location header. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/billing/processInvoiceSchedules/{companyKey}
POST /billing/processInvoiceSchedules/{companyKey}
Resources
InvoiceSchedule
The following elements are required:
| selectedCount | (int) Selected Count. |
The following elements are optional:
| customerParty | (string) Customer Party. |
| dateFrom | (DateTime) Date From. |
| dateUntil | (DateTime) Date Until. |
| recurringInvoice | (string) Recurring Invoice. |
| invoiceDate | (DateTime) Invoice Date. |
| sendEmail | (bool) Send Email. |
| company | (string) Company. |
InvoiceScheduleLine
The following elements are required:
| selected | (bool) Selected. |
The following elements are optional:
| scheduleDate | (DateTime) Schedule Date. |
| description | (string) Description. |
| recurringInvoiceShedule | (string) Recurring Invoice Shedule. |
| customerParty | (string) Customer Party. |
| total | (decimal) Total. |
| currency | (string) Currency. |
| company | (string) Company. |
| recurringInvoiceTemplate | (string) Recurring Invoice Template. |