Class SpendingAccounts

Index

Methods

As Create Delete DeleteAssignment Get List ListAssignments Patch Save SaveAssignment

Methods

As

As(): this
Returns this
Description
enables impersonation by calling the subsequent method with the stored impersonation token
Example
```
SpendingAccounts.As().List() // lists SpendingAccounts using the impersonated users' token
```
- Defined in api/SpendingAccounts.ts:252

Create

Create<TSpendingAccount extends SpendingAccount<any>>(
    buyerID: string,
    spendingAccount: SpendingAccount,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TSpendingAccount>>
Create a spending account Check out the docs for more info
Type Parameters
- TSpendingAccount extends SpendingAccount<any>
Parameters
- buyerID: string
  ID of the buyer.
- spendingAccount: SpendingAccount
  Required fields: Name, Balance
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TSpendingAccount>>
- Defined in api/SpendingAccounts.ts:70

Delete

Delete(
    buyerID: string,
    spendingAccountID: string,
    requestOptions?: RequestOptions,
): Promise<void>
Delete a spending account Check out the docs for more info
Parameters
- buyerID: string
  ID of the buyer.
- spendingAccountID: string
  ID of the spending account.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<void>
- Defined in api/SpendingAccounts.ts:137

DeleteAssignment

DeleteAssignment(
    buyerID: string,
    spendingAccountID: string,
    listOptions?: { userGroupID?: string; userID?: string },
    requestOptions?: RequestOptions,
): Promise<void>
Delete a spending account assignment Check out the docs for more info
Parameters
- buyerID: string
  ID of the buyer.
- spendingAccountID: string
  ID of the spending account.
- listOptions: { userGroupID?: string; userID?: string } = {}
  - OptionaluserGroupID?: string
    
    ID of the user group.
  - OptionaluserID?: string
    
    ID of the user.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<void>
- Defined in api/SpendingAccounts.ts:184

Get

Get<TSpendingAccount extends SpendingAccount<any>>(
    buyerID: string,
    spendingAccountID: string,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TSpendingAccount>>
Retrieve a spending account Check out the docs for more info
Type Parameters
- TSpendingAccount extends SpendingAccount<any>
Parameters
- buyerID: string
  ID of the buyer.
- spendingAccountID: string
  ID of the spending account.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TSpendingAccount>>
- Defined in api/SpendingAccounts.ts:92

List

List<TSpendingAccount extends SpendingAccount<any>>(
    buyerID: string,
    listOptions?: {
        filters?: Filters;
        page?: number;
        pageSize?: number;
        search?: string;
        searchOn?: ("ID" | "Name")[];
        sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TSpendingAccount>>>
List spending accounts Check out the docs for more info
Type Parameters
- TSpendingAccount extends SpendingAccount<any>
Parameters
- buyerID: string
  ID of the buyer.
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "Name")[];
      sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
  } = {}
  - Optionalfilters?: Filters
    
    An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
  - Optionalpage?: number
    
    Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - Optionalsearch?: string
    
    Word or phrase to search for.
  - OptionalsearchOn?: ("ID" | "Name")[]
    
    Comma-delimited list of fields to search on.
  - OptionalsortBy?: ("ID" | "Name" | "!ID" | "!Name")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredObjectDeep<ListPage<TSpendingAccount>>>
- Defined in api/SpendingAccounts.ts:48

ListAssignments

ListAssignments<TSpendingAccountAssignment extends SpendingAccountAssignment>(
    buyerID: string,
    listOptions?: {
        level?: PartyType;
        page?: number;
        pageSize?: number;
        spendingAccountID?: string;
        userGroupID?: string;
        userID?: string;
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TSpendingAccountAssignment>>>
List spending account assignments Check out the docs for more info
Type Parameters
- TSpendingAccountAssignment extends SpendingAccountAssignment
Parameters
- buyerID: string
  ID of the buyer.
- listOptions: {
      level?: PartyType;
      page?: number;
      pageSize?: number;
      spendingAccountID?: string;
      userGroupID?: string;
      userID?: string;
  } = {}
  - Optionallevel?: PartyType
    
    Level of the spending account assignment. Possible values: User, Group, Company, BuyerGroup.
  - Optionalpage?: number
    
    Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - OptionalspendingAccountID?: string
    
    ID of the spending account.
  - OptionaluserGroupID?: string
    
    ID of the user group.
  - OptionaluserID?: string
    
    ID of the user.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredObjectDeep<ListPage<TSpendingAccountAssignment>>>
- Defined in api/SpendingAccounts.ts:211

Patch

Patch<TSpendingAccount extends SpendingAccount<any>>(
    buyerID: string,
    spendingAccountID: string,
    spendingAccount: PartialDeep<SpendingAccount>,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TSpendingAccount>>
Partially update a spending account Check out the docs for more info
Type Parameters
- TSpendingAccount extends SpendingAccount<any>
Parameters
- buyerID: string
  ID of the buyer.
- spendingAccountID: string
  ID of the spending account.
- spendingAccount: PartialDeep<SpendingAccount>
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TSpendingAccount>>
- Defined in api/SpendingAccounts.ts:160

Save

Save<TSpendingAccount extends SpendingAccount<any>>(
    buyerID: string,
    spendingAccountID: string,
    spendingAccount: SpendingAccount,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TSpendingAccount>>
Create or update a spending account If an object with the same ID already exists, it will be overwritten. Check out the docs for more info
Type Parameters
- TSpendingAccount extends SpendingAccount<any>
Parameters
- buyerID: string
  ID of the buyer.
- spendingAccountID: string
  ID of the spending account.
- spendingAccount: SpendingAccount
  Required fields: Name, Balance
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TSpendingAccount>>
- Defined in api/SpendingAccounts.ts:115

SaveAssignment

SaveAssignment(
    buyerID: string,
    spendingAccountAssignment: SpendingAccountAssignment,
    requestOptions?: RequestOptions,
): Promise<void>
Create or update a spending account assignment Check out the docs for more info
Parameters
- buyerID: string
  ID of the buyer.
- spendingAccountAssignment: SpendingAccountAssignment
  Required fields: SpendingAccountID
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<void>
- Defined in api/SpendingAccounts.ts:233

Class SpendingAccounts

Index

Methods

Methods

As

Returns this

Description

Example

Create

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TSpendingAccount>>

Delete

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<void>

DeleteAssignment

Parameters

OptionaluserGroupID?: string

OptionaluserID?: string

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<void>

Get

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TSpendingAccount>>

List

Type Parameters

Parameters

Optionalfilters?: Filters

Optionalpage?: number

OptionalpageSize?: number

Optionalsearch?: string

OptionalsearchOn?: ("ID" | "Name")[]

OptionalsortBy?: ("ID" | "Name" | "!ID" | "!Name")[]

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredObjectDeep<ListPage<TSpendingAccount>>>

ListAssignments

Type Parameters

Parameters

Optionallevel?: PartyType

Optionalpage?: number

OptionalpageSize?: number

OptionalspendingAccountID?: string

OptionaluserGroupID?: string

OptionaluserID?: string

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredObjectDeep<ListPage<TSpendingAccountAssignment>>>

Patch

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TSpendingAccount>>

Save

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TSpendingAccount>>

SaveAssignment

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`userGroupID?: string

`Optional`userID?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`filters?: Filters

`Optional`page?: number

`Optional`pageSize?: number

`Optional`search?: string

`Optional`searchOn?: ("ID" | "Name")[]

`Optional`sortBy?: ("ID" | "Name" | "!ID" | "!Name")[]

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`level?: PartyType

`Optional`page?: number

`Optional`pageSize?: number

`Optional`spendingAccountID?: string

`Optional`userGroupID?: string

`Optional`userID?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string