Function SimpleContractsApiAxiosParamCreator

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

• apiSimpleContractsContractIdPut: ((contractId: string, simpleContractUpdateDeets?: SimpleContractUpdateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Update a SimpleContract

  Throws

  • • (contractId, simpleContractUpdateDeets?, options?): Promise<RequestArgs>

    • Parameters

      • contractId: string

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

        Override http request option.

      Returns Promise<RequestArgs>

• apiSimpleContractsDelete: ((contractId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Delete a SimpleContract

  Throws

  • • (contractId?, options?): Promise<RequestArgs>

    • Parameters

      • OptionalcontractId: string
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getSimpleContracts: ((activeOnly?: boolean, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  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

  Throws

  • • (activeOnly?, limit?, page?, userId?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• simpleContractPayments: ((id: string, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Retrieve a list of all related payments

  Throws

  • • (id, limit?, page?, userId?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• simpleContractsDeleteAvatar: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Reset avatar to the default

  Throws

  • • (id, options?): Promise<RequestArgs>

    • Parameters

      • id: string
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• simpleContractsGetAvatarById: ((id: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Retrieve an avatar by id

  Throws

  • • (id, userId?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• simpleContractsGETByAccountAndId: ((accountId: string, contractId: string, specificRevision?: number, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

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

  summary Retrieve a SimpleContract by accountID and contract ID

  Throws

  • • (accountId, contractId, specificRevision?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• simpleContractsGETById: ((id: string, specificRevision?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

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

  summary Retrieve a SimpleContract

  Throws

  • • (id, specificRevision?, userId?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• simpleContractsPOST: ((simpleContractCreateDeets?: SimpleContractCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

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

  summary Create a SimpleContract

  Throws

  • • (simpleContractCreateDeets?, options?): Promise<RequestArgs>

    • Parameters

      • OptionalsimpleContractCreateDeets: SimpleContractCreateDeets
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• simpleContractsPOSTAccept: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Accept the specified SimpleContract

  Throws

  • • (id, options?): Promise<RequestArgs>

    • Parameters

      • id: string
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• simpleContractsPOSTArchive: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Archive the specified SimpleContract

  Throws

  • • (id, options?): Promise<RequestArgs>

    • Parameters

      • id: string
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• simpleContractsPOSTDecline: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Decline the specified SimpleContract

  Throws

  • • (id, options?): Promise<RequestArgs>

    • Parameters

      • id: string
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• simpleContractsUpdateAvatar: ((id: string, file?: File, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

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

  Throws

  • • (id, file?, options?): Promise<RequestArgs>

    • Parameters

      • id: string

        SimpleContract id
      • Optionalfile: File
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• simpleContractsUpdateAvatarByDeets: ((id: string, userId?: string, avatarBytes?: AvatarBytes, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

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

  Throws

  • • (id, userId?, avatarBytes?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• simpleContractsUpdateAvatarByPrompt: ((id: string, avatarPromptCreateDeets?: AvatarPromptCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

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

  Throws

  • • (id, avatarPromptCreateDeets?, options?): Promise<RequestArgs>

    • Parameters

      • id: string
      • OptionalavatarPromptCreateDeets: AvatarPromptCreateDeets
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>