Back to Payment

GET Method Details for GetByID.

Get payment by payment ID

Definition

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

Parameters

• paymentID integer Payment ID
• version string The requested API version

Returns

• [200] A payment
  • Model
  • Example Value
  • Amount number Gets or sets the amount
  • Comment string Gets or sets the comment
  • Discount number Gets or sets the discount
  • ExpensesCost number Gets or sets the expenses cost
  • InstallmentType integer Gets or sets the installment type
  • InvoiceDate string Gets or sets the invoice date
  • IsFixedPricePayment boolean Gets or sets a value indicating whether the payment is fixed price
  • IsReadyForInvoicing boolean Gets or sets a value indicating whether this instance is ready for invoicing
  • Name string Gets or sets the name
  • PaymentGuid string Gets or sets the payment GUID
  • PaymentID integer Gets or sets the payment ID
  • ProductNumberID integer Gets or sets the product number ID
  • ProjectID integer Gets or sets the project ID
  • ProjectSubContractID integer Gets or sets the project sub contract ID
  • Quantity number Gets or sets the quantity
  • Rate number Gets or sets the rate
  • TaskID integer Gets or sets the task ID
  • UnitType integer Gets or sets the unit type

  {
    "Amount": 0.0,
    "Comment": "",
    "Discount": 0.0,
    "ExpensesCost": 0.0,
    "InstallmentType": 0,
    "InvoiceDate": "2024-12-22T00:00:00+00:00",
    "IsFixedPricePayment": false,
    "IsReadyForInvoicing": false,
    "Name": "",
    "PaymentGuid": "00000000-0000-0000-0000-000000000000",
    "PaymentID": 0,
    "ProductNumberID": 0,
    "ProjectID": 0,
    "ProjectSubContractID": 0,
    "Quantity": 0.0,
    "Rate": 0.0,
    "TaskID": 0,
    "UnitType": 0
  }

• [401] Invalid authentication token
• [500] Payment with the ID does not exist
  • Model
  • Example Value
  • 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": ""
  }