PUT api/provider/program/submit?contactId={contactId}&accountId={accountId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| contactId | globally unique identifier |
Required |
|
| accountId | globally unique identifier |
Required |
Body Parameters
FreeProviderProgramSubmitModel| Name | Description | Type | Additional information |
|---|---|---|---|
| CartId | globally unique identifier |
None. |
|
| ProviderProgramId | globally unique identifier |
None. |
|
| ProviderApplicationId | globally unique identifier |
None. |
|
| WebProductId | globally unique identifier |
None. |
|
| WebProductName | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"CartId": "b1cdf116-ed91-451e-af96-e8ca554fe788",
"ProviderProgramId": "319ef3bb-3092-461a-94d5-9ec7825bb4ac",
"ProviderApplicationId": "e799dea2-31bc-4e5c-8958-665397a0bdea",
"WebProductId": "f08bd8f4-d5b1-49a5-b3b0-019ea27d2e5c",
"WebProductName": "sample string 5"
}
application/xml, text/xml
Sample:
<FreeProviderProgramSubmitModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models"> <CartId>b1cdf116-ed91-451e-af96-e8ca554fe788</CartId> <ProviderApplicationId>e799dea2-31bc-4e5c-8958-665397a0bdea</ProviderApplicationId> <ProviderProgramId>319ef3bb-3092-461a-94d5-9ec7825bb4ac</ProviderProgramId> <WebProductId>f08bd8f4-d5b1-49a5-b3b0-019ea27d2e5c</WebProductId> <WebProductName>sample string 5</WebProductName> </FreeProviderProgramSubmitModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Receipt| Name | Description | Type | Additional information |
|---|---|---|---|
| InvoiceId | globally unique identifier |
None. |
|
| Messages | Collection of string |
None. |
|
| InvoiceNumber | string |
None. |
|
| InvoiceDate | date |
None. |
|
| TotalAmountPaid | decimal number |
None. |
|
| PaymentAuthorizationNumber | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"InvoiceId": "afecea81-1159-47a7-897c-e98071f1e30b",
"Messages": [
"sample string 1",
"sample string 2"
],
"InvoiceNumber": "sample string 2",
"InvoiceDate": "2026-01-26T12:11:49.149019+00:00",
"TotalAmountPaid": 4.0,
"PaymentAuthorizationNumber": "sample string 5"
}
application/xml, text/xml
Sample:
<Receipt xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models">
<InvoiceDate>2026-01-26T12:11:49.149019+00:00</InvoiceDate>
<InvoiceId>afecea81-1159-47a7-897c-e98071f1e30b</InvoiceId>
<InvoiceNumber>sample string 2</InvoiceNumber>
<Messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Messages>
<PaymentAuthorizationNumber>sample string 5</PaymentAuthorizationNumber>
<TotalAmountPaid>4</TotalAmountPaid>
</Receipt>