Function ContractsApiAxiosParamCreator

ContractsApi - axios parameter creator export

  • ContractsApiAxiosParamCreator(configuration?): {
        apiContractsContractIdGet: ((contractId: string, revision?: number, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiContractsDelete: ((id?: number, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiContractsPost: ((contract?: Contract, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiContractsPut: ((id?: number, contract?: Contract, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        contractPayments: ((id: string, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        contractPaymentTotals: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        contractsGetAll: ((activeOnly?: boolean, latestOnly?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

    Returns {
        apiContractsContractIdGet: ((contractId: string, revision?: number, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiContractsDelete: ((id?: number, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiContractsPost: ((contract?: Contract, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiContractsPut: ((id?: number, contract?: Contract, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        contractPayments: ((id: string, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        contractPaymentTotals: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        contractsGetAll: ((activeOnly?: boolean, latestOnly?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

    • apiContractsContractIdGet: ((contractId: string, revision?: number, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

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

      summary Retrieve a contract

      Throws

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

        • Parameters

          • contractId: string

            The id of the contract you want to retrieve

          • Optionalrevision: number

            The optional revision number of the contract you want to retrieve

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • apiContractsDelete: ((id?: number, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Delete a contract

      Throws

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

        • Parameters

          • Optionalid: number
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • apiContractsPost: ((contract?: Contract, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Used to create new contracts or link to a existing contract group

      summary Create a contract

      Throws

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

        • Parameters

          • Optionalcontract: Contract
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • apiContractsPut: ((id?: number, contract?: Contract, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Update a contract

      Throws

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

        • Parameters

          • Optionalid: number
          • Optionalcontract: Contract
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • contractPayments: ((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>

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

      summary Retrieve the total payments associated with a contract

      Throws

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

        • Parameters

          • id: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • contractsGetAll: ((activeOnly?: boolean, latestOnly?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Contracts are core to the Splits 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 contracts

      Throws

        • (activeOnly?, latestOnly?, options?): Promise<RequestArgs>

        • Parameters

          • OptionalactiveOnly: boolean

            If set to true, then this only returns active contracts

          • OptionallatestOnly: boolean

            If set to true, then only the latest revision is sent. Defaults to true.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility