GET
/
v0
/
ledgers
/
{ap_ledger_id}
/
payables
/
{payable_id}
/
status
curl --request GET \
  --url https://api.sandbox.teal.dev/v0/ledgers/{ap_ledger_id}/payables/{payable_id}/status \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'
{
  "status": "open",
  "payments": [
    {
      "amount": "<string>",
      "line_entry_id": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

teal-instance-id
string
required

The Teal instance ID

Path Parameters

payable_id
string
required

The Payable ID

ap_ledger_id
string
required

The AP ledger ID

Query Parameters

tag_group_id
string
required

The ID of the tag group used to apply payments.

Response

200
application/json
Successful Response
status
enum<string>
required

The status of the receivable.

Available options:
open,
partially_paid,
paid
payments
object[]
required

A list of payments applied towards the receivable.