DocuSign.Api.Payments (DocuSign v0.3.3) View Source

API calls for all endpoints tagged Payments.

Link to this section Summary

Functions

Gets billing payment information for a specific payment. Retrieves the information for a specified payment. Privileges required: account administrator

Gets payment information for one or more payments. Retrieves a list containing information about one or more payments. If the from date or to date queries are not used, the response returns payment information for the last 365 days. Privileges required: account administrator

Posts a payment to a past due invoice. Posts a payment to a past due invoice. ###### Note: This can only be used if the `paymentAllowed` value for a past due invoice is true. This can be determined calling [ML:GetBillingInvoicesPastDue]. The response returns information for a single payment, if a payment ID was used in the endpoint, or a list of payments. If the from date or to date queries or payment ID are not used, the response returns payment information for the last 365 days. If the request was for a single payment ID, the `nextUri` and `previousUri` properties are not returned. Privileges required: account administrator

Link to this section Functions

Link to this function

billing_payments_get_payment(connection, account_id, payment_id, opts \\ [])

View Source

Specs

billing_payments_get_payment(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, DocuSign.Model.Payments.t()} | {:error, Tesla.Env.t()}

Gets billing payment information for a specific payment. Retrieves the information for a specified payment. Privileges required: account administrator

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • payment_id (String.t):
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

billing_payments_get_payment_list(connection, account_id, opts \\ [])

View Source

Specs

billing_payments_get_payment_list(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.BillingPaymentsResponse.t()} | {:error, Tesla.Env.t()}

Gets payment information for one or more payments. Retrieves a list containing information about one or more payments. If the from date or to date queries are not used, the response returns payment information for the last 365 days. Privileges required: account administrator

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • opts (KeywordList): [optional] Optional parameters
    • :from_date (String.t): Specifies the date/time of the earliest payment in the account to retrieve.
    • :to_date (String.t): Specifies the date/time of the latest payment in the account to retrieve.

Returns

} on success {:error, info} on failure

Link to this function

billing_payments_post_payment(connection, account_id, opts \\ [])

View Source

Specs

billing_payments_post_payment(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.BillingPaymentResponse.t()} | {:error, Tesla.Env.t()}

Posts a payment to a past due invoice. Posts a payment to a past due invoice. ###### Note: This can only be used if the `paymentAllowed` value for a past due invoice is true. This can be determined calling [ML:GetBillingInvoicesPastDue]. The response returns information for a single payment, if a payment ID was used in the endpoint, or a list of payments. If the from date or to date queries or payment ID are not used, the response returns payment information for the last 365 days. If the request was for a single payment ID, the `nextUri` and `previousUri` properties are not returned. Privileges required: account administrator

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • opts (KeywordList): [optional] Optional parameters
    • :billing_payment_request (BillingPaymentRequest):

Returns

} on success {:error, info} on failure