List payment terms

GET/v1/api/store/{team_slug}/setting/payment_term

v1Operation ID v1_public_payment_term_index

Returns all the team's payment terms in one list, including deleted ones (trashed: true).

A payment term says whether an order needs a deposit, how big, and when the deposit and full payment are due. A new sales order or quote takes the customer's default payment term, or else the team's default. YoPrint copies the term onto the order: the deposit requirement and percentage, a full payment due date full_amount_due days after the order is created and, when a deposit is required, a deposit due date deposit_due days after it. Changing or deleting a term later doesn't change existing orders.

Permission

Any team member can call it. Reading needs no extra permission.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team

Request body

This operation takes no request body.

Response

200Successful response.

• dataarray of objectsrequired
  Fields of each item (10)

  • defaultbooleanrequired

    Whether it is the team's default payment term.

  • deposit_dueintegerrequired

    Days until the deposit is due. 0 when never set.

  • deposit_due_fromstring | nullrequired
    • One of: "issue_date"
  • deposit_percentinteger | nullrequired

    The deposit percentage. A percentage ×1000: 8250 is 8.25% (20000 is 20%). With X-Yoprint-Decimal-Format: exact-v1, a value that isn't a whole number comes back as a string.

  • enable_depositbooleanrequired

    Whether a deposit is required before production.

  • full_amount_dueintegerrequired

    Days until full payment is due.

  • full_amount_due_fromstringrequired

    What the days count from: the issue date, or the customer due date.

    • One of: "issue_date", "customer_due_date"
  • idstringrequired
  • namestringrequired
  • trashedbooleanrequired

    True for a deleted payment term.

• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

Notes

• Skip terms with trashed: true when you offer a choice. The default term is what new orders get when the customer has none.

Related

• POSTCreate a payment term/v1/api/store/{team_slug}/setting/payment_term
• PATCHSet the default payment term/v1/api/store/{team_slug}/setting/payment_term/{id}/default
• POSTCreate a sales order or quote/v2/api/store/{team_slug}/v2/sales_order/new

Example request

curl

curl 'https://secure.yoprint.com/v1/api/store/your-team/setting/payment_term' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": [
    {
      "default": true,
      "deposit_due": 30,
      "deposit_due_from": "issue_date",
      "deposit_percent": 20000,
      "enable_deposit": true,
      "full_amount_due": 30,
      "full_amount_due_from": "issue_date",
      "id": "H3J5exdciYshbk",
      "name": "20/80 (20% deposit/upfront)",
      "trashed": false
    }
  ],
  "status": 200,
  "success": true
}