SEservicechannel
Invoices

Retrieve general invoice settings for a subscriber

Returns general invoice settings for the specified subscriber. <br />Both subscribers and providers can use this method.  • Subscribers should enter their subscriber ID.  • Providers need to pass the ID of the subscriber they have a contract with. <br />Subscriber users with the Super Admin secondary role set up general invoice parameters in Admin > Invoices > General, where they configure when invoices can be created, if providers should enter a resolution before submitting invoices, and whether any restrictions should apply to invoice numbers. Other parameters may be available if the corresponding features are turned on for the subscriber. Learn more about configuring general invoice settings in ServiceChannel University.

get/invoices/{subscriberId}/InvoiceRequirements

Request

Path parameters

subscriberIdinteger required

Unique numeric identifier of the subscriber to return general invoice settings for.

Response

General invoice settings for the specified subscriber are in the response.

DaysBeforePostingDateinteger

The number of days prior to the invoice posting date within which the invoice creation date can be set. Providers can not create invoices for a date in the past that is older than the specified number of days from the invoice posting date.

MaxDaysAfterPostingDateinteger

The number of days after the invoice posting date within which the invoice creation date can be set. Providers can not generate invoices for a date in the future that is greater than the specified number of days from the invoice posting date.

RequireResolutionTextboolean

Defines whether providers are required to enter a resolution when creating an invoice.

RequireApprovalTextboolean

Defines whether subscriber’s employees are required to enter a comment when approving invoices.

IsInvoiceApprovalCommentFeatureEnabledboolean

Defines whether the feature that prompts subscriber’s employees to enter a comment when approving invoices is turned on.

IsInvoiceNumberValidationFeatureEnabledboolean

Defines whether the feature that enables the invoice number validation is turned on.

IsInvoiceNegativeFeatureEnabledboolean

Defines whether the feature that enables the invoice negative amounts for the required line items.

IsInvoiceZeroVATEUboolean

Use Us UI model in international locations.

AvailableTradesstring

A list of trades configured for the subscriber. The following parameters are returned for each trade:<br /> • Id — trade ID.<br /> • Name — trade name.<br /> • PrimaryTradeName — name of the primary trade for this trade.

AvailableCategoriesstring

A list of categories set up for the subscriber. The following parameters are returned for each category:<br /> • Id — category ID.<br /> • SubscriberId — subscriber ID.<br /> • Name — category name.<br /> • HasDependency — defines whether the category has dependent categories.<br /> • PrimaryCategoryID — ID of the primary category for this category.<br /> • PrimaryCategoryName — name of the primary category for this category.

LaborTradeIdsinteger[]

Trade IDs for which providers must itemize Labor charges when creating a line-item invoice.

MaterialsTradeIdsinteger[]

Trade IDs for which providers must itemize Material charges when creating a line-item invoice.

TravelTradeIdsinteger[]

Trade IDs for which providers must itemize Travel charges when creating a line-item invoice.

OtherTradeIdsinteger[]

Trade IDs for which providers must itemize Other charges when creating a line-item invoice.

LaborCategoryIdsinteger[]

Category IDs for which providers must itemize Labor charges when creating a line-item invoice.

MaterialsCategoryIdsinteger[]

Category IDs for which providers must itemize Material charges when creating a line-item invoice.

TravelCategoryIdsinteger[]

Category IDs for which providers must itemize Travel charges when creating a line-item invoice.

OtherCategoryIdsinteger[]

Category IDs for which providers must itemize Other charges when creating a line-item invoice.

IsProviderAbleToAddSalesTaxboolean

Defines whether the provider can add sales tax to its ivoices

RequireProviderDigitalCopyboolean

Specified is Provider Digital Copy requirement set for the provider

Changes

No recorded changes to this operation across all 1 revision of this API.