Finance

Get an invoice relation by relation ID

Get invoice relationsGet an invoice relation by relation ID

get/admin/finance/invoice-relations/{id}

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/finance/invoice-relations/{id}
  • Auth: HTTP basic

Path parameters

idnumber double required
Example:5

ID of the desired invoice relation

Response

idnumber

This is ID of invoice relation

customer_idnumber

This is ID of related customer

payer_idnumber

This is ID of a payment or transaction or credit note

typestring

Type of payer (payment, transaction or credit_note)

invoice_idnumber

ID of related an invoice

transaction_idnumber

ID of related transaction. Used instead of invoice_id

amountnumber

Amount

Example response

{
  "id": 1,
  "customer_id": 3,
  "payer_id": 45,
  "type": "payment",
  "invoice_id": 100,
  "transaction_id": 132,
  "amount": 15.3
}

Changes

No recorded changes to this operation across all 1 revision of this API.