POST api/Receipt/InsertOrUpdateTakePayment
Insert/Update receipt payment
Request Information
URI Parameters
None.
Body Parameters
ReceiptForTakePaymentInsertModel properties.
ReceiptForTakePaymentInsertModelName | Description | Type | Additional information |
---|---|---|---|
Id | globally unique identifier |
None. |
|
Description | string |
None. |
|
InvoiceNumber | string |
None. |
|
LocationId | string |
None. |
|
LocationBusinessName | string |
None. |
|
TransactionDate | date |
None. |
|
DueDate | date |
None. |
|
Number | string |
None. |
|
PaymentReceiptDate | date |
None. |
|
InsuredCommercialName | string |
None. |
|
InsuredDatabaseId | globally unique identifier |
None. |
|
InsuredEmail | string |
None. |
|
InsuredFirstName | string |
None. |
|
InsuredLastName | string |
None. |
|
Fees | Collection of ReceiptInsertModelFee |
None. |
|
PaymentMethodAndPaidAmount | PaymentMethodAndPaidAmount |
None. |
|
PolicyId | globally unique identifier |
None. |
|
PolicyNumber | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "id": "e5ad42b4-8fc9-41bf-80c6-ff8817d4f577", "description": "sample string 2", "invoiceNumber": "sample string 3", "locationId": "sample string 4", "locationBusinessName": "sample string 5", "transactionDate": "2024-07-26T22:05:27.9877336-05:00", "dueDate": "2024-07-26T22:05:28.0033619-05:00", "number": "sample string 8", "paymentReceiptDate": "2024-07-26T22:05:28.0033619-05:00", "insuredCommercialName": "sample string 10", "insuredDatabaseId": "98cf94a3-04c7-4d43-b632-08748e8c9491", "insuredEmail": "sample string 11", "insuredFirstName": "sample string 12", "insuredLastName": "sample string 13", "fees": [ { "feeName": "sample string 1", "dueAmount": 1.0, "paidAmount": 1.0 }, { "feeName": "sample string 1", "dueAmount": 1.0, "paidAmount": 1.0 } ], "paymentMethodAndPaidAmount": { "paymentMethod": "sample string 1", "paidAmount": 2.1, "confirmationRefNum": "sample string 3", "paymentNotes": "sample string 4" }, "policyId": "ef5f6efe-e8a1-426c-abb1-bafb7ec71648", "policyNumber": "sample string 15" }
application/xml, text/xml
Sample:
<ReceiptForTakePaymentInsertModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.NowCertsFulcrum"> <Description>sample string 2</Description> <DueDate>2024-07-26T22:05:28.0033619-05:00</DueDate> <Fees> <ReceiptInsertModelFee> <DueAmount>1</DueAmount> <FeeName>sample string 1</FeeName> <PaidAmount>1</PaidAmount> </ReceiptInsertModelFee> <ReceiptInsertModelFee> <DueAmount>1</DueAmount> <FeeName>sample string 1</FeeName> <PaidAmount>1</PaidAmount> </ReceiptInsertModelFee> </Fees> <Id>e5ad42b4-8fc9-41bf-80c6-ff8817d4f577</Id> <InsuredCommercialName>sample string 10</InsuredCommercialName> <InsuredDatabaseId>98cf94a3-04c7-4d43-b632-08748e8c9491</InsuredDatabaseId> <InsuredEmail>sample string 11</InsuredEmail> <InsuredFirstName>sample string 12</InsuredFirstName> <InsuredLastName>sample string 13</InsuredLastName> <InvoiceNumber>sample string 3</InvoiceNumber> <LocationBusinessName>sample string 5</LocationBusinessName> <LocationId>sample string 4</LocationId> <Number>sample string 8</Number> <PaymentMethodAndPaidAmount> <ConfirmationRefNum>sample string 3</ConfirmationRefNum> <PaidAmount>2.1</PaidAmount> <PaymentMethod>sample string 1</PaymentMethod> <PaymentNotes>sample string 4</PaymentNotes> </PaymentMethodAndPaidAmount> <PaymentReceiptDate>2024-07-26T22:05:28.0033619-05:00</PaymentReceiptDate> <PolicyId>ef5f6efe-e8a1-426c-abb1-bafb7ec71648</PolicyId> <PolicyNumber>sample string 15</PolicyNumber> <TransactionDate>2024-07-26T22:05:27.9877336-05:00</TransactionDate> </ReceiptForTakePaymentInsertModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
NowCertsApiResultOfReceiptForTakePaymentInsertModelName | Description | Type | Additional information |
---|---|---|---|
Status | ApiStatus |
None. |
|
Data | ReceiptForTakePaymentInsertModel |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "status": 0, "data": { "id": "cb8d98fe-a8e8-47cf-afe4-e337fa25990d", "description": "sample string 2", "invoiceNumber": "sample string 3", "locationId": "sample string 4", "locationBusinessName": "sample string 5", "transactionDate": "2024-07-26T22:05:28.0502377-05:00", "dueDate": "2024-07-26T22:05:28.0502377-05:00", "number": "sample string 8", "paymentReceiptDate": "2024-07-26T22:05:28.0502377-05:00", "insuredCommercialName": "sample string 10", "insuredDatabaseId": "4218809f-6ee2-4425-b047-53a45e4ed317", "insuredEmail": "sample string 11", "insuredFirstName": "sample string 12", "insuredLastName": "sample string 13", "fees": [ { "feeName": "sample string 1", "dueAmount": 1.0, "paidAmount": 1.0 }, { "feeName": "sample string 1", "dueAmount": 1.0, "paidAmount": 1.0 } ], "paymentMethodAndPaidAmount": { "paymentMethod": "sample string 1", "paidAmount": 2.1, "confirmationRefNum": "sample string 3", "paymentNotes": "sample string 4" }, "policyId": "1ff58961-ee18-44af-9f9f-14654e2f606e", "policyNumber": "sample string 15" }, "message": "sample string 1" }
application/xml, text/xml
Sample:
<NowCertsApiResultOfReceiptForTakePaymentInsertModelodPQ2rGR xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.NowCertsFulcrum"> <Data> <Description>sample string 2</Description> <DueDate>2024-07-26T22:05:28.0502377-05:00</DueDate> <Fees> <ReceiptInsertModelFee> <DueAmount>1</DueAmount> <FeeName>sample string 1</FeeName> <PaidAmount>1</PaidAmount> </ReceiptInsertModelFee> <ReceiptInsertModelFee> <DueAmount>1</DueAmount> <FeeName>sample string 1</FeeName> <PaidAmount>1</PaidAmount> </ReceiptInsertModelFee> </Fees> <Id>cb8d98fe-a8e8-47cf-afe4-e337fa25990d</Id> <InsuredCommercialName>sample string 10</InsuredCommercialName> <InsuredDatabaseId>4218809f-6ee2-4425-b047-53a45e4ed317</InsuredDatabaseId> <InsuredEmail>sample string 11</InsuredEmail> <InsuredFirstName>sample string 12</InsuredFirstName> <InsuredLastName>sample string 13</InsuredLastName> <InvoiceNumber>sample string 3</InvoiceNumber> <LocationBusinessName>sample string 5</LocationBusinessName> <LocationId>sample string 4</LocationId> <Number>sample string 8</Number> <PaymentMethodAndPaidAmount> <ConfirmationRefNum>sample string 3</ConfirmationRefNum> <PaidAmount>2.1</PaidAmount> <PaymentMethod>sample string 1</PaymentMethod> <PaymentNotes>sample string 4</PaymentNotes> </PaymentMethodAndPaidAmount> <PaymentReceiptDate>2024-07-26T22:05:28.0502377-05:00</PaymentReceiptDate> <PolicyId>1ff58961-ee18-44af-9f9f-14654e2f606e</PolicyId> <PolicyNumber>sample string 15</PolicyNumber> <TransactionDate>2024-07-26T22:05:28.0502377-05:00</TransactionDate> </Data> <Message>sample string 1</Message> <Status>Error</Status> </NowCertsApiResultOfReceiptForTakePaymentInsertModelodPQ2rGR>