Arta API Reference

Get an Invoice record

GET /invoices/{invoice_id}

Retrieve an existing Invoice record

Headers

Authorization string Required

Authorize your API calls with an Arta API token

Path parameters

invoice_id integer Required

invoice_id parameter

Responses

• 200 application/json

Successful Invoice response
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
- 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
• 404 application/json

Resource Not Found
Hide headers attributes Show headers attributes
- content-type string
- x-arta-request-id string
  
  A unique identifier for the Arta API call
Hide response attribute Show response attribute object
- errors object
  
  Hide errors attribute Show errors attribute
  
  detail string

GET /invoices/{invoice_id}

curl \
 -X GET https://api.arta.io/invoices/{invoice_id} \
 -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"

Response examples (200)

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

# Payload
{
  "amount_owed": "276.91",
  "amount_owed_currency": "USD",
  "amount_paid": "276.91",
  "amount_paid_currency": "USD",
  "created_at": "2021-03-10T20:15:34.096258",
  "invoice_url": null,
  "id": 2216,
  "issued_on": "2021-03-10",
  "shipment_id": "53d6bdec-1eae-46e2-97c2-3e56b1a1095d",
  "status": "closed",
  "updated_at": "2021-03-10T20:16:10.202836"
}

Response examples (404)

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

# Payload
{
  "errors": {
    "detail": "string"
  }
}