Block invoices

curl --request PATCH \ --url https://api.paytsoftware.com/v1/invoices/block \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data 'administration_id=<string>' \ --data 'fields={}' \ --data 'invoice_numbers=<string>' \ --data 'invoice_identifiers=<string>'

{ "success": true, "count": 98, "errors": { "123456": [ "Validation error 1", "Validation error 2" ], "123461": [ "Validation error" ] }, "warnings": { "123457": [ "Warning message 1", "Warning message 2" ] } }

Authorizations

Authorization

string

header

required

OAuth2 access token or static API token. See Authorization for how to obtain one.

Body

application/x-www-form-urlencoded

administration_id

string

required

Administration identifier

fields

object

JSON object defining fields to receive (e.g {"only": ["field1", {"field2": ["field3"]}]})

invoice_numbers

string[]

Unique number from your invoicing software that is communicated to the debtor

Maximum array length: 1000

invoice_identifiers

string[]

Unique database identifier from your invoicing software

Maximum array length: 1000

Response

Invoices blocked

CustomerApi_SuccessEntity model

success

boolean

required

Request was handled successfully

count

integer<int32>

required

Number of records processed, those without errors

Example:

98

errors

object

required

List of records that could not be processed and for which reasons

Example:

{
  "123456": ["Validation error 1", "Validation error 2"],
  "123461": ["Validation error"]
}

warnings

object

List of records that were partially processed, the messages contain warnings

Example:

{
  "123457": ["Warning message 1", "Warning message 2"]
}