Skip to content
/
Update an invoice

Resolve API Reference (V5)

API Support: accounts@resolvepay.com

Legacy (v2) API documentation: https://app.resolvepay.com/docs/api/v2

Download OpenAPI description
swagger.json
swagger.yaml
Languages
Servers
Mock server
https://api-docs.resolvepay.com/_mock/swagger
Sandbox server
https://app-sandbox.resolvepay.com/api

Introduction

The Resolve API is organized around REST principles. It uses predictable resource-oriented URLs, standard HTTP verbs and response codes, and accepts and returns JSON-encoded request and response bodies.

Getting started

Resolve offers both server-side and client-side integrations. This documentation refers to the server-side API. Refer to our e-commerce plugin guides for details on client-side checkout solutions.

There is a sandbox API available for testing, which leverages the same data store as your sandbox dashboard. Testing on sandbox won't affect your live data or create money movements.

Environment Base URL
Production https://app.resolvepay.com/api/
Sandbox https://app-sandbox.resolvepay.com/api/

Authentication

Before using the API, reach out and get your Resolve account created. This account enables access to the credentials that are necessary for API access.

Resolve uses HTTP basic authentication where the username refers to your merchant ID, and the password refers to your secret API key.

Versioning and Upgrading

When backwards-incompatible changes are released, a new, dated version is released. The current version is V5. You can upgrade the version of the api that your account uses within your merchant settings.

Legacy (v2) API documentation may be found here.

Rate Limits

To ensure platform reliability and fair use, Resolve implements rate limits for the REST API.

Resolve APIs use the Sliding Window algorithm to monitor and control request rates with a 100 requests/minute limit. The API will return a 429 Too Many Requests status if the amount of requests exceeds rate limits.

All responses from Resolve APIs will include the following headers:

  • X-Ratelimit-Limit: The maximum amount of requests permitted within a 60-second period.
  • X-Ratelimit-Remaining: The remaining requests within the current period.
  • X-Ratelimit-Reset: A UNIX timestamp indicating when the rate limit period will reset.

Best Practices

  • Use caching when necessary for data that is routinely requested by your application.
  • Utilize the X-Ratelimit-Limit and X-Ratelimit-Remaining response headers in your application to avoid surpassing rate limits.
  • Your application should avoid making additional API requests if your requests return with a 429 status code.

Webhooks

Webhooks allow you to receive real-time notifications about events in your Resolve account. When an event occurs, Resolve sends an HTTP POST request to your configured webhook endpoint with details about the event.

Operations

Invoices

The invoice represents the business transaction between you and your customer. In Resolve, an invoice must be tied to a customer and an advance can be taken on the invoice.

For an advance to be taken on the invoice, a PDF of the invoice must be uploaded and the associated customer must be approved and have available credit for the amount of the invoice.

Operations

List all invoices

Request

Return a list of invoices.

Security
basicAuth
Query
limitinteger[ 25 .. 100 ]

Limit the number of invoices returned.

Default 25
pagestring

Specify the page of invoices returned.

Default "1"
filterobject

Filter invoices by the specified fields.

Filter semantics: filter[field][operator]=value.

Available filter operators:

  • eq - equal (=)
  • ne - not equal (!=)
  • gt - greater than (>)
  • gte - greater than or equal (>=)
  • lt - less than (<)
  • lte - less than or equal (<=)

Filtering is allowed by the following fields:

  • number (eq)
  • order_number (eq)
  • po_number (eq)
  • customer_id (eq)
  • advance_requested (eq)
  • created_at (eq, gt, lt, gte, lte)
  • fully_paid (eq, ne)
  • fully_paid_at (eq, gt, lt, gte, lte)
  • amount_due (eq, gt, lt, gte, lte)
  • amount_balance (eq, gt, lt, gte, lte)
  • amount_pending (eq, gt, lt, gte, lte)
  • amount_refunded (eq, gt, lt, gte, lte)
  • archived (eq, ne)

Example: filter[number][eq]=100

Note: filter with the eq operator is equivalent to the following filter filter[field]=value

