API changelog

As part of an ongoing effort to better align the documentation with the API, we’ve corrected several response schemas. These changes affect the documentation only; the API was already returning this data.

Corrected nullable fields on vendor responses

Several VendorQueryRecord fields can return null and are now documented as nullable — including Address1, Address2, City, State, Zip, Country, Contacts, BillingData, PaymentMethod, EnrollmentStatus, Summary, the remit* and payee* fields, and the enrichment fields (CardAccepted, AchAccepted, CheckAccepted, EnrichedBy, EnrichedAt, EnrichmentId). The response’s always-present fields are now marked required. This affects:

• Get vendor
• List vendors by paypoint
• List vendors by organization

Corrected additionalData type on bill, vendor, payout, and user responses

The AdditionalData field was documented as a string on several response fields, but the API returns an object. This affects the following endpoints:

• Get bill — AdditionalData
• Get vCard — associatedVendor.additionalData
• List payouts by paypoint and by organization — Bills[].AdditionalData
• List payout subscriptions by paypoint and by organization — BillData[].AdditionalData
• List users by paypoint and by organization — AdditionalData

The AdditionalData field was also changed from a string to an object for the following endpoints’ request bodies:

• Add bill
• Update bill
• Create payout subscription request bodies.

Corrected BillDate/DueDate format on bill responses

BillDate and DueDate were documented as a date (YYYY-MM-DD), but the API always returns a full timestamp. We changed the documentation to reflect this. This affects the following endpoints:

• Get bill
• List bills by paypoint and by organization