Skip to main content
PATCH
/
companies
/
{company_id}
/
invoices
/
{uuid}
Update Invoice
curl --request PATCH \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/invoices/{uuid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "due_date": null,
  "metadata": {},
  "notes": null
}'
{
  "auto_charges": true,
  "billed_customer_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "currency": "<string>",
  "customer_id": "<string>",
  "due": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "due_date": "2023-11-07T05:31:56Z",
  "hosted_link": null,
  "invoice_date": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "number": "<string>",
  "paid": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "paid_date": null,
  "pdf_link": null,
  "prorated_amount": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "status": "<string>",
  "sub_total": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "subscription_id": null,
  "total": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "updated_at": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

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
​
due_date
string<date-time> | null

The due date of the invoice in RFC-3339 format as long as the invoice is not paid, partially paid or void

​
metadata
object

The metadata associated with the invoice for internal references as long as the invoice is not paid, partially paid or void

​
notes
string | null

The notes field of the invoice as long as the invoice is not paid, partially paid or void

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_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_id
string

The customer ID for the invoice

​
due
object

The total amount due on the invoice after any payments

​
due_date
string<date-time>

The date the invoice total is due

​
hosted_link
string | null

The hosted link for the invoice

​
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

The total amount paid against the invoice

​
paid_date
string<date-time> | null

The date the invoice was paid

​
pdf_link
string | null

The PDF link for the invoice

​
prorated_amount
object

Any prorated amounts for the invoice

​
status
string

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

​
sub_total
object

The subtotal of the invoice which is prior to applying credits

​
subscription_id
string | null

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

​
total
object

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

⌘I