REresolvepay
Invoices

Void an invoice

Void an invoice.

post/invoices/{invoice_id}/void

Request

Path parameters

invoice_idstring required

ID of the invoice to void

Response

An object representing an invoice.

idstring

Unique identifier for the invoice.

merchant_idstring

ID of the sub-merchant this invoice belongs to.

source'QUICKBOOKS' | 'MERCHANT_USER' | 'ADMIN_USER' | 'CUSTOMER_USER' | 'API'
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.

numberstring

Invoice number identifier.

po_numberstring

PO number identifier.

notesstring

Additional notes for the Customer

merchant_invoice_urlstring

The invoice PDF that you've uploaded to Resolve.

resolve_invoice_urlstring

Resolve-issued invoice PDF with your invoice attached.

resolve_invoice_status'not_generated' | 'processing' | 'completed'

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.
fully_paidboolean

Indicates whether the invoice is fully paid.

fully_paid_atstring date-time

The date the invoice has been fully paid.

advancedboolean

Indicates whether the invoice has been advanced.

due_atstring date-time

The current due date for this invoice's payment.

original_due_atstring date-time

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

invoiced_atstring date-time

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

advance_requestedboolean

Indicated if advance was requested.

terms'due_upon_receipt' | 'net7' | 'net10' | 'net10th' | 'net15' | 'net20' | 'net30' | 'net45' | 'net60' | 'net75' | 'net90' | 'net120' | 'net180'

The terms selected for this invoice.

amount_payout_duenumber double

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

amount_payout_paidnumber double

The amount that Resolve has paid out.

amount_payout_pendingnumber double

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

amount_payout_refundednumber double

The amount that Resolve has debited from due to refunds.

amount_payout_balancenumber double

The amount remaining to be paid out.

payout_fully_paidboolean

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

payout_fully_paid_atstring date-time

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

amount_balancenumber double

Current balance due.

amount_duenumber double

Original amount due.

amount_refundednumber double

Amount that has been refunded.

amount_pendingnumber double

Amount of total payments pending.

amount_paidnumber double

Amount of total payments applied to this invoice.

amount_advancenumber double

Amount of advance received.

amount_additional_advancenumber double

Amount of additional advance received.

amount_advance_feenumber double

Fee for the amount of advance.

amount_advance_fee_refundnumber double

Refunded fees for the amount of advance.

advance_ratenumber double

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

advanced_atstring date-time

The date this invoice was advanced.

amount_customer_fee_totalnumber double

The total amount of customer fees accrued.

amount_customer_fee_waivednumber double

The total amount of customer fees waived.

amount_customer_fee_paidnumber double

The total amount of customer fees paid.

amount_customer_fee_balancenumber double

The current amount of customer fees owed.

created_atstring date-time

Date the invoice was created.

updated_atstring date-time

Date the invoice was last updated.

archivedboolean

Boolean indicating if invoice is archived.

invoice_payment_urlstring

Link to make invoice payments.

canceledboolean

Indicates whether the invoice is canceled.

canceled_atstring date-time

Date the invoice was canceled.

voidedboolean

Indicates whether the invoice is voided.

voided_atstring date-time

Date the invoice was voided.

amount_cancelednumber double

Amount that has been canceled.

amount_voidednumber double

Amount that has been voided.

amount_schedulednumber double

Amount of scheduled payments.

statusstring

Current payment status of the invoice.

sent_atstring date-time

Date the invoice was sent.

Example response

{
  "id": "PMMlaE5wbg0",
  "merchant_id": "MER456789",
  "source": "MERCHANT_USER",
  "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",
  "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",
  "amount_payout_due": 4000,
  "amount_payout_paid": 2000,
  "amount_payout_pending": 1000,
  "amount_payout_refunded": 500,
  "amount_payout_balance": 500,
  "payout_fully_paid_at": "2020-01-02T00:00:00.730Z",
  "amount_balance": 2000,
  "amount_due": 4000,
  "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",
  "invoice_payment_url": "https://app.resolvepay.com/merchant/invoices/PMMlaE5wbg0",
  "sent_at": "2020-01-01T00:00:00.730Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.