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": "2e70d561-39a6-4585-9b6a-f5c68a5329be", "description": "sample string 2", "invoiceNumber": "sample string 3", "locationId": "sample string 4", "locationBusinessName": "sample string 5", "transactionDate": "2023-06-02T12:27:18.4626597-05:00", "dueDate": "2023-06-02T12:27:18.4626597-05:00", "number": "sample string 8", "paymentReceiptDate": "2023-06-02T12:27:18.4626597-05:00", "insuredCommercialName": "sample string 10", "insuredDatabaseId": "aeb998a3-a730-4664-aae5-b920b1b4d78f", "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": "7ea3d636-b2af-4c78-9faf-5f2a4185f657", "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>2023-06-02T12:27:18.4626597-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>2e70d561-39a6-4585-9b6a-f5c68a5329be</Id> <InsuredCommercialName>sample string 10</InsuredCommercialName> <InsuredDatabaseId>aeb998a3-a730-4664-aae5-b920b1b4d78f</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>2023-06-02T12:27:18.4626597-05:00</PaymentReceiptDate> <PolicyId>7ea3d636-b2af-4c78-9faf-5f2a4185f657</PolicyId> <PolicyNumber>sample string 15</PolicyNumber> <TransactionDate>2023-06-02T12:27:18.4626597-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": "8f629844-91d8-4ac2-8770-90abe6d02f27", "description": "sample string 2", "invoiceNumber": "sample string 3", "locationId": "sample string 4", "locationBusinessName": "sample string 5", "transactionDate": "2023-06-02T12:27:18.4782853-05:00", "dueDate": "2023-06-02T12:27:18.4782853-05:00", "number": "sample string 8", "paymentReceiptDate": "2023-06-02T12:27:18.4782853-05:00", "insuredCommercialName": "sample string 10", "insuredDatabaseId": "b6566d37-dd8b-4109-8e66-7cba645c6fbb", "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": "0506386f-71dd-4dc5-a98b-0852ce74f78d", "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>2023-06-02T12:27:18.4782853-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>8f629844-91d8-4ac2-8770-90abe6d02f27</Id> <InsuredCommercialName>sample string 10</InsuredCommercialName> <InsuredDatabaseId>b6566d37-dd8b-4109-8e66-7cba645c6fbb</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>2023-06-02T12:27:18.4782853-05:00</PaymentReceiptDate> <PolicyId>0506386f-71dd-4dc5-a98b-0852ce74f78d</PolicyId> <PolicyNumber>sample string 15</PolicyNumber> <TransactionDate>2023-06-02T12:27:18.4782853-05:00</TransactionDate> </Data> <Message>sample string 1</Message> <Status>Error</Status> </NowCertsApiResultOfReceiptForTakePaymentInsertModelodPQ2rGR>