Back to Payment Method

GET Method Details for GetByStatus.

Get a list of payment method belonging to the user by status (all, inactive, active)

Definition

https://app[x].timelog.com/[account name]/api/v{version}/payment-method/{status}

Parameters

  • status integer An enum of ActiveStatus, can be all(-1), inactive(0) or active(1)
  • version string The requested API version

Returns

  • [200] A list of payment method
    • CreditCardEmployeeUserID integer Gets or sets the credit card employee user identifier.
    • IsActive boolean Gets or sets a value indicating whether this instance is active.
    • IsDefaultForEmployeeExpense boolean Gets or sets a value indicating whether this instance is default for employee expense.
    • IsDefaultForImport boolean Gets or sets a value indicating whether this instance is default for import.
    • IsDefaultForProjectExpense boolean Gets or sets a value indicating whether this instance is default for project expense.
    • IsPaidByEmployee boolean Gets or sets a value indicating whether this instance is paid by employee.
    • IsPersonalCreditCard boolean Gets or sets a value indicating whether this instance is personal credit card.
    • Name string Gets or sets the name.
    • PaymentMethodID integer Gets or sets the payment method identifier. 
    {
  "CreditCardEmployeeUserID": 0,
  "IsActive": false,
  "IsDefaultForEmployeeExpense": false,
  "IsDefaultForImport": false,
  "IsDefaultForProjectExpense": false,
  "IsPaidByEmployee": false,
  "IsPersonalCreditCard": false,
  "Name": "",
  "PaymentMethodID": 0
}
  • [400] Status specified is invalid
    • Code integer Gets the code.
    • Details array Gets the details.
    • Message string Gets the message.
    • Parameters string Gets the parameters.
    • Url string Gets the URL. 
    {
  "Code": 0,
  "Details": "",
  "Message": "",
  "Parameters": "",
  "Url": ""
}
  • [401] Invalid authentication token
  • [500] Request to GetByStatus has failed
    • Code integer Gets the code.
    • Details array Gets the details.
    • Message string Gets the message.
    • Parameters string Gets the parameters.
    • Url string Gets the URL. 
    {
  "Code": 0,
  "Details": "",
  "Message": "",
  "Parameters": "",
  "Url": ""
}