Skip to content
Partners API/
/
Cancel an invoice

Cancel an invoice

Request

Cancel an invoice.

Security
bearerAuth or basicAuth
Path
invoice_idstringrequired

ID of the invoice to cancel

curl -i -X POST \
  'https://docs.resolvepay.com/_mock/partners-api/openapi/invoices/{invoice_id}/cancel' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

An object representing an invoice.

Bodyapplication/json
idstring

Unique identifier for the invoice.

Example:"PMMlaE5wbg0"
merchant_idstring

ID of the sub-merchant this invoice belongs to.

Example:"MER456789"
sourcestring
Enum:"QUICKBOOKS""MERCHANT_USER""ADMIN_USER""CUSTOMER_USER""API"
Example:"MERCHANT_USER"
customer_idstring

ID of the customer being charged. For marketplace partners, the customer belongs to the partner. For single-merchant partners, the customer belongs to the sub-merchant.

order_numberstring

Order number identifier.

Example:"5055"
numberstring

Invoice number identifier.

Example:"Inv # 123"
po_numberstring

PO number identifier.

Example:"PO-555"
notesstring

Additional notes for the Customer

Example:"Example of additional notes for Customer."
line_itemsArray of any

Line item data

Example:
[]
merchant_invoice_urlstring

The invoice PDF that you've uploaded to Resolve.

Example:"https://www.example.com/invoice.pdf"
resolve_invoice_urlstring

Resolve-issued invoice PDF with your invoice attached.

Example:"https://www.example.com/resolve-invoice.pdf"
resolve_invoice_statusstring

Shows current status of the Resolve-issued invoice PDF.

  • not_generated - PDF wasn't created or queued for creation. Resolve PDFs are generated when an invoice is sent.
  • processing - PDF is in the process of being generated. Try to refetch the invoice in a minute to get a resolve_invoice_url link.
  • completed - PDF is generated, resolve_invoice_url points to the generated file.
Enum:"not_generated""processing""completed"
Example:"completed"
fully_paidboolean

Indicates whether the invoice is fully paid.

Example:true
fully_paid_atstring, (date-time)

The date the invoice has been fully paid.

Example:"2020-01-01T00:00:00.730Z"
advancedboolean

Indicates whether the invoice has been advanced.

Example:false
due_atstring, (date-time)

The current due date for this invoice's payment.

Example:"2020-02-01T00:00:00.750Z"
original_due_atstring, (date-time)

The due date for this invoice at the time an advance was issued.

Example:"2020-02-01T00:00:00.750Z"
invoiced_atstring, (date-time)

The date this invoice was created in your system of record (Resolve or Quickbooks).

Example:"2020-01-01T00:00:00.750Z"
advance_requestedboolean

Indicated if advance was requested.

Example:"false"
termsstring

The terms selected for this invoice.

Enum:"due_upon_receipt""net7""net10""net10th""net15""net20""net30""net45""net60""net75"
amount_payout_duenumber, (double)

The original amount that Resolve owed on this invoice on the advance date.

Example:4000
amount_payout_paidnumber, (double)

The amount that Resolve has paid out.

Example:2000
amount_payout_pendingnumber, (double)

The amount that Resolve has currently pending to be paid out.

Example:1000
amount_payout_refundednumber, (double)

The amount that Resolve has debited from due to refunds.

Example:500
amount_payout_balancenumber, (double)

The amount remaining to be paid out.

Example:500
payout_fully_paidboolean

The status of whether or not this invoice has been fully paid out.

Example:false
payout_fully_paid_atstring, (date-time)

The date of when this invoice has been fully paid out.

Example:"2020-01-02T00:00:00.730Z"
amount_balancenumber, (double)

Current balance due.

Example:2000
amount_duenumber, (double)

Original amount due.

Example:4000
amount_refundednumber, (double)

Amount that has been refunded.

Example:0
amount_pendingnumber, (double)

Amount of total payments pending.

Example:1000
amount_paidnumber, (double)

Amount of total payments applied to this invoice.

Example:1000
amount_advancenumber, (double)

Amount of advance received.

Example:4000
amount_additional_advancenumber, (double)

Amount of additional advance received.

Example:1000
amount_advance_feenumber, (double)

Fee for the amount of advance.

