Counterparty Upsert Many Ep

POST 
/v1/counterparty/upsert_many

Upsert Counterparty

Creates or updates counterparty information based on provided identifier(s) or name.

Required Scopes (ia.w)

Request

id: str | None = None
Internal identifier for the counterparty. If provided, updates the counterparty with this ID.

---

source_id: str | None = None
If received from integration, the identifier inside the source system.

---

source_system_id: str | None = None
If received from integration, the source system identifier.

---

sourcing_strategy: str | None = None
Different options for a counterparty to control supply on order generation. Supported sourcing strategies are Specific Supply, Tank Supply Default, Use Best, and Manual.

---

name: str
The unique counterparty name. If provided, updates the counterparty with this name.

---

types: list[CounterpartyType]
Indicates all the counterparty’s types or roles. Controls the counterparty’s behavior in the system.

Show Types

Carrier
A counterparty that acts as a carrier.

Internal
An internal counterparty.

Supplier
A supplier of fuel.

Customer
A customer of fuel.

Other
Any other type of counterparty.

---

trailer_config: str | None = None
If applicable, the trailer configuration associated with the counterparty.

---

emails: list[EmailStr] = []
List of the counterparty’s emails.

---

supply_map: list[SourceMap] = None
List of source_system and source_id mappings. Used for eBOL process.

Details

Show SourceMap Attributes

source_system: str
System name.

source_id: str
ID in the source system.

---

extra_data: dict | None = None
Any additional data provided or managed by the client through integration endpoints.

---

goid: str | None = None
Beta: Gravitate Object ID. Used for integration with Crossroads

Show Deprecated

carrier_type: str | None = None
Deprecated. If the counterparty has type Carrier in types, specifies the type of carrier, which can be Simple, Managed, or Other. A counterparty can have only one carrier type.

---

available_credit: float | None = None
The amount of available credit for the counterparty.

---

hold: bool | None = False
Indicates if the counterparty is on credit hold or not.

Response

created: int
Number of created counterparties.

---

updated: int
Number of updated counterparties.

---

errors: list
Any records on the upsert that errored, detailing the cause of the error.

Responses

200

Successful Response

422

Validation Error

application/json

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...