List Invoice Payment

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 integer

Page number of the results to fetch.

Default value is 1.
page_size integer

Results per page (max 50)

Default value is 20.

Responses

200 application/json

A collection of Invoice Payment 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 string
  
  amount_currency string
  
  created_at string
  
  id integer
  
  invoice_id integer
  
  payment_id integer
  
  shipment_id string | null
  
  updated_at string
- metadata object
  
  Additional properties are allowed.
  
  Hide metadata attributes Show metadata attributes object
  
  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": [
    {
      "id": 1,
      "amount": "502.25",
      "created_at": "2021-02-19T19:09:57.971464",
      "invoice_id": 11,
      "payment_id": 1,
      "updated_at": "2021-02-19T19:09:57.971464",
      "shipment_id": "45360593-6c6c-44ab-8a17-0fd198fff058",
      "amount_currency": "USD"
    }
  ],
  "metadata": {
    "page": 1,
    "page_size": 20,
    "total_count": 1
  }
}