Arta API Reference

List invoice payment records

GET /invoice_payments

Retrieve a paginated collection of Invoice Payments belonging to your Organization

Headers

Authorization string Required

Authorize your API calls with an Arta API token

Query parameters

page_size integer

Results per page (max 50)

Default value is 20.
page integer

Page number of the results to fetch.

Default value is 1.

Responses

• 200 application/json

A collection of Log records
Hide headers attributes Show headers attributes
- content-type string
- x-arta-request-id string
  
  A unique identifier for the Arta API call
Hide response attributes Show response attributes object
- items array[object]
  
  Hide items attributes Show items attributes object
  
  amount_owed string
  
  amount_owed_currency string
  
  amount_paid string
  
  amount_paid_currency string
  
  created_at string
  
  invoice_url string | null
  
  id integer
  
  issued_on string | null
  
  shipment_id string | null
  
  status string
  
  updated_at string
- metadata object
  
  Hide metadata attributes Show metadata attributes
  
  page integer(int64)
  
  page_size integer(int64)
  
  total_count integer(int64)

GET /invoice_payments

curl \
 -X GET https://api.arta.io/invoice_payments \
 -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"

Response examples (200)

# Headers
content-type: application/json
x-arta-request-id: FkBjuxbwLLTx4RoAARkx

# Payload
{
  "items": [
    {
      "amount": "502.25",
      "amount_currency": "USD",
      "created_at": "2021-02-19T19:09:57.971464",
      "id": 1,
      "invoice_id": 11,
      "payment_id": 1,
      "shipment_id": "45360593-6c6c-44ab-8a17-0fd198fff058",
      "updated_at": "2021-02-19T19:09:57.971464"
    }
  ],
  "metadata": {
    "page": 1,
    "page_size": 20,
    "total_count": 1
  }
}