How do the JSON output and object table of Apideck list payments API function?

In this article, I will provide a clear explanation of the object table and JSON output for the Apideck list payments API. As a programmer, you are likely familiar with these terms, but it is important to understand their specific implementation in the context of the Apideck API. By the end of this article, you should have a solid understanding of the structure and contents of the object table and JSON output for this particular API endpoint. This understanding will be useful when working with the Apideck API to retrieve payment data.

Object and Description table

1. data: An object that contains the payment data.

2. id: A unique identifier that represents the payment entity.

3. downstream_id: The third-party API ID of the original entity.

4. currency: An object that indicates the associated currency for an amount of money. Values correspond to ISO 4217.

5. currency_rate: The currency exchange rate at the time the entity was recorded/generated.

6. total_amount: The amount of payment.

7. reference: An optional payment reference message, such as a debit remittance detail.

8. payment_method: The payment method.

9. payment_method_reference: An optional reference message returned by the payment method on processing.

10. accounts_receivable_account_type: The type of accounts receivable account.

11. accounts_receivable_account_id: A unique identifier for the account to allocate payment to.

12. account: An object that contains the account details.

13. transaction_date: The date the transaction was entered - YYYY:MM::DDThh:mm:ss.sTZD.

14. customer: The customer this entity is linked to.

15. supplier: The supplier this entity is linked to.

16. reconciled: A boolean value that indicates whether the payment has been reconciled.

17. status: The status of payment.

18. type: The type of payment.

19. allocations: An object that contains the allocation details.

20. note: An optional note to be associated with the payment.

The information in the table is useful because it provides a clear and concise overview of the different objects and their descriptions for the Apideck list payments API. This information is essential for developers who are working with the Apideck API to retrieve payment data, as it enables them to understand the structure and contents of the data returned by the API endpoint. By having a clear understanding of the objects and their descriptions, developers can effectively manipulate and analyze the payment data to generate insights that can inform business decisions. Additionally, the table can serve as a reference guide for developers who need to quickly look up the details of a specific object while working on their code.

Clarifying the JSON Output

The given JSON output represents a payment object, containing various attributes that describe the payment. The "id" attribute represents the unique identifier for the payment entity, while "downstream_id" represents the third-party API ID of the original entity. The "currency" attribute indicates the associated currency for the payment amount in ISO 4217 format, and "currency_rate" is the exchange rate for the currency at the time of payment. The "total_amount" attribute specifies the payment amount, and "reference" is an optional message about the payment. The "payment_method" attribute indicates the payment method used, while "payment_method_reference" is an optional reference message returned by the payment method on processing. The "accounts_receivable_account_type" and "accounts_receivable_account_id" attributes describe the accounts receivable account used to allocate payment. The "transaction_date" attribute indicates when the transaction occurred, and "reconciled" is a boolean value indicating whether the payment has been reconciled. The "status" attribute indicates the payment's current status, while "type" specifies the type of payment. The "allocations" attribute is an array of objects that describe the allocation details for the payment. The "note" attribute is an optional note associated with the payment. Finally, there are several attributes that relate to the payment's versioning, creation and update times, and creators.

{
"id": "123456",
"downstream_id": "12345",
"currency": "USD",
"currency_rate": 0.69,
"total_amount": 49.99,
"reference": "123456",
"payment_method": "Credit Card",
"payment_method_reference": "123456",
"accounts_receivable_account_type": "Account",
"accounts_receivable_account_id": "123456",
"transaction_date": "2021-05-01T12:00:00.000Z",
"reconciled": true,
"status": "authorised",
"type": "accounts_receivable",
"allocations": [
{
"id": "123456",
"code": "N091",
"amount": 49.99
}
],
"note": "Some notes about this payment",
"row_version": "1-12345",
"display_id": "123456",
"updated_by": "12345",
"created_by": "12345",
"created_at": "2020-09-30T07:43:32.000Z",
"updated_at": "2020-09-30T07:43:32.000Z"
}

Final words

In this article, we explained the object table and JSON output for the Apideck list payments API. The table provides a clear description of the different objects used in the API endpoint, while the JSON output represents a payment object and its various attributes. Understanding the structure and contents of these objects is crucial for developers working with the Apideck API to retrieve payment data. By having a clear understanding of the objects, developers can manipulate and analyze the data more effectively to generate insights that inform business decisions. The information in this conversation serves as a useful reference guide for developers working with the Apideck list payments API.

Note

It is possible to request access to the Apideck list payments API through the third-party data marketplace of Worldindata. The Worldindata data marketplace provides a platform for developers to discover and access various data APIs, including the Apideck list payments API. By requesting access through the Worldindata data marketplace, developers can gain access to the API's payment data and leverage it to generate insights that inform business decisions. The Worldindata data marketplace provides a simple and secure way for developers to access the Apideck list payments API and other APIs, making it a valuable resource for businesses looking to integrate data-driven insights into their operations.