Function ContractsApiFp

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

• apiContractsContractIdGet:function

  • apiContractsContractIdGet(contractId, revision?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => 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 Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Contract>)>

    Throws

• apiContractsDelete:function

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

  • summary Delete a contract

    Parameters

    • Optionalid: number
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• apiContractsPost:function

  • apiContractsPost(contract?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => 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 Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Contract>)>

    Throws

• apiContractsPut:function

  • apiContractsPut(id?, contract?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Contract>)>

  • summary Update a contract

    Parameters

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

      Override http request option.

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

    Throws

• contractPayments:function

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

• contractPaymentTotals:function

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

  • summary Retrieve the total payments associated with a contract

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• contractsGetAll:function

  • contractsGetAll(activeOnly?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => 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
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Contract[]>)>

    Throws