Accounting scripts V1

Create accounting script V1

Create an accounting script.

Refer to the How to create accounting script guide for more information.

post/v1/accounting-scripts

Request

  • Base URL
    https://sandbox.pismolabs.io/passport
  • URL
    https://sandbox.pismolabs.io/passport/v1/accounting-scripts
  • Auth
    none declared

Request body

entry_type_idinteger required

Related entry type ID

event_type_idinteger required

Related event type ID

credit_accounting_account_idinteger required

Accounting account ID assigned as credit account

debit_accounting_account_idinteger required

Accounting account ID assigned as debit account

program_idinteger required

Related program ID

entry_name'amount' | 'amount-advancement' | 'amount-advancement-dueDate' | 'amount-advancement-shift' | 'amount-advancement-shift-dueDate' | 'amount-anticipation' | 'amount-cancelment-anticipation' | 'amount-clearing' | 'amount-contract' | 'amount-dueDate' | 'amount-dueDate-cancelment' | 'amount-reversal' | 'contractAmount' | 'daily-interest' | 'fine' | 'interest' | 'interest-advancement' | 'interest-advancement-dueDate' | 'interest-anticipation' | 'interest-dueDate' | 'interest-not-appropriated' | 'interest-partial' | 'iof' | 'iof-dueDate' | 'overdue'

Base entry ID. If not provided, defaults to 'amount'.

  • amount: Principal amount of the transaction on the event date. It usually represents the gross value of the operation associated with the corresponding flow/entry_type.
  • amount-advancement: Principal amount of the advance (excluding interest/charges), that is, the principal being advanced (for example, installment agreement advance, invoice advance, receivables advance).
  • amount-advancement-dueDate: Principal amount of the advance, posted on the due date of the cycle to which the transaction was advanced.
  • amount-advancement-shift: Principal amount of the advance using the “shift” API (date change / flow adjustment), for example advance of an installment or invoice where there is a replacement/change of the original flow. Used to represent the principal of the installment/amount that is being moved from a future date to a present date through an advance.
  • amount-advancement-shift-dueDate: Same concept as amount-advancement-shift, but related to the due date. It represents the principal of the advance associated with the original due date of the obligation that was “shifted” (moved/adjusted) by the advance process.
  • amount-anticipation: This amount name is deprecated. Standard routings that were eventually created with it are deprecated and have corresponding routings with -advancement amount values.
  • amount-cancelment-anticipation: This amount name is deprecated. Standard routings that were created with it are deprecated and have corresponding routings with -advancement amount values.
  • amount-clearing: Amount used exclusively for configuring the posting of the installment principal (without interest) upon the clearing arrival of each installment.
  • amount-contract: This amount name is deprecated. Standard routings that were created with it are deprecated and have corresponding routings with amount values.
  • amount-dueDate: Principal amount of the transaction related to the due date (for example, an installment or invoice that is due). Used when the amount to be posted is linked to a specific due date, even if the event occurs before that date. It represents the due date posting of the amount.
  • amount-dueDate-cancelment: This amount name is deprecated.
  • amount-reversal: This amount name is deprecated and has no corresponding movement, as there are no mapped usage scenarios for it.
  • contractAmount: This amount is deprecated. The transactions for which it may be configured are transactions 608 and 612. If it is currently used, the recommendation is to create routings with amount, which will return the total transaction value. Used as a reference for the total obligation assumed at the time of contracting.
  • daily-interest: Amount of daily interest calculated for a period (for example, between two specific dates), usually used in scenarios such as pro-rata interest calculation.
  • fine: Fine amount included in a payment (amount that is discharged). This type should only be used when linked to transaction 201 (payment). When used, it provides details of how much of that payment corresponds to the fine.
  • interest: Amount of interest calculated/incurred on the transaction, whether it is a contract transaction or an installment. Important: this should only be used if the interest is included together with the transaction's total amount, so that the interest is explicitly identified as such. If the interest is already in a separate transaction, amount should be used instead.
  • interest-advancement: Interest amount related to the advance operation, for example, interest amount of an advanced installment.
  • interest-advancement-dueDate: Interest amount of the advance, posted on the due date of the cycle to which the transaction was advanced.
  • interest-anticipation: This amount name is deprecated. Standard routings that were created with it are deprecated and have corresponding routings with -advancement amount values.
  • interest-dueDate: Interest amount of an operation at the due date. The usage logic is the same as for interest, but in this case the posting occurs on the due date.
  • interest-not-appropriated: Amount exclusively used for posting interest from transaction 706 (invoice installment cancellation). It obtains the interest amount to be posted from the original contracting transaction.
  • interest-partial: This amount name is deprecated and has been replaced by daily-interest.
  • iof: IOF amount (financial transactions tax) associated with the event operation. As with interest, the same logic applies: if the IOF is already in a specific and separate transaction, this option should not be used, and amount is the correct option.
  • iof-dueDate: IOF amount (financial transactions tax) associated with the event operation. As with interest, the same logic applies: if the IOF is already in a specific and separate transaction, this option should not be used, and `amount`` is the correct option. This due-date option posts the value on the due date of the invoice that contains the transaction.
  • overdue: Late interest (penalty interest) amount included in a payment (amount that is discharged). This type should only be used when linked to transaction 201 (payment). When used, it provides details of how much of that payment corresponds to late interest.
processing_codestring

Processint code. When the script is based on a processing code, this field is REQUIRED.

Example request

{
  "cost_center": {
    "debit_org": "999999",
    "credit_org": "999999",
    "debit_cost": "999999",
    "credit_cost": "999999",
    "deactivated_at": "2021-10-10T10:10:00.000Z"
  }
}

Response

OK

entry_namestring

Base entry ID

entry_type_idinteger

Related entry type ID

event_type_idinteger

Related event type ID

idinteger

Account script ID

processing_codestring

Processing code. When the script is based on a processing code, this field is REQUIRED.

program_idinteger

Related program ID

Example response

{
  "credit_accounting": {
    "id": 1,
    "description": "SAMPLE ACCOUNT",
    "account": "123123132-x",
    "program_id": 12,
    "created_at": "2021-10-10T10:10:00.000Z"
  },
  "cost_center": {
    "debit_org": "999999",
    "credit_org": "999999",
    "debit_cost": "999999",
    "credit_cost": "999999",
    "deactivated_at": "2021-10-10T10:10:00.000Z"
  },
  "debit_accounting": {
    "id": 1,
    "description": "SAMPLE ACCOUNT",
    "account": "123123132-x",
    "program_id": 12,
    "created_at": "2021-10-10T10:10:00.000Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.