Retrieve Bill Payment Or Credit

Returns a specific BillPaymentOrCredit by its unique identifier.

Loading API schema for BillPaymentOrCredit…

GET/api/v1/bill-payment-or-credit/{id}

curl -X GET "https://api.nx-us.net/api/v1/bill-payment-or-credit/{id}" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Connection-Id: YOUR_CONNECTION_ID" \
  -H "Accept: application/json"

Response200

{
  "objectType": "<string>",
  "createdAt": "<date-time>",
  "updatedAt": "<date-time>",
  "revisionNumber": "<string>",
  "bill": {
    "id": "<string>",
    "objectType": "<string>",
    "createdAt": "<date-time>",
    "updatedAt": "<date-time>",
    "revisionNumber": "<string>",
    "transactionDate": "<date>",
    "currency": {
      "id": "<string>",
      "fullname": "<string>"
    },
    "amountDue": "<number>",
    "exchangeRate": "<number>",
    "amountDueInHomeCurrency": "<string>",
    "refNumber": "<string>",
    "memo": "<string>",
    "transactionType": "<string>",
    "payablesAccount": {
      "id": "<string>",
      "fullname": "<string>"
    },
    "dueDate": "<date>",
    "entity": {
      "id": "<string>",
      "fullname": "<string>"
    },
    "account": {
      "id": "<string>",
      "fullname": "<string>"
    },
    "amountInHomeCurrency": "<string>",
    "hasValidLineItems": "<boolean>",
    "externalId": "<string>",
    "linkedTransactions": [
      {
        "objectType": "<string>",
        "transactionId": "<string>",
        "transactionType": "<string>",
        "transactionDate": "<date>",
        "refNumber": "<string>",
        "linkType": "<string>",
        "amount": "<number>"
      }
    ],
    "expenseLines": [
      {
        "id": "<string>",
        "objectType": "<string>",
        "account": null,
        "amount": "<number>",
        "memo": "<string>",
        "class": null,
        "customer": null,
        "salesRepresentative": null,
        "salesTaxCode": null,
        "taxAmount": "<number>",
        "vendor": null,
        "billableStatus": null,
        "customFields": null
      }
    ],
    "itemLines": [
      {
        "id": "<string>",
        "objectType": "<string>",
        "otherCustomField1": "<string>",
        "otherCustomField2": "<string>",
        "item": null,
        "description": "<string>",
        "quantity": "<number>",
        "cost": "<number>",
        "amount": "<number>",
        "customer": null,
        "class": null,
        "overrideItemAccount": null,
        "billableStatus": null,
        "itemGroup": null,
        "unitOfMeasure": "<string>",
        "rate": "<number>",
        "salesTaxCode": null,
        "inventorySite": null,
        "inventorySiteLocation": null,
        "serialNumber": "<string>",
        "lotNumber": "<string>",
        "serviceDate": "<date>",
        "customFields": null
      }
    ],
    "itemGroupLines": [
      {
        "id": "<string>",
        "objectType": "<string>",
        "itemGroup": null,
        "description": "<string>",
        "quantity": "<number>",
        "totalAmount": "<number>",
        "unitOfMeasure": "<string>",
        "isPrintItemsInGroup": "<boolean>",
        "lines": null,
        "customFields": null
      }
    ],
    "customFields": [
      {
        "ownerId": "<string>",
        "name": "<string>",
        "type": "<string>",
        "value": "<string>"
      }
    ]
  },
  "credit": {
    "id": "<string>",
    "objectType": "<string>",
    "createdAt": "<date-time>",
    "updatedAt": "<date-time>",
    "revisionNumber": "<string>",
    "transactionDate": "<date>",
    "currency": {
      "id": "<string>",
      "fullname": "<string>"
    },
    "exchangeRate": "<number>",
    "refNumber": "<string>",
    "memo": "<string>",
    "transactionType": "<string>",
    "payablesAccount": {
      "id": "<string>",
      "fullname": "<string>"
    },
    "creditRemaining": "<number>",
    "creditRemainingInHomeCurrency": "<number>",
    "amount": "<number>",
    "entity": {
      "id": "<string>",
      "fullname": "<string>"
    },
    "account": {
      "id": "<string>",
      "fullname": "<string>"
    },
    "hasValidLineItems": "<boolean>",
    "externalId": "<string>",
    "linkedTransactions": [
      {
        "objectType": "<string>",
        "transactionId": "<string>",
        "transactionType": "<string>",
        "transactionDate": "<date>",
        "refNumber": "<string>",
        "linkType": "<string>",
        "amount": "<number>"
      }
    ],
    "expenseLines": [
      {
        "id": "<string>",
        "objectType": "<string>",
        "account": null,
        "amount": "<number>",
        "memo": "<string>",
        "class": null,
        "customer": null,
        "salesRepresentative": null,
        "salesTaxCode": null,
        "taxAmount": "<number>",
        "vendor": null,
        "billableStatus": null,
        "customFields": null
      }
    ],
    "itemLines": [
      {
        "id": "<string>",
        "objectType": "<string>",
        "otherCustomField1": "<string>",
        "otherCustomField2": "<string>",
        "item": null,
        "description": "<string>",
        "quantity": "<number>",
        "cost": "<number>",
        "amount": "<number>",
        "customer": null,
        "class": null,
        "overrideItemAccount": null,
        "billableStatus": null,
        "itemGroup": null,
        "unitOfMeasure": "<string>",
        "rate": "<number>",
        "salesTaxCode": null,
        "inventorySite": null,
        "inventorySiteLocation": null,
        "serialNumber": "<string>",
        "lotNumber": "<string>",
        "serviceDate": "<date>",
        "customFields": null
      }
    ],
    "itemGroupLines": [
      {
        "id": "<string>",
        "objectType": "<string>",
        "itemGroup": null,
        "description": "<string>",
        "quantity": "<number>",
        "totalAmount": "<number>",
        "unitOfMeasure": "<string>",
        "isPrintItemsInGroup": "<boolean>",
        "lines": null,
        "customFields": null
      }
    ],
    "customFields": [
      {
        "ownerId": "<string>",
        "name": "<string>",
        "type": "<string>",
        "value": "<string>"
      }
    ]
  },
  "customFields": [
    {
      "ownerId": "<string>",
      "name": "<string>",
      "type": "<string>",
      "value": "<string>"
    }
  ]
}