Fetch AR aging detail for a customer

curl --request GET \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/invoices/ar-aging/customer/{customerId} \
  --header 'Authorization: Bearer <token>'

{
  "type": "AR_Aging_Customer_Detail",
  "as_of_date": "2023-11-07T05:31:56Z",
  "customer": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "31415926535",
    "individual_name": "<string>",
    "company_name": "<string>",
    "email": "<string>",
    "mobile_phone": "<string>",
    "office_phone": "<string>",
    "address_string": "<string>",
    "memo": "<string>",
    "status": "ACTIVE",
    "transaction_tags": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "key": "ExampleTagKey",
        "value": "ExampleTagValue",
        "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dimension_display_name": "<string>",
        "value_display_name": "<string>",
        "archived_at": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "buckets": [
    {
      "start_day_number": 123,
      "end_day_number": 123,
      "outstanding_value": 123
    }
  ],
  "current": 123,
  "days_1_30": 123,
  "days_31_60": 123,
  "days_61_90": 123,
  "days_91_over": 123,
  "total": 123
}

GET

businesses

{businessId}

invoices

ar-aging

customer

{customerId}

Fetch AR aging detail for a customer

curl --request GET \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/invoices/ar-aging/customer/{customerId} \
  --header 'Authorization: Bearer <token>'

{
  "type": "AR_Aging_Customer_Detail",
  "as_of_date": "2023-11-07T05:31:56Z",
  "customer": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "31415926535",
    "individual_name": "<string>",
    "company_name": "<string>",
    "email": "<string>",
    "mobile_phone": "<string>",
    "office_phone": "<string>",
    "address_string": "<string>",
    "memo": "<string>",
    "status": "ACTIVE",
    "transaction_tags": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "key": "ExampleTagKey",
        "value": "ExampleTagValue",
        "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dimension_display_name": "<string>",
        "value_display_name": "<string>",
        "archived_at": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "buckets": [
    {
      "start_day_number": 123,
      "end_day_number": 123,
      "outstanding_value": 123
    }
  ],
  "current": 123,
  "days_1_30": 123,
  "days_31_60": 123,
  "days_61_90": 123,
  "days_91_over": 123,
  "total": 123
}

Authorizations

Authorization

string

header

required

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

Headers

Content-Type

string

Content-Type must be set to application/json

Path Parameters

businessId

string<uuid>

required

The UUID of the business to fetch the AR aging detail for

customerId

string<uuid>

required

The UUID of the customer to fetch AR aging detail for

Query Parameters

effective_date

string<date-time>

The date to calculate aging from. Invoices are aged based on their due date relative to this date. Defaults to today if not specified. ISO 8601 date format.

Response

AR aging customer detail retrieved successfully

Detailed AR aging information for a specific customer

type

enum<string>

Type identifier for this response

Available options:

AR_Aging_Customer_Detail

as_of_date

string<date-time> | null

The effective date used to calculate aging buckets

customer

object

The customer details

Show child attributes

customer.id

string<uuid>

Unique identifier for the customer.

customer.external_id

string

Unique ID of the customer in your system for linking purposes. Idempotency key.

Example:

"31415926535"

customer.individual_name

string | null

Full name of the individual customer or contact at a corporate customer.

customer.company_name

string | null

Name of the company customer.

customer.email

string | null

Email address of the customer.

customer.mobile_phone

string | null

Mobile phone number of the customer.

customer.office_phone

string | null

Office phone number of the customer.

customer.address_string

string | null

Address of the customer.

customer.memo

string | null

Memo for any text you would like to associate with the customer (for example, to display to end users).

customer.status

string

Status of the customer. Possible values: ACTIVE, ARCHIVED.

Example:

"ACTIVE"

customer.transaction_tags

object[]

Show child attributes

customer.transaction_tags.id

string<uuid>

required

ID for the tag

customer.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

customer.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

customer.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

customer.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

customer.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

customer.transaction_tags.value_display_name

string | null

Display name for the tag value definition

customer.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

buckets

object[]

Detailed breakdown of outstanding balances by aging bucket

Show child attributes

buckets.start_day_number

integer | null

Start day of the aging bucket (e.g., 1 for 1-30 days). Null for current/not-yet-due invoices.

buckets.end_day_number

integer | null

End day of the aging bucket (e.g., 30 for 1-30 days). Null for open-ended buckets (e.g., 91+ days).

buckets.outstanding_value

integer<int64>

Outstanding balance for this aging bucket in cents

current

integer<int64>

Total outstanding balance for invoices not yet past due in cents

days_1_30

integer<int64>

Total outstanding balance for invoices 1-30 days past due in cents

days_31_60

integer<int64>

Total outstanding balance for invoices 31-60 days past due in cents

days_61_90

integer<int64>

Total outstanding balance for invoices 61-90 days past due in cents

days_91_over

integer<int64>

Total outstanding balance for invoices 91+ days past due in cents

total

integer<int64>

Total outstanding balance across all aging buckets in cents

Fetch AR aging report Vendor object

⌘I

Businesses

Financial Activity

Accounting Reports

Platform Configuration

Activity Metrics

Quickbooks

Fetch AR aging detail for a customer

Authorizations

Headers

Path Parameters

Query Parameters

Response