Skip to content

Get an org

Request

Returns a single org by its external ID. Implementation is required.

If multiple source tables are combined into the orgs entity, prefix the external_id with the source type to maintain uniqueness (e.g., vendor-123).

Security
OAuth2.0-Partner or Bearer-Token-Partner
Path
external_idstring, non-emptyrequired

The unique, immutable identifier for the entity in the FFS.

curl -i -X GET \
  'https://apidocs.bravotran.com/_mock/openapi/orgs/{external_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Org details

Bodyapplication/json
One of:
external_idstring, non-emptyrequired

Unique, immutable identifier for this org.

updated_atstring, (date-time)required

ISO 8601 timestamp of when this org was last updated.

namestring, non-emptyrequired

Full legal name of the org.

codestring, non-emptyrequired

Short code used to identify this org in the FFS UI.

is_activebooleanrequired

Whether this org is currently active.

is_creditorbooleanrequired

Whether this org can submit payables invoices.

is_debtorbooleanrequired

Whether this org will receive receivables invoices.

countrystring^[A-Z]{2}$required

ISO 3166-1 alpha-2 country code in uppercase, such as US or CH. The country determines how BravoTran reads dates on this org's invoices and whether BravoTran treats the org as a domestic vendor.

BravoTran rejects the org when country is missing or isn't a valid alpha-2 code, and the import of that org fails. Values such as us or USA are not corrected.

days_to_payinteger or null, [ 1 .. 31 ]

Payment scheduling parameter. For n_days_after_invoice_date, the number of days after the invoice date that payment is due. For day_n_month_after_invoice_date, the day of the month (in the month after the invoice date) that payment is due, from 1 to 31. Not used by the other rules. When null, BravoTran uses the account's default.

payments_scheduling_rulestring or nullrequired

Rule governing when payments are scheduled when this org is a creditor:

  • n_days_after_invoice_date — payment is due days_to_pay days after the invoice date (BravoTran may snap the date to the account's configured payment day of week)
  • day_n_month_after_invoice_date — payment is due on day days_to_pay of the month after the invoice date
  • eom_following_receipt — payment is due at the end of the month following the invoice date (despite the name, this is computed from the invoice date, not the receipt date)
  • always_ignore — payments for this creditor are always marked ignored and never scheduled
Enum:"n_days_after_invoice_date""eom_following_receipt""day_n_month_after_invoice_date""always_ignore"null
Value:"day_n_month_after_invoice_date"
address_line_1string or null

First line of the org's street address. BravoTran uses the street address, city, state, and postal code to match invoices to this org and to set up vendor payments.

Sending null leaves BravoTran's existing value unchanged; it doesn't clear it.

address_line_2string or null

Second line of the org's street address, such as a suite, floor, or building. Used with address_line_1 to match invoices to this org and to set up vendor payments.

Sending null leaves BravoTran's existing value unchanged; it doesn't clear it.

citystring or null

City of the org's address. Used to match invoices to this org and to set up vendor payments.

Sending null leaves BravoTran's existing value unchanged; it doesn't clear it.

statestring or null

State, province, or region of the org's address. Used to match invoices to this org and to set up vendor payments.

Sending null leaves BravoTran's existing value unchanged; it doesn't clear it.

postal_codestring or null

Postal or ZIP code of the org's address. Used to match invoices to this org and to set up vendor payments.

Sending null leaves BravoTran's existing value unchanged; it doesn't clear it.

contactsArray of objects(Contact)

Contact persons associated with this org. Helps BravoTran identify the creditor.

Response
{
  "external_id": "feaa09da-9551-47f8-b30d-6e303b6ad6d5",
  "updated_at": "2024-12-24T19:04:29Z",
  "name": "Mediterranean Shipping Company S.A.",
  "code": "MSC",
  "is_active": true,
  "is_creditor": true,
  "is_debtor": false,
  "country": "CH",
  "days_to_pay": 30,
  "payments_scheduling_rule": "n_days_after_invoice_date",
  "address_line_1": "Chemin Rieu 12",
  "address_line_2": null,
  "city": "Geneva",
  "state": null,
  "postal_code": "1202",
  "contacts": [
    { … },
    { … }
  ]
}