Skip to main content
POST
Mark Invoice As Paid

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Scopes

Headers

Idempotency-Key
string

The idempotency key that will be used to ensure the request is only performed once

Path Parameters

company_id
string
required

The company ID with the prefix 'cmp_'.

uuid
string
required

The resource UUID

Body

application/json
amount
object | null
required

The amount paid against the invoice

provider_type
enum<string>
required

The payment mechanism used for the payment against the invoice which can be one of WIRE, CHEQUE, CASH, CREDIT_CARD_OFFLINE, BILL_COM, STRIPE, BANK_TRANSFER or INTERNAL

Available options:
WIRE,
CHEQUE,
CASH,
CREDIT_CARD_OFFLINE,
BILL_COM,
STRIPE,
BANK_TRANSFER,
INTERNAL
notes
null | string

Any additional notes related to the payment such as transaction number or cheque number

paid_date
null | string<date-time>

The date of payment against the invoice

Response

200 - application/json

OK

auto_charges
boolean

Whether the invoice is automatically charged to the payment method on file for the customer

billed_customer
object

The expanded billed customer details for the invoice

billed_customer_id
string

The billed customer ID for the invoice. This matches the customer_id by default, but can be set to another parent customer ID

created_at
string<date-time>

The date the invoice was created

currency
string

The currency of the invoice

customer
object

The expanded customer details for the invoice

customer_id
string

The customer ID for the invoice

due
object | null

The total amount due on the invoice after any payments

due_date
string<date-time>

The date the invoice total is due

The hosted link for the invoice. Includes a 1-day authentication token in the URL query parameter.

invoice_date
string<date-time>

The date for the invoice

name
string

The name of the invoice

number
string

The invoice number for the invoice

paid
object | null

The total amount paid against the invoice

paid_date
null | string<date-time>

The date the invoice was paid

The PDF link for the invoice. Includes a 1-day authentication token in the URL query parameter.

prorated_amount
object | null

Any prorated amounts for the invoice

refunded_amount
object | null

The total amount refunded against the invoice

revenue
object | null

The revenue amount of the invoice (total minus credits)

status
string

The status of the invoice such as PAID, DRAFT, VOID or PENDING

sub_total
object | null

The amount before tax. It holds each line but customer credits. Those come off the amount due after tax.

subscription_id
null | string

The subscription ID for the invoice, if is not a one-time invoice

total
object | null

The final total of the invoice after applying all credits, discounts and taxes

updated_at
string<date-time>

The last date the invoice was updated

uuid
string

The unique identifier for the invoice