BootView WebApi

<back to all web services

CreateCustomerInvoiceTerm

The following routes are available for this service:
POST/customers/{customerId}/invoicetermsCreates a new Invoice Term entry for this Customer.
CreateCustomerInvoiceTerm Parameters:
NameParameterData TypeRequiredDescription
CustomerIdpathGuidYesThe customer Id.
StartDatebodyDateTimeYesThe start date when this invoice term becomes active.
EndDatebodyDateTimeNoThe end date when this invoice term is no longer active.
FlatServiceFeebodydecimalNoThe flat service fee.
FlatServiceFeeShowbodyintNoWhether or not to show the flat service fee. (0 = false, 1 = true)
FieldCrewFlatRatebodydecimalNoThe field crew flat rate.
FieldCrewHourlyRatebodydecimalNoThe field crew hourly rate.
FieldCrewShowbodyintNoWheither or not to show the field crew rates. (0 = false, 1 = true)
PerBootAppliedFeebodydecimalNoThe per boot applied fee.
PerBootAppliedShowbodyintNoWhether or not to show the per boot applied fee. (0 = false, 1 = true)
PerBootPaidFeebodydecimalNoThe per boot paid fee.
PerBootPaidShowbodyintNoWhether or not to show the per boot paid fee. (0 = false, 1 = true)
PerNoticeAppliedFeebodydecimalNoThe per notice applied fee.
PerNoticeAppliedShowbodyintNoWhether or not to show the per notice applied fee. (0 = false, 1 = true)
PerNoticePaidFeebodydecimalNoThe per notice paid fee.
PerNoticePaidShowbodyintNoWhether or not to show the per notice paid fee. (0 = false, 1 = true)
PerTowFeebodydecimalNoThe per tow fee.
PerTowShowbodyintNoWhether or not to show the per tow fee. (0 = false, 1 = true)
PerTowPaidbodydecimalNoThe per tow paid fee.
PerTowPaidShowbodyintNoWhether or not to show the per tow paid fee. (0 = false, 1 = true)
TicketContingencyPercentbodydecimalNoThe ticket contingency percent.
TicketContingencyShowbodyintNoWhether or not to show the ticket contingency percent. (0 = false, 1 = true)
TieredPaymentShowbodyintNoWhether or not to show tiered payment. (0 = false, 1 = true)
InvoicePaylockFeesbodyintNoThe invoice PayLock fees.
InvoiceMerchantFeesbodyintNoThe invoice mechant fees.
ContactNamebodystringNoThe contact name.
ContactCompanybodystringNoThe contact company.
ContactAddressLine1bodystringNoThe contact address line 1.
ContactAddressLine2bodystringNoThe contact address line 2.
ContactCitybodystringNoThe contact city.
ContactStatebodystringNoThe contact state.
ContactZipbodystringNoThe contact zip code.
ContactPhonebodystringNoThe contact phone.
ContactEmailbodystringNoThe contact email.
PaylockContactbodystringNoThe PayLock contact name.
PaymentDueDateDescbodystringNoThe payment due date description.
GracePeriodbodyintNoThe grace period.
CashPaymentsOwnedByPaylockbodyboolNoWhether or not cash payments are owned by PayLock.
IsNetRemitbodyboolNoWhether or not it is net remit.
PaymentTermsbodystringNoDescription of the payment terms.
PerBootFeePaidShowbodyintNoWhether or not to show per boot fee paid. (0 = false, 1 = true)
PerNoticeFeePaidShowbodyintNoWhether or not to show per boot fee paid. (0 = false, 1 = true)
InvoiceConvenienceFeesbodyboolNoWhether or not there are convenience fees.
InvoiceSalesTaxbodyboolNoWhether or not there is invoice sales tax.
TicketContingencySlidingScaleShowbodyboolNoWhether or not to show the ticket contingency sliding scale.
PerBootReleaseFeePaidShowbodyintNoWhether or not to show per boot release fee paid. (0 = false, 1 = true)
ProrateRevenueAdjustmentsbodyboolNoWhether or not there are prorated revenue adjustments.
RedLightContingencyPercentbodydecimalNoThe red light contingency percent.
NoticeContingencyPercentbodydecimalNoThe notice contingency percent.
NoticeContingencyPercentShowbodystringNoWhether or not to show the notice contingency percent.
NoticeContingencyAmountShowbodystringNoWhether or not to show the notice contingency amount.
CreateCustomerInvoiceTermResult Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/CreateCustomerInvoiceTerm HTTP/1.1 
Host: api.paylock.com 
Content-Type: text/jsv
Content-Length: length

{
	customerId: 00000000000000000000000000000000,
	startDate: 0001-01-01,
	endDate: 0001-01-01,
	flatServiceFee: 0,
	flatServiceFeeShow: 0,
	fieldCrewFlatRate: 0,
	fieldCrewHourlyRate: 0,
	fieldCrewShow: 0,
	perBootAppliedFee: 0,
	perBootAppliedShow: 0,
	perBootPaidFee: 0,
	perBootPaidShow: 0,
	perNoticeAppliedFee: 0,
	perNoticeAppliedShow: 0,
	perNoticePaidFee: 0,
	perNoticePaidShow: 0,
	perTowFee: 0,
	perTowShow: 0,
	perTowPaid: 0,
	perTowPaidShow: 0,
	ticketContingencyPercent: 0,
	ticketContingencyShow: 0,
	tieredPaymentShow: 0,
	invoicePaylockFees: 0,
	invoiceMerchantFees: 0,
	contactName: String,
	contactCompany: String,
	contactAddressLine1: String,
	contactAddressLine2: String,
	contactCity: String,
	contactState: String,
	contactZip: String,
	contactPhone: String,
	contactEmail: String,
	paylockContact: String,
	paymentDueDateDesc: String,
	gracePeriod: 0,
	cashPaymentsOwnedByPaylock: False,
	isNetRemit: False,
	paymentTerms: String,
	perBootFeePaidShow: 0,
	perNoticeFeePaidShow: 0,
	invoiceConvenienceFees: False,
	invoiceSalesTax: False,
	ticketContingencySlidingScaleShow: False,
	perBootReleaseFeePaidShow: 0,
	prorateRevenueAdjustments: False,
	redLightContingencyPercent: 0,
	noticeContingencyPercent: 0,
	noticeContingencyPercentShow: False,
	noticeContingencyAmountShow: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	id: 00000000000000000000000000000000
}