Function SimpleContractsApiFp

Returns {
    apiSimpleContractsContractIdPut(contractId: string, simpleContractUpdateDeets?: SimpleContractUpdateDeets, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SimpleContract>)>;
    apiSimpleContractsDelete(contractId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    getSimpleContracts(activeOnly?: boolean, limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SimpleContractListResponse>)>;
    simpleContractPayments(id: string, limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentCycleListResponse>)>;
    simpleContractsDeleteAvatar(id: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    simpleContractsGetAvatarById(id: string, userId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    simpleContractsGETByAccountAndId(accountId: string, contractId: string, specificRevision?: number, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SimpleContract>)>;
    simpleContractsGETById(id: string, specificRevision?: number, userId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SimpleContract>)>;
    simpleContractsPOST(simpleContractCreateDeets?: SimpleContractCreateDeets, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SimpleContract>)>;
    simpleContractsPOSTAccept(id: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SimpleContract>)>;
    simpleContractsPOSTArchive(id: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SimpleContract>)>;
    simpleContractsPOSTDecline(id: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SimpleContract>)>;
    simpleContractsUpdateAvatar(id: string, file?: File, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    simpleContractsUpdateAvatarByDeets(id: string, userId?: string, avatarBytes?: AvatarBytes, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    simpleContractsUpdateAvatarByPrompt(id: string, avatarPromptCreateDeets?: AvatarPromptCreateDeets, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
}

• apiSimpleContractsContractIdPut:function

  • apiSimpleContractsContractIdPut(contractId, simpleContractUpdateDeets?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SimpleContract>)>

  • summary Update a SimpleContract

    Parameters

    • contractId: string

      the ContractId of the Contract (not the Id property)
    • OptionalsimpleContractUpdateDeets: SimpleContractUpdateDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SimpleContract>)>

    Throws

• apiSimpleContractsDelete:function

  • apiSimpleContractsDelete(contractId?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • summary Delete a SimpleContract

    Parameters

    • OptionalcontractId: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Throws

• getSimpleContracts:function

  • getSimpleContracts(activeOnly?, limit?, page?, userId?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SimpleContractListResponse>)>

  • SimpleContracts are a lighter-weight version of the standard contracts. Contracts are core to the Mozaic API, they contain Income objects which have child terms used to specify the rules of how income should be split or sent to payees.

    summary List all SimpleContracts

    Parameters

    • OptionalactiveOnly: boolean

      If true only active SimpleContracts will be returned
    • Optionallimit: number

      A limit of the number of objects to be returned for the next page, between 1 and 100. The default is 25
    • Optionalpage: number

      1-based page index for paginated results
    • OptionaluserId: string

      The user id to operate on their behalf (tenants only)
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SimpleContractListResponse>)>

    Throws

• simpleContractPayments:function

  • simpleContractPayments(id, limit?, page?, userId?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentCycleListResponse>)>

  • summary Retrieve a list of all related payments

    Parameters

    • id: string
    • Optionallimit: number

      A limit of the number of objects to be returned for the next page, between 1 and 100. The default is 25
    • Optionalpage: number

      1-based page index for paginated results
    • OptionaluserId: string

      The user id to operate on their behalf (tenants only)
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentCycleListResponse>)>

    Throws

• simpleContractsDeleteAvatar:function

  • simpleContractsDeleteAvatar(id, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • summary Reset avatar to the default

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Throws

• simpleContractsGetAvatarById:function

  • simpleContractsGetAvatarById(id, userId?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • summary Retrieve an avatar by id

    Parameters

    • id: string

      The id of the record you wish to retrieve
    • OptionaluserId: string

      The user id to operate on their behalf (tenants only)
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Throws

• simpleContractsGETByAccountAndId:function

  • simpleContractsGETByAccountAndId(accountId, contractId, specificRevision?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SimpleContract>)>

  • Returns a single `SimpleContract` object based on the specified id

    summary Retrieve a SimpleContract by accountID and contract ID

    Parameters

    • accountId: string

      The id of the account that holds the simple contract
    • contractId: string

      The id of the SimpleContract you want to retrieve
    • OptionalspecificRevision: number

      Optional revision number of the contract to retrieve
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SimpleContract>)>

    Throws

• simpleContractsGETById:function

  • simpleContractsGETById(id, specificRevision?, userId?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SimpleContract>)>

  • Returns a single `SimpleContract` object based on the specified id

    summary Retrieve a SimpleContract

    Parameters

    • id: string

      The id of the record you wish to retrieve
    • OptionalspecificRevision: number
    • OptionaluserId: string

      The user id to operate on their behalf (tenants only)
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SimpleContract>)>

    Throws

• simpleContractsPOST:function

  • simpleContractsPOST(simpleContractCreateDeets?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SimpleContract>)>

  • Used to create new SimpleContracts or link to a existing SimpleContract group

    summary Create a SimpleContract

    Parameters

    • OptionalsimpleContractCreateDeets: SimpleContractCreateDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SimpleContract>)>

    Throws

• simpleContractsPOSTAccept:function

  • simpleContractsPOSTAccept(id, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SimpleContract>)>

  • summary Accept the specified SimpleContract

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SimpleContract>)>

    Throws

• simpleContractsPOSTArchive:function

  • simpleContractsPOSTArchive(id, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SimpleContract>)>

  • summary Archive the specified SimpleContract

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SimpleContract>)>

    Throws

• simpleContractsPOSTDecline:function

  • simpleContractsPOSTDecline(id, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SimpleContract>)>

  • summary Decline the specified SimpleContract

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SimpleContract>)>

    Throws

• simpleContractsUpdateAvatar:function

  • simpleContractsUpdateAvatar(id, file?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • avatar_id could be tenant.id, SimpleContract.id, work.id, project.id, team.id, etc summary Upload avatar image via file

    Parameters

    • id: string

      SimpleContract id
    • Optionalfile: File
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Throws

• simpleContractsUpdateAvatarByDeets:function

  • simpleContractsUpdateAvatarByDeets(id, userId?, avatarBytes?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • avatar_id could be tenant.id, SimpleContract.id, work.id, project.id, team.id, etc summary Upload avatar via JSON body

    Parameters

    • id: string

      The id of the record you wish to retrieve
    • OptionaluserId: string

      The user id to operate on their behalf (tenants only)
    • OptionalavatarBytes: AvatarBytes
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Throws

• simpleContractsUpdateAvatarByPrompt:function

  • simpleContractsUpdateAvatarByPrompt(id, avatarPromptCreateDeets?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • avatar_id could be tenant.id, SimpleContract.id, work.id, project.id, team.id, etc summary Generate a new avatar image via AI prompt.

    Parameters

    • id: string
    • OptionalavatarPromptCreateDeets: AvatarPromptCreateDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Throws