Skip to main content
GET
/
v1
/
invoices
/
upcoming
Retrieve an upcoming invoice
curl --request GET \
  --url https://api.yorlet.com/v1/invoices/upcoming \
  --header 'Authorization: <api-key>'
{
  "id": "<string>",
  "created": 123,
  "object": "invoice",
  "application": "<string>",
  "assignee": "<string>",
  "billing_reason": "manual",
  "collection_method": "charge_automatically",
  "credit_grant": "<string>",
  "credit_grant_creation": {
    "enabled": true,
    "credit_grant_data": {
      "applicability_config": {
        "limits": {
          "max_credit_per_invoice_item": 123
        }
      },
      "name": "<string>"
    }
  },
  "currency": "<string>",
  "custom_fields": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "customer": "<string>",
  "customer_address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "country": "<string>",
    "postal_code": "<string>",
    "state": "<string>"
  },
  "customer_email": "<string>",
  "customer_name": "<string>",
  "default_payment_method": "<string>",
  "description": "<string>",
  "discount": {},
  "discount_amount": 123,
  "due_date": 123,
  "ending_balance": 123,
  "finalized_at": 123,
  "footer": "<string>",
  "from_invoice": {
    "action": "<string>",
    "invoice": "<string>"
  },
  "hosted_invoice_url": "<string>",
  "issuer": {
    "type": "owner",
    "owner": "<string>"
  },
  "last_finalization_error": {
    "code": "<string>",
    "message": "<string>"
  },
  "late_payment_failure_invoice": "<string>",
  "latest_revision": "<string>",
  "marked_uncollectible_at": 123,
  "next_payment_attempt": 123,
  "number": "<string>",
  "number_transfer_reference": "<string>",
  "off_platform_reference": "<string>",
  "optimized_collection_date": 123,
  "optimized_collection_reason": "bacs_debit",
  "paid": true,
  "paid_at": 123,
  "paid_off_platform": true,
  "payment_settings": {
    "payment_method_types": [
      "autogiro"
    ]
  },
  "period": {
    "end": 123,
    "start": 123
  },
  "source_dispute": "<string>",
  "starting_balance": 123,
  "status": "draft",
  "subscription": "<string>",
  "transaction": "<string>",
  "transfer_error": {
    "message": "<string>",
    "reason": "<string>"
  },
  "voided_at": 123,
  "line_items": [
    {
      "id": "<string>",
      "created": 123,
      "object": "invoice_item",
      "amount": 123,
      "apply_after": 123,
      "credit_amount": 123,
      "currency": "<string>",
      "customer": "<string>",
      "description": "<string>",
      "discount_amount": 123,
      "invoice": "<string>",
      "price_data": {
        "amount": 123,
        "currency": "<string>",
        "recurring": {
          "interval": "<string>",
          "interval_count": 123
        },
        "tax_percent": 50,
        "type": "recurring"
      },
      "price": "<string>",
      "proration_amount": 123,
      "tax_percent": 50,
      "total_credit_grant_amount": 123,
      "transfer_destination": "<string>",
      "type": "charge",
      "unit": "<string>",
      "account": "<string>",
      "deleted": false,
      "metadata": {},
      "transfer_behavior": "automatic"
    }
  ],
  "account": "<string>",
  "deleted": false,
  "amount_due": 0,
  "amount_paid": 0,
  "amount_remaining": 0,
  "applied_balance": 0,
  "apply_customer_balance": false,
  "attempt_count": 0,
  "attempted": false,
  "auto_advance": false,
  "late_payment_failure": false,
  "metadata": {},
  "part_payment_amount": 0,
  "pending_part_payment": false,
  "pending_transaction": false,
  "post_payment_credit_notes_amount": 0,
  "pre_payment_credit_notes_amount": 0,
  "subtotal": 0,
  "tax": 0,
  "total": 0,
  "total_excluding_tax": 0,
  "total_pretax_credit_amounts": [],
  "total_tax_amounts": [],
  "transfer_data": []
}

Authorizations

Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Response

200 - application/json

Retrieve an upcoming invoice

id
string
required

Unique identifier for the object.

created
number
required

Time at which the object was created. Measured in seconds since the Unix epoch.

object
enum<string>
required
Available options:
invoice
application
string | null
required
assignee
string | null
required
billing_reason
enum<string> | null
required
Available options:
manual,
subscription,
partial_payment,
null
collection_method
enum<string> | null
required
Available options:
charge_automatically,
send_invoice,
null
credit_grant
required
credit_grant_creation
object
required
currency
string
required
custom_fields
object[] | null
required
Maximum array length: 4
customer
required
customer_address
object
required
customer_email
string | null
required
customer_name
string | null
required
default_payment_method
string | null
required
description
string | null
required
discount
object
required
discount_amount
number
required
due_date
integer | null
required

Must be a Unix timestamp in UTC time.

ending_balance
number
required
finalized_at
integer | null
required

Must be a Unix timestamp in UTC time.

from_invoice
object
required
hosted_invoice_url
string | null
required
issuer
object
required
last_finalization_error
object
required
late_payment_failure_invoice
string | null
required
latest_revision
string | null
required
marked_uncollectible_at
integer | null
required

Must be a Unix timestamp in UTC time.

next_payment_attempt
integer | null
required

Must be a Unix timestamp in UTC time.

number
string | null
required
number_transfer_reference
string | null
required
off_platform_reference
string | null
required
optimized_collection_date
integer | null
required

Must be a Unix timestamp in UTC time.

optimized_collection_reason
enum<string> | null
required
Available options:
bacs_debit,
days_before_collection,
null
paid
boolean
required
paid_at
integer | null
required

Must be a Unix timestamp in UTC time.

paid_off_platform
boolean
required
payment_settings
object
required
period
object
required
source_dispute
string | null
required
starting_balance
number
required
status
enum<string>
required
Available options:
draft,
open,
paid,
uncollectible,
void
subscription
string | null
required
transaction
required
transfer_error
object
required
voided_at
integer | null
required

Must be a Unix timestamp in UTC time.

line_items
object[] | null
required
account
string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

deleted
boolean
default:false

Only returned if the object has been deleted.

amount_due
number
default:0
amount_paid
number
default:0
amount_remaining
number
default:0
applied_balance
number
default:0
apply_customer_balance
boolean
default:false
attempt_count
number
default:0
attempted
boolean
default:false
auto_advance
boolean
default:false
late_payment_failure
boolean
default:false
metadata
object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

part_payment_amount
number
default:0
pending_part_payment
boolean
default:false
pending_transaction
boolean
default:false
post_payment_credit_notes_amount
number
default:0
pre_payment_credit_notes_amount
number
default:0
subtotal
number
default:0
tax
number
default:0
total
number
default:0
total_excluding_tax
number
default:0
total_pretax_credit_amounts
any[]
total_tax_amounts
object[]
transfer_data
any[]