Generate a billing invoice from a signed contract

POST

/api/v1/contracts/{id}/generate-invoice

const url = 'https://api.dokanmazad.com/api/v1/contracts/cmcont00000001ny11aabbcc0/generate-invoice';
const options = {method: 'POST', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.dokanmazad.com/api/v1/contracts/cmcont00000001ny11aabbcc0/generate-invoice \
  --header 'X-API-Key: <X-API-Key>'

Authorizations

ApiKeyAuth

Parameters

Path Parameters

required

string

Contract ID (CUID)

Example

cmcont00000001ny11aabbcc0

Responses

200

Success

application/json

object

success

required

boolean

data

required

meta

object

page

integer

limit

integer

total

integer

totalPages

integer

data

required

object

billingId

required

CUID of the newly created billing (invoice) record

string

Examples

success

{
  "success": true,
  "data": {
    "billingId": "cmbill00000010ny11aabbcc0"
  }
}

401

Unauthorized — missing or invalid API key

application/json

object

success

required

boolean

error

required

string

statusCode

required

integer

Example

{
  "success": false
}

403

Forbidden — route not in this key’s allowedRoutes

application/json

object

success

required

boolean

error

required

string

statusCode

required

integer

Example

{
  "success": false
}

429

Rate limit exceeded

application/json

object

success

required

boolean

error

required

string

statusCode

required

integer

Example

{
  "success": false
}

Headers

Retry-After

integer

Seconds to wait before retrying