Class SpendingAccounts

Hierarchy

SpendingAccounts

Index

Properties

impersonating

Methods

As Create Delete DeleteAssignment Get List ListAssignments Patch Save SaveAssignment

Properties

`Private` impersonating

impersonating: boolean = false

Methods

As

As(): SpendingAccounts
Description
enables impersonation by calling the subsequent method with the stored impersonation token

Example
```
SpendingAccounts.As().List() // lists SpendingAccounts using the impersonated users' token
```
Returns SpendingAccounts
- Defined in api/SpendingAccounts.ts:252

Create

Create<TSpendingAccount>(buyerID: string, spendingAccount: SpendingAccount<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TSpendingAccount>>
Create a new spending account. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. Check out the docs for more info
Type Parameters
- TSpendingAccount extends SpendingAccount<any, TSpendingAccount>
Parameters
- buyerID: string
  
  ID of the buyer.
- spendingAccount: SpendingAccount<any>
  
  Required fields: Name, Balance
- requestOptions: RequestOptions = {}
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 = {}
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;
  } = {}
  - Optional userGroupID?: string
    
    ID of the user group.
  - Optional userID?: string
    
    ID of the user.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/SpendingAccounts.ts:184

Get

Get<TSpendingAccount>(buyerID: string, spendingAccountID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TSpendingAccount>>
Get a single spending account. Check out the docs for more info
Type Parameters
- TSpendingAccount extends SpendingAccount<any, TSpendingAccount>
Parameters
- buyerID: string
  
  ID of the buyer.
- spendingAccountID: string
  
  ID of the spending account.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TSpendingAccount>>
- Defined in api/SpendingAccounts.ts:92

List

List<TSpendingAccount>(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>>>
Get a list of spending accounts. Check out the docs for more info
Type Parameters
- TSpendingAccount extends SpendingAccount<any, TSpendingAccount>
Parameters
- buyerID: string
  
  ID of the buyer.
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "Name")[];
      sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
  } = {}
  - Optional filters?: 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.???'
  - Optional page?: number
    
    Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - Optional pageSize?: number
    
    Number of results to return per page. Default: 20, max: 100.
  - Optional search?: string
    
    Word or phrase to search for.
  - Optional searchOn?: ("ID" | "Name")[]
    
    Comma-delimited list of fields to search on.
  - Optional sortBy?: ("ID" | "Name" | "!ID" | "!Name")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TSpendingAccount>>>
- Defined in api/SpendingAccounts.ts:48

ListAssignments

ListAssignments<TSpendingAccountAssignment>(buyerID: string, listOptions?: {
    level?: PartyType;
    page?: number;
    pageSize?: number;
    spendingAccountID?: string;
    userGroupID?: string;
    userID?: string;
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TSpendingAccountAssignment>>>
Get a list of 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;
  } = {}
  - Optional level?: PartyType
    
    Level of the spending account assignment. Possible values: User, Group, Company.
  - Optional page?: number
    
    Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - Optional pageSize?: number
    
    Number of results to return per page. Default: 20, max: 100.
  - Optional spendingAccountID?: string
    
    ID of the spending account.
  - Optional userGroupID?: string
    
    ID of the user group.
  - Optional userID?: string
    
    ID of the user.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TSpendingAccountAssignment>>>
- Defined in api/SpendingAccounts.ts:211

Patch

Patch<TSpendingAccount>(buyerID: string, spendingAccountID: string, spendingAccount: PartialObjectDeep<SpendingAccount<any>>, requestOptions?: RequestOptions): Promise<RequiredDeep<TSpendingAccount>>
Partially update a spending account. Check out the docs for more info
Type Parameters
- TSpendingAccount extends SpendingAccount<any, TSpendingAccount>
Parameters
- buyerID: string
  
  ID of the buyer.
- spendingAccountID: string
  
  ID of the spending account.
- spendingAccount: PartialObjectDeep<SpendingAccount<any>>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TSpendingAccount>>
- Defined in api/SpendingAccounts.ts:160

Save

Save<TSpendingAccount>(buyerID: string, spendingAccountID: string, spendingAccount: SpendingAccount<any>, 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, TSpendingAccount>
Parameters
- buyerID: string
  
  ID of the buyer.
- spendingAccountID: string
  
  ID of the spending account.
- spendingAccount: SpendingAccount<any>
  
  Required fields: Name, Balance
- requestOptions: RequestOptions = {}
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 = {}
Returns Promise<void>
- Defined in api/SpendingAccounts.ts:233

Class SpendingAccounts

Hierarchy

Index

Properties

Methods

Properties

Private impersonating

Methods

As

Description

Example

Returns SpendingAccounts

Create

Type Parameters

TSpendingAccount extends SpendingAccount<any, TSpendingAccount>

Parameters

buyerID: string

spendingAccount: SpendingAccount<any>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TSpendingAccount>>

Delete

Parameters

buyerID: string

spendingAccountID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

DeleteAssignment

Parameters

buyerID: string

spendingAccountID: string

listOptions: { userGroupID?: string; userID?: string; } = {}

Optional userGroupID?: string

Optional userID?: string

requestOptions: RequestOptions = {}

Returns Promise<void>

Get

Type Parameters

TSpendingAccount extends SpendingAccount<any, TSpendingAccount>

Parameters

buyerID: string

spendingAccountID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TSpendingAccount>>

List

Type Parameters

TSpendingAccount extends SpendingAccount<any, TSpendingAccount>

Parameters

buyerID: string

listOptions: { filters?: Filters; page?: number; pageSize?: number; search?: string; searchOn?: ("ID" | "Name")[]; sortBy?: ("ID" | "Name" | "!ID" | "!Name")[]; } = {}

Optional filters?: Filters

Optional page?: number

Optional pageSize?: number

Optional search?: string

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

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

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TSpendingAccount>>>

ListAssignments

Type Parameters

TSpendingAccountAssignment extends SpendingAccountAssignment

Parameters

buyerID: string

listOptions: { level?: PartyType; page?: number; pageSize?: number; spendingAccountID?: string; userGroupID?: string; userID?: string; } = {}

Optional level?: PartyType

Optional page?: number

Optional pageSize?: number

Optional spendingAccountID?: string

Optional userGroupID?: string

Optional userID?: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TSpendingAccountAssignment>>>

Patch

Type Parameters

TSpendingAccount extends SpendingAccount<any, TSpendingAccount>

Parameters

buyerID: string

spendingAccountID: string

spendingAccount: PartialObjectDeep<SpendingAccount<any>>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TSpendingAccount>>

`Private` impersonating

listOptions: {
userGroupID?: string;
userID?: string;
} = {}

`Optional` userGroupID?: string

`Optional` userID?: string

listOptions: {
filters?: Filters;
page?: number;
pageSize?: number;
search?: string;
searchOn?: ("ID" | "Name")[];
sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
} = {}

`Optional` filters?: Filters

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

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

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

listOptions: {
level?: PartyType;
page?: number;
pageSize?: number;
spendingAccountID?: string;
userGroupID?: string;
userID?: string;
} = {}

`Optional` level?: PartyType

`Optional` page?: number

`Optional` pageSize?: number

`Optional` spendingAccountID?: string

`Optional` userGroupID?: string

`Optional` userID?: string