POST {language}/report/APEX_SubmitCPF

Request Information

URI Parameters

NameDescriptionTypeAdditional information
language

string

Required

Body Parameters

CPFSubmitRequest
NameDescriptionTypeAdditional information
CompanyId

globally unique identifier

None.
UserName

string

None.
FileCreationDateTime

date

None.
ReservedForFutureUse

integer

None.
CPFPenaltyInterest

decimal number

None.
MonthContribution

integer

None.
YearContributionm

integer

None.
AccessToken

string

None.
AdviceCode

string

None.
PaymentMode

string

None.
DeductionDate

date

None.
RequestId

globally unique identifier

None.
Language

string

None.
LanguageLogin

string

None.
AuthToken

string

None.
ClientId

string

None.
PageIndex

integer

None.
PageSize

integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "CompanyId": "6af8b03d-698d-405d-8f71-de40c2f5cde4",
  "UserName": "sample string 2",
  "FileCreationDateTime": "2025-07-13T01:32:42.0696016+00:00",
  "ReservedForFutureUse": 1,
  "CPFPenaltyInterest": 4.1,
  "MonthContribution": 5,
  "YearContributionm": 6,
  "AccessToken": "sample string 7",
  "AdviceCode": "sample string 8",
  "PaymentMode": "sample string 9",
  "DeductionDate": "2025-07-13T01:32:42.0696016+00:00",
  "RequestId": "f2801f98-d17b-4b5a-b049-da5e73710bdd",
  "Language": "sample string 12",
  "LanguageLogin": "sample string 13",
  "AuthToken": "sample string 14",
  "ClientId": "sample string 15",
  "PageIndex": 16,
  "PageSize": 17
}

application/xml, text/xml

Sample: 
<CPFSubmitRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Paytime.Infrastructure.WebApi.Models.Requests">
  <AuthToken xmlns="http://schemas.datacontract.org/2004/07/Cadena.Common.WebApi">sample string 14</AuthToken>
  <ClientId xmlns="http://schemas.datacontract.org/2004/07/Cadena.Common.WebApi">sample string 15</ClientId>
  <Language xmlns="http://schemas.datacontract.org/2004/07/Cadena.Common.WebApi">sample string 12</Language>
  <LanguageLogin xmlns="http://schemas.datacontract.org/2004/07/Cadena.Common.WebApi">sample string 13</LanguageLogin>
  <PageIndex xmlns="http://schemas.datacontract.org/2004/07/Cadena.Common.WebApi">16</PageIndex>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/Cadena.Common.WebApi">17</PageSize>
  <RequestId xmlns="http://schemas.datacontract.org/2004/07/Cadena.Common.WebApi">f2801f98-d17b-4b5a-b049-da5e73710bdd</RequestId>
  <AccessToken>sample string 7</AccessToken>
  <AdviceCode>sample string 8</AdviceCode>
  <CPFPenaltyInterest>4.1</CPFPenaltyInterest>
  <CompanyId>6af8b03d-698d-405d-8f71-de40c2f5cde4</CompanyId>
  <DeductionDate>2025-07-13T01:32:42.0696016+00:00</DeductionDate>
  <FileCreationDateTime>2025-07-13T01:32:42.0696016+00:00</FileCreationDateTime>
  <MonthContribution>5</MonthContribution>
  <PaymentMode>sample string 9</PaymentMode>
  <ReservedForFutureUse>1</ReservedForFutureUse>
  <UserName>sample string 2</UserName>
  <YearContributionm>6</YearContributionm>
</CPFSubmitRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.