Skip to main content

​
Tango AP Outbound API

Generated from Tango AP Outbound API Integration Design Specification V1.4.docx in SharePoint folder 02 Lease Integrations. OAS spec: ap-outbound-api.yaml

​
Overview

Async REST API used by the client to fetch approved lease payments from Tango. Two-call pattern: GET initiating call returns a gu_id; GET on /v1/batch/status with that gu_id (and optional page_no) returns paginated payment records (5000/page). Owner: Tango Analytics Spec version: 1.4 Status: Draft (auto-generated — needs review)

​
Base URLs

​
Authentication

Headers x-client + x-api-key.

​
Endpoints

​
GET /v1/leasemgmt/payments

Optional query params: Response — 200 OK

​
GET /v1/batch/status?gu_id=...&page_no=...

Default page_no = 1, page size 5000. Header carries total_records, total_pages, page_size, page_no. Null fields are omitted from the JSON.

​
Integration logic

  • Only approved batches and payments associated with Active leases are returned.
  • Zero-dollar payments are excluded.
  • pay_id == lease_payment_id in the AP Inbound payload (reconciliation key).
  • After successful export the payments are flagged accordingly in Tango.

​
Data model

Required fields per the source data-mapping table (✅ = required):

​
Open Questions / Assumptions

  • No synchronous error response shape documented for the initial GET — assumed it returns the same envelope without a gu_id.
  • year and mon field types: the data mapping says NUMBER, but the response example wraps them in quotes ("year": "2020"). Treated as integers in the schema.
  • Lookup codes are <TBD> in source Appendix.
  • payext1 is missing from the JSON sample (jumps from cattr16 to payext2); confirmed via mapping table that there is no payext1 field.
  • Pagination: page size 5000 appears non-configurable.

​
Changelog