ROSE Developers - Web API Reference

Accounts Payable | Payment

The Payments represents end point is used to record the settlement of the memos and invoices from your company.

Overview


URL api/{tenantKey}/{orgKey}/accountsPayable/payments
Methods Supported GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

All Enumerations

This service uses the following enumerations:

GET Operations

GET Payments

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See PaymentResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /accountsPayable/payments

GET Payments (paged)

Returns a page of the list of all the entity records available.

The following elements are optional:

page (int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize (int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

Response:

When successful, the response body contains the list of records available. See PaymentResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /accountsPayable/payments?page={page}&pageSize={pageSize}

GET Payment by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id (string) The record identifier.

Response:

When successful, the response body contains the entity record. See PaymentResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /accountsPayable/payments/{id}

GET Payment by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.

Response:

When successful, the response body contains the entity record. See PaymentResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}

GET Print Payment by identifier

Prints the specified entity record.

The following elements are required:

id (string) The record identifier.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
404 NotFound. The specified resord does not exist.

Resource URL:

GET /accountsPayable/payments/{id}/print?template={template}

GET Print Payment by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/print

GET Original Print PaymentOriginal by identifier

Prints the specified entity record.

The following elements are required:

id (string) The record identifier.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
404 NotFound. The specified resord does not exist.

Resource URL:

GET /accountsPayable/payments/{id}/printOriginal?template={template}

GET Original Print Payment by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/printOriginal

POST Operations

POST Payments

Creates a new entity record.

The following elements are required:

paymentResource (ApiPaymentResource) The request body should contain the entity record that should be created.
See ApiPaymentResource.

The following elements are optional:

customAttributes (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiPaymentResource.

Response status codes:

201 Created. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

POST /accountsPayable/payments

PUT Operations

PUT Set Account Payment

Updates the value of attribute 'Account' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/account

PUT Set AccountingSchema Payment

Updates the value of attribute 'AccountingSchema' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
companyKey (string) The company key.
value (enum AccountingSchema) The request body should contain the new value for the attribute.
See AccountingSchema.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/accountingSchema

PUT Set BaseExchangeRate PaymentLine

Updates the value of attribute 'BaseExchangeRate' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/baseExchangeRate

PUT Set BeneficiaryParty PaymentWTax

Updates the value of attribute 'BeneficiaryParty' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentWTaxes/{lineId}/beneficiaryParty

PUT Set CashFlowItem Payment

Updates the value of attribute 'CashFlowItem' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/cashFlowItem

PUT Set ChartOfAccount Payment

Updates the value of attribute 'ChartOfAccount' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/chartOfAccount

PUT Set ChartOfAccount PaymentLine

Updates the value of attribute 'ChartOfAccount' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/chartOfAccount

PUT Set DimensionSet Payment

Updates the value of attribute 'DimensionSet' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/dimensionSet

PUT Set DimensionSet PaymentLine

Updates the value of attribute 'DimensionSet' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/dimensionSet

PUT Set DimensionSetJson Payment

Updates the value of attribute 'DimensionSetJson' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/dimensionSetJson

PUT Set DimensionSetJson PaymentLine

Updates the value of attribute 'DimensionSetJson' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/dimensionSetJson

PUT Set DiscountAccount PaymentLine

Updates the value of attribute 'DiscountAccount' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/discountAccount

PUT Set EmailTo Payment

Updates the value of attribute 'EmailTo' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/emailTo

PUT Set FinancialAccount Payment

Updates the value of attribute 'FinancialAccount' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/financialAccount

PUT Set IBAN Payment

Updates the value of attribute 'IBAN' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/iBAN

PUT Set IsActive Payment

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
companyKey (string) The company key.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/isActive

PUT Set IsPaymentMethodCheck Payment

Updates the value of attribute 'IsPaymentMethodCheck' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
companyKey (string) The company key.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/isPaymentMethodCheck

PUT Set IsPrinted Payment

Updates the value of attribute 'IsPrinted' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
companyKey (string) The company key.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/isPrinted

PUT Set Nature PaymentLine

Updates the value of attribute 'Nature' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (enum AccountingNature) The request body should contain the new value for the attribute.
See AccountingNature.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/nature

PUT Set Note Payment

Updates the value of attribute 'Note' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/note

PUT Set NoteToRecipient Payment

Updates the value of attribute 'NoteToRecipient' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/noteToRecipient

PUT Set Notification Payment

Updates the value of attribute 'Notification' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/notification

PUT Set OriginalExchangeRate PaymentLine

Updates the value of attribute 'OriginalExchangeRate' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/originalExchangeRate

PUT Set OutgoingCheckLot Payment

Updates the value of attribute 'OutgoingCheckLot' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/outgoingCheckLot

PUT Set PartyAccountingSchema Payment

Updates the value of attribute 'PartyAccountingSchema' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
companyKey (string) The company key.
value (enum AccountingSchema) The request body should contain the new value for the attribute.
See AccountingSchema.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/partyAccountingSchema

PUT Set PaymentInstruction Payment

Updates the value of attribute 'PaymentInstruction' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/paymentInstruction

PUT Set PaymentMethod Payment

Updates the value of attribute 'PaymentMethod' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/paymentMethod

PUT Set PaymentReference Payment

Updates the value of attribute 'PaymentReference' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/paymentReference

PUT Set PrintedReportName Payment

Updates the value of attribute 'PrintedReportName' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/printedReportName

PUT Set Remarks Payment

Updates the value of attribute 'Remarks' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/remarks

PUT Set ReportingExchangeRate PaymentLine

Updates the value of attribute 'ReportingExchangeRate' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/reportingExchangeRate

PUT Set SettledOriginalAmount PaymentLine

Updates the value of attribute 'SettledOriginalAmount' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/settledOriginalAmount

PUT Set SourceDocId PaymentTax

Updates the value of attribute 'SourceDocId' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentTaxes/{lineId}/sourceDocId

PUT Set SourceSchemaEntity PaymentWTax

Updates the value of attribute 'SourceSchemaEntity' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentWTaxes/{lineId}/sourceSchemaEntity

PUT Set Swift Payment

Updates the value of attribute 'Swift' in the specified entity record.

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/swift

PUT Set Custom Attribute Payment

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey (string) The company key.
documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
customAttributeName (string) The custom attribute name.
value (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute.
See ExtensibilityCustomAttributeValueResource.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/{customAttributeName}

PUT Set Custom Attribute PaymentLine

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey (string) The company key.
documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
lineId (string) The detail identifier.
customAttributeName (string) The custom attribute name.
value (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute.
See ExtensibilityCustomAttributeValueResource.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

PUT /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/{customAttributeName}

DELETE Operations

DELETE Payment by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id (string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204 Deleted. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /accountsPayable/payments/{id}

DELETE Payment by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.

Response:

When successful, the response body is empty.

Response status codes:

204 Deleted. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}

Resources


ApiPaymentDocumentLinesResource

The following elements are required:

settledAmount (MoneyResource) It indicates the amount (in the payment curreny) that is settled by this payment. This amount is deducted to the original open amount. One original document document can be partially settled over multiple payments.
See MoneyResource .
discount (MoneyResource) It indicates the discount amount (in the payment curreny) that is settled by this payment. This discount amount is deducted to the setteled amount. One original document document can be partially settled over multiple payments.
See MoneyResource .
dueDate (DateTime) The due date of the original document to be settled. Internally determined.
issueDate (DateTime) The issue date original document to be settled. Internally determined.
amount (MoneyResource) It indicates the total amount of the original document in the payment currency. Internally determined.
See MoneyResource .
openAmount (MoneyResource) It indicates the current open amount of the original document in the payment currency. One original document document can be partially settled over multiple payments. Internally determined.
See MoneyResource .
settled (bool) Indicates that the current line is selected to include on current payment.
currencyKey (string) The money unit key. Inferred from the payment currency.
withholdingTaxAmount (MoneyResource) It indicates the withholding tax amount (in the payment curreny) that is settled by this payment. In some countries, define the tax amount deducted at the beginning of the payment flow and paid to the tax authorities on behalf of the person / company subject to that tax. This amount is deducted to the original open amount.
See MoneyResource .
openWithholdingTaxAmount (MoneyResource) It indicates the open withholding tax amount (in the payment curreny) that is settled by this payment. In some countries, define the tax amount deducted at the beginning of the payment flow and paid to the tax authorities on behalf of the person / company subject to that tax. This amount is deducted to the original open amount. Internally determined.
See MoneyResource .
financialArea (enum FinancialArea) The payment document financial area (Accounts Receivable or Accounts Payable). Internally determined.
See FinancialArea.
currency (string) Money unit used by the system, such as Euros (EUR) or United States Dollars (USD). This value is important for currency exchanges or to set the number of decimal places used to represent values. The default is defined on the supplier party.
exchangeRate (decimal) The price of the document's currency expressed in the company's base currency. In other words, the rate at which the document's currency can be exchanged for the company's currency. The default is inferred using the defined exchange rates on the system for the document date and currency.
settledOriginalAmount (decimal) It indicates the amount (in the original document currency) that is settled by this payment. This amount is deducted to the original open amount. One original document document can be partially settled over multiple payments. Internally determined.
baseExchangeRate (decimal) The price of the document's currency expressed in the company's base currency. In other words, the rate at which the document's currency can be exchanged for the company's base currency. The default is inferred using the defined exchange rates on the system for the document date and currency.
reportingExchangeRate (decimal) The price of the document's currency expressed in the organization reporting currency. In other words, the rate at which the document's currency can be exchanged for the organization reporting currency. The default is inferred using the defined exchange rates on the system for the document date and currency.
originalExchangeRate (decimal) The original price of the document's currency expressed in the payment's currency. In other words, the rate at which the document's original currency can be exchanged for the payment's currency. Internally infered.

The following elements are optional:

sourceDoc (string) The original document to be settled. The source documents is usually an invoice but other documents can be included on a payment (ex: Credit or Debit Notes). Internally determined.
sourceDocId (Guid) The identifier of the original document to be settled. Internally determined.
accountPosting (string) The accounting posting of the original document. Internally determined.
paymentMethod (string) Financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. The default is defined on the supplier party.
sourceSchemaEntity (string) The schema of the source document entity. Internally determined.
exchangeRateDate (DateTime) The exchange rate creation date.
supplierAccount (string) The supplier GL account.
discountAccount (string) The financial discount GL account assigned from the financial account determination.
dimensionSet (string) The dimension set inherited from the customer dimensions.
chartOfAccount (string) The chart of accounts. Infered from the financial company setup.
nature (enum AccountingNature) The nature of the settled document.
See AccountingNature.
dimensionSetJson (string) Dimension Set Json.


ApiPaymentDocumentTaxesResource

The following elements are required:

taxableAmount (MoneyResource) The payment withholding tax taxable amount. Internally determined.
See MoneyResource .
taxAmount (MoneyResource) The payment line tax amount. Internally determined.
See MoneyResource .
sourceDoc (string) The source document key.
percentage (decimal) The percentage for the payment tax.
openTaxAmount (MoneyResource) The open tax amount for the payment tax.
See MoneyResource .
openTaxableAmount (MoneyResource) The open taxable amount for the payment tax.
See MoneyResource .
taxTypeCode (string) Payment tax type code. Internally determined.
currency (string) Money unit. Inferred from the payment currency. Internally determined.
exchangeRate (decimal) The price of one country's currency expressed in another country's currency. In other words, the rate at which one currency can be exchanged for another. The default is inferred using the defined exchange rates on the system for the document date and currency.

The following elements are optional:

sourceDocId (Guid) The source document id, when the payment was transformed. The source document is usually the invoice. Internally determined.
isExempt (bool) Indicates whether the payment line tax schema is exempt. Internally determined.
sourceSchemaEntityId (Guid) Schema entity from originating document.
taxPosting (string) The tax posting for the payment tax.
exemptionReasonCode (string) Indicates whether the payment tax schema exemption reason. Applicable only if the tax schema is exempt. Internally determined.
exchangeRateDate (DateTime) The exchange rate creation date.


ApiPaymentDocumentWTaxesResource

The following elements are required:

taxableAmount (MoneyResource) The payment withholding tax taxable amount. Internally determined.
See MoneyResource .
withholdingTaxAmount (MoneyResource) The payment total amount for a withhold tax. Internally calculated.
See MoneyResource .
ignore (bool) Indicates whether the payment line tax schema is ignored. Internally determined.
sourceDoc (string) The source document key.
percentage (decimal) The payment withholding tax code rate percentage. Internally determined.
openWithholdingTaxAmount (MoneyResource) The payment line open withholding tax amount.
See MoneyResource .
openTaxableAmount (MoneyResource) The open taxable amount for the payment tax.
See MoneyResource .
wTaxSummary (string) The withholding tax summary for the payment withholding tax.
withholdingTaxCode (string) The payment withholding tax code. Internally determined.
beneficiaryParty (string) The party that will benefit the WTax.
currency (string) Money unit. Inferred from the payment currency.
exchangeRate (decimal) The price of one country's currency expressed in another country's currency. In other words, the rate at which one currency can be exchanged for another. The default is inferred using the defined exchange rates on the system for the document date and currency.

The following elements are optional:

sourceDocId (Guid) The source document id, when the payment was transformed. The source document is usually the invoice. Internally determined.
withholdingPosting (string) The payment line withholding tax amount.
wTaxPosting (string) The withholding tax posting for the payment withholding tax.
sourceSchemaEntity (string) Schema entity from originating document.
exchangeRateDate (DateTime) The exchange rate creation date.


ApiPaymentReportingLinesResource

The following elements are required:

currency (string) Money unit. Inferred from the payment currency.

The following elements are optional:

sourceDoc (string) The source document key.
issueDate (DateTime) Date in which the payment reporting line was issued.
dueDate (DateTime) Date in which the payment is due. In some countries it is also known as law date.
currencyKey (string) Money unit key. Inferred from the payment currency.
amount (decimal) The total line amount.
openAmount (decimal) The remain amount to be settled.
settledAmount (decimal) The line settled amount.
discount (decimal) The line item discount. The default is 0.
withholdingTaxAmount (decimal) The payment line withholding tax amount.
taxableAmount (decimal) The document line taxable amount.
percentage (decimal) The document line taxable percentage.
taxAmount (decimal) The document line tax amount.
taxTypeCode (string) The document line tax type code.


ApiPaymentResource

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
accountingParty (string) The supplier designated in the payment as the party to whom the payment should be sent. It may or may not be the party to whom the goods or services are delivered. The default is defined on the supplier party.
company (string) The company code is the central organizational unit within the system.
documentDate (DateTime) The date when the document is issued.
postingDate (DateTime) The date when the document is created.
currency (string) Money unit used by the system, such as Euros (EUR) or United States Dollars (USD). This value is important for currency exchanges or to set the number of decimal places used to represent values. The default is defined on the supplier party.
exchangeRate (decimal) The price of the document's currency expressed in the company's base currency. In other words, the rate at which the document's currency can be exchanged for the company's base currency. The default is inferred using the defined exchange rates on the system for the document date and currency.
isPaymentMethodCheck (bool) Determines if the used payment method is of type check. Applicable only when the payment is cash payment and the payment method is of type check. Internally determined.
allowanceChargeAmount (MoneyResource) Total discount over goods and services. Internally calculated.
See MoneyResource .
grossValue (MoneyResource) Total value of goods and services before taxes or discounts. Internally calculated.
See MoneyResource .
payableAmount (MoneyResource) The payable amount. Total value of goods and services including taxes and discounts. Internally calculated.
See MoneyResource .
wTaxTotal (MoneyResource) Total withholding tax value of goods and services. Internally calculated.
See MoneyResource .
taxTotal (MoneyResource) Total tax value of goods and services. Internally calculated.
See MoneyResource .
taxExclusiveAmount (MoneyResource) The payment total net value. Total value of goods and services after discounts, excluding taxes. Internally calculated.
See MoneyResource .
chartOfAccount (string) The chart of accounts. Infered from the financial company setup.

The following elements are optional:

documentLines (List of ApiPaymentDocumentLinesResource) The payment lines.
See ApiPaymentDocumentLinesResource.
documentTaxes (List of ApiPaymentDocumentTaxesResource) The payment taxes.
See ApiPaymentDocumentTaxesResource.
documentWTaxes (List of ApiPaymentDocumentWTaxesResource) The payment withholding taxes.
See ApiPaymentDocumentWTaxesResource.
reportingLines (List of ApiPaymentReportingLinesResource) The reporting lines.
See ApiPaymentReportingLinesResource.
remarks (string) The payment remarks.
note (string) The document note.
partyAddress (string) The supplier address.
isPrinted (bool) Indicates if the payment has been printed. Internally determined.
noteToRecipient (string) Note to the payment recipient.
accountingSchemaLegalStamp (string) The accounting schema legal stamp.
paymentMethodStamp (string) Sentence to be printed on the Payment, regarding the Payment Means.
financialAccount (string) An account that exists in a financial institution. The financial institution holds someone's money, resulting in a positive balance. It can also be a credit or loans account in which the bank lends money, resulting in a negative balance or debit. Unlike a brokerage account, which allows the investor to buy and sell stocks, a bank account is used for savings. The types of bank accounts include savings accounts and current accounts.
cashFlowItem (string) Incoming and outgoing cash flow caused by the main business activities. The component of the cash flow operations shows how much money is generated by a company's products or services. Generally, the changes made to the cash, banks, accounts receivables and accounts payable affects operational cash. The classification of each of these operations' types is made by using cash flows.
exchangeRateDate (DateTime) The exchange rate creation date.
checkNumber (int) The number of the check used for this payment. Applicable only when the payment is cash payment and the payment method is of type check.
outgoingCheckLot (string) The outgoint lot of the check used for this payment document. Applicable only when the payment is cash payment and the payment method is of type check.
paymentMethod (string) Financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. The default is defined on the supplier party.
accountingSchema (enum AccountingSchema) The accounting organization method. The organization can follow the rules of "Cash Accounting" or "Accrual Accounting".
See AccountingSchema.
partyAccountingSchema (enum AccountingSchema) The supplier accounting organization method. The supplier organication can follow the rules of "Cash Accounting" or "Accrual Accounting".
See AccountingSchema.
notification (string) The payment notification configuration. Inferred from the payment type.
emailTo (string) The email(s) to send payment notification. Inferred from the notification.
dimensionSet (string) The dimension set. Infered from the dimensions of the petty cash or bank account.
account (string) The GL account to be used for the cash flow (petty cash or financial account).
paymentReference (string) The external payment reference.
dimensionSetJson (string) Dimension Set Json.
swift (string) Swift.
iBAN (string) IBAN.
paymentInstruction (string) Payment Instruction.
printedReportName (string) Indicates the report name used to print the document. Internally determined.


MoneyResource

The following elements are required:

amount (decimal) The amount.

The following elements are optional:

baseAmount (decimal) The base amount.
reportingAmount (decimal) The reporting amount.
fractionDigits (int) The fraction digits.
symbol (string) The symbol.

Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.



PaymentLineResource

The following elements are required:

settledAmount (MoneyResource) It indicates the amount (in the payment curreny) that is settled by this payment. This amount is deducted to the original open amount. One original document document can be partially settled over multiple payments.
See MoneyResource .
discount (MoneyResource) It indicates the discount amount (in the payment curreny) that is settled by this payment. This discount amount is deducted to the setteled amount. One original document document can be partially settled over multiple payments.
See MoneyResource .
dueDate (DateTime) The due date of the original document to be settled. Internally determined.
issueDate (DateTime) The issue date original document to be settled. Internally determined.
amount (MoneyResource) It indicates the total amount of the original document in the payment currency. Internally determined.
See MoneyResource .
openAmount (MoneyResource) It indicates the current open amount of the original document in the payment currency. One original document document can be partially settled over multiple payments. Internally determined.
See MoneyResource .
settled (bool) Indicates that the current line is selected to include on current payment.
currencyKey (string) The money unit key. Inferred from the payment currency.
withholdingTaxAmount (MoneyResource) It indicates the withholding tax amount (in the payment curreny) that is settled by this payment. In some countries, define the tax amount deducted at the beginning of the payment flow and paid to the tax authorities on behalf of the person / company subject to that tax. This amount is deducted to the original open amount.
See MoneyResource .
openWithholdingTaxAmount (MoneyResource) It indicates the open withholding tax amount (in the payment curreny) that is settled by this payment. In some countries, define the tax amount deducted at the beginning of the payment flow and paid to the tax authorities on behalf of the person / company subject to that tax. This amount is deducted to the original open amount. Internally determined.
See MoneyResource .
financialArea (enum FinancialArea) The payment document financial area (Accounts Receivable or Accounts Payable). Internally determined.
See FinancialArea.
currency (string) Money unit used by the system, such as Euros (EUR) or United States Dollars (USD). This value is important for currency exchanges or to set the number of decimal places used to represent values. The default is defined on the supplier party.
exchangeRate (decimal) The price of the document's currency expressed in the company's base currency. In other words, the rate at which the document's currency can be exchanged for the company's currency. The default is inferred using the defined exchange rates on the system for the document date and currency.
settledOriginalAmount (decimal) It indicates the amount (in the original document currency) that is settled by this payment. This amount is deducted to the original open amount. One original document document can be partially settled over multiple payments. Internally determined.
baseExchangeRate (decimal) The price of the document's currency expressed in the company's base currency. In other words, the rate at which the document's currency can be exchanged for the company's base currency. The default is inferred using the defined exchange rates on the system for the document date and currency.
reportingExchangeRate (decimal) The price of the document's currency expressed in the organization reporting currency. In other words, the rate at which the document's currency can be exchanged for the organization reporting currency. The default is inferred using the defined exchange rates on the system for the document date and currency.
originalExchangeRate (decimal) The original price of the document's currency expressed in the payment's currency. In other words, the rate at which the document's original currency can be exchanged for the payment's currency. Internally infered.
originalOpenAmount (MoneyResource) Original Open Amount.
See MoneyResource .

The following elements are optional:

sourceDoc (string) The original document to be settled. The source documents is usually an invoice but other documents can be included on a payment (ex: Credit or Debit Notes). Internally determined.
sourceDocId (Guid) The identifier of the original document to be settled. Internally determined.
accountPosting (string) The accounting posting of the original document. Internally determined.
paymentMethod (string) Financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. The default is defined on the supplier party.
sourceSchemaEntity (string) The schema of the source document entity. Internally determined.
exchangeRateDate (DateTime) The exchange rate creation date.
supplierAccount (string) The supplier GL account.
discountAccount (string) The financial discount GL account assigned from the financial account determination.
dimensionSet (string) The dimension set inherited from the customer dimensions.
chartOfAccount (string) The chart of accounts. Infered from the financial company setup.
nature (enum AccountingNature) The nature of the settled document.
See AccountingNature.
dimensionSetJson (string) Dimension Set Json.


PaymentReportingLineResource

The following elements are required:

currency (string) Money unit. Inferred from the payment currency.

The following elements are optional:

sourceDoc (string) The source document key.
issueDate (DateTime) Date in which the payment reporting line was issued.
dueDate (DateTime) Date in which the payment is due. In some countries it is also known as law date.
currencyKey (string) Money unit key. Inferred from the payment currency.
amount (decimal) The total line amount.
openAmount (decimal) The remain amount to be settled.
settledAmount (decimal) The line settled amount.
discount (decimal) The line item discount. The default is 0.
withholdingTaxAmount (decimal) The payment line withholding tax amount.
taxableAmount (decimal) The document line taxable amount.
percentage (decimal) The document line taxable percentage.
taxAmount (decimal) The document line tax amount.
taxTypeCode (string) The document line tax type code.


PaymentResource

The following elements are required:

documentType (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
(fk) Allowed value: the natural key of a record of type PaymentType. These records are accessibly through the PaymentTypes service.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
(fk) Allowed value: the natural key of a record of type Serie. These records are accessibly through the Series service.
seriesNumber (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key.
accountingParty (string) The supplier designated in the payment as the party to whom the payment should be sent. It may or may not be the party to whom the goods or services are delivered. The default is defined on the supplier party.
(fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service.
company (string) The company code is the central organizational unit within the system.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
documentDate (DateTime) The date when the document is issued.
postingDate (DateTime) The date when the document is created.
currency (string) Money unit used by the system, such as Euros (EUR) or United States Dollars (USD). This value is important for currency exchanges or to set the number of decimal places used to represent values. The default is defined on the supplier party.
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.
exchangeRate (decimal) The price of the document's currency expressed in the company's base currency. In other words, the rate at which the document's currency can be exchanged for the company's base currency. The default is inferred using the defined exchange rates on the system for the document date and currency.
isPaymentMethodCheck (bool) Determines if the used payment method is of type check. Applicable only when the payment is cash payment and the payment method is of type check. Internally determined.
allowanceChargeAmount (MoneyResource) Total discount over goods and services. Internally calculated.
See MoneyResource .
grossValue (MoneyResource) Total value of goods and services before taxes or discounts. Internally calculated.
See MoneyResource .
payableAmount (MoneyResource) The payable amount. Total value of goods and services including taxes and discounts. Internally calculated.
See MoneyResource .
wTaxTotal (MoneyResource) Total withholding tax value of goods and services. Internally calculated.
See MoneyResource .
taxTotal (MoneyResource) Total tax value of goods and services. Internally calculated.
See MoneyResource .
taxExclusiveAmount (MoneyResource) The payment total net value. Total value of goods and services after discounts, excluding taxes. Internally calculated.
See MoneyResource .
journalType (string) The journal type of the account document(ex:80).
(fk) Allowed value: the natural key of a record of type JournalType. These records are accessibly through the JournalTypes service.
journalNumber (int) The journal number assigned in accounting.
chartOfAccount (string) The chart of accounts. Infered from the financial company setup.
(fk) Allowed value: the natural key of a record of type ChartOfAccount. These records are accessibly through the ChartOfAccounts service.

The following elements are optional:

documentLines (List of PaymentLineResource) The payment lines.
See PaymentLineResource.
documentTaxes (List of PaymentTaxResource) The payment taxes.
See PaymentTaxResource.
documentWTaxes (List of PaymentWTaxResource) The payment withholding taxes.
See PaymentWTaxResource.
reportingLines (List of PaymentReportingLineResource) The reporting lines.
See PaymentReportingLineResource.
remarks (string) The payment remarks.
note (string) The document note.
partyAddress (string) The supplier address.
isPrinted (bool) Indicates if the payment has been printed. Internally determined.
noteToRecipient (string) Note to the payment recipient.
accountingSchemaLegalStamp (string) The accounting schema legal stamp.
paymentMethodStamp (string) Sentence to be printed on the Payment, regarding the Payment Means.
financialAccount (string) An account that exists in a financial institution. The financial institution holds someone's money, resulting in a positive balance. It can also be a credit or loans account in which the bank lends money, resulting in a negative balance or debit. Unlike a brokerage account, which allows the investor to buy and sell stocks, a bank account is used for savings. The types of bank accounts include savings accounts and current accounts.
(fk) Allowed value: the natural key of a record of type FinancialAccount. These records are accessibly through the FinancialAccounts service.
cashFlowItem (string) Incoming and outgoing cash flow caused by the main business activities. The component of the cash flow operations shows how much money is generated by a company's products or services. Generally, the changes made to the cash, banks, accounts receivables and accounts payable affects operational cash. The classification of each of these operations' types is made by using cash flows.
(fk) Allowed value: the natural key of a record of type CashFlowItem. These records are accessibly through the CashFlowItems service.
exchangeRateDate (DateTime) The exchange rate creation date.
checkNumber (int) The number of the check used for this payment. Applicable only when the payment is cash payment and the payment method is of type check.
outgoingCheckLot (string) The outgoint lot of the check used for this payment document. Applicable only when the payment is cash payment and the payment method is of type check.
(fk) Allowed value: the natural key of a record of type OutgoingCheckLot. These records are accessibly through the OutgoingCheckLots service.
paymentMethod (string) Financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. The default is defined on the supplier party.
(fk) Allowed value: the natural key of a record of type PaymentMethod. These records are accessibly through the PaymentMethods service.
accountingSchema (enum AccountingSchema) The accounting organization method. The organization can follow the rules of "Cash Accounting" or "Accrual Accounting".
See AccountingSchema.
partyAccountingSchema (enum AccountingSchema) The supplier accounting organization method. The supplier organication can follow the rules of "Cash Accounting" or "Accrual Accounting".
See AccountingSchema.
notification (string) The payment notification configuration. Inferred from the payment type.
(fk) Allowed value: the natural key of a record of type Notification.
emailTo (string) The email(s) to send payment notification. Inferred from the notification.
ledger (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger.
(fk) Allowed value: the natural key of a record of type Ledger. These records are accessibly through the Ledgers service.
dimensionSet (string) The dimension set. Infered from the dimensions of the petty cash or bank account.
(fk) Allowed value: the natural key of a record of type DimensionSet. These records are accessibly through the DimensionSets service.
account (string) The GL account to be used for the cash flow (petty cash or financial account).
(fk) Allowed value: the natural key of a record of type GLAccount. These records are accessibly through the GLAccounts service.
accountingDocument (string) The accounting document that was assigned in accounting.
paymentReference (string) The external payment reference.
dimensionSetJson (string) Dimension Set Json.
swift (string) Swift.
iBAN (string) IBAN.
paymentInstruction (string) Payment Instruction.
printedReportName (string) Indicates the report name used to print the document. Internally determined.
isReprinted (bool) Indicates if the document has been reprinted. Internally determined.
isSigned (bool) Indicates if the document is electronically signed with a valid certificate. Internally determined.


PaymentTaxResource

The following elements are required:

taxableAmount (MoneyResource) The payment withholding tax taxable amount. Internally determined.
See MoneyResource .
taxAmount (MoneyResource) The payment line tax amount. Internally determined.
See MoneyResource .
sourceDoc (string) The source document key.
percentage (decimal) The percentage for the payment tax.
openTaxAmount (MoneyResource) The open tax amount for the payment tax.
See MoneyResource .
openTaxableAmount (MoneyResource) The open taxable amount for the payment tax.
See MoneyResource .
taxTypeCode (string) Payment tax type code. Internally determined.
currency (string) Money unit. Inferred from the payment currency. Internally determined.
exchangeRate (decimal) The price of one country's currency expressed in another country's currency. In other words, the rate at which one currency can be exchanged for another. The default is inferred using the defined exchange rates on the system for the document date and currency.

The following elements are optional:

sourceDocId (Guid) The source document id, when the payment was transformed. The source document is usually the invoice. Internally determined.
isExempt (bool) Indicates whether the payment line tax schema is exempt. Internally determined.
sourceSchemaEntityId (Guid) Schema entity from originating document.
taxPosting (string) The tax posting for the payment tax.
exemptionReasonCode (string) Indicates whether the payment tax schema exemption reason. Applicable only if the tax schema is exempt. Internally determined.
exchangeRateDate (DateTime) The exchange rate creation date.


PaymentWTaxResource

The following elements are required:

taxableAmount (MoneyResource) The payment withholding tax taxable amount. Internally determined.
See MoneyResource .
withholdingTaxAmount (MoneyResource) The payment total amount for a withhold tax. Internally calculated.
See MoneyResource .
ignore (bool) Indicates whether the payment line tax schema is ignored. Internally determined.
sourceDoc (string) The source document key.
percentage (decimal) The payment withholding tax code rate percentage. Internally determined.
openWithholdingTaxAmount (MoneyResource) The payment line open withholding tax amount.
See MoneyResource .
openTaxableAmount (MoneyResource) The open taxable amount for the payment tax.
See MoneyResource .
wTaxSummary (string) The withholding tax summary for the payment withholding tax.
withholdingTaxCode (string) The payment withholding tax code. Internally determined.
beneficiaryParty (string) The party that will benefit the WTax.
currency (string) Money unit. Inferred from the payment currency.
exchangeRate (decimal) The price of one country's currency expressed in another country's currency. In other words, the rate at which one currency can be exchanged for another. The default is inferred using the defined exchange rates on the system for the document date and currency.

The following elements are optional:

sourceDocId (Guid) The source document id, when the payment was transformed. The source document is usually the invoice. Internally determined.
withholdingPosting (string) The payment line withholding tax amount.
wTaxPosting (string) The withholding tax posting for the payment withholding tax.
sourceSchemaEntity (string) Schema entity from originating document.
exchangeRateDate (DateTime) The exchange rate creation date.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.

Enumerations


AccountingNature

1 Debit
2 Credit


AccountingSchema

1 Accrual Acrrual Accounting Schema.
2 Cash


FinancialArea

1 AccountsReceivable
2 AccountsPayable
3 Accounting