Function ContractsApiFactory

ContractsApi - factory interface export

  • ContractsApiFactory(configuration?, basePath?, axios?): {
        apiContractsContractIdGet(contractId: string, revision?: number, options?: RawAxiosRequestConfig): AxiosPromise<Contract>;
        apiContractsDelete(id?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
        apiContractsPost(contract?: Contract, options?: RawAxiosRequestConfig): AxiosPromise<Contract>;
        apiContractsPut(id?: number, contract?: Contract, options?: RawAxiosRequestConfig): AxiosPromise<Contract>;
        contractPayments(id: string, limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaymentCycleListResponse>;
        contractPaymentTotals(id: string, options?: RawAxiosRequestConfig): AxiosPromise<PaymentCycleListResponse>;
        contractsGetAll(activeOnly?: boolean, latestOnly?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<Contract[]>;
    }

  • Parameters

    • Optionalconfiguration: Configuration
    • OptionalbasePath: string
    • Optionalaxios: AxiosInstance

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

    • apiContractsContractIdGet:function
      • apiContractsContractIdGet(contractId, revision?, options?): AxiosPromise<Contract>

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

        summary Retrieve a contract

        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 AxiosPromise<Contract>

        Throws

    • apiContractsDelete:function
      • apiContractsDelete(id?, options?): AxiosPromise<void>

      • summary Delete a contract

        Parameters

        • Optionalid: number
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<void>

        Throws

    • apiContractsPost:function
      • apiContractsPost(contract?, options?): AxiosPromise<Contract>

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

        summary Create a contract

        Parameters

        • Optionalcontract: Contract
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<Contract>

        Throws

    • apiContractsPut:function
      • apiContractsPut(id?, contract?, options?): AxiosPromise<Contract>

      • summary Update a contract

        Parameters

        • Optionalid: number
        • Optionalcontract: Contract
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<Contract>

        Throws

    • contractPayments:function
      • contractPayments(id, limit?, page?, userId?, options?): 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 AxiosPromise<PaymentCycleListResponse>

        Throws

    • contractPaymentTotals:function
    • contractsGetAll:function
      • contractsGetAll(activeOnly?, latestOnly?, options?): AxiosPromise<Contract[]>

      • 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

        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 AxiosPromise<Contract[]>

        Throws

Settings

Member Visibility