POST | /customers/{customerId}/invoiceterms | Creates a new Invoice Term entry for this Customer. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CustomerId | path | Guid | Yes | The customer Id. |
StartDate | body | DateTime | Yes | The start date when this invoice term becomes active. |
EndDate | body | DateTime | No | The end date when this invoice term is no longer active. |
FlatServiceFee | body | decimal | No | The flat service fee. |
FlatServiceFeeShow | body | int | No | Whether or not to show the flat service fee. (0 = false, 1 = true) |
FieldCrewFlatRate | body | decimal | No | The field crew flat rate. |
FieldCrewHourlyRate | body | decimal | No | The field crew hourly rate. |
FieldCrewShow | body | int | No | Wheither or not to show the field crew rates. (0 = false, 1 = true) |
PerBootAppliedFee | body | decimal | No | The per boot applied fee. |
PerBootAppliedShow | body | int | No | Whether or not to show the per boot applied fee. (0 = false, 1 = true) |
PerBootPaidFee | body | decimal | No | The per boot paid fee. |
PerBootPaidShow | body | int | No | Whether or not to show the per boot paid fee. (0 = false, 1 = true) |
PerNoticeAppliedFee | body | decimal | No | The per notice applied fee. |
PerNoticeAppliedShow | body | int | No | Whether or not to show the per notice applied fee. (0 = false, 1 = true) |
PerNoticePaidFee | body | decimal | No | The per notice paid fee. |
PerNoticePaidShow | body | int | No | Whether or not to show the per notice paid fee. (0 = false, 1 = true) |
PerTowFee | body | decimal | No | The per tow fee. |
PerTowShow | body | int | No | Whether or not to show the per tow fee. (0 = false, 1 = true) |
PerTowPaid | body | decimal | No | The per tow paid fee. |
PerTowPaidShow | body | int | No | Whether or not to show the per tow paid fee. (0 = false, 1 = true) |
TicketContingencyPercent | body | decimal | No | The ticket contingency percent. |
TicketContingencyShow | body | int | No | Whether or not to show the ticket contingency percent. (0 = false, 1 = true) |
TieredPaymentShow | body | int | No | Whether or not to show tiered payment. (0 = false, 1 = true) |
InvoicePaylockFees | body | int | No | The invoice PayLock fees. |
InvoiceMerchantFees | body | int | No | The invoice mechant fees. |
ContactName | body | string | No | The contact name. |
ContactCompany | body | string | No | The contact company. |
ContactAddressLine1 | body | string | No | The contact address line 1. |
ContactAddressLine2 | body | string | No | The contact address line 2. |
ContactCity | body | string | No | The contact city. |
ContactState | body | string | No | The contact state. |
ContactZip | body | string | No | The contact zip code. |
ContactPhone | body | string | No | The contact phone. |
ContactEmail | body | string | No | The contact email. |
PaylockContact | body | string | No | The PayLock contact name. |
PaymentDueDateDesc | body | string | No | The payment due date description. |
GracePeriod | body | int | No | The grace period. |
CashPaymentsOwnedByPaylock | body | bool | No | Whether or not cash payments are owned by PayLock. |
IsNetRemit | body | bool | No | Whether or not it is net remit. |
PaymentTerms | body | string | No | Description of the payment terms. |
PerBootFeePaidShow | body | int | No | Whether or not to show per boot fee paid. (0 = false, 1 = true) |
PerNoticeFeePaidShow | body | int | No | Whether or not to show per boot fee paid. (0 = false, 1 = true) |
InvoiceConvenienceFees | body | bool | No | Whether or not there are convenience fees. |
InvoiceSalesTax | body | bool | No | Whether or not there is invoice sales tax. |
TicketContingencySlidingScaleShow | body | bool | No | Whether or not to show the ticket contingency sliding scale. |
PerBootReleaseFeePaidShow | body | int | No | Whether or not to show per boot release fee paid. (0 = false, 1 = true) |
ProrateRevenueAdjustments | body | bool | No | Whether or not there are prorated revenue adjustments. |
RedLightContingencyPercent | body | decimal | No | The red light contingency percent. |
NoticeContingencyPercent | body | decimal | No | The notice contingency percent. |
NoticeContingencyPercentShow | body | string | No | Whether or not to show the notice contingency percent. |
NoticeContingencyAmountShow | body | string | No | Whether or not to show the notice contingency amount. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | Guid | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /customers/{customerId}/invoiceterms HTTP/1.1
Host: api.paylock.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CreateCustomerInvoiceTerm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
<CashPaymentsOwnedByPaylock>false</CashPaymentsOwnedByPaylock>
<ContactAddressLine1>String</ContactAddressLine1>
<ContactAddressLine2>String</ContactAddressLine2>
<ContactCity>String</ContactCity>
<ContactCompany>String</ContactCompany>
<ContactEmail>String</ContactEmail>
<ContactName>String</ContactName>
<ContactPhone>String</ContactPhone>
<ContactState>String</ContactState>
<ContactZip>String</ContactZip>
<CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
<EndDate>0001-01-01T00:00:00</EndDate>
<FieldCrewFlatRate>0</FieldCrewFlatRate>
<FieldCrewHourlyRate>0</FieldCrewHourlyRate>
<FieldCrewShow>0</FieldCrewShow>
<FlatServiceFee>0</FlatServiceFee>
<FlatServiceFeeShow>0</FlatServiceFeeShow>
<GracePeriod>0</GracePeriod>
<InvoiceConvenienceFees>false</InvoiceConvenienceFees>
<InvoiceMerchantFees>0</InvoiceMerchantFees>
<InvoicePaylockFees>0</InvoicePaylockFees>
<InvoiceSalesTax>false</InvoiceSalesTax>
<IsNetRemit>false</IsNetRemit>
<NoticeContingencyAmountShow>false</NoticeContingencyAmountShow>
<NoticeContingencyPercent>0</NoticeContingencyPercent>
<NoticeContingencyPercentShow>false</NoticeContingencyPercentShow>
<PaylockContact>String</PaylockContact>
<PaymentDueDateDesc>String</PaymentDueDateDesc>
<PaymentTerms>String</PaymentTerms>
<PerBootAppliedFee>0</PerBootAppliedFee>
<PerBootAppliedShow>0</PerBootAppliedShow>
<PerBootFeePaidShow>0</PerBootFeePaidShow>
<PerBootPaidFee>0</PerBootPaidFee>
<PerBootPaidShow>0</PerBootPaidShow>
<PerBootReleaseFeePaidShow>0</PerBootReleaseFeePaidShow>
<PerNoticeAppliedFee>0</PerNoticeAppliedFee>
<PerNoticeAppliedShow>0</PerNoticeAppliedShow>
<PerNoticeFeePaidShow>0</PerNoticeFeePaidShow>
<PerNoticePaidFee>0</PerNoticePaidFee>
<PerNoticePaidShow>0</PerNoticePaidShow>
<PerTowFee>0</PerTowFee>
<PerTowPaid>0</PerTowPaid>
<PerTowPaidShow>0</PerTowPaidShow>
<PerTowShow>0</PerTowShow>
<ProrateRevenueAdjustments>false</ProrateRevenueAdjustments>
<RedLightContingencyPercent>0</RedLightContingencyPercent>
<StartDate>0001-01-01T00:00:00</StartDate>
<TicketContingencyPercent>0</TicketContingencyPercent>
<TicketContingencyShow>0</TicketContingencyShow>
<TicketContingencySlidingScaleShow>false</TicketContingencySlidingScaleShow>
<TieredPaymentShow>0</TieredPaymentShow>
</CreateCustomerInvoiceTerm>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <CreateCustomerInvoiceTermResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel"> <Id>00000000-0000-0000-0000-000000000000</Id> </CreateCustomerInvoiceTermResult>