Hanzo AI

List clearance

Lists the caller org's clearances, newest first, 200 at most; a payee narrows them.

GET /v1/principal/clearance

Addresshttps://api.hanzo.ai/v1/principal/clearance
MethodGET
Operationget_principal_clearance
AuthAuthorization: Bearer $HANZO_API_KEY

Lists the caller org's clearances, newest first, 200 at most; a payee narrows them. Any member of the paying org.

Request

1 field.

FieldInTypeRequiredDescription
payeequerystring—Payee narrows to one payee.

Response

StatusBodyMeaning
200principal.clearanceListok
defaultproblem-detailsrefused

200 body — 59 fields.

FieldInTypeAlwaysDescription
clearancesbodyprincipal.Clearance[]—
clearances[].allowedbodyboolean—
clearances[].amountbodystring—Amount is the gross amount, U.S. dollars.
clearances[].categorybodystring—Category is what is bought: services, attorney, rents, royalties, other or merchandise.
clearances[].decidedAtbodyinteger (int64)—DecidedAt is when, unix seconds.
clearances[].facts_requiredbodyprincipal.Fact[]—
clearances[].facts_required[].blocksbodyboolean—Blocks is whether the payment waits on it.
clearances[].facts_required[].codebodystring—Code is the fact's stable name.
clearances[].facts_required[].questionbodystring—Question is what must be answered.
clearances[].facts_required[].rulebodyprincipal.Rule—
clearances[].facts_required[].rule.codebodystring—Code is the rule's stable name, for a caller that branches on it.
clearances[].facts_required[].rule.reasonbodystring—Reason is the rule, stated.
clearances[].idbodystring—ID is the clearance, "clr_"-prefixed.
clearances[].noticebodystring—Notice is what a clearance is and is not.
clearances[].payeebodystring—Payee is the org to be paid.
clearances[].payerbodystring—Payer is the caller's org.
clearances[].performedbodystring—Performed is where the service is performed, as stated.
clearances[].platformbodyboolean—Platform is whether the caller operates the payee's platform, as stated.
clearances[].railbodystring—Rail is how it moves.
clearances[].reporting_obligationsbodyprincipal.Obligation[]—
clearances[].reporting_obligations[].authoritybodystring—Authority is who it is filed with.
clearances[].reporting_obligations[].codebodystring—Code is the obligation's stable name.
clearances[].reporting_obligations[].duebodystring—Due is when.
clearances[].reporting_obligations[].filerbodystring—Filer is the org that files it.
clearances[].reporting_obligations[].formbodystring—Form is what is filed.
clearances[].reporting_obligations[].jurisdictionbodystring—Jurisdiction is where, ISO 3166-1 alpha-2 or "EU".
clearances[].reporting_obligations[].rulebodyprincipal.Rule—
clearances[].reporting_obligations[].rule.codebodystring—Code is the rule's stable name, for a caller that branches on it.
clearances[].reporting_obligations[].rule.reasonbodystring—Reason is the rule, stated.
clearances[].reporting_obligations[].whenbodystring—When is the condition it is owed on, when it is owed on one.
clearances[].required_before_paymentbodyprincipal.Step[]—
clearances[].required_before_payment[].codebodystring—Code is the step's stable name, for a caller that branches on it.
clearances[].required_before_payment[].rulebodyprincipal.Rule—
clearances[].required_before_payment[].rule.codebodystring—Code is the rule's stable name, for a caller that branches on it.
clearances[].required_before_payment[].rule.reasonbodystring—Reason is the rule, stated.
clearances[].required_before_payment[].whatbodystring—What must happen, in words.
clearances[].required_before_payment[].wherebodystring—Where it is done, when it is done on this platform.
clearances[].required_before_payment[].whobodystring—Who does it: payer, payee, or "Hanzo platform reviewer".
clearances[].rulesbodyprincipal.Decided[]—
clearances[].rules[].fieldbodystring—
clearances[].rules[].rulebodyprincipal.Rule—
clearances[].rules[].rule.codebodystring—Code is the rule's stable name, for a caller that branches on it.
clearances[].rules[].rule.reasonbodystring—Reason is the rule, stated.
clearances[].settlement_methodsbodyprincipal.Method[]—
clearances[].settlement_methods[].netbodystring—Net is what the payee receives, U.S. dollars.
clearances[].settlement_methods[].railbodystring—Rail is the rail: ledger or chain.
clearances[].settlement_methods[].rulebodyprincipal.Rule—
clearances[].settlement_methods[].rule.codebodystring—Code is the rule's stable name, for a caller that branches on it.
clearances[].settlement_methods[].rule.reasonbodystring—Reason is the rule, stated.
clearances[].settlement_methods[].withheldbodystring—Withheld is what the payer keeps back and deposits itself, U.S. dollars.
clearances[].statusbodystring—
clearances[].withholdingbodyprincipal.Withholding—
clearances[].withholding.amountbodystring—Amount is the amount to withhold, U.S. dollars; empty when the rate is.
clearances[].withholding.chapterbodystring—Chapter is "3" (IRC chapter 3, a payment to a foreign person) or "backup" (IRC §3406), and empty when nothing is withheld or it cannot yet be decided.
clearances[].withholding.ratebodystring—Rate is the rate in percent: "30", "24", "10", "0".
clearances[].withholding.reasonbodystring—Reason says why, in words.
clearances[].withholding.rulebodyprincipal.Rule—
clearances[].withholding.rule.codebodystring—Code is the rule's stable name, for a caller that branches on it.
clearances[].withholding.rule.reasonbodystring—Reason is the rule, stated.

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.


Principal API · All Hanzo APIs · Interactive reference

How is this guide?

On this page