curl -i -X GET \
  -u <username>:<password> \
  'https://api-docs.resolvepay.com/_mock/swagger/invoices?limit=25&page=1&filter%5Bnumber%5D=%5Bobject+Object%5D&filter%5Border_number%5D=%5Bobject+Object%5D&filter%5Bpo_number%5D=%5Bobject+Object%5D&filter%5Bcustomer_id%5D=%5Bobject+Object%5D&filter%5Bcreated_at%5D=%5Bobject+Object%5D&filter%5Bfully_paid%5D=%5Bobject+Object%5D&filter%5Bfully_paid_at%5D=%5Bobject+Object%5D&filter%5Bamount_due%5D=%5Bobject+Object%5D&filter%5Bamount_balance%5D=%5Bobject+Object%5D&filter%5Bamount_pending%5D=%5Bobject+Object%5D&filter%5Bamount_refunded%5D=%5Bobject+Object%5D&filter%5Barchived%5D=%5Bobject+Object%5D'

Responses

An object with an array of results containing up to the limit. If no invoices are found, the results array will be empty.

Bodyapplication/json
countinteger
Example: 1
limitinteger
Example: 25
pageinteger
Example: 1
resultsArray of objects(Invoice)
Response
application/json
{
  "count": 1,
  "limit": 25,
  "page": 1,
  "results": [
    { … }
  ]
}

Create an invoice

Request

Create a new advanced or non-advanced invoice with the desired terms.

Security
basicAuth
Bodyapplication/json

Invoice to add to the system.

termsstring

The terms selected for this invoice. Terms selected must be available on your account and different terms will be available based on advance_requested.

Enum"due_upon_receipt""net7""net10""net10th""net15""net20""net30""net45""net60""net75"
Example: "due_upon_receipt"
merchant_invoice_urlstring(url)required

URL for the publicly-accessible invoice PDF.

Example: "https://example.com/invoice.pdf"
numberstringrequired

Invoice number identifier.

Example: "R334-097"
order_numberstring

Order number identifier.

Example: "09785"
po_numberstring

PO number identifier.

Example: "PO-09785"
notesstring

Additional notes for the Customer

Example: "Example of additional notes for Customer."
customer_idstringrequired

ID of the customer being charged

Example: "X50sgfRd"
advance_requestedboolean

The type of invoice. This will determine if this is an advanced or non-advanced invoice.

Example: "false"
amountnumber(double)required

Amount being charged from the customer

Example: 2000
curl -i -X POST \
  -u <username>:<password> \
  https://api-docs.resolvepay.com/_mock/swagger/invoices \
  -H 'Content-Type: application/json' \
  -d '{
    "terms": "due_upon_receipt",
    "merchant_invoice_url": "https://example.com/invoice.pdf",
    "number": "R334-097",
    "order_number": "09785",
    "po_number": "PO-09785",
    "notes": "Example of additional notes for Customer.",
    "customer_id": "X50sgfRd",
    "advance_requested": "false",
    "amount": 2000
  }'

Responses

An object representing an invoice.

Bodyapplication/json
idstring

Unique identifier for the invoice.

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

ID of the customer being charged.

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 arrays

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
Response
application/json
{
  "id": "PMMlaE5wbg0",
  "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
}

Fetch an invoice

Request

Retrieve an existing invoice by its ID.

Security
basicAuth
Path
invoice_idstringrequired

ID of the invoice to retrieve

curl -i -X GET \
  -u <username>:<password> \
  'https://api-docs.resolvepay.com/_mock/swagger/invoices/{invoice_id}'

Responses

An object representing an invoice.

Bodyapplication/json
idstring

Unique identifier for the invoice.

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

ID of the customer being charged.

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 arrays

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
Response
application/json
{
  "id": "PMMlaE5wbg0",
  "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
}

Update an invoice

Request

Update an invoice.

Security
basicAuth
Path
invoice_idstringrequired

ID of the invoice to update

Bodyapplication/json

Fields to update an invoice with. Please note, allowed fields depend on whether or not the invoice has been sent.

One of:
termsstring

The terms selected for this invoice. Terms selected must be available on your account and different terms will be available based on advance_requested.

Enum"due_upon_receipt""net7""net10""net10th""net15""net20""net30""net45""net60""net75"
Example: "due_upon_receipt"
merchant_invoice_urlstring(url)

URL for the publicly-accessible invoice PDF.

Example: "https://example.com/invoice.pdf"
numberstring

Invoice number identifier.

Example: "R334-097"
order_numberstring

Order number identifier.

Example: "09785"
po_numberstring

PO number identifier.

Example: "PO-09785"
notesstring

Additional notes for the Customer

Example: "Example of additional notes for Customer."
customer_idstring

