Home > API > Clients > Pauses the dunning on an invoice.

Pauses the dunning on an invoice.

Allows pausing the processing of reminders and debt collection of an invoice.

PATH:

/v1/clients/{clientId}/invoices/{invoiceNumber}/pause

PATH PARAMETERS:

clientId
required

integer

Your assigned clientId.
invoiceNumber
required

string

The invoice number.

HYPERMEDIA CONTROL

AVAILABLE IN:

REQUEST BODY SCHEMA:

resumeDate

string date

Date on which to resume (unpause) the invoice automatically.

RESPONSES:

200 Returned when the invoice is paused successfully.
400 Returned when the request is malformed.

RESPONSE SCHEMA:

type

string

no description in swagger file
category

string

Enum: BusinessError TechnicalError

no description in swagger file
title

string

no description in swagger file
message

string

no description in swagger file
detail

string

There is an error message.
customerFacingMessage

string

no description in swagger file
401 Returned when the request has a missing or invalid "Authorization" header.

RESPONSE SCHEMA:

type

string

no description in swagger file
category

string

Enum: BusinessError TechnicalError

no description in swagger file
title

string

no description in swagger file
message

string

no description in swagger file
detail

string

There is an error message.
customerFacingMessage

string

no description in swagger file
403 Returned when the requester is lacking permissions.

RESPONSE SCHEMA:

type

string

no description in swagger file
category

string

Enum: BusinessError TechnicalError

no description in swagger file
title

string

no description in swagger file
message

string

no description in swagger file
detail

string

There is an error message.
customerFacingMessage

string

no description in swagger file
404 Returned when the invoice is not found.

RESPONSE SCHEMA:

type

string

no description in swagger file
category

string

Enum: BusinessError TechnicalError

no description in swagger file
title

string

no description in swagger file
message

string

no description in swagger file
detail

string

There is an error message.
customerFacingMessage

string

no description in swagger file
422 Returned when the request could not be processed.

RESPONSE SCHEMA:

type

string

no description in swagger file
title

string

no description in swagger file
status

integer int32

no description in swagger file
detail

string

no description in swagger file
instance

string

no description in swagger file
500 Returned when some internal error happens.

RESPONSE SCHEMA:

type

string

no description in swagger file
category

string

Enum: BusinessError TechnicalError

no description in swagger file
title

string

no description in swagger file
message

string

no description in swagger file
detail

string

There is an error message.
customerFacingMessage

string

no description in swagger file

Path

put

/v1/clients/{clientId}/invoices/{invoiceNumber}/pause

Request samples

  • {
    • "resumeDate": "string"
  • }

Response samples

400401403404422500
  • {
    • "type": "string",
    • "category": "string",
    • "title": "string",
    • "message": "string",
    • "detail": "string",
    • "customerFacingMessage": "string"
    }
  • {
    • "type": "string",
    • "category": "string",
    • "title": "string",
    • "message": "string",
    • "detail": "string",
    • "customerFacingMessage": "string"
    }
  • {
    • "type": "string",
    • "category": "string",
    • "title": "string",
    • "message": "string",
    • "detail": "string",
    • "customerFacingMessage": "string"
    }
  • {
    • "type": "string",
    • "category": "string",
    • "title": "string",
    • "message": "string",
    • "detail": "string",
    • "customerFacingMessage": "string"
    }
  • {
    • "type": "string",
    • "title": "string",
    • "status": 1,
    • "detail": "string",
    • "instance": "string"
    }
  • {
    • "type": "string",
    • "category": "string",
    • "title": "string",
    • "message": "string",
    • "detail": "string",
    • "customerFacingMessage": "string"
    }