V3 Manage Warehouse Details

Manage external organization warehouse details.

Usage Notes

  • This API requires the Edit Warehouse Banks persona access. Configure your persona setting located in the following Encompass settings: Company/User Setup > Personas > External Settings > Company Details > TPO Organization Settings > Warehouse Tab > Edit Warehouse Banks.
  • When the action parameter is not passed while invoking the API, the default action will be considered as update.
  • See the following conditional requirements for each action type:
  • warehouse.warehouseDetails.bank.entityId required when action = add & update.
  • warehouse.warehouseDetails.id required when action = update & delete.
  • bank.entityName is readOnly when action = add, update & delete.
  • bank.entityType is readOnly when action = add, update & delete.
  • All date fields have validations related to Min and Max value. Allowed date range is 01/01/1900 to 12/31/2199.
  • Once the warehouse record is deleted, the warehouse record will be deleted from the database, but the bank information will not be deleted.
  • If at least one record is having errors in the request payload, the API will fail with error.
Path Params
string
required

Organization ID. Required

Query Params
string

Supported actions: Add, Update, Delete

string

Optional. View type parameter. Enumerations: entity, id
When no view parameter is provided, the API will return 204 - No Content with no response body.

Body Params
string

Indicates the bank assigned as the warehouse of the TPO company.

integer

Unique identifier of the warehouse bank.

string

Status date of the warehouse bank. Date format: yyyy-MM-dd
To clear the value of the statusDate, the user needs to pass the null value explicitly.

boolean

Indicates if the warehouse bank is approved for the TPO Company

string

Account number of the particular warehouse bank of TPO company.

string

Account name of the particular warehouse bank of TPO company. Maximum length is 256 characters.

string

Credit account number of the particular warehouse bank of the TPO company.

string

Credit account name of the particular warehouse bank of the TPO company.

string

Description of the particular warehouse bank of the TPO company.

string

The bailee expiration deadline date. Date format: yyyy-MM-dd

boolean

Indicates if the correspondent warehouse bank is a self-funding bank.

boolean

Indicates if the correspondent warehouse bank bailee letter is required.

boolean

Indicates if the correspondent warehouse bank tri-party contact contract is included.

contact
object

Indicates if the correspondent warehouse bank tri-party contact contract is included.

string

The correspondent warehouse bank note field contents.

Headers
string
required

Bearer token

Responses

400

Bad Request

Language
URL
Response
Choose an example:
application/json