POST api/Integration/WebHook

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Event	BillingEvent	None.
ContractId	string	None.
CustomerId	string	None.
DunningId	string	None.
InvoiceId	string	None.
OldInvoiceId	string	None.
NewInvoiceId	string	None.
OldInvoiceDraftId	string	None.
NewInvoiceDraftId	string	None.
ExpiryDate	date	None.
YourCustomerId	string	None.
PaymentProvider	string	None.
TriggerDays	string	None.
DueDate	date	None.
PaymentEscalationProcessId	string	None.
PaymentTransactionId	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Event": 0,
  "ContractId": "sample string 1",
  "CustomerId": "sample string 2",
  "DunningId": "sample string 3",
  "InvoiceId": "sample string 4",
  "OldInvoiceId": "sample string 5",
  "NewInvoiceId": "sample string 6",
  "OldInvoiceDraftId": "sample string 7",
  "NewInvoiceDraftId": "sample string 8",
  "ExpiryDate": "2025-01-29T02:40:56.4825336+00:00",
  "YourCustomerId": "sample string 9",
  "PaymentProvider": "sample string 10",
  "TriggerDays": "sample string 11",
  "DueDate": "2025-01-29T02:40:56.4825336+00:00",
  "PaymentEscalationProcessId": "sample string 12",
  "PaymentTransactionId": "sample string 13"
}

application/xml, text/xml

Sample:

<BillingIntegrationWebHookRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Entities">
  <ContractId>sample string 1</ContractId>
  <CustomerId>sample string 2</CustomerId>
  <DueDate>2025-01-29T02:40:56.4825336+00:00</DueDate>
  <DunningId>sample string 3</DunningId>
  <Event>PaymentSucceeded</Event>
  <ExpiryDate>2025-01-29T02:40:56.4825336+00:00</ExpiryDate>
  <InvoiceId>sample string 4</InvoiceId>
  <NewInvoiceDraftId>sample string 8</NewInvoiceDraftId>
  <NewInvoiceId>sample string 6</NewInvoiceId>
  <OldInvoiceDraftId>sample string 7</OldInvoiceDraftId>
  <OldInvoiceId>sample string 5</OldInvoiceId>
  <PaymentEscalationProcessId>sample string 12</PaymentEscalationProcessId>
  <PaymentProvider>sample string 10</PaymentProvider>
  <PaymentTransactionId>sample string 13</PaymentTransactionId>
  <TriggerDays>sample string 11</TriggerDays>
  <YourCustomerId>sample string 9</YourCustomerId>
</BillingIntegrationWebHookRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.