DELETE Api/Promise

Cancel Promises for a list of Invoices

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Customer	Contains the information of the customer. Conditionally required for calls under the Unenrolled Customer Role.	CustomerModel	None.
CustomerToken	Contains the unique customer token used to identify the customer. Conditionally required for calls involving Enrolled Customers.	string	String length: inclusive between 0 and 100
dtUpdateExternal	External update date time for the Promise	date-time	Required
InvoiceLookups	List of InvoiceLookupModel. Invoice identification data used to find Invoice associated with Promise.	Collection of InvoiceLookupModel	Required

Request Formats

application/json, text/json

Sample:

{
  "Customer": {
    "AcceptedTermsOfService": true,
    "Address": "sample string 1",
    "Address2": "sample string 2",
    "AttnAddressLine": "sample string 3",
    "BillDue": "None",
    "BillDueDays": 1,
    "BillPastDue": "None",
    "BillPastDueDays": 1,
    "City": "sample string 4",
    "CompanyName": "sample string 5",
    "Country": "sample string 6",
    "Email": "sample string 8",
    "ConfirmEmail": "sample string 9",
    "DisableBillNotification": true,
    "Email2": "sample string 11",
    "Email3": "sample string 12",
    "ExternalUserID": "sample string 13",
    "Fax": "sample string 14",
    "FirstName": "sample string 15",
    "LastName": "sample string 16",
    "MiddleName": "sample string 17",
    "Phone": "sample string 18",
    "MobilePhone": "sample string 19",
    "PaperSuppression": true,
    "SendPinacleRFP": true,
    "State": "sample string 21",
    "SMSEnrollOnlyRegistrationStatus": "NotRegistered",
    "SMSEnrollOnlyMobile": "sample string 22",
    "Zip": "sample string 24"
  },
  "CustomerToken": "sample string 1",
  "dtUpdateExternal": "2026-06-18T21:44:03.2053262Z",
  "InvoiceLookups": [
    {
      "BillID": 1,
      "BillerInvoiceNo": "sample string 1",
      "ExternalInvoiceID": "sample string 2",
      "OtherData": "sample string 3",
      "ReferenceNumber": "sample string 4"
    },
    {
      "BillID": 1,
      "BillerInvoiceNo": "sample string 1",
      "ExternalInvoiceID": "sample string 2",
      "OtherData": "sample string 3",
      "ReferenceNumber": "sample string 4"
    }
  ]
}

Response Information

Resource Description

Cancel Promises for a list of Invoices

APIPromiseResponseModel

Name	Description	Type	Additional information
ErrorCode	Name of the error condition/category. See ErrorCode enumeration for details. Conditionally required in case when Success is false.	ErrorCode	None.
ErrorCodeDetail	Detailed error condition code.	string	None.
ErrorID	Internal error identification number that uniquely identifies this specific error that occurred.	string	None.
ErrorNum	Numeric value of the ErrorCode. Conditionally required in case when Success is false.	int	None.
Errors	List of errors that occurred when performing the operation. Conditionally required in case when Success is false.	Collection of string	None.
Result	Upon success, it includes a list of the requested promises in the PromiseResponseModel format. Conditionally required in case when Success is true.	Collection of PromiseResponseModel	None.
Success	Indicates success or failure of the REST request.	boolean	Required

Response Formats

application/json, text/json

Sample:

