POST /sales/invoices/compliance/evaluate

POST 
/sales/invoices/compliance/evaluate

POST /sales/invoices/compliance/evaluate

Request

application/json-patch+json

Body

invoice_ids int64[]required

Possible values: >= 1, <= 1000

application/json

Body

invoice_ids int64[]required

Possible values: >= 1, <= 1000

text/json

Body

invoice_ids int64[]required

Possible values: >= 1, <= 1000

application/*+json

Body

invoice_ids int64[]required

Possible values: >= 1, <= 1000

Responses

202

Accepted

text/plain

Schema

Schema

• Array [

invoice_id int64

compliance

object

status Apollo.Models.Compliance.ComplianceStatus (string)

Possible values: [pending, evaluated, blocked]

reporting_method Apollo.Models.Compliance.ReportingMethod (string)

Possible values: [no_reporting, reporting_by_delivery]

delivery_eligibility Apollo.Models.Compliance.DeliveryEligibility (string)

Possible values: [eligible, eligible_via_required_channel]

required_action Apollo.Models.Compliance.RequiredAction (string)

Possible values: [none, send_via_peppol]

allowed_actions

object

send_email boolean

download_pdf boolean

send_via_peppol boolean

submit_to_tax_authority boolean

evaluated_at date-timenullable

blocking_reason stringnullable

• ]

Example (from schema)

[
  {
    "invoice_id": 0,
    "compliance": {
      "status": "pending",
      "reporting_method": "no_reporting",
      "delivery_eligibility": "eligible",
      "required_action": "none",
      "allowed_actions": {
        "send_email": true,
        "download_pdf": true,
        "send_via_peppol": true,
        "submit_to_tax_authority": true
      },
      "evaluated_at": "2024-07-29T15:51:28.071Z",
      "blocking_reason": "string"
    }
  }
]

application/json

Schema

Schema

• Array [

invoice_id int64

compliance

object

status Apollo.Models.Compliance.ComplianceStatus (string)

Possible values: [pending, evaluated, blocked]

reporting_method Apollo.Models.Compliance.ReportingMethod (string)

Possible values: [no_reporting, reporting_by_delivery]

delivery_eligibility Apollo.Models.Compliance.DeliveryEligibility (string)

Possible values: [eligible, eligible_via_required_channel]

required_action Apollo.Models.Compliance.RequiredAction (string)

Possible values: [none, send_via_peppol]

allowed_actions

object

send_email boolean

download_pdf boolean

send_via_peppol boolean

submit_to_tax_authority boolean

evaluated_at date-timenullable

blocking_reason stringnullable

• ]

Example (from schema)

[
  {
    "invoice_id": 0,
    "compliance": {
      "status": "pending",
      "reporting_method": "no_reporting",
      "delivery_eligibility": "eligible",
      "required_action": "none",
      "allowed_actions": {
        "send_email": true,
        "download_pdf": true,
        "send_via_peppol": true,
        "submit_to_tax_authority": true
      },
      "evaluated_at": "2024-07-29T15:51:28.071Z",
      "blocking_reason": "string"
    }
  }
]

text/json

Schema

Schema

• Array [

invoice_id int64

compliance

object

status Apollo.Models.Compliance.ComplianceStatus (string)

Possible values: [pending, evaluated, blocked]

reporting_method Apollo.Models.Compliance.ReportingMethod (string)

Possible values: [no_reporting, reporting_by_delivery]

delivery_eligibility Apollo.Models.Compliance.DeliveryEligibility (string)

Possible values: [eligible, eligible_via_required_channel]

required_action Apollo.Models.Compliance.RequiredAction (string)

Possible values: [none, send_via_peppol]

allowed_actions

object

send_email boolean

download_pdf boolean

send_via_peppol boolean

submit_to_tax_authority boolean

evaluated_at date-timenullable

blocking_reason stringnullable

• ]

Example (from schema)

[
  {
    "invoice_id": 0,
    "compliance": {
      "status": "pending",
      "reporting_method": "no_reporting",
      "delivery_eligibility": "eligible",
      "required_action": "none",
      "allowed_actions": {
        "send_email": true,
        "download_pdf": true,
        "send_via_peppol": true,
        "submit_to_tax_authority": true
      },
      "evaluated_at": "2024-07-29T15:51:28.071Z",
      "blocking_reason": "string"
    }
  }
]

Loading...