ID of the customer being charged

Example: "X50sgfRd"
advance_requestedboolean

The type of invoice. This will determine if this is an advanced or non-advanced invoice.

Example: "false"
amountnumber(double)

Amount being charged from the customer

Example: 2000
curl -i -X PUT \
  -u <username>:<password> \
  'https://api-docs.resolvepay.com/_mock/swagger/invoices/{invoice_id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "terms": "due_upon_receipt",
    "merchant_invoice_url": "https://example.com/invoice.pdf",
    "number": "R334-097",
    "order_number": "09785",
    "po_number": "PO-09785",
    "notes": "Example of additional notes for Customer.",
    "customer_id": "X50sgfRd",
    "advance_requested": "false",
    "amount": 2000
  }'

Responses

An object representing an invoice.

Bodyapplication/json
idstring

Unique identifier for the invoice.

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

ID of the customer being charged.

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 arrays

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
Response
application/json
{
  "id": "PMMlaE5wbg0",
  "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
}

Delete an invoice

Request

Delete an invoice.

Security
basicAuth
Path
invoice_idstringrequired

ID of the invoice to delete

curl -i -X DELETE \
  -u <username>:<password> \
  'https://api-docs.resolvepay.com/_mock/swagger/invoices/{invoice_id}'

Responses

An object representing an invoice.

Bodyapplication/json
idstring

Unique identifier for the invoice.

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

ID of the customer being charged.

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 arrays

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
Response
application/json
{
  "id": "PMMlaE5wbg0",
  "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
}

Send an invoice

Request

Send an invoice to the customer.

Security
basicAuth
Path
invoice_idstringrequired

ID of the invoice to send

curl -i -X PUT \
  -u <username>:<password> \
  'https://api-docs.resolvepay.com/_mock/swagger/invoices/{invoice_id}/send'

Responses

An object representing an invoice.

Bodyapplication/json
idstring

Unique identifier for the invoice.

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

ID of the customer being charged.

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 arrays

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
Response
application/json
{
  "id": "PMMlaE5wbg0",
  "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
}

Void an invoice

Request

Void an invoice.

Security
basicAuth
Path
invoice_idstringrequired

ID of the invoice to void

curl -i -X POST \
  -u <username>:<password> \
  'https://api-docs.resolvepay.com/_mock/swagger/invoices/{invoice_id}/void'

Responses

An object representing an invoice.

Bodyapplication/json
idstring

Unique identifier for the invoice.

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

ID of the customer being charged.

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 arrays

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
Response
application/json
{
  "id": "PMMlaE5wbg0",
  "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
}

Cancel an invoice

Request

Cancel an invoice.

Security
basicAuth
Path
invoice_idstringrequired

ID of the invoice to cancel

curl -i -X POST \
  -u <username>:<password> \
  'https://api-docs.resolvepay.com/_mock/swagger/invoices/{invoice_id}/cancel'

Responses

An object representing an invoice.

Bodyapplication/json
idstring

Unique identifier for the invoice.

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

ID of the customer being charged.

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 arrays

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
Response
application/json
{
  "id": "PMMlaE5wbg0",
  "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
}

Customers

A customer represents a company that you do business with. For larger companies, there may be several users with access to the customer account that can make purchases with their credit line. For smaller companies, a customer may represent a single individual. Retrieve a customer to get a summary of their total credit line and available credit balance.

Operations

Payouts

A Payout is a transfer of money between the Merchant and Resolve.

Operations

Payout Transactions

Payout Transactions are the individual transactions like customer payments, Resolve advances, forwarded payments, etc. that are rolled into a Payout. Each Payout is the sum of one or more transactions. Note that certain fields are only relevant to certain transaction types - e.g.: a Payout Transaction of type monthly_fee will have both customer_id and invoice_id set to null.

Operations

Payments

A payment represents a transaction where a customer pays towards their invoices. When a payment is made to Resolve, the customer's available credit balance is increased by the amount of the payment. Payments can be made via various methods including ACH, credit card, check, or wire transfer. Each payment can be applied to one or more invoices.

Operations

Credit Notes

Credit Notes are issued to customers to reduce the amount they owe.

Operations

Shipments

A shipment represents the fulfillment of goods or services for an invoice. Track shipments to monitor delivery status and fulfillment progress. Shipments can be fulfilled through various methods including shipping providers, self-delivery, customer pickup, or for services-only transactions.

Operations