finov.ioDocumentationHome

Get, update, or archive payment terms

API Documentation / Resources / Accounts and settings

Edit payment term dialog showing the Net 14 Days due-date calculation
Editing changes future use while existing invoices retain their saved due dates.
Remove payment term confirmation explaining the effect on defaults and existing invoices
Removal clears entity defaults but preserves due dates already saved on invoices.

Get a payment term

GET /v1/tenants/{tenant_id}/subsidiaries/{subsidiary_id}/payment-terms/{payment_term_id}

Required OAuth scope: accounting:read

Returns one payment term by UUID. Terms outside the granted tenant and subsidiary context are not disclosed.

Parameters

Name In Required Type Description
tenant_id path Yes string (uuid) UUID of the authorized company group.
subsidiary_id path Yes string (uuid) UUID of the subsidiary whose books contain the bank account.
payment_term_id path Yes string (uuid) UUID of a payment term configured for the subsidiary.

Request

GET /v1/tenants/{tenant_id}/subsidiaries/{subsidiary_id}/payment-terms/{payment_term_id} HTTP/1.1
Host: api.finov.io
Authorization: Bearer {access_token}

Responses

Status Description
200 Payment-term details.
401 Access token is missing, expired, revoked, or invalid.
403 Token lacks the required scope or granted accounting context.
404 Resource does not exist in the granted accounting context.

200 example

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": {
    "id": "109f329b-7172-4de6-b03b-c83f03141510",
    "name": "Net 20",
    "calculation": "days_after_invoice",
    "days": 20,
    "day_of_month": null,
    "active": true,
    "created_at": "2026-08-10T12:00:00Z",
    "updated_at": "2026-08-10T12:00:00Z"
  }
}

Update a payment term

PATCH /v1/tenants/{tenant_id}/subsidiaries/{subsidiary_id}/payment-terms/{payment_term_id}

Required OAuth scope: accounting:write

Updates one or more fields on a payment term. Omitted fields retain their current values.

When changing calculation, supply all fields needed by the new rule in the same request. Existing invoices keep their stored due dates; the revised rule applies only when a later document calculates a due date.

Parameters

Name In Required Type Description
tenant_id path Yes string (uuid) UUID of the authorized company group.
subsidiary_id path Yes string (uuid) UUID of the subsidiary whose books contain the bank account.
payment_term_id path Yes string (uuid) UUID of a payment term configured for the subsidiary.

Request

PATCH /v1/tenants/{tenant_id}/subsidiaries/{subsidiary_id}/payment-terms/{payment_term_id} HTTP/1.1
Host: api.finov.io
Authorization: Bearer {access_token}
Content-Type: application/json

{
  "name": "Net 30",
  "days": 30
}

Required body fields: None.

Responses

Status Description
200 Updated payment term.
401 Access token is missing, expired, revoked, or invalid.
403 Token lacks the required scope or granted accounting context.
404 Resource does not exist in the granted accounting context.
409 Request conflicts with uniqueness or current accounting state.
422 One or more supplied values failed validation.

200 example

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": {
    "id": "109f329b-7172-4de6-b03b-c83f03141510",
    "name": "Net 20",
    "calculation": "days_after_invoice",
    "days": 20,
    "day_of_month": null,
    "active": true,
    "created_at": "2026-08-10T12:00:00Z",
    "updated_at": "2026-08-10T12:00:00Z"
  }
}

Archive a payment term

DELETE /v1/tenants/{tenant_id}/subsidiaries/{subsidiary_id}/payment-terms/{payment_term_id}

Required OAuth scope: accounting:write

Archives the term so it cannot be selected for new contacts or documents.

Existing use Behavior
Posted or draft invoices Stored due dates do not change.
Contact defaults The archived term is removed from future default selection.
Historical audit data Resource references remain available internally.

This operation is an archive, not a physical deletion.

Parameters

Name In Required Type Description
tenant_id path Yes string (uuid) UUID of the authorized company group.
subsidiary_id path Yes string (uuid) UUID of the subsidiary whose books contain the bank account.
payment_term_id path Yes string (uuid) UUID of a payment term configured for the subsidiary.

Request

DELETE /v1/tenants/{tenant_id}/subsidiaries/{subsidiary_id}/payment-terms/{payment_term_id} HTTP/1.1
Host: api.finov.io
Authorization: Bearer {access_token}

Responses

Status Description
204 Payment term archived. The response has no body.
401 Access token is missing, expired, revoked, or invalid.
403 Token lacks the required scope or granted accounting context.
404 Resource does not exist in the granted accounting context.
409 Request conflicts with uniqueness or current accounting state.