Get customer aging - Streamlined

GET

/

customers

/

{id}

/

aging

Get customer aging

curl --request GET \
  --url https://api.staging.streamlinedpayments.com/api/v1/customers/{id}/aging \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-App-Id: <api-key>'

const options = {method: 'GET', headers: {'X-App-Id': '<api-key>', 'X-Api-Key': '<api-key>'}};

fetch('https://api.staging.streamlinedpayments.com/api/v1/customers/{id}/aging', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.staging.streamlinedpayments.com/api/v1/customers/{id}/aging"

headers = {
    "X-App-Id": "<api-key>",
    "X-Api-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://api.staging.streamlinedpayments.com/api/v1/customers/{id}/aging")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-App-Id"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "currency": "USD",
  "total_receivables": 124900000,
  "overdue_receivables": 40200000,
  "credits": 120000,
  "invoice_count": 214,
  "buckets": {
    "not_yet_due": {
      "amount": 4020000,
      "invoice_count": 31
    },
    "between_1_and_30_days": {
      "amount": 4020000,
      "invoice_count": 31
    },
    "between_31_and_60_days": {
      "amount": 4020000,
      "invoice_count": 31
    },
    "between_61_and_90_days": {
      "amount": 4020000,
      "invoice_count": 31
    },
    "over_91_days": {
      "amount": 4020000,
      "invoice_count": 31
    }
  }
}

Authorizations

X-App-Id

string

header

required

App ID for authentication

X-Api-Key

string

header

required

API Key for authentication

Path Parameters

id

string<uuid>

required

The customer's UUID.

Response

Successful operation

currency

enum<string>

ISO currency code. Most resources support these. Products are limited to USD, CAD, EUR, GBP, AUD.

Available options:

USD,

CAD,

GBP,

EUR,

AUD,

JPY,

INR

total_receivables

integer

Everything owed, in cents. The sum of the buckets. Unapplied credit doesn't reduce it.

Example:

124900000

overdue_receivables

integer

The part of total_receivables past its due date, in cents.

Example:

40200000

credits

integer

Unapplied credit, in cents, as a positive number.

Example:

120000

invoice_count

integer

Number of invoices with something owed. An invoice paid in milestones can sit in two buckets, so the bucket counts can add up to more than this.

Example:

214

buckets

object

What's owed by how far past due, under the same names as an invoice's aging_status.

Show child attributes

Get customer aging

curl --request GET \
  --url https://api.staging.streamlinedpayments.com/api/v1/customers/{id}/aging \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-App-Id: <api-key>'

const options = {method: 'GET', headers: {'X-App-Id': '<api-key>', 'X-Api-Key': '<api-key>'}};

fetch('https://api.staging.streamlinedpayments.com/api/v1/customers/{id}/aging', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.staging.streamlinedpayments.com/api/v1/customers/{id}/aging"

headers = {
    "X-App-Id": "<api-key>",
    "X-Api-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://api.staging.streamlinedpayments.com/api/v1/customers/{id}/aging")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-App-Id"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "currency": "USD",
  "total_receivables": 124900000,
  "overdue_receivables": 40200000,
  "credits": 120000,
  "invoice_count": 214,
  "buckets": {
    "not_yet_due": {
      "amount": 4020000,
      "invoice_count": 31
    },
    "between_1_and_30_days": {
      "amount": 4020000,
      "invoice_count": 31
    },
    "between_31_and_60_days": {
      "amount": 4020000,
      "invoice_count": 31
    },
    "between_61_and_90_days": {
      "amount": 4020000,
      "invoice_count": 31
    },
    "over_91_days": {
      "amount": 4020000,
      "invoice_count": 31
    }
  }
}