{
  "ErrorCode": "None",
  "ErrorCodeDetail": "sample string 1",
  "ErrorID": "sample string 2",
  "ErrorNum": 0,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Result": [
    {
      "PromiseDate": "2026-06-18T21:44:03.2249149Z",
      "Status": "Initiated",
      "dtUpdate": "2026-06-18T21:44:03.2249149Z",
      "Invoice": {
        "Address": "sample string 3",
        "Address2": "sample string 4",
        "AttnAddressLine": "sample string 5",
        "AmountDue": 1.0,
        "BillerInvoiceNo": "sample string 6",
        "BillerRemittanceField1": "sample string 7",
        "BillerRemittanceField2": "sample string 8",
        "BillerRemittanceField3": "sample string 9",
        "BillerRemittanceField4": "sample string 10",
        "BillerRemittanceField5": "sample string 11",
        "City": "sample string 12",
        "CompanyName": "sample string 13",
        "Country": "sample string 14",
        "CurrentCharges": 1.0,
        "CustomAttributes": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        },
        "Details": [
          {
            "DisputedAmount": 1.0,
            "InvAltTaxAmtItmLevel": 1.0,
            "InvAltTaxIdItmLevel": "sample string 1",
            "InvAltTaxRate": 1.0,
            "InvAltTaxType": "sample string 2",
            "InvAltTaxTypeApp": "sample string 3",
            "InvCommodityCode": "sample string 4",
            "InvDiscountPerItem": 1.0,
            "InvLineItemDiscountRate": 1.0,
            "InvLineItemTaxRate": 1.0,
            "InvLineItemTotal": 1.0,
            "InvLineItemVATTaxAmount": 1.0,
            "InvLineItemVATTaxRate": 1.0,
            "InvLocalTaxItmLevel": 1.0,
            "InvNationalTaxItmLevel": 1.0,
            "InvNetGrossIndicator": "sample string 5",
            "InvProductCode": "sample string 6",
            "InvProductName": "sample string 7",
            "InvProductSKU": "sample string 8",
            "InvPurchaseIDItmLevel": "sample string 9",
            "InvTaxAmount": 1.0,
            "InvUnitMeasure": "sample string 10",
            "ItemDesc": "sample string 11",
            "ItemFromDate": "sample string 12",
            "ItemNetAmount": "sample string 13",
            "ItemNum": "sample string 14",
            "ItemOrderQty": "sample string 15",
            "ItemQtyShipped": "sample string 16",
            "ItemQuantity": 1.0,
            "ItemToDate": "sample string 17",
            "ItemUnitPrice": "sample string 18",
            "ItemUnitPriceAmt": 1.0,
            "ItemQtyShippedNum": 1,
            "ItemNetAmountAmt": 1.0,
            "ItemExternalID": "sample string 19"
          },
          {
            "DisputedAmount": 1.0,
            "InvAltTaxAmtItmLevel": 1.0,
            "InvAltTaxIdItmLevel": "sample string 1",
            "InvAltTaxRate": 1.0,
            "InvAltTaxType": "sample string 2",
            "InvAltTaxTypeApp": "sample string 3",
            "InvCommodityCode": "sample string 4",
            "InvDiscountPerItem": 1.0,
            "InvLineItemDiscountRate": 1.0,
            "InvLineItemTaxRate": 1.0,
            "InvLineItemTotal": 1.0,
            "InvLineItemVATTaxAmount": 1.0,
            "InvLineItemVATTaxRate": 1.0,
            "InvLocalTaxItmLevel": 1.0,
            "InvNationalTaxItmLevel": 1.0,
            "InvNetGrossIndicator": "sample string 5",
            "InvProductCode": "sample string 6",
            "InvProductName": "sample string 7",
            "InvProductSKU": "sample string 8",
            "InvPurchaseIDItmLevel": "sample string 9",
            "InvTaxAmount": 1.0,
            "InvUnitMeasure": "sample string 10",
            "ItemDesc": "sample string 11",
            "ItemFromDate": "sample string 12",
            "ItemNetAmount": "sample string 13",
            "ItemNum": "sample string 14",
            "ItemOrderQty": "sample string 15",
            "ItemQtyShipped": "sample string 16",
            "ItemQuantity": 1.0,
            "ItemToDate": "sample string 17",
            "ItemUnitPrice": "sample string 18",
            "ItemUnitPriceAmt": 1.0,
            "ItemQtyShippedNum": 1,
            "ItemNetAmountAmt": 1.0,
            "ItemExternalID": "sample string 19"
          }
        ],
        "DisplayField1": "sample string 15",
        "DisplayField2": "sample string 16",
        "DisplayField3": "sample string 17",
        "DisplayField4": "sample string 18",
        "DisplayField5": "sample string 19",
        "DisputedAmount": 1.0,
        "DueDate": "2026-06-18T21:44:03.2299498Z",
        "EIR": true,
        "EIRShouldPersist": true,
        "EIRTransmissionLogID": 1,
        "Email": "test3@test.com",
        "EntryField1": "sample string 22",
        "EntryField2": "sample string 23",
        "EntryField3": "sample string 24",
        "EntryField4": "sample string 25",
        "EntryField5": "sample string 26",
        "ExternalID": "sample string 28",
        "Fax": "sample string 30",
        "FDICode": "sample string 31",
        "FirstName": "sample string 32",
        "HasLevel3InDetails": true,
        "ID": 33,
        "InvoiceAge": 34,
        "InvoiceCategory": "Invoice",
        "InvAltTaxAmount": 1.0,
        "InvAltTaxAmtItmLevel": 1.0,
        "InvAltTaxIdItmLevel": "sample string 35",
        "InvAltTaxIDOrdLevel": "sample string 36",
        "InvAltTaxID": "sample string 37",
        "InvAltTaxRate": "sample string 38",
        "InvAltTaxType": "sample string 39",
        "InvAltTaxTypeApp": "sample string 40",
        "InvCommodityCode": "sample string 41",
        "InvCustomerCode": "sample string 42",
        "InvDestAddress1": "sample string 43",
        "InvDestAddress2": "sample string 44",
        "InvDestCardholderName": "sample string 45",
        "InvDestCity": "sample string 46",
        "InvDestCountryCode": "sample string 47",
        "InvDestStateCode": "sample string 48",
        "InvDestZipCode": "sample string 49",
        "InvDiscountPerItem": 1.0,
        "InvDutyAmount": 1.0,
        "InvFreightAmount": 1.0,
        "InvLineItemTotal": 1.0,
        "InvLineItemDiscountRate": "sample string 50",
        "InvLineItemTaxRate": "sample string 51",
        "InvLineItemVATTaxAmount": 1.0,
        "InvLineItemVATTaxRate": "sample string 52",
        "InvLocalTaxAmount": 1.0,
        "InvLocalTaxItmLevel": 1.0,
        "InvLocalTaxRate": "sample string 53",
        "InvMerchantVATRegistrationNumber": "sample string 54",
        "InvNationalTaxAmount": 1.0,
        "InvNationalTaxItmLevel": 1.0,
        "InvNationalTaxRate": "sample string 55",
        "InvNetGrossIndicator": "sample string 56",
        "InvOrderDisAmtOrdLevel": "sample string 57",
        "InvProductCode": "sample string 58",
        "InvProductName": "sample string 59",
        "InvProductSKU": "sample string 60",
        "InvPurchaseID": "sample string 61",
        "InvPurchaseIDItmLevel": "sample string 62",
        "InvPstTaxRegNum": "sample string 63",
        "InvRequestorName": "sample string 64",
        "InvQuantity": 1,
        "InvShipFromZipCode": "sample string 65",
        "InvSummaryCommodityCode": "sample string 66",
        "InvSupplierOrdRef": "sample string 67",
        "InvTaxAmount": 1.0,
        "InvTaxRate": "sample string 68",
        "InvUnitCost": 1.0,
        "InvUnitMeasure": "sample string 69",
        "InvVatRefNumber": "sample string 70",
        "InvVatRegNumber": "sample string 71",
        "InvVatTaxAmount": 1.0,
        "InvVatTaxRate": "sample string 72",
        "ItemQuantity": 1.0,
        "LastName": "sample string 76",
        "MerchantDescriptor": "sample string 77",
        "MerchantDescriptorAlt": "sample string 78",
        "MerchantDescriptorCity": "sample string 79",
        "MerchantDescriptorContact": "sample string 80",
        "MerchantDescriptorCountry": "sample string 81",
        "MerchantDescriptorState": "sample string 82",
        "MerchantDescriptorStreet": "sample string 83",
        "MerchantDescriptorZip": "sample string 84",
        "Message_OutstandingBalance": "sample string 85",
        "MiddleName": "sample string 86",
        "MinimumAmountDue": 1.0,
        "OtherData": "sample string 87",
        "PaymentInstrumentBlock": "sample string 88",
        "PaymentReceived": 1.0,
        "PaymentsPostedAsOfDate": "2026-06-18T21:44:03.245581Z",
        "PayThisAmount": 1.0,
        "Phone": "sample string 89",
        "Prev_0To30Days": 1.0,
        "Prev_30To60Days": 1.0,
        "Prev_60To90Days": 1.0,
        "Prev_90DaysPlus": 1.0,
        "PreviousBalance": 1.0,
        "Promise": {
          "PromiseDate": "2026-06-18T21:44:03.245581Z",
          "PromiseStatus": "Initiated"
        },
        "ReferenceNumber": "sample string 90",
        "RemainingAmount": 91.0,
        "State": "sample string 92",
        "StatementDate": "2026-06-18T21:44:03.245581Z",
        "Status": "Active",
        "TotalAccountBalance": 1.0,
        "WaiveFee": true,
        "Zip": "sample string 93"
      }
    },
    {
      "PromiseDate": "2026-06-18T21:44:03.2249149Z",
      "Status": "Initiated",
      "dtUpdate": "2026-06-18T21:44:03.2249149Z",
      "Invoice": {
        "Address": "sample string 3",
        "Address2": "sample string 4",
        "AttnAddressLine": "sample string 5",
        "AmountDue": 1.0,
        "BillerInvoiceNo": "sample string 6",
        "BillerRemittanceField1": "sample string 7",
        "BillerRemittanceField2": "sample string 8",
        "BillerRemittanceField3": "sample string 9",
        "BillerRemittanceField4": "sample string 10",
        "BillerRemittanceField5": "sample string 11",
        "City": "sample string 12",
        "CompanyName": "sample string 13",
        "Country": "sample string 14",
        "CurrentCharges": 1.0,
        "CustomAttributes": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        },
        "Details": [
          {
            "DisputedAmount": 1.0,
            "InvAltTaxAmtItmLevel": 1.0,
            "InvAltTaxIdItmLevel": "sample string 1",
            "InvAltTaxRate": 1.0,
            "InvAltTaxType": "sample string 2",
            "InvAltTaxTypeApp": "sample string 3",
            "InvCommodityCode": "sample string 4",
            "InvDiscountPerItem": 1.0,
            "InvLineItemDiscountRate": 1.0,
            "InvLineItemTaxRate": 1.0,
            "InvLineItemTotal": 1.0,
            "InvLineItemVATTaxAmount": 1.0,
            "InvLineItemVATTaxRate": 1.0,
            "InvLocalTaxItmLevel": 1.0,
            "InvNationalTaxItmLevel": 1.0,
            "InvNetGrossIndicator": "sample string 5",
            "InvProductCode": "sample string 6",
            "InvProductName": "sample string 7",
            "InvProductSKU": "sample string 8",
            "InvPurchaseIDItmLevel": "sample string 9",
            "InvTaxAmount": 1.0,
            "InvUnitMeasure": "sample string 10",
            "ItemDesc": "sample string 11",
            "ItemFromDate": "sample string 12",
            "ItemNetAmount": "sample string 13",
            "ItemNum": "sample string 14",
            "ItemOrderQty": "sample string 15",
            "ItemQtyShipped": "sample string 16",
            "ItemQuantity": 1.0,
            "ItemToDate": "sample string 17",
            "ItemUnitPrice": "sample string 18",
            "ItemUnitPriceAmt": 1.0,
            "ItemQtyShippedNum": 1,
            "ItemNetAmountAmt": 1.0,
            "ItemExternalID": "sample string 19"
          },
          {
            "DisputedAmount": 1.0,
            "InvAltTaxAmtItmLevel": 1.0,
            "InvAltTaxIdItmLevel": "sample string 1",
            "InvAltTaxRate": 1.0,
            "InvAltTaxType": "sample string 2",
            "InvAltTaxTypeApp": "sample string 3",
            "InvCommodityCode": "sample string 4",
            "InvDiscountPerItem": 1.0,
            "InvLineItemDiscountRate": 1.0,
            "InvLineItemTaxRate": 1.0,
            "InvLineItemTotal": 1.0,
            "InvLineItemVATTaxAmount": 1.0,
            "InvLineItemVATTaxRate": 1.0,
            "InvLocalTaxItmLevel": 1.0,
            "InvNationalTaxItmLevel": 1.0,
            "InvNetGrossIndicator": "sample string 5",
            "InvProductCode": "sample string 6",
            "InvProductName": "sample string 7",
            "InvProductSKU": "sample string 8",
            "InvPurchaseIDItmLevel": "sample string 9",
            "InvTaxAmount": 1.0,
            "InvUnitMeasure": "sample string 10",
            "ItemDesc": "sample string 11",
            "ItemFromDate": "sample string 12",
            "ItemNetAmount": "sample string 13",
            "ItemNum": "sample string 14",
            "ItemOrderQty": "sample string 15",
            "ItemQtyShipped": "sample string 16",
            "ItemQuantity": 1.0,
            "ItemToDate": "sample string 17",
            "ItemUnitPrice": "sample string 18",
            "ItemUnitPriceAmt": 1.0,
            "ItemQtyShippedNum": 1,
            "ItemNetAmountAmt": 1.0,
            "ItemExternalID": "sample string 19"
          }
        ],
        "DisplayField1": "sample string 15",
        "DisplayField2": "sample string 16",
        "DisplayField3": "sample string 17",
        "DisplayField4": "sample string 18",
        "DisplayField5": "sample string 19",
        "DisputedAmount": 1.0,
        "DueDate": "2026-06-18T21:44:03.2299498Z",
        "EIR": true,
        "EIRShouldPersist": true,
        "EIRTransmissionLogID": 1,
        "Email": "test3@test.com",
        "EntryField1": "sample string 22",
        "EntryField2": "sample string 23",
        "EntryField3": "sample string 24",
        "EntryField4": "sample string 25",
        "EntryField5": "sample string 26",
        "ExternalID": "sample string 28",
        "Fax": "sample string 30",
        "FDICode": "sample string 31",
        "FirstName": "sample string 32",
        "HasLevel3InDetails": true,
        "ID": 33,
        "InvoiceAge": 34,
        "InvoiceCategory": "Invoice",
        "InvAltTaxAmount": 1.0,
        "InvAltTaxAmtItmLevel": 1.0,
        "InvAltTaxIdItmLevel": "sample string 35",
        "InvAltTaxIDOrdLevel": "sample string 36",
        "InvAltTaxID": "sample string 37",
        "InvAltTaxRate": "sample string 38",
        "InvAltTaxType": "sample string 39",
        "InvAltTaxTypeApp": "sample string 40",
        "InvCommodityCode": "sample string 41",
        "InvCustomerCode": "sample string 42",
        "InvDestAddress1": "sample string 43",
        "InvDestAddress2": "sample string 44",
        "InvDestCardholderName": "sample string 45",
        "InvDestCity": "sample string 46",
        "InvDestCountryCode": "sample string 47",
        "InvDestStateCode": "sample string 48",
        "InvDestZipCode": "sample string 49",
        "InvDiscountPerItem": 1.0,
        "InvDutyAmount": 1.0,
        "InvFreightAmount": 1.0,
        "InvLineItemTotal": 1.0,
        "InvLineItemDiscountRate": "sample string 50",
        "InvLineItemTaxRate": "sample string 51",
        "InvLineItemVATTaxAmount": 1.0,
        "InvLineItemVATTaxRate": "sample string 52",
        "InvLocalTaxAmount": 1.0,
        "InvLocalTaxItmLevel": 1.0,
        "InvLocalTaxRate": "sample string 53",
        "InvMerchantVATRegistrationNumber": "sample string 54",
        "InvNationalTaxAmount": 1.0,
        "InvNationalTaxItmLevel": 1.0,
        "InvNationalTaxRate": "sample string 55",
        "InvNetGrossIndicator": "sample string 56",
        "InvOrderDisAmtOrdLevel": "sample string 57",
        "InvProductCode": "sample string 58",
        "InvProductName": "sample string 59",
        "InvProductSKU": "sample string 60",
        "InvPurchaseID": "sample string 61",
        "InvPurchaseIDItmLevel": "sample string 62",
        "InvPstTaxRegNum": "sample string 63",
        "InvRequestorName": "sample string 64",
        "InvQuantity": 1,
        "InvShipFromZipCode": "sample string 65",
        "InvSummaryCommodityCode": "sample string 66",
        "InvSupplierOrdRef": "sample string 67",
        "InvTaxAmount": 1.0,
        "InvTaxRate": "sample string 68",
        "InvUnitCost": 1.0,
        "InvUnitMeasure": "sample string 69",
        "InvVatRefNumber": "sample string 70",
        "InvVatRegNumber": "sample string 71",
        "InvVatTaxAmount": 1.0,
        "InvVatTaxRate": "sample string 72",
        "ItemQuantity": 1.0,
        "LastName": "sample string 76",
        "MerchantDescriptor": "sample string 77",
        "MerchantDescriptorAlt": "sample string 78",
        "MerchantDescriptorCity": "sample string 79",
        "MerchantDescriptorContact": "sample string 80",
        "MerchantDescriptorCountry": "sample string 81",
        "MerchantDescriptorState": "sample string 82",
        "MerchantDescriptorStreet": "sample string 83",
        "MerchantDescriptorZip": "sample string 84",
        "Message_OutstandingBalance": "sample string 85",
        "MiddleName": "sample string 86",
        "MinimumAmountDue": 1.0,
        "OtherData": "sample string 87",
        "PaymentInstrumentBlock": "sample string 88",
        "PaymentReceived": 1.0,
        "PaymentsPostedAsOfDate": "2026-06-18T21:44:03.245581Z",
        "PayThisAmount": 1.0,
        "Phone": "sample string 89",
        "Prev_0To30Days": 1.0,
        "Prev_30To60Days": 1.0,
        "Prev_60To90Days": 1.0,
        "Prev_90DaysPlus": 1.0,
        "PreviousBalance": 1.0,
        "Promise": {
          "PromiseDate": "2026-06-18T21:44:03.245581Z",
          "PromiseStatus": "Initiated"
        },
        "ReferenceNumber": "sample string 90",
        "RemainingAmount": 91.0,
        "State": "sample string 92",
        "StatementDate": "2026-06-18T21:44:03.245581Z",
        "Status": "Active",
        "TotalAccountBalance": 1.0,
        "WaiveFee": true,
        "Zip": "sample string 93"
      }
    }
  ],
  "Success": true
}