Example:10.75
amount_advance_fee_refundnumber, (double)

Refunded fees for the amount of advance.

Example:10.75
advance_ratenumber, (double), [ 0 .. 1 ]

The advance rate that was used to determine amount of advance.

Example:0.75
advanced_atstring, (date-time)

The date this invoice was advanced.

Example:"2020-01-02T00:00:00.730Z"
amount_customer_fee_totalnumber, (double)

The total amount of customer fees accrued.

Example:500
amount_customer_fee_waivednumber, (double)

The total amount of customer fees waived.

Example:120
amount_customer_fee_paidnumber, (double)

The total amount of customer fees paid.

Example:300
amount_customer_fee_balancenumber, (double)

The current amount of customer fees owed.

Example:80
created_atstring, (date-time)

Date the invoice was created.

Example:"2020-01-02T00:00:00.730Z"
updated_atstring, (date-time)

Date the invoice was last updated.

Example:"2020-01-02T00:00:00.730Z"
archivedboolean

Boolean indicating if invoice is archived.

Example:false
invoice_payment_urlstring

Link to make invoice payments.

Example:"https://app.resolvepay.com/merchant/invoices/PMMlaE5wbg0"
canceledboolean

Indicates whether the invoice is canceled.

Example:false
canceled_atstring, (date-time)

Date the invoice was canceled.

Example:null
voidedboolean

Indicates whether the invoice is voided.

Example:false
voided_atstring, (date-time)

Date the invoice was voided.

Example:null
amount_cancelednumber, (double)

Amount that has been canceled.

Example:0
amount_voidednumber, (double)

Amount that has been voided.

Example:0
amount_schedulednumber, (double)

Amount of scheduled payments.

Example:0
statusstring

Current payment status of the invoice.

sent_atstring, (date-time)

Date the invoice was sent.

Example:"2020-01-01T00:00:00.730Z"
Response
{
  "id": "PMMlaE5wbg0",
  "merchant_id": "MER456789",
  "source": "MERCHANT_USER",
  "customer_id": "string",
  "order_number": "5055",
  "number": "Inv # 123",
  "po_number": "PO-555",
  "notes": "Example of additional notes for Customer.",
  "line_items": [],
  "merchant_invoice_url": "https://www.example.com/invoice.pdf",
  "resolve_invoice_url": "https://www.example.com/resolve-invoice.pdf",
  "resolve_invoice_status": "completed",
  "fully_paid": true,
  "fully_paid_at": "2020-01-01T00:00:00.730Z",
  "advanced": false,
  "due_at": "2020-02-01T00:00:00.750Z",
  "original_due_at": "2020-02-01T00:00:00.750Z",
  "invoiced_at": "2020-01-01T00:00:00.750Z",
  "advance_requested": "false",
  "terms": "due_upon_receipt",
  "amount_payout_due": 4000,
  "amount_payout_paid": 2000,
  "amount_payout_pending": 1000,
  "amount_payout_refunded": 500,
  "amount_payout_balance": 500,
  "payout_fully_paid": false,
  "payout_fully_paid_at": "2020-01-02T00:00:00.730Z",
  "amount_balance": 2000,
  "amount_due": 4000,
  "amount_refunded": 0,
  "amount_pending": 1000,
  "amount_paid": 1000,
  "amount_advance": 4000,
  "amount_additional_advance": 1000,
  "amount_advance_fee": 10.75,
  "amount_advance_fee_refund": 10.75,
  "advance_rate": 0.75,
  "advanced_at": "2020-01-02T00:00:00.730Z",
  "amount_customer_fee_total": 500,
  "amount_customer_fee_waived": 120,
  "amount_customer_fee_paid": 300,
  "amount_customer_fee_balance": 80,
  "created_at": "2020-01-02T00:00:00.730Z",
  "updated_at": "2020-01-02T00:00:00.730Z",
  "archived": false,
  "invoice_payment_url": "https://app.resolvepay.com/merchant/invoices/PMMlaE5wbg0",
  "canceled": false,
  "canceled_at": null,
  "voided": false,
  "voided_at": null,
  "amount_canceled": 0,
  "amount_voided": 0,
  "amount_scheduled": 0,
  "status": "string",
  "sent_at": "2020-01-01T00:00:00.730Z"
}