POST api/Receipt/InsertOrUpdateTakePayment

Request Information

URI Parameters

None.

Body Parameters

ReceiptForTakePaymentInsertModel
NameDescriptionTypeAdditional 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": "a1c34e92-2761-4336-80b2-a06dd378a7d6",
  "description": "sample string 2",
  "invoiceNumber": "sample string 3",
  "locationId": "sample string 4",
  "locationBusinessName": "sample string 5",
  "transactionDate": "2020-10-27T23:15:23.1642449-06:00",
  "dueDate": "2020-10-27T23:15:23.1642449-06:00",
  "number": "sample string 8",
  "paymentReceiptDate": "2020-10-27T23:15:23.1642449-06:00",
  "insuredCommercialName": "sample string 10",
  "insuredDatabaseId": "46bb18ce-e9b1-4ab6-9095-fafccfea1be1",
  "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": "dca694ef-cbd4-4a22-93b7-c142494a5dc4",
  "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>2020-10-27T23:15:23.1642449-06: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>a1c34e92-2761-4336-80b2-a06dd378a7d6</Id>
  <InsuredCommercialName>sample string 10</InsuredCommercialName>
  <InsuredDatabaseId>46bb18ce-e9b1-4ab6-9095-fafccfea1be1</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>2020-10-27T23:15:23.1642449-06:00</PaymentReceiptDate>
  <PolicyId>dca694ef-cbd4-4a22-93b7-c142494a5dc4</PolicyId>
  <PolicyNumber>sample string 15</PolicyNumber>
  <TransactionDate>2020-10-27T23:15:23.1642449-06:00</TransactionDate>
</ReceiptForTakePaymentInsertModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

NowCertsApiResultOfReceiptForTakePaymentInsertModel
NameDescriptionTypeAdditional information
Status

ApiStatus

None.

Data

ReceiptForTakePaymentInsertModel

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "status": 0,
  "data": {
    "id": "bff5401c-2543-4c28-b752-7296ec7fb739",
    "description": "sample string 2",
    "invoiceNumber": "sample string 3",
    "locationId": "sample string 4",
    "locationBusinessName": "sample string 5",
    "transactionDate": "2020-10-27T23:15:23.1798259-06:00",
    "dueDate": "2020-10-27T23:15:23.1798259-06:00",
    "number": "sample string 8",
    "paymentReceiptDate": "2020-10-27T23:15:23.1798259-06:00",
    "insuredCommercialName": "sample string 10",
    "insuredDatabaseId": "dc3134fb-d5fc-42f4-9792-9e4baadb6fa5",
    "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": "6452bc8b-fb4c-42ac-a63d-dcd41c256dee",
    "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>2020-10-27T23:15:23.1798259-06: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>bff5401c-2543-4c28-b752-7296ec7fb739</Id>
    <InsuredCommercialName>sample string 10</InsuredCommercialName>
    <InsuredDatabaseId>dc3134fb-d5fc-42f4-9792-9e4baadb6fa5</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>2020-10-27T23:15:23.1798259-06:00</PaymentReceiptDate>
    <PolicyId>6452bc8b-fb4c-42ac-a63d-dcd41c256dee</PolicyId>
    <PolicyNumber>sample string 15</PolicyNumber>
    <TransactionDate>2020-10-27T23:15:23.1798259-06:00</TransactionDate>
  </Data>
  <Message>sample string 1</Message>
  <Status>Error</Status>
</NowCertsApiResultOfReceiptForTakePaymentInsertModelodPQ2